From: Jason M. <ko...@gm...> - 2008-08-30 06:27:34
|
That's the great thing about DocBook: you don't need an index. Or rather, you don't need an explicit one. I arranged the documentation in a very specific way. In the root of the docs folder is a single, short document called "glsdk_documentation.xml." All it is is a series of <xi:include> elements. These are very special XML elements; what they do is cause the referenced XML file to be included in this document at that location, as though the document in question were written there. And those documents will include other parts. What this means is that essentially, all our documentation gets put into one huge file that gets processed as a block. There is a file in the docs/reference directory called "sdk_reference.xml". I have just checked in a change to this file that includes the file, "docs/reference/glm.xml". That file should be a gigantic list of <xi:include> entries that include every other .xml file in that directory. It might even be a good idea to write a simple script to automatically generate this file. I'll include a few includes as examples. The process of generating documentation will take care of creating a table of contents and so forth. Henri Häkkinen wrote: > Could you do or instruct me how to do a sort of index page that would > list each GLM API entry-point with a link to the correct page? |