[JIRA] Updated: (CC-202) generate configxml.html automatically

     [ http://jira.public.thoughtworks.org/browse/CC-202?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Seth Pollen updated CC-202:
---------------------------

    Attachment: patch-v2.4.diff

Attached: patch-v2.4.diff

This is our first cut at a complete patch. There's an ANT target in main/build.xml called "gendoc" that generates "configxml-gendoc.html" every time the build runs. The other web pages still link to the old "configxml.html" page; they can be updated later, once gendoc annotations have been placed throughout the codebase. There's also another new ANT target called "copy-css" that concatenates some stylesheets together so that the JMX interface can provide a single CSS file to clients--this is intended for use by CC-Config, which we are also working on.

Anyway, this patch hopefully has everything gendoc needs to run. Let me know if it's otherwise. Once this gets committed, the only thing left to do is incorporate the gendoc annotations into all the plugin JAVA files. We have already done this for DefaultPropertiesPlugin.java as an example.

> generate configxml.html automatically
> -------------------------------------
>
>                 Key: CC-202
>                 URL: http://jira.public.thoughtworks.org/browse/CC-202
>             Project: CruiseControl
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.2.1
>            Reporter: Jerome Lacoste
>         Assigned To: Jeffrey Fredrick
>            Priority: Trivial
>         Attachments: CC-202-part2-v1.diff, configxml.html, configxml.html, configxml.html, configxml.html, Gendoc Design Proposal v2.0.pdf, net.sourceforge.cruisecontrol.ProjectConfig.xml, patch-v2.0.diff, patch-v2.1.diff, patch-v2.2.diff, patch-v2.3.diff, patch-v2.4.diff, patch-v6-part1.diff, patch-v6-part2.diff, patch_before_cleanup_and_full_conversion.diff, patch_v3.diff, patch_v4.diff, patch_v5.diff, proof-of-concept-diff.log, proof-of-concept-diff.txt, proof-of-concept-diff.txt
>
>
> Several people have expressed their desire of having such feature.
> xdoclet sounds like a good candidate for this problem. If addressed that way, this issue can be broken down in several steps:
> - identify the documentation requirements
> - create a tag specification that would allow to solve these requirements. 
>   We might lose some features as we will perhaps not be able to be as flexible as with the manual documentation
> - write the xdoclet tags that help to generate the intermediate XML
> - create an XSL template that generates the HTML from the intermediate XML
> - move the current configxml.html into tags inside the code
> - update the build/release process to generate the documentation

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.public.thoughtworks.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

------------------------------------------------------------------------------
Start uncovering the many advantages of virtual appliances
and start using them to simplify application deployment and
accelerate your shift to cloud computing.
http://p.sf.net/sfu/novell-sfdev2dev