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
I think the things you mention are a bit too different from programming APIs for autodoc to be of any good help. The extraction and build process is however fairly modularized, so you might find some of the tools useful. But I doubt that.
/ Martin Nilsson (Åskblod)
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
not necessarily. rxml tags are in a sense like function calls a name, arguments and a return value.
it's just a different level of documentation.
sTeam classes would be a different matter,
however the whole thing is leaning towards a documented programming style introduced by donald knuth where more then just plain api documentation is embedded into the code.
one way of looking at it might be, to just add a few more keywords which are ignored when the pike api reference docs are made, and are used only when user-level docs are made.
greetings, martin.
Le lundi, 17 fév 2003, à 20:35 Europe/Paris, Martin Nilsson (Åskblod) @ Pike (-) developers forum a écrit :
I think the things you mention are a bit too different from programming APIs for autodoc to be of any good help. The extraction and build process is however fairly modularized, so you might find some of the tools useful. But I doubt that.
So bad... I am _really_ disapointed by that.
Seems that we (the caudium group) will have to make our own autodocs system.
This is so bad we have to reinvent the wheel every time... :(
/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
On Mon, Feb 17, 2003 at 11:06:26PM +0100, Xavier Beaudouin wrote:
Seems that we (the caudium group) will have to make our own autodocs system. This is so bad we have to reinvent the wheel every time... :(
i don't think this is a "reinventing the wheel" problem, but rather an extension and integration problem.
the current autodoc system has not been designed for what we want to use it.
we do need a more generic system to embedd documentation and help into the code. however different from the pike reference documentation caudium and sTeam documentation needs to be accessible by the functions through some sort of introspection, eg to display help in the admin interface and the like and to publish that same help in an admin or user manual.
some sort of integration with the current autodoc system would be usefull, but if it can not be done, then that's that.
greetings, martin.
Extern kopiemottagare: pike-devel@lists.lysator.liu.se Extern kopiemottagare: pike@roxen.com
This kind of cross-posting makes texts appear both in this lyskom conference, and in my mailbox (which is subscribed to pike@roxen.com).
I'm not sure what's the point of the pike@roxen.com list nowadays, but if it's supposed to be a "user list", different from the "developer" list, then I think cross posting should be discouraged. I imagine many of us are subscribed to both lists, but those who are subscribed on only one of the lists probably have a good reason.
/ Niels Möller ()
Previous text:
2003-02-17 23:19: Subject: Re: Extending autodocs (2nd try)
On Mon, Feb 17, 2003 at 11:06:26PM +0100, Xavier Beaudouin wrote:
Seems that we (the caudium group) will have to make our own autodocs system. This is so bad we have to reinvent the wheel every time... :(
i don't think this is a "reinventing the wheel" problem, but rather an extension and integration problem.
the current autodoc system has not been designed for what we want to use it.
we do need a more generic system to embedd documentation and help into the code. however different from the pike reference documentation caudium and sTeam documentation needs to be accessible by the functions through some sort of introspection, eg to display help in the admin interface and the like and to publish that same help in an admin or user manual.
some sort of integration with the current autodoc system would be usefull, but if it can not be done, then that's that.
greetings, martin.
interested in doing pike programming, sTeam/caudium/pike/roxen training, sTeam/caudium/roxen and/or unix system administration anywhere in the world. -- pike programmer working in europe csl-gmbh.net open-steam.org (www.archlab|(www|db).hb2).tuwien.ac.at unix bahai.or.at iaeste.(tuwien.ac|or).at systemadministrator (stuts|black.linux-m68k).org is.(schon.org|root.at) Martin Bähr http://www.iaeste.or.at/~mbaehr/
/ Brevbäraren
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
pike-devel@lists.lysator.liu.se
-
Johan Sundstr�m (a hugging punishment!) ＠ Pike (-) developers forum -
Martin Baehr -
Martin Nilsson (�skblod) ＠ Pike (-) developers forum
-
Niels M�ller () ＠ Pike (-) developers forum
-
Xavier Beaudouin