What about generating the XMLs based on the embedded documentation in
components? (Maybe with some external documentation like examples.)
Today I finished the integrating of TapDoc and Tapestry's parsing features,
so it works even with annotations as well. (Of course there are several
enhancements to do yet.)
It would be possible to create an XSL file (and do some configuration) which
generates the required XMLs.
(I don't know how Forrest works and I haven't found any component XML on
CVS, it's just an idea.)
What do you think?
BR,
Norbi
----- Original Message -----
From: "Howard Lewis Ship" <[EMAIL PROTECTED]>
To: "Tapestry development" <[email protected]>
Sent: Wednesday, August 03, 2005 8:20 PM
Subject: [IMPORTANT] Community effort to supply documentation
Over the weekend I added a LARGE number of JIRA Issues, describing the
gaps in the component reference (for the framework, and for the
contrib library).
Thiis is an EXCELLENT chance for the wider Tapestry developer
community to contribute to the project!
Converting from the HTML format to the Forrest XML format is not very
difficult and there's plenty of examples already available. Better
yet, you can be effective without needing commit privs ... because
it's very reasonable to just attach the final file to the JIRA issue.
Here's how I see the process:
- Developers (not committers) select a Component Reference page to work on
- Add a comment to the JIRA issue (i.e., take ownership)
- Create the documentation (Forrest XML) and attach it to the JIRA issue
- A committer applies the file (or patch) and closes the issue
To build the documentation, you need to do a bit of setup, documented
on the Wiki:
http://wiki.apache.org/jakarta-tapestry/BuildingTapestry
Pay attention to the notes at the end, about the live-site target. Very
handy.
Thanks in advance to everyone who pitches in!
--
Howard M. Lewis Ship
Independent J2EE / Open-Source Java Consultant
Creator, Jakarta Tapestry
Creator, Jakarta HiveMind
Professional Tapestry training, mentoring, support
and project work. http://howardlewisship.com
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
