Menu
▾
▴
lcd4linux-devel
|
From: Michael R. <re...@eu...> - 2004-05-27 03:52:26
|
Hi there, I jhust changed lots of function names in CVS to follow the plugin::name convention. This may lead to unusable configurations, so double-check your lcd4linux.conf for function names! Furter, this is important for the documentation guys! If you already did a "grep AddFunction *.c" to get all plugins, please do it again. If I have a look at the Status file, we're heading for 0.10 Real Soon Now(tm)!! There's one display driver missing (Beckmann+Egle), all other drivers have been ported, all plugins have been ported. But documentation is missing! Anybody with a Beckmann+Egle "Mini-Terminal" out there? I need a tester for porting the driver.... Can anyone tell me how to write documentation? I didn't follow these discussions... bye, Michael -- Michael Reinelt Tel: +43 676 3079941 Geisslergasse 4 Fax: +43 316 692343 A-8045 Graz, Austria e-mail: re...@eu... |
|
From: Jerry S. <ye...@th...> - 2004-05-27 17:05:15
|
Hi Michael, On Thu, May 27, 2004 at 05:52:20AM +0200, Michael Reinelt wrote: > Hi there, > > I jhust changed lots of function names in CVS to follow the plugin::name > convention. This may lead to unusable configurations, so double-check > your lcd4linux.conf for function names! > > Furter, this is important for the documentation guys! If you already did > a "grep AddFunction *.c" to get all plugins, please do it again. Nope, haven't done it yet. Thanks for the heads up, though. > If I have a look at the Status file, we're heading for 0.10 Real Soon > Now(tm)!! There's one display driver missing (Beckmann+Egle), all other > drivers have been ported, all plugins have been ported. But > documentation is missing! <cringe!> > Can anyone tell me how to write documentation? I didn't follow these > discussions... Off the top of my head, I can't. I have just been writing plain text for the moment, I write better that way. I'll be working on formatting/markup hopefully next week. 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-28 14:53:56
|
Hi List, >>Can anyone tell me how to write documentation? I didn't follow these >>discussions... > Jerry answered: > Off the top of my head, I can't. I have just been writing plain text > for the moment, I write better that way. I'll be working on > formatting/markup hopefully next week. Hmm. What came to my mind is something like "embedded documentation", at least for all calls to cfg_get()/cfg_number(), and for all functions a plugin provides. This would be 1) clear text, and 2) always up-to-date with the code What do you think? Is there a "common format" for such things? 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-29 15:18:08
Attachments:
documentation.tar.bz2
|
Hello list ! First, sorry for the delay ! > Can anyone tell me how to write documentation? I didn't follow these > discussions... You'll find in this tarball the documentation system. Read HTML/write_doc.html and HTML/test.html. Bye ! -- Xavier VELLO <xav...@fr...> |
|
From: Michael R. <re...@eu...> - 2004-05-29 16:00:38
|
Hi Xavier, Hi List, >>Can anyone tell me how to write documentation? I didn't follow these >>discussions... > > You'll find in this tarball the documentation system. Read > HTML/write_doc.html and HTML/test.html. Hey! This look cool! I really like it! Great! Congratulations! Is it possible to create a "standard unix man page" out of this? What do the other guys think about it? If this is okay with all of you, I'd like to add this stuff to the CVS. Xavier, you'll have to tell me what belongs into CVS, and what into a distribution tarball. I have to install these xmllint and xmlanything. As a last step, we have to agree on who writes what parts of the documentation. I think I should write the drivers section, because I know most of them by heart :-) bye, Michael -- Michael Reinelt Tel: +43 676 3079941 Geisslergasse 4 Fax: +43 316 692343 A-8045 Graz, Austria e-mail: re...@eu... |
|
From: Jerry S. <ye...@th...> - 2004-05-31 06:36:01
|
On Sat, May 29, 2004 at 06:00:30PM +0200, Michael Reinelt wrote: > Hi Xavier, Hi List, > > >>Can anyone tell me how to write documentation? I didn't follow these > >>discussions... > > > >You'll find in this tarball the documentation system. Read > >HTML/write_doc.html and HTML/test.html. > > Hey! This look cool! I really like it! Great! Congratulations! > > Is it possible to create a "standard unix man page" out of this? From my understanding, no. > What do the other guys think about it? I'm okay with it. Xavier pointed out that man pages and html pages are directed at different audiences, and I agree with him to a certain degree. I think the driver documentation can be useful in both formats, so I might look at hacking something together to make the driver docs into part of a man page. > As a last step, we have to agree on who writes what parts of the > documentation. I think I should write the drivers section, because I > know most of them by heart :-) All right. You're nominated for writing driver documentation. I've been working on what basically is a "getting started" section. I'll also work on basic program usage. What other areas need documentation? 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-06-01 11:10:54
|
Hi Michael, Jerry and the others ! > > Hey! This look cool! I really like it! Great! Congratulations! Thanks ;) BTW, the CSS isn't finished. There are some glitches, especially with KHTML. > > Is it possible to create a "standard unix man page" out of this? > >From my understanding, no. Right ! In fact, I'd prefer the html doc and the manpage not to be identical. In fact, the manpage should just list the comandline options and point to the html doc for the config. Moreover, I don't think we can generate manpages with xslt (it may be possible to output docbook and them process it to man, but it's not very clean). > I'm okay with it. Xavier pointed out that man pages and html pages are > directed at different audiences, and I agree with him to a certain > degree. I think the driver documentation can be useful in both formats, > so I might look at hacking something together to make the driver docs > into part of a man page. Maybe an xsl to outpub docbook, but I don't think it would be useful nor coherent. Another solution would be to genrate plain text to be read with a terminal (this one is easy !) > > As a last step, we have to agree on who writes what parts of the > > documentation. I think I should write the drivers section, because I > > know most of them by heart :-) > All right. You're nominated for writing driver documentation. I've > been working on what basically is a "getting started" section. I'll > also work on basic program usage. What other areas need documentation? I think I'll write the plugins section, as I know them well. Another point : > > If this is okay with all of you, I'd like to add this stuff to the CVS. > > Xavier, you'll have to tell me what belongs into CVS, and what into a > > distribution tarball. The data, drivers, dtd, lcd4linux, plugins and xsl folder and Makefile and Makefile.generic are part of the build system. The HTML folder should never be on the CVS, but in the tarballs. I don't know if we should include the whole build system in the releases or just the compiled html ... Bye ! -- Xavier VELLO <xav...@fr...> |
|
From: Michael R. <re...@eu...> - 2004-06-02 05:30:22
|
Hi there, >>>Is it possible to create a "standard unix man page" out of this? >> >>>From my understanding, no. > > Right ! In fact, I'd prefer the html doc and the manpage not to be identical. > In fact, the manpage should just list the comandline options and point to > the html doc for the config. Moreover, I don't think we can generate manpages > with xslt (it may be possible to output docbook and them process it to > man, but it's not very clean). Okay, forget about the man page for now. >>>As a last step, we have to agree on who writes what parts of the >>>documentation. I think I should write the drivers section, because I >>>know most of them by heart :-) >> >>All right. You're nominated for writing driver documentation. I've >>been working on what basically is a "getting started" section. I'll >>also work on basic program usage. What other areas need documentation? > > I think I'll write the plugins section, as I know them well. Fine! >>>Xavier, you'll have to tell me what belongs into CVS, and what into a >>>distribution tarball. > > The data, drivers, dtd, lcd4linux, plugins and xsl folder and Makefile and > Makefile.generic are part of the build system. The HTML folder should never > be on the CVS, but in the tarballs. Check in done. > I don't know if we should include the whole build system in the releases or > just the compiled html ... Hmmm... Good question... Another point: how to include the documentation tree into the main Makefile? (automake!?!) bye, Michael -- Michael Reinelt Tel: +43 676 3079941 Geisslergasse 4 Fax: +43 316 692343 A-8045 Graz, Austria e-mail: re...@eu... |
×
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