Re: Docbook (Help files)
im doing some editting as thiings are now, so the html isnt just "hacked together nonsense" it is being made coherant and valid. trust me. trust halcyon. and for those of you on the project... made a change to the template. same addy. http://www.solnet-data.dk/gimphelp/ as for it belonging somehwere else... i just put it there as a help to get the project moving. as for when to get it done... i vote for ASAP. im already proofing my butt off on docs that exist. i think we need more writers and translators. please volunteer everyone.
Re: Docbook (Help files)
DocBook sounds fine to me presuming that the tools are validating (ie users who just type nonsense into their text editor will be rewarded with a screenful of errors) and so we get some decent structured documents, not the hacked-together nonsense you usually get when people write HTML. I don't know DocBook, but presuming all I need is some web tutorial and a bunch of RPMs I am willing to learn it and submit documentation for all file formats maintained by me or unmaintained + a bonus section for all the Gimp newsgroup users who ask.. "There are so many file formats, which should I use?" ... to which the answer is of course always use PNG :) Writing this stuff will take some time, how much time do we have? Nick.
Re: Docbook (Help files)
I skimmed the documentation for DocBook, and while parts of it look quit different from HTML, the necessities are simple, and I don't see why anybody couldn't easily write a help file from a template file (that's really how we all started learning how to write in HTML, right?) Give me a good example file to work with, as well as a quick cheat sheet for the common tags and I won't complain at all about having to learn a new language. -James Smaby
Re: Docbook (Help files)
On Mon, Jul 31, 2000 at 07:40:12PM +0100, Austin Donnelly <[EMAIL PROTECTED]> wrote: > The problem with this is that it suggests actually using "->" > literally in the HTML, rather than the more correct "->". There is nothing wrong with using "->" in html, except for some *very* outdated and *very* broken user agents. -- -==- | ==-- _ | ---==---(_)__ __ __ Marc Lehmann +-- --==---/ / _ \/ // /\ \/ / [EMAIL PROTECTED] |e| -=/_/_//_/\_,_/ /_/\_\ XX11-RIPE --+ The choice of a GNU generation | |
Re: Docbook (Help files)
On Monday, 31 Jul 2000, Kevin Turner wrote: > [Kevin checks the latest mail. Now it seems we have a help template > file in HTML. Okay. Uh-oh, it's under a non .gimp.org domain, Sven > will frown about that.] The template includes "->" as a menu path separator. The problem with this is that it suggests actually using "->" literally in the HTML, rather than the more correct "->". Personally, I think anything that makes updating the help text as easy as possible is good. Ideally, there would be a button at the bottom of the help browser labelled "email corrected version" or something, that people could use if they come across typos, wrong, or missing info. Make it totally trivial for people to scratch their itch, basically :) Austin
Re: Docbook (Help files)
I guess another argument in favour of Docbook is peer pressure. When making the rounds around the documentation sites, I found that at the recent Open Source Documentation Summit, the Gnome Documentation Project, Linux Documentation Project, and FreeBSD folks have all agreed to use DocBook (in its XML flavour). With that kind of support behind docbook and its tools, it may be silly to use anything less[4]. On this list, I've heard a chorus of "DocBook is good," along with a few "I'm not sure but I'll learn it if I have to" remarks. The as-yet-hypothetical "might scare contributers" remark can be addressed if we have people who are willing to do plaintext or html to docbook conversions. (Yes, I will do such conversions.) I guess we're still waiting to hear the Grand High Yoshman's words. [Kevin checks the latest mail. Now it seems we have a help template file in HTML. Okay. Uh-oh, it's under a non .gimp.org domain, Sven will frown about that.] A few other pointers to resources: The Open Source Writers Group serves as a pool of authors and editors which we may dip in to if we need more hands: http://oswg.org/ Piers has tracked down an introduction to DocBook as provided by the LDP's Author's Guide: http://linuxdoc.org/LDP/LDP-Author-Guide/ The "Definitative Guide to DocBook", a reference guide, may be found at http://docbook.org/ Cheers, - Kevin Footnotes: 1. Reports on the Open Source Documentation Summit: http://mail.gnome.org/pipermail/gnome-doc-list/2000-July/001502.html http://www.oreilly.com/frank/oscon_summit.html 2. Gnome Documentation Project (GDP): http://developer.gnome.org/projects/gdp/ 3. Linux Documentation Project (LDP. These are the "HOWTO" people.): http://linuxdoc.org/ 4. Unless you're the FSF, in which case you're committed to using TeXinfo forever. 5. Its times like this that make me think maybe HTML e-mail isn't such a bad idea after all. -- Kevin Turner <[EMAIL PROTECTED]> | OpenPGP encryption welcome here Plug-ins: They make GIMP do stuff. http://gimp-plug-ins.sourceforge.net/ This list is archived at http://marc.theaimsgroup.com/?l=gimp-developer To unsubscribe, mail [EMAIL PROTECTED]
