Menu
▾
▴
lcd4linux-devel
|
From: Xavier V. <xav...@fr...> - 2004-05-04 19:04:06
|
Hello list ! I'm finishing the framework to write documentation for the Next Generation. It will be based on the XSLT technology : articles are xml files with specific tags and helpers to put the layout in. These files look like html files (the same tags are used, plus specific helpers and a lot of information in the <head>). But we'll need some volunteers to write the doc ;) The best case would be that every developer writes the doc for the plugins/drivers he wrote. On the other hand, this would put a lot of the work on Michael's shoulders. So everyone is invited to contribute. Here's a (non limitative) list of what is needed : - every driver - every plugin - installation and configure flags (--with-drivers --with-plugins) - lcd4linux.conf - FAQ / troubleshooting - how to report bugs, very important ! - ... The framework isn't yet finished (mostly the output part), but you can begin to post your intentions about this here. I'll try to finish the framework this WE so that Michael put it in the CVS. Bye ! ---- Xavier PS to Michael : maybe it would be good to put this documentation work in a separate CVS module to put it clear. What do you think about this ? |
|
From: Jerry S. <ye...@th...> - 2004-05-21 20:28:54
|
Hello Xavier, list, On Tue, May 04, 2004 at 09:02:23PM +0200, Xavier VELLO wrote: > Hello list ! > > I'm finishing the framework to write documentation for the Next > Generation. It will be based on the XSLT technology : articles are xml > files with specific tags and helpers to put the layout in. These files > look like html files (the same tags are used, plus specific helpers and > a lot of information in the <head>). > > But we'll need some volunteers to write the doc ;) The best case would > be that every developer writes the doc for the plugins/drivers he wrote. > On the other hand, this would put a lot of the work on Michael's > shoulders. So everyone is invited to contribute. Here's a (non > limitative) list of what is needed : > > - every driver > - every plugin > - installation and configure flags (--with-drivers --with-plugins) > - lcd4linux.conf > - FAQ / troubleshooting > - how to report bugs, very important ! > - ... > > The framework isn't yet finished (mostly the output part), but you can > begin to post your intentions about this here. I'll try to finish the > framework this WE so that Michael put it in the CVS. Xavier, where are you at on that framework? I looked in CVS and didn't see it yet... My intention this weekend is to start writing documentation for the functionality currently in CVS. For the time being, I'll write docs in plain text and format them when the framework becomes available. I won't be connected this weekend but I pulled from CVS last night. Jerry -- Jerry Seutter Email: ye...@th... Web: http://www.thegeeks.net/~yello Gallery: www.thegeeks.net/~yello/gallery (email me for username and password). |
|
From: Michael R. <re...@eu...> - 2004-05-22 04:06:03
|
Hi Jerry, Hi List, > Xavier, where are you at on that framework? I looked in CVS and didn't > see it yet... It's not in the CVS by now. (Should it be?) > My intention this weekend is to start writing documentation for the > functionality currently in CVS. For the time being, I'll write docs > in plain text and format them when the framework becomes available. I > won't be connected this weekend but I pulled from CVS last night. A good idea. I try to find some more time for lcd4linux, and I think we should at least release a "beta" of 0.10 Real Soon Now (TM). But without any docs, this would be quite useless. A good thing for writing docs is a "grep cfg_get" and "grep cfg_number", you'll get all config file entries for a specific driver and/or plugin. bye, Michael -- Michael Reinelt Tel: +43 676 3079941 Geisslergasse 4 Fax: +43 316 692343 A-8045 Graz, Austria e-mail: re...@eu... |
|
From: Xavier V. <xav...@fr...> - 2004-05-22 09:22:38
|
Hi Michael ! > > Xavier, where are you at on that framework? I looked in CVS and didn't > > see it yet... > It's not in the CVS by now. (Should it be?) In fact, I didn't want to bother you, and there's a little detail I wanted to speak with you : I think including it in a "doc" folder of the CVS tree isn't a good choice, as there are API changes, and the doc won't be up-to-date with both the release and CVS version. So I'd like it to stay in a separate cvs module, and then just put the compiled HTML files in the release tarballs. But in this case, developpers would certainly forget to document their changes, as there are two different "modules". It's up to you to decide what to do. I'll send you a tarball this WE (tomorrow I think), with the last helper I forgot and a "how to write doc" page, and you can use this delay to decide where to put it. > A good idea. I try to find some more time for lcd4linux, and I think we > should at least release a "beta" of 0.10 Real Soon Now (TM). But without > any docs, this would be quite useless. In fact, I think at least one RC is _mandatory_, to clean this freash code, and get material to write the FAQ, the notes, ... Bye ! -- Xavier VELLO <xav...@fr...> |
|
From: Michael R. <re...@eu...> - 2004-05-22 19:02:09
|
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Hi Xavier, | In fact, I didn't want to bother you, and there's a little detail I wanted | to speak with you : I think including it in a "doc" folder of the CVS tree | isn't a good choice, as there are API changes, and the doc won't be | up-to-date with both the release and CVS version. Hmmm... | So I'd like it to stay in a separate cvs module, and then just put the | compiled HTML files in the release tarballs. But in this case, | developpers would certainly forget to document their changes, as there | are two different "modules". Hmmm... | It's up to you to decide what to do. I knew you would say so :-) I must say that I've absolutely no idea how to decide. both ways have their pros an cons. anybody out there with experience in this area? Martin? | In fact, I think at least one RC is _mandatory_, to clean this freash | code, and get material to write the FAQ, the notes, ... Of course there will be at least one RC. I'm afraid there will be much more than RC's were meant to be... bye, Michael - -- Michael Reinelt Tel: +43 676 3079941 Geisslergasse 4 Fax: +43 316 692343 A-8045 Graz, Austria e-mail: re...@eu... -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.4 (GNU/Linux) Comment: Using GnuPG with Debian - http://enigmail.mozdev.org iD8DBQFAr6OsiebFT98TulARAjVPAKCGF0WDY/pkUYRDcIQEQJcxznmXZwCgqr/Y y7NRfflkUsz2N+IH/JcdryE= =HQxc -----END PGP SIGNATURE----- |
|
From: Jerry S. <ye...@th...> - 2004-05-22 13:30:33
|
On Sat, May 22, 2004 at 06:05:57AM +0200, Michael Reinelt wrote: > Hi Jerry, Hi List, > should at least release a "beta" of 0.10 Real Soon Now (TM). But without > any docs, this would be quite useless. > > A good thing for writing docs is a "grep cfg_get" and "grep cfg_number", > you'll get all config file entries for a specific driver and/or plugin. Ah, thanks for the tip, that will make my life easier. :) Jerry -- Jerry Seutter Email: ye...@th... Web: http://www.thegeeks.net/~yello Gallery: www.thegeeks.net/~yello/gallery (email me for username and password). |
|
From: Xavier V. <xav...@fr...> - 2004-05-22 09:22:25
|
Hello Jerry, Michael and others ! > > The framework isn't yet finished (mostly the output part), but you can > > begin to post your intentions about this here. I'll try to finish the > > framework this WE so that Michael put it in the CVS. > > Xavier, where are you at on that framework? I looked in CVS and didn't > see it yet... Err... the framework is done (and the CSS is CSS2 valid !), but as Michael was too busy, I didn't want to bother him. In fact, it's the same as the one I sent you last week, with some minor rendering modifications. The xml syntax is the same, so go on with this one. > My intention this weekend is to start writing documentation for the > functionality currently in CVS. For the time being, I'll write docs > in plain text and format them when the framework becomes available. I > won't be connected this weekend but I pulled from CVS last night. The best think would be to wrte the "general" part (lcd4linux dir), but maybe it's too hard. The best to begin would be to write doc for drivers/plugins you understand (greping the configuration options). Oh, ****, I forgot the helper to add a synopis with configuration options ! I'll do it this WE. Bye ! --- Xavier VELLO <xav...@fr...> |
|
From: Jerry S. <ye...@th...> - 2004-05-22 13:32:22
|
On Sat, May 22, 2004 at 11:21:12AM +0200, Xavier VELLO wrote: > Hello Jerry, Michael and others ! > > > > The framework isn't yet finished (mostly the output part), but you can > > > begin to post your intentions about this here. I'll try to finish the > > > framework this WE so that Michael put it in the CVS. > > > > Xavier, where are you at on that framework? I looked in CVS and didn't > > see it yet... > Err... the framework is done (and the CSS is CSS2 valid !), but as Michael > was too busy, I didn't want to bother him. Whoops. Sorry about that. > In fact, it's the same as the one I sent you last week, with some minor > rendering modifications. The xml syntax is the same, so go on with this > one. Cool. I'll go with that then. -- Jerry Seutter Email: ye...@th... Web: http://www.thegeeks.net/~yello Gallery: www.thegeeks.net/~yello/gallery (email me for username and password). |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X