Thread: [Plog-general] Documentation in CVS
Brought to you by:
jondaley
From: Oscar R. <os...@re...> - 2003-08-15 16:59:51
|
Warren, I've added to CVS some more html files that make up the "pLog Template Objects" section. They are a bunch of html files, and a style-sheet and have been automatically generated by a tool called Doxygen, that extracts information from code (pretty much like what Javadoc does) Such documentation is actually needed if we are to introduce people to the development/customization of templates since for every object, it describes its methods, attributes, etc. Unfortunately they follow their own design and layout but I don't think we should worry too much about that. Have a look at them if you want, they're under the objref/ folder. I've modified the index to accomodate this new section/appendix and I've also been working on the Customization section. It's growing big! :) It's growing so big that I am considering moving the whole part about templates to its own section... Don't know if it's me or if there really is so much to tell ;) On a side note, could we be more careful with the new line characters? I mean, I updated today the files in the plog_docs module and for some reason, CVS choked on docs.css and decided that my file was completely different from yours... "huh?", I though, very intelligently... ;) It turns out that the file had been saved using the linefeed from windows (\r\n) and had those strange characters all over the place in the end of the lines... Nothing that this time couldn't be sorted out but it could be a little bit more difficult next time. Could we make sure we don't run in the same trouble again? Don't get me wrong, but just in case O:) Have a nice weekend!!! Oscar. |
From: Warren L. <wa...@is...> - 2003-08-16 04:23:02
|
Hmm weird.. I made sure I saved the files under UNIX format.. Will recheck.. > -----Original Message----- > From: plo...@li... > [mailto:plo...@li...] On Behalf > Of Oscar Renalias > Sent: Friday, August 15, 2003 11:31 PM > To: plo...@li... > Subject: [Plog-general] Documentation in CVS > > > Warren, > > I've added to CVS some more html files that make up the "pLog > Template > Objects" section. They are a bunch of html files, and a > style-sheet and have > been automatically generated by a tool called Doxygen, that extracts > information from code (pretty much like what Javadoc does) > Such documentation > is actually needed if we are to introduce people to the > development/customization of templates since for every > object, it describes > its methods, attributes, etc. Unfortunately they follow their > own design and > layout but I don't think we should worry too much about that. > Have a look at > them if you want, they're under the objref/ folder. > > I've modified the index to accomodate this new > section/appendix and I've also > been working on the Customization section. It's growing big! > :) It's growing > so big that I am considering moving the whole part about > templates to its own > section... Don't know if it's me or if there really is so > much to tell ;) > > On a side note, could we be more careful with the new line > characters? I mean, > I updated today the files in the plog_docs module and for > some reason, CVS > choked on docs.css and decided that my file was completely > different from > yours... "huh?", I though, very intelligently... ;) It turns > out that the > file had been saved using the linefeed from windows (\r\n) > and had those > strange characters all over the place in the end of the > lines... Nothing that > this time couldn't be sorted out but it could be a little bit > more difficult > next time. Could we make sure we don't run in the same > trouble again? Don't > get me wrong, but just in case O:) > > Have a nice weekend!!! > > Oscar. > > > ------------------------------------------------------- > This SF.Net email sponsored by: Free pre-built ASP.NET sites > including Data Reports, E-commerce, Portals, and Forums are > available now. Download today and enter to win an XBOX or > Visual Studio .NET. > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet _072303_01/01 _______________________________________________ Plog-general mailing list Plo...@li... https://lists.sourceforge.net/lists/listinfo/plog-general |
From: Warren L. <wa...@is...> - 2003-08-16 04:43:39
|
Oscar, My suggestion for the objects is to put it under the Customization/Templates/ section then just put a link to that section. We're running out of space for section links up top. I also feel that we shouldn't have too many main sections. We can categorize those sections and from the section files just make another link to the files holding the information. ie the Object reference goes, i. Templates 4. pLog Template Object Reference Text: For in-depth information regarding what you can use as objects in templates, please go here --> objref/index.html How's that? |
From: Oscar R. <os...@re...> - 2003-08-16 08:17:01
|
Hi! > i. Templates > 4. pLog Template Object Reference > > Text: For in-depth information regarding what you can use as objects in > templates, please go here --> objref/index.html Sounds good to me. I'll change it as soon as possible. I guess its also good not to have so many sections... but when things get bigger, adding another section is the first thing that comes to my mind. I'll see how I can reorganize the "Customization" section. Regards, Oscar. |
From: Warren L. <wa...@is...> - 2003-08-16 08:20:00
|
Already done. Updated but haven't committed yet. Working on it right now. Please take a look at the TODO file > -----Original Message----- > From: plo...@li... > [mailto:plo...@li...] On Behalf > Of Oscar Renalias > Sent: Saturday, August 16, 2003 3:00 PM > To: plo...@li... > Subject: Re: [Plog-general] Documentation in CVS > > > Hi! > > > i. Templates > > 4. pLog Template Object Reference > > > > Text: For in-depth information regarding what you can use > as objects > > in templates, please go here --> objref/index.html > > Sounds good to me. > > I'll change it as soon as possible. > > I guess its also good not to have so many sections... but > when things get > bigger, adding another section is the first thing that comes > to my mind. I'll > see how I can reorganize the "Customization" section. > > Regards, > > Oscar. > > > ------------------------------------------------------- > This SF.Net email sponsored by: Free pre-built ASP.NET sites > including Data Reports, E-commerce, Portals, and Forums are > available now. Download today and enter to win an XBOX or > Visual Studio .NET. > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet _072303_01/01 _______________________________________________ Plog-general mailing list Plo...@li... https://lists.sourceforge.net/lists/listinfo/plog-general |
From: Oscar R. <os...@re...> - 2003-08-16 08:28:32
|
Checked. My comments about this one: "objref/ - Warren 1. Think of ways to let it conform to grey template style and implement it once Oscar confirms text is done" The problem with this is that... For every little change we'll have to rebuild all the pages since they are generated automatically from the comments inside the source file. That is why I said that we should not bother so much about making it look like everything else, since I also guess that users will understand that. Unless it does not need many more changes other than adding the "docs.css" stylesheet, I'd say that we think about it carefully. I'll also have a look at it and evaluate how long that would take... Oh, and about this one: "customization.html - Warren 1. Clean up layout code before Oscar adds more text and standardize formatting with the other pages 2. Finish proof-reading Oscar's text 3. Create CSS entries for <table> so that IE displays it properly and conforms to the grey look" Sorry that the whole page looks now in a mess. I normally write everything first and then start applying the formatting ;) I was also trying to find a solution for the problem with the table but I didn't have time yesterday to get round to it... Let me know if you can think of something. Regards, Oscar. On Saturday 16 August 2003 11:19, Warren Liu wrote: > Already done. Updated but haven't committed yet. Working on it right > now. > > Please take a look at the TODO file > > > -----Original Message----- > > From: plo...@li... > > [mailto:plo...@li...] On Behalf > > Of Oscar Renalias > > Sent: Saturday, August 16, 2003 3:00 PM > > To: plo...@li... > > Subject: Re: [Plog-general] Documentation in CVS > > > > > > Hi! > > > > > i. Templates > > > 4. pLog Template Object Reference > > > > > > Text: For in-depth information regarding what you can use > > > > as objects > > > > > in templates, please go here --> objref/index.html > > > > Sounds good to me. > > > > I'll change it as soon as possible. > > > > I guess its also good not to have so many sections... but > > when things get > > bigger, adding another section is the first thing that comes > > to my mind. I'll > > see how I can reorganize the "Customization" section. > > > > Regards, > > > > Oscar. > > > > > > ------------------------------------------------------- > > This SF.Net email sponsored by: Free pre-built ASP.NET sites > > including Data Reports, E-commerce, Portals, and Forums are > > available now. Download today and enter to win an XBOX or > > Visual Studio .NET. > > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet > > _072303_01/01 > _______________________________________________ > Plog-general mailing list > Plo...@li... > https://lists.sourceforge.net/lists/listinfo/plog-general > > > > > > ------------------------------------------------------- > This SF.Net email sponsored by: Free pre-built ASP.NET sites including > Data Reports, E-commerce, Portals, and Forums are available now. > Download today and enter to win an XBOX or Visual Studio .NET. > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01 > _______________________________________________ > Plog-general mailing list > Plo...@li... > https://lists.sourceforge.net/lists/listinfo/plog-general |
From: Warren L. <wa...@is...> - 2003-08-16 08:58:19
|
My installation.html is also a mess right now so I can't really complain about customization.html. I think we should stick with <table> and define it in CSS, at least that's what I'm doing right now. IE doesn't really conform to CSS so using a deprecated tag makes some sense, since I don't even want to bother making it look the same on IE as the other more acceptable geek browsers like Konq + variants, Moz + variants and opera. Long as the basic formating holds on IE, I'll just leave it at that. Right now IE is displaying the tables in customization.html in font sizes that's at 14px on my end. UGLY... Moz is doing alright... I'm doing everything by hand right now. Can't trust any WYSIWYG editors to generate nice clean html code. I'm currently working on the layout code and adding things to docs.css as needed. I really like the span stuff you added. Just hoping this heat doesn't kill my notebook, at the office and no ac, temperature at 35C inside and 38C outside and my router at home died from a power spike, no easy way to replace it since the nearest place that sells it is 1 hour's drive from the city center, or I pay 200% the normal price from places in the business district, part of the sacrifice you get for accepting a job in emerging markets, at least I've got maids to clean up the place when I make a mess and no more laundry stacked sky-high. Anyways, I'm back to fixing it.. Warren PS nothing is really our faults.. Its bloody IE that's freaking annoying to deal with if you want to write standard conformance html code. > -----Original Message----- > From: plo...@li... > [mailto:plo...@li...] On Behalf > Of Oscar Renalias > Sent: Saturday, August 16, 2003 3:23 PM > To: plo...@li... > Subject: Re: [Plog-general] Documentation in CVS > > > Checked. My comments about this one: > > "objref/ - Warren > 1. Think of ways to let it conform to grey template style and > implement it once Oscar confirms text is done" > > The problem with this is that... For every little change > we'll have to rebuild > all the pages since they are generated automatically from the > comments inside > the source file. That is why I said that we should not bother > so much about > making it look like everything else, since I also guess that > users will > understand that. > > Unless it does not need many more changes other than adding > the "docs.css" > stylesheet, I'd say that we think about it carefully. I'll > also have a look > at it and evaluate how long that would take... > > Oh, and about this one: > > "customization.html - Warren > 1. Clean up layout code before Oscar adds more text > and standardize > formatting with the other pages > 2. Finish proof-reading Oscar's text > 3. Create CSS entries for <table> so that IE displays > it properly and > conforms to the grey look" > > Sorry that the whole page looks now in a mess. I normally > write everything > first and then start applying the formatting ;) I was also > trying to find a > solution for the problem with the table but I didn't have > time yesterday to > get round to it... Let me know if you can think of something. > > Regards, > > Oscar. > > On Saturday 16 August 2003 11:19, Warren Liu wrote: > > Already done. Updated but haven't committed yet. Working on > it right > > now. > > > > Please take a look at the TODO file > > > > > -----Original Message----- > > > From: plo...@li... > > > [mailto:plo...@li...] On > Behalf Of Oscar > > > Renalias > > > Sent: Saturday, August 16, 2003 3:00 PM > > > To: plo...@li... > > > Subject: Re: [Plog-general] Documentation in CVS > > > > > > > > > Hi! > > > > > > > i. Templates > > > > 4. pLog Template Object Reference > > > > > > > > Text: For in-depth information regarding what you can use > > > > > > as objects > > > > > > > in templates, please go here --> objref/index.html > > > > > > Sounds good to me. > > > > > > I'll change it as soon as possible. > > > > > > I guess its also good not to have so many sections... but when > > > things get bigger, adding another section is the first thing that > > > comes to my mind. I'll > > > see how I can reorganize the "Customization" section. > > > > > > Regards, > > > > > > Oscar. > > > > > > > > > ------------------------------------------------------- > > > This SF.Net email sponsored by: Free pre-built ASP.NET sites > > > including Data Reports, E-commerce, Portals, and Forums are > > > available now. Download today and enter to win an XBOX or Visual > > > Studio .NET. > > > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet > > > > _072303_01/01 > > _______________________________________________ > > Plog-general mailing list > > Plo...@li... > > https://lists.sourceforge.net/lists/listinfo/plog-general > > > > > > > > > > > > ------------------------------------------------------- > > This SF.Net email sponsored by: Free pre-built ASP.NET > sites including > > Data Reports, E-commerce, Portals, and Forums are available now. > > Download today and enter to win an XBOX or Visual Studio .NET. > > > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_> 072303_ > > 01/01 > > _______________________________________________ > > Plog-general mailing list > > Plo...@li... > > https://lists.sourceforge.net/lists/listinfo/plog-general > > > ------------------------------------------------------- > This SF.Net email sponsored by: Free pre-built ASP.NET sites > including Data Reports, E-commerce, Portals, and Forums are > available now. Download today and enter to win an XBOX or > Visual Studio .NET. > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet _072303_01/01 _______________________________________________ Plog-general mailing list Plo...@li... https://lists.sourceforge.net/lists/listinfo/plog-general |
From: Warren L. <wa...@is...> - 2003-08-16 09:32:13
|
Oscar, Can you not touch customization.html for a day. This heat is killing me and I'm going to go home and work on this. So I can't do any CVS updates or commit. There will be lots of changes by the time I commit and I rather not go through diffing, especially if you are adding text. Will do a commit before I get on the plane tomorrow which should still be wee hours in the morning for you in europe. Warren |
From: Oscar R. <os...@re...> - 2003-08-16 10:21:42
|
That's fine for me. I'll work on the Resource Center of the new version since it looks like there are no more bugs in the stable version ;) Let me know when it's done, somehow. Have a nice weekend! Oscar. On Saturday 16 August 2003 12:30, Warren Liu wrote: > Oscar, > > Can you not touch customization.html for a day. This heat is killing me > and I'm going to go home and work on this. So I can't do any CVS updates > or commit. There will be lots of changes by the time I commit and I > rather not go through diffing, especially if you are adding text. Will > do a commit before I get on the plane tomorrow which should still be wee > hours in the morning for you in europe. > > Warren > > > > > ------------------------------------------------------- > This SF.Net email sponsored by: Free pre-built ASP.NET sites including > Data Reports, E-commerce, Portals, and Forums are available now. > Download today and enter to win an XBOX or Visual Studio .NET. > http://aspnet.click-url.com/go/psa00100003ave/direct;at.aspnet_072303_01/01 > _______________________________________________ > Plog-general mailing list > Plo...@li... > https://lists.sourceforge.net/lists/listinfo/plog-general |
From: Warren L. <wa...@is...> - 2003-08-16 06:22:10
|
I think I figured out what was causing the problems with CVS. The editor that I usually use UltraEdit on Win got exceedingly bloated so I tried out TextPad much much faster... TextPad was set to write unicode BOM at the beginning of the file. Since I use TopStyle to handling the CSS doc but before I made a commit, I used TextPad to make sure that I was saving the file in UNIX format, it attached the Unicode BOM at the beginning of the file and did all sorts of werid things to the file.. Crashed WinMerge (diff prog) a few times and I thought was cuz WinMerge wasn't stable. Anyways I disabled writing of Unicode BOM to all the files TextPad is handling. If you encounter the same problem again, I'll stop using TextPad and start using VIM instead. |
From: Oscar R. <os...@re...> - 2003-08-16 08:04:58
|
Hi > Anyways I disabled writing of Unicode BOM to all the files TextPad is > handling. If you encounter the same problem again, I'll stop using > TextPad and start using VIM instead. Well, we don't have to get _that_ minimalistic!!! :) Regards, Oscar. |