On Friday 30 December 2005 22:44, Oliver Steele wrote: > I wrote the part of the doc tools that have to do with docbook, but > they're effectively orphaned now. The tools work in two stages: > > - HTML to docbook sources. This is so that John can write in HTML.
John, is it going to be a major problem if you edit direct in XML? There some tools that will give you a reasonable "What You See Is One Option" editing view. <snip what="note about converging sources from authors"/> > > - Docbook to HTML. This uses the standard docbook xslt to add > navigation and cross-links; there's also support for indices and > glossary that I turned off because it was too slow and we weren't > ready to make them high enough quality to be justified. I extended > this to handle cross-references for the programmatic APIs, for > example, so that <tagname>view</tagname> generates a link into the > reference documentation. We could use <xref linkend="" endterm=""/> And dynamically insert the element name from the xml-instance that documents the element While it is unlikely that the element name will change after a release, I have known them to change during devel and doing a search and release of all instances when the element was named in the documentation set is a RPITA. There are a number of solutions of this nature. > > Whether to maintain or ditch the HTML->docbook conversion should be > John's call, since he's the one who works with the sources. Agreed. > Since > there's a clean separation between the two stages, it shouldn't > matter much, though, as long as it's clearly documented (it may not > be right now) --- you should be able to do any docbook processing to > the current guide. > > (As John mentioned, there is also the reference guide, which uses > custom XML source and doesn't go through docbook at any point. I've > sometimes wished that it did, since then we could use docbook to > create indices, PDFs, and WinHelp and EclipseHelp for the guide.) Yes I saw the process. A bit long winded. I think much of the information is also duplicated in whole or in part through the documentation set, increasing the maintenance overhead. > > I'm actually on vacation through next Tuesday, but I'll be happy to > Skype with you after that and also to write up whatever additional > documentation will make it easy for you to work on this. Sure, no worries. If you have time to discuss, it's cool. If not no worries. A VoIP chat will be good. I am sure everyone can impart much more information in a conversation, more quickly. Thanks for the response. Oh. BTW. Is it standard to top or bottom post on this list? :-) -- Sean Wheller Technical Author [EMAIL PROTECTED] +27-84-854-9408 http://www.inwords.co.za _______________________________________________ Laszlo-dev mailing list [email protected] http://www.openlaszlo.org/mailman/listinfo/laszlo-dev
