And the least wanted and yet most honest and helpful answer is "no; the code and tagdoc user level documentation (how to embed and employ which tags and for what use with pike code) is all the docs there is".
The system could with a bit of effort be molded to fit purposes like those you envision, but you really would have to look at the code and get some hands dirty. :-)
You will probably find the extractor fairly useful and might find the XML format employed somewhat unorthodox (it does grouping on every second level of tag nesting, for awkward dated reasons I am in part responsible for). Least appetizing (I have been told - but this may have changed since) is the stage that transforms XML to HTML. It was kindly thrown together (by JS, I believe) to finally get something out of the system, after a prolonged period of busy idle looping tedious minor details with the rest of the system.
I can probably still answer some questions on why some policies were chosen in various design issues, but I know precious little of overall implementation issues. (My role in the autodoc system was mostly going through details and problems we encountered when David [Norlin] was busy hacking at it.)
/ Johan Sundström (a hugging punishment!)
Previous text:
2003-02-17 19:53: Subject: Extending autodocs (2nd try)
Hello,
As maintainer of Caudium, I'd like to use pike autodocs for :
- caudium modules
- tags
- containers
- entities
I'd like to know if current pike autodocs can be extended to handle such extensions, if yes is there any examples / plugins or some docs (except as usual "use the source luke") to handle that.
Note this part is really a *wanted* feature for others projects like sTeam, and maybe this should be "a plus" for Roxen as well.
Sincerly, /Xavier -- Xavier Beaudouin - Unix System Administrator & Projects Leader. Please visit http://caudium.net/, home of Caudium & Camas projects O ascii ribbon campaign against html email |\ and Microsoft attachments
/ Brevbäraren