Author: brett
Date: Wed Sep 21 01:04:53 2005
New Revision: 290648
URL: http://svn.apache.org/viewcvs?rev=290648&view=rev
Log:
PR: MNG-902
Submitted by: Allan Ramirez
Reviewed by: Brett Porter
documentation for the site plugin
Added:
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt
Modified:
maven/components/trunk/maven-plugins/maven-site-plugin/src/main/java/org/apache/maven/doxia/DoxiaMojo.java
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/site.xml
Modified:
maven/components/trunk/maven-plugins/maven-site-plugin/src/main/java/org/apache/maven/doxia/DoxiaMojo.java
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-site-plugin/src/main/java/org/apache/maven/doxia/DoxiaMojo.java?rev=290648&r1=290647&r2=290648&view=diff
==============================================================================
---
maven/components/trunk/maven-plugins/maven-site-plugin/src/main/java/org/apache/maven/doxia/DoxiaMojo.java
(original)
+++
maven/components/trunk/maven-plugins/maven-site-plugin/src/main/java/org/apache/maven/doxia/DoxiaMojo.java
Wed Sep 21 01:04:53 2005
@@ -95,6 +95,8 @@
"**/.DS_Store"};
/**
+ * Directory that contains the reports in apt/fml format.
+ *
* @parameter expression="${basedir}/src/site"
* @required
*/
@@ -107,23 +109,31 @@
private File generatedSiteDirectory;
/**
+ * Directory that contains the generated reports.
+ *
* @parameter expression="${project.build.directory}/site"
* @required
*/
private File outputDirectory;
/**
+ * Directory which contains the resources for the site.
+ *
* @parameter expression="${basedir}/src/site/resources"
* @required
*/
private File resourcesDirectory;
/**
+ * Directory containing the template page.
+ *
* @parameter expression="${templateDirectory}"
*/
private String templateDirectory;
/**
+ * Default template page.
+ *
* @parameter expression="${template}"
*/
private String template = DEFAULT_TEMPLATE;
@@ -161,6 +171,8 @@
private Renderer siteRenderer;
/**
+ * Internationalization.
+ *
* @parameter expression="${component.org.codehaus.plexus.i18n.I18N}"
* @required
* @readonly
@@ -168,6 +180,8 @@
private I18N i18n;
/**
+ * The maven project.
+ *
* @parameter expression="${project}"
* @required
* @readonly
@@ -409,6 +423,12 @@
}
}
+ /**
+ * Categorize reports by category name.
+ *
+ * @param reports list of reports
+ * @return the categorised reports
+ */
private Map categorizeReports( List reports )
{
Map categories = new HashMap();
@@ -670,7 +690,7 @@
}
/**
- * Generated an index page.
+ * Generate an index page.
*
* @param siteDescriptor
* @param locale
Added:
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt?rev=290648&view=auto
==============================================================================
---
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt
(added)
+++
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt
Wed Sep 21 01:04:53 2005
@@ -0,0 +1,52 @@
+ ------
+ Maven 2 Site Plugin
+ ------
+
+Maven 2 Site Plugin
+
+ Generate the project's site and report distributions.
+
+*How to Use
+
+ Using the site plugin is very easy, just execute the site goal from your
project
+
+-------------------
+ m2 site:site
+-------------------
+
+ and it would generate its default reports.
+
+ *jdepend
+
+ *checkstyle
+
+ *surefire-report
+
+ *javadoc
+
+ *jxr (cross reference)
+
+ *taglist
+
+ *changelog
+
+
+*How to configure the default reports version
+
+ You can configure the reports version by adding arguments in the command
line.
+
+-------------------
+
+ m2 site:site -DjdependVersion=2.0-beta-1 \
+ -DcheckstyleVersion=1.0 \
+ -DsurefireVersion=2.0 \
+ -DjavadocVersion=3.0 \
+
+-------------------
+
+ Note: The command is only a single line and the version value are just
examples.
+
+
+*Deploying site & Site Descriptor
+
+ For more references of deploying the site and site descriptor here's a link
{{{http://maven.apache.org/maven2/site.html}http://maven.apache.org/maven2/site.html}}.
\ No newline at end of file
Modified:
maven/components/trunk/maven-plugins/maven-site-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewcvs/maven/components/trunk/maven-plugins/maven-site-plugin/src/site/site.xml?rev=290648&r1=290647&r2=290648&view=diff
==============================================================================
--- maven/components/trunk/maven-plugins/maven-site-plugin/src/site/site.xml
(original)
+++ maven/components/trunk/maven-plugins/maven-site-plugin/src/site/site.xml
Wed Sep 21 01:04:53 2005
@@ -34,6 +34,7 @@
<menu name="Overview">
<item name="i18n" href="/i18n.html"/>
+ <item name="How to use" href="howto.html"/>
</menu>
${reports}
</body>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
