Re: [Webwork-user] Interactive documentation

[Andrius J. <an...@li...>]

hi all,

one nice way of building interactive documentation is implemented in
http://www.php.net/manual/ - you can add comments and remarcs to the help
topics. such a thing would really make support easier later on - and it is
good place to share experience, etc. btw, I am almost done with documenting
the ebs-like architecture, will post the final draft sometime next week.

--andrius

----- Original Message -----
From: "Maurice C . Parker" <Ma...@vi...>
To: <web...@li...>
Sent: Tuesday, December 05, 2000 5:43 PM
Subject: [Webwork-user] Interactive documentation


: All,
:
: I was just about to begin documenting the template controls and was
wondering if there were any documentation standards that should be followed.
Is everything to be done plaintext, HTML, Docbook, or something else?
:
: I was going to put links next to the controls on the form test page to go
to a page that had the control on it, show the code used to include it, and
document the required and optionional parameters.  This would be similar to
how Tomcat's documentation is merged with it's demo system.  Then I noticed
that there was already a doc directory, and some standard maybe should be
followed.
:
: Suggestions?
:
: Maurice
: _______________________________________________
: Webwork-user mailing list
: Web...@li...
: http://lists.sourceforge.net/mailman/listinfo/webwork-user
: