webwork-user

[Webwork-user] Interactive documentation

[Maurice C . P. <Ma...@Vi...>]

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

Re: [Webwork-user] Interactive documentation

[Rickard <ri...@jb...>]

"Maurice C . Parker" wrote:
> 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?

I'm open. If there are no major wishes on this, you may choose to do it
any way you please. 

I usually do it in plain HTML (using only <pre> <h?> <p>), and use a
styles.css to get it to look decent. See any of my projects on
dreambean.com for examples. That's one ok way to do it.

/Rickard

-- 
Rickard Öberg

Email: ri...@jb...

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
:

Re: [Webwork-user] Interactive documentation

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

hola,

this exact functionality is actually a piece of cake to implement, ie. with
the same jboss + tomcat + webmacro combo. anyway there should be some
responsible person that monitors, groups and sorts the posts, but the good
thing about it would be that contributions would have been made easy. the
problem is if we could find a runtime environment for that - so far I don't
know any servers doing this, though I can try to organize some low-bandwidth
access (at least temporarily) here (512 kbps). if somebody's interested, let
me know.

regards,
--andrius


--andrius
----- Original Message -----
From: "Maurice C . Parker" <Ma...@Vi...>
To: "Andrius Juozapaitis" <an...@li...>
Sent: Wednesday, December 06, 2000 1:17 AM
Subject: Re: [Webwork-user] Interactive documentation


: Hey,
:
: * Andrius Juozapaitis (an...@li...) wrote:
: > 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
:
: Interesting concept.  Looks like a job for Jive.  This actually on
something that I'm working on right now.  I am using Webwork to embed Jive
into portals.  A side effect of this should be the ability to use Jive
forums as a component of a larger framework.  Possibilities include
documentations systems or ecommerce applications (I'm thinking about Amazon
user comments here).
:
: > 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
: >
: