You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/09/21 12:20:28 UTC
svn commit: r290674 - in
/maven/components/trunk/maven-plugins/maven-site-plugin/src:
main/java/org/apache/maven/doxia/DoxiaMojo.java site/apt/howto.apt
Author: brett
Date: Wed Sep 21 03:20:21 2005
New Revision: 290674
URL: http://svn.apache.org/viewcvs?rev=290674&view=rev
Log:
PR: MNG-856
Submitted by: Allan Ramirez
Reviewed by: Brett Porter
site plugin documentation
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/apt/howto.apt
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=290674&r1=290673&r2=290674&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 03:20:21 2005
@@ -95,7 +95,7 @@
"**/.DS_Store"};
/**
- * Directory that contains the reports in apt/fml format.
+ * Directory containing source for apt, fml and xdoc docs.
*
* @parameter expression="${basedir}/src/site"
* @required
@@ -109,7 +109,7 @@
private File generatedSiteDirectory;
/**
- * Directory that contains the generated reports.
+ * Directory containing the generated project sites and report distributions.
*
* @parameter expression="${project.build.directory}/site"
* @required
@@ -164,6 +164,8 @@
private String outputEncoding;
/**
+ * Site Renderer
+ *
* @parameter expression="${component.org.codehaus.plexus.siterenderer.Renderer}"
* @required
* @readonly
@@ -196,6 +198,10 @@
private List reports;
/**
+ * Generate the project site
+ *
+ * throws MojoExecutionException if any
+ *
* @see org.apache.maven.plugin.Mojo#execute()
*/
public void execute()
@@ -502,6 +508,14 @@
return localesList;
}
+ /**
+ * Retrieve the reports menu
+ *
+ * @param locale the locale used
+ * @param projectInfos list of project infos
+ * @param projectReports list of project reports
+ * @return a XML for reports menu
+ */
private String getReportsMenu( Locale locale, List projectInfos, List projectReports )
{
StringBuffer buffer = new StringBuffer();
@@ -522,6 +536,15 @@
return buffer.toString();
}
+ /**
+ * Create a report sub menu
+ *
+ * @param reports list of reports specified in pom
+ * @param buffer string to be appended
+ * @param locale the locale used
+ * @param key
+ * @param indexFilename index page filename
+ */
private void writeReportSubMenu( List reports, StringBuffer buffer, Locale locale, String key,
String indexFilename )
{
@@ -798,6 +821,14 @@
return generatedReportsFileName;
}
+ /**
+ * Generates Project Info Page
+ *
+ * @param siteDescriptor site.xml
+ * @param locale the locale used
+ * @param projectInfos list of projectInfos
+ * @param outputDirectory directory that will contain the generated project info page
+ */
private void generateProjectInfoPage( String siteDescriptor, Locale locale, List projectInfos,
File outputDirectory )
throws RendererException, IOException
@@ -879,6 +910,14 @@
template, attributes, sink, locale );
}
+ /**
+ * Generates the Project Report Pages
+ *
+ * @param siteDescriptor site.xml
+ * @param locale the locale used
+ * @param projectReports list of project reports
+ * @param outputDirectory directory that will contain the generated project report pages
+ */
private void generateProjectReportsPage( String siteDescriptor, Locale locale, List projectReports,
File outputDirectory )
throws RendererException, IOException
@@ -956,6 +995,12 @@
template, attributes, sink, locale );
}
+ /**
+ * Copy Resources
+ *
+ * @param outputDir the output directory
+ * @throws IOException if any
+ */
private void copyResources( File outputDir )
throws IOException
{
@@ -997,11 +1042,24 @@
}
}
+ /**
+ * Get the resource as stream
+ *
+ * @param name
+ * @return the inputstream
+ */
private InputStream getStream( String name )
{
return DoxiaMojo.class.getClassLoader().getResourceAsStream( name );
}
+ /**
+ * Copy the directory
+ *
+ * @param source source file to be copied
+ * @param destination destination file
+ * @throws IOException if any
+ */
private void copyDirectory( File source, File destination )
throws IOException
{
Modified: 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=290674&r1=290673&r2=290674&view=diff
==============================================================================
--- maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt (original)
+++ maven/components/trunk/maven-plugins/maven-site-plugin/src/site/apt/howto.apt Wed Sep 21 03:20:21 2005
@@ -6,6 +6,17 @@
Generate the project's site and report distributions.
+*How to Use Site plugin
+
+ Here is a link for more information {{{http://maven.apache.org/maven2/site.html}http://maven.apache.org/maven2/site.html}}
+ ------
+ 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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org