OO docs 2 - crosslinks

Gabor Hojtsy wrote: >> Which the great problem with OO after all? Render, search, filenames? >> http://www.docbook.org/tdg/en/html/classsynopsis.html > > Rendering, what to put into a file, crosslinks, relating OO docs to > functional docs, etc... > > Goba As JTR, "in pieces..." ;] ---------------------------------------- CROSSLINKS a.k.a. UNIQUE IDs To crosslink, we need unique xml IDs, or, in other way, good AND unique xml IDs. I may be wrong, but I believe that cannot have a global function with the same name of a class [same case] and so, a combination of the class's name with method/property's name will be a good ID. So, we continue creating one refentry per function/method/property and in extension's front page it's possible to set up an script to generate classsynopsis per directory, based only in refentry's id. Example: /dir reference.xml -> ref.dir /dir/functions chdir.xml -> function.chdir chroot.xml -> function.chroot [...] /dir/classes /dir/classes/Directory construct1.xml -> class.Directory.construct.1 read.xml -> class.Directory.method.read close.xml -> class.Directory.method.close [...] Note that the directory's structure really does not matter, but the structure of the IDs. In the same way that we have one script to generate the files functions.xml, we can construct one script to generate several class.Zzzz.xml, based only on ID structure. Prefix the constructors/properts and methods is to permit ordenate this presentation. []s André Æ