Geir,
I have fix and improved the documentation somewhat.
I'd like to define a documentation structure and templates for the tools
such that I can document them step by step. Here a proposal (repeating some of
today's facts just to be clear):
o We have categories of tools. Each category get its subdirectory below
jakarta-velocity-tools, for example
jakarta-velocity-tools/view - toolbox, tool loader,
jakarta-velocity-tools/struts - tools for struts integration
jakarta-velocity-tools/math - math tools
jakarta-velocity-tools/forms - HTML form validation tools
...
o A top level doc documents the tools support in general and points to
the existing tool categories.
o Each tool category has it tutorial-style doc about purpose, applications,
examples. It points to reference docs for each tool within that tool
category.
o Each tools has a reference-style doc about supported methods, parameters,
etc.
This would make the following structure:
jakarta-velocity-tools
docs
index.html - top level tutorial
view
docs
index.html - view tools tutorial
toolX.html - reference doc for toolX
toolY.html - reference doc for toolY
struts
docs
index.html - struts tools tutorial
toolX.html
toolY.html
....
Templates for the following are needed: (for dvsl)
- tutorials (at top level and tool category level)
- tool reference documentation
Agree?
Gabe
--
Gabriel Sidler
Software Engineer, Eivycom GmbH, Zurich, Switzerland
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
