Hey' On Fri, 28 Nov 2003 15:23:10 +0000 Alan Gifford wrote:
> I was envisioning a documentation set consisting of > relatively small documents about particular subjects in gtk-gnutella, Sure, there's a need for all kinds of documentation so it's more important to do what you would enjoy doing if it means something will actually get written. You could write article type pages like those in: http://gtk-gnutella.sourceforge.net/index.php?page=docs and we could re-use parts of these for other formats when we reach a critical mass there. Grab the htdocs cvs module to see how the html is handled. The web pages conform to html-4.01 transitional. New FAQ's are always handy. I envisioned writing a user manual by walking through the gui and doing a writeup on each pane in plaintext and then marking them up for (probably) docbook-xml, which would allow conversion through xsl stylesheets to html for the web page. DocBook-xml is the standard for both KDE and GNOME help and once gtk-gnutella is separated into lib and gui, there may be native gnome and/or kde frontends. So using dockbook would lend to reusability. It's the content we need, though. Content is hard - markup is easy. In fact, I'm willing to do all the markup if people can contribute some of the the content. As far as acronyms go, it's something I'm not really decided about. When writing for an international audience, it's hard to know which terms are commonly known. Consistancy is more important since it allows search and replace operations across all documents if, for example, we wanted to replace all instances of "Local Area Network" with "<acronym title="Local Area Network">LAN</acronym>" which would would pop up a tooltip when you hover the mouse over it (in some browsers.) -- Murphy (eqom14) ------------------------------------------------------- This SF.net email is sponsored by: SF.net Giveback Program. Does SourceForge.net help you be more productive? Does it help you create better code? SHARE THE LOVE, and help us help YOU! Click Here: http://sourceforge.net/donate/ _______________________________________________ Gtk-gnutella-devel mailing list [EMAIL PROTECTED] https://lists.sourceforge.net/lists/listinfo/gtk-gnutella-devel
