Use the DTDDoc plugin to generate HTML formatted DTD documentation

• Key: STR-2942
• Type: Task
• Status: Closed
• Resolution: Fixed
• Priority: Minor
• Assignee: Paul Benedict
• Reporter: Wendy Smoak
• Component/s: Core, Tiles 1 Plugin, Website
• Affects Version/s: 1.3.5
• Fix Version/s: 1.3.6

Description

Use the DTDDoc plugin for Maven 2 to generate HTML-formatted DTD documentation.

Also, remove the LiveDTD docs under http://struts.apache.org/dtds, and update links in the documentation.

Comments

[Wendy Smoak]

Discussion thread over on dtddoc-develop: http://sourceforge.net/mailarchive/forum.php?thread_id=30371684&forum_id=33177

DTDDoc is now generated as part of the 'mvn site' build for Struts 1.

The configuration is in the struts-parent pom, in the 'dtddoc' profile. Once the plugin is released, the config can be moved into the <reporting> section without a profile. This way just keeps it all together since it requires another repository.

Note: This depends on an *unreleased* plugin available in a snapshot repo.

Once the website syncs, DTDDoc should be visible here:
  * http://struts.apache.org/1.x/struts-core/dtddoc/index.html
  * http://struts.apache.org/1.x/struts-tiles/dtddoc/index.html

[Wendy Smoak]

Done and published, see: http://struts.apache.org/1.x/dtddoc/index.html

Leaving this open as a reminder that we have a snapshot dependency until the plugin is released.

The generated docs would look better if the comments were formatted according to DTDDoc's conventions (similar to Javadoc).

The LiveDTD docs have been removed from /www/struts.apache.org/dtds, double check that they disappear from the live site at some point, or ask to have them removed.

[Paul Benedict]

URL:
http://svn.apache.org/viewvc?view=rev&rev=479779

Log:
STR-2942: DTDDoc 1.0 has been released. I have removed the temporary profile and moved the plug-in into the reporting section.

Modified:
struts/struts1/trunk/pom.xml