Created: (STR-2942) Use the DTDDoc plugin to generate HTML formatted DTD documentation

Use the DTDDoc plugin to generate HTML formatted DTD
documentation
------------------------------------------------------------
------

                 Key: STR-2942
                 URL: http:
//issues.apache.org/struts/browse/STR-2942
             Project: Struts 1
          Issue Type: Task
          Components: Core, Tiles, Website
    Affects Versions: 1.3.5
            Reporter: Wendy Smoak
            Priority: Minor
             Fix For: 1.3.6


When the DTDDoc plugin for Maven 2 is released, configure
the build to generate HTML-formatted DTD documentation.

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

        

     [ http://issues.apache.org/struts/browse/STR-2942?page=all
 ]

Wendy Smoak updated STR-2942:
-----------------------------

    Description: 
When the DTDDoc plugin for Maven 2 is released, configure
the build to generate HTML-formatted DTD documentation.

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

  was:When the DTDDoc plugin for Maven 2 is released,
configure the build to generate HTML-formatted DTD
documentation.


> Use the DTDDoc plugin to generate HTML formatted DTD
documentation
>
------------------------------------------------------------
------
>
>                 Key: STR-2942
>                 URL: http:
//issues.apache.org/struts/browse/STR-2942
>             Project: Struts 1
>          Issue Type: Task
>          Components: Core, Tiles, Website
>    Affects Versions: 1.3.5
>            Reporter: Wendy Smoak
>            Priority: Minor
>             Fix For: 1.3.6
>
>
> When the DTDDoc plugin for Maven 2 is released,
configure the build to generate HTML-formatted DTD
documentation.
> Also, remove the LiveDTD docs under http://struts.apache.or
g/dtds, and update links in the documentation.

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

        

    [ http://issues.apache.org/struts/browse
/STR-2942?page=comments#action_38090 ] 
            
Wendy Smoak commented on STR-2942:
----------------------------------

Discussion thread over on dtddoc-develop: http://sourceforge.net/mailarc
hive/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/inde
x.html


> Use the DTDDoc plugin to generate HTML formatted DTD
documentation
>
------------------------------------------------------------
------
>
>                 Key: STR-2942
>                 URL: http:
//issues.apache.org/struts/browse/STR-2942
>             Project: Struts 1
>          Issue Type: Task
>          Components: Core, Tiles, Website
>    Affects Versions: 1.3.5
>            Reporter: Wendy Smoak
>            Priority: Minor
>             Fix For: 1.3.6
>
>
> When the DTDDoc plugin for Maven 2 is released,
configure the build to generate HTML-formatted DTD
documentation.
> Also, remove the LiveDTD docs under http://struts.apache.or
g/dtds, and update links in the documentation.

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

        

     [ http://issues.apache.org/struts/browse/STR-2942?page=all
 ]

Wendy Smoak updated STR-2942:
-----------------------------

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

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

  was:
When the DTDDoc plugin for Maven 2 is released, configure
the build to generate HTML-formatted DTD documentation.

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



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.

> Use the DTDDoc plugin to generate HTML formatted DTD
documentation
>
------------------------------------------------------------
------
>
>                 Key: STR-2942
>                 URL: http:
//issues.apache.org/struts/browse/STR-2942
>             Project: Struts 1
>          Issue Type: Task
>          Components: Core, Tiles, Website
>    Affects Versions: 1.3.5
>            Reporter: Wendy Smoak
>            Priority: Minor
>             Fix For: 1.3.6
>
>
> Use the DTDDoc plugin for Maven 2 to generate
HTML-formatted DTD documentation.
> Also, remove the LiveDTD docs under http://struts.apache.or
g/dtds, and update links in the documentation.

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

        

     [ http://issues.apache.org/struts/browse/STR-2942?page=all
 ]

Paul Benedict resolved STR-2942.
--------------------------------

    Resolution: Fixed
      Assignee: 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

> Use the DTDDoc plugin to generate HTML formatted DTD
documentation
>
------------------------------------------------------------
------
>
>                 Key: STR-2942
>                 URL: http:
//issues.apache.org/struts/browse/STR-2942
>             Project: Struts 1
>          Issue Type: Task
>          Components: Core, Tiles, Website
>    Affects Versions: 1.3.5
>            Reporter: Wendy Smoak
>         Assigned To: Paul Benedict
>            Priority: Minor
>             Fix For: 1.3.6
>
>
> Use the DTDDoc plugin for Maven 2 to generate
HTML-formatted DTD documentation.
> Also, remove the LiveDTD docs under http://struts.apache.or
g/dtds, and update links in the documentation.

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