Migrate component documentation from marinschek.com tiki / wiki to forrest xdocs --------------------------------------------------------------------------------
Key: MYFACES-316 URL: http://issues.apache.org/jira/browse/MYFACES-316 Project: MyFaces Type: Task Versions: Nightly Build Reporter: Mike Kienenberger Migrate component documentation from marinschek.com tiki and wiki to forrest xdocs. Sean Schofield and I wrote something along the lines of: The component documentation should really go in the website. Install forrest and setup a FORREST_HOME environment variable (follow their instructions on that.) Then you can checkout the "myfaces/forrest" project from SVN and build. There is a sample component documentation that I setup (component-template.xml.) This is the preferred way to document components. Note that I setup a template for most components a while back (with just a bunch of to-dos.) If you want to document one of those, please just replace with the new forrest/content/xdocs/components/component-template.xml format. The documentation for newspaperTable is representative of the new format. you also need to patch forrest/content/site.xml so that the new component page shows up in the index. Ie, just add a <component-name="component-name" href="component-name.html"/> line in site.xml at the appropriate spot. So that work is not being duplicated, add a comment to this issue for each component that you are documenting so that someone else doesn't start working on it at the same time. -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira