You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by ka...@apache.org on 2003/01/31 22:50:17 UTC
cvs commit: jakarta-turbine-maven/xdocs/reference project-descriptor.xml user-guide.xml
kaz 2003/01/31 13:50:17
Modified: xdocs/reference project-descriptor.xml user-guide.xml
Log:
Documentation
o Added a section to the POM doc about the use of <report/> tags and how
they can be used to specify which reports are generated.
o Created the Site Generation section of the user guide which includes
how to customize site generation of maven.
Revision Changes Path
1.7 +30 -0 jakarta-turbine-maven/xdocs/reference/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/reference/project-descriptor.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- project-descriptor.xml 5 Dec 2002 15:55:36 -0000 1.6
+++ project-descriptor.xml 31 Jan 2003 21:50:17 -0000 1.7
@@ -226,6 +226,13 @@
when invoking the <a href="build-file.html">build system</a>.
</td>
</tr>
+ <tr>
+ <td><a href="#reports">reports</a></td>
+ <td>
+ Describes the reports that should be included as part of the
+ Maven-generated site.
+ </td>
+ </tr>
</table>
</section>
<section name="organization">
@@ -662,6 +669,29 @@
</tr>
</table>
</subsection>
+ </section>
+ <section name="reports">
+ <p>
+ This element includes the specification of reports to be
+ included in a Maven-generated site. These reports will be run
+ when a user executes <code>maven site</code>. All of the
+ reports will be included in the navigation bar for browsing in
+ the order they are specified.
+ </p>
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td>report</td>
+ <td>
+ The name of the report that should be run when the site is
+ generated. There is an established naming convention that
+ is to be used when specifying reports. If you want the
+ report that is generated by a plugin called
+ <code>xyz</code>, then you would specify the following for
+ the value of this element: <code>maven-xyz-plugin</code>.
+ </td>
+ </tr>
+ </table>
</section>
</body>
</document>
1.28 +51 -1 jakarta-turbine-maven/xdocs/reference/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/reference/user-guide.xml,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- user-guide.xml 11 Dec 2002 17:54:37 -0000 1.27
+++ user-guide.xml 31 Jan 2003 21:50:17 -0000 1.28
@@ -39,6 +39,11 @@
</ol>
</li>
<li><a href="#Site Generation">Site Generation</a></li>
+ <ol>
+ <li><a href="#Colors">Colors</a></li>
+ <li><a href="#Stylesheets">Stylesheets</a></li>
+ <li><a href="#Reports">Reports</a></li>
+ </ol>
<li>
<a href="#Deployment">Deployment</a>
<br/>
@@ -808,7 +813,52 @@
<section name="Site Generation">
<p>
- </p>
+ Maven can be used to generate an entire web site for your
+ project. This web site will contain various reports generated
+ by the numerous plugins included in Maven such as javadocs,
+ metrics, unit test results, changelogs, and many more. The rest
+ of this section talks about the various site customization
+ options available in Maven.
+ </p>
+ <subsection name="Colors">
+ <p>
+ By default, all Maven-generated sites use the same look and
+ feel for consistency. This enables users to easily recognize
+ a Maven-generated site and immediately feel comfortable
+ searching for information on the site. Of course, the Maven
+ development team understands that users might want to
+ customize their own sites. The easiest method to alter the
+ appearance of the Maven-generated site is to specify your own
+ color scheme to use. This is as simple as setting the
+ appropriate properties in your project's
+ <code>project.properties</code> file. All of the available
+ properties are described in the <a
+ href="plugins/xdoc/properties.html">xdoc plugin</a>.
+ </p>
+ </subsection>
+ <subsection name="Stylesheets">
+ <p>
+ If you feel that colors are simply not enough to distinguish
+ your site, you can specify your own stylesheet that will be
+ used. To override the Maven-supplied stylesheet, copy your
+ own and override the <code>maven.css</code> stylesheet in your
+ <code>${basedir}/xdocs/stylesheets/</code> directory. You can
+ also specify your own javadoc stylesheet by setting the
+ <code>maven.javadoc.stylesheet</code> property.
+ </p>
+ </subsection>
+ <subsection name="Reports">
+ <p>
+ Finally, if you want to customize which reports are
+ automatically generated for your site, you need to include the
+ <a href="project-descriptor.html#reports"><code>reports</code></a> tag
+ in your project descriptor. As of this writing, if you do not
+ utilize the <code>reports</code> tag, all of the plugin
+ reports will be generated. This tag enables you to
+ selectively choose which reports to include and exclude as
+ well as the order of the reports.
+ </p>
+ </subsection>
</section>
<section name="Deployment">