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...