Author: dennisl
Date: Tue Jul 11 12:43:22 2006
New Revision: 420962
URL: http://svn.apache.org/viewvc?rev=420962&view=rev
Log:
Use standard filenames for examples.
Minor spelling corrections.
Modified:
maven/site/trunk/src/site/apt/guides/development/guide-plugin-documentation.apt
Modified:
maven/site/trunk/src/site/apt/guides/development/guide-plugin-documentation.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-plugin-documentation.apt?rev=420962&r1=420961&r2=420962&view=diff
==============================================================================
---
maven/site/trunk/src/site/apt/guides/development/guide-plugin-documentation.apt
(original)
+++
maven/site/trunk/src/site/apt/guides/development/guide-plugin-documentation.apt
Tue Jul 11 12:43:22 2006
@@ -24,16 +24,16 @@
Generated Documentation
It is recommended that you let maven generate the basic information for the
plugin to make sure that
- that the basic information is always accurate and synchronize with the plugin
implementation.
+ that the basic information is always accurate and synchronized with the
plugin implementation.
- Documentations are generated by running
+ Documentation is generated by running
+---------------+
mvn site:site
+---------------+
It will generate a plugin site based on the information in the POM,
<<<src/site>>> and other reporting
- plugin configured in the POM. But in order for the generated site to be
usable, the required
+ plugins configured in the POM. But in order for the generated site to be
usable, the required
information should be available to the site plugin.
*POM elements
@@ -66,7 +66,7 @@
*description - project description, an overview of what the plugin can do
- *url - the site of the plugin, normally mave.apache.org or mojo.codehaus.org
+ *url - the site of the plugin, normally maven.apache.org or mojo.codehaus.org
*issueManagement - describes the system used for reporting problems and
modification requests
@@ -169,7 +169,7 @@
*Site organization
- Visibility of the information is also crucial, having a uniform navigation
links will greatly improve the visibility of the
+ Visibility of the information is also crucial, having uniform navigation
links will greatly improve the visibility of the
documentations. The index page can also help emphasize important sections and
pages of the plugin documentation.
**Site descriptor
@@ -191,8 +191,8 @@
</menu>
<menu name="Examples">
- <item name="description1" href="examples/example1.html"/>
- <item name="description2" href="examples/example2.html"/>
+ <item name="description1" href="examples/example-one.html"/>
+ <item name="description2" href="examples/example-two.html"/>
</menu>
${reports}
@@ -234,19 +234,19 @@
* Examples
- To provide you with better understanding on some usages of the Plugin Name,
+ To provide you with better understanding of some usages of the Plugin Name,
you can take a look into the following examples:
- * {{{examples/short_description1.html}Example Description One}}
+ * {{{examples/example-one.html}Example Description One}}
- * {{{examples/short_description2.html}Example Description Two}}
+ * {{{examples/example-two.html}Example Description Two}}
+--------------+
*Goals
<<<plugin-info.html>>> is generated by the plugin plugin. Until the site
plugin is updated it would be better to pull it out
- to the main menu for greater visibility. This contains the goals and their
description with a link to the configuration parameters.
+ to the main menu for greater visibility. This contains the goals and their
descriptions with a link to the configuration parameters.
The information is based on the comments and annotations of the plugin.
*Usage (Howto)
@@ -278,10 +278,10 @@
*Examples
- The advance configurations and examples not covered in the usage page is
located here. Advance users who wants to maximize the use
+ The advanced configurations and examples not covered in the usage page is
located here. Advanced users who wants to maximize the use
of a plugin can check the items here. Tips on how to use the plugin
effectively is also a good thing to put here.
- For examples on of items under "Examples" check these plugin sites :
+ For examples of items under "Examples" check these plugin sites :
{{{http://maven.apache.org/plugins/maven-javadoc-plugin/}Maven Javadoc
Plugin Examples}}
@@ -320,13 +320,13 @@
[...]
+--------------+
- Check the
{{{http://maven.apache.org/plugins/maven-javadoc-plugin/configuration.html}javadoc
documentation}} for the advance configurations.
+ Check the
{{{http://maven.apache.org/plugins/maven-javadoc-plugin/configuration.html}javadoc
documentation}} for the advanced configurations.
*JXR Report Plugin
The jxr plugin generates a cross-reference of the project sources. The
generated cross-references are also linked to the corresponding
javadoc if javadoc is generated. The cross-references is great for those who
wants to better understand the inner workings of the
- plugin
+ plugin.
To enable the jxr plugin add the following to your <<<pom.xml>>>
