You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by bu...@apache.org on 2018/02/05 23:15:38 UTC
svn commit: r1024901 - in /websites/staging/maven/trunk/content: ./
archetypes/ guides/plugin/
Author: buildbot
Date: Mon Feb 5 23:15:38 2018
New Revision: 1024901
Log:
Staging update by buildbot for maven
Added:
websites/staging/maven/trunk/content/archetypes/maven-archetype-archetype (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-j2ee-simple (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin-site (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-portlet (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-quickstart (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-simple (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-site-simple (with props)
websites/staging/maven/trunk/content/archetypes/maven-archetype-webapp (with props)
Removed:
websites/staging/maven/trunk/content/archetypes/archetypes
Modified:
websites/staging/maven/trunk/content/ (props changed)
websites/staging/maven/trunk/content/guides/plugin/guide-java-plugin-development.html
websites/staging/maven/trunk/content/guides/plugin/guide-java-report-plugin-development.html
websites/staging/maven/trunk/content/maven-site-1.0-site.jar
Propchange: websites/staging/maven/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Feb 5 23:15:38 2018
@@ -1 +1 @@
-1823260
+1823261
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-archetype
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-archetype (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-archetype Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-archetype
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-archetype
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-j2ee-simple
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-j2ee-simple (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-j2ee-simple Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-j2ee-simple
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-j2ee-simple
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-plugin
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin-site
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin-site (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin-site Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-plugin-site
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-plugin-site
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-portlet
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-portlet (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-portlet Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-portlet
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-portlet
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-quickstart
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-quickstart (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-quickstart Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-quickstart
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-quickstart
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-simple
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-simple (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-simple Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-simple
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-simple
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-site-simple
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-site-simple (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-site-simple Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-site-simple
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-site-simple
------------------------------------------------------------------------------
svn:special = *
Added: websites/staging/maven/trunk/content/archetypes/maven-archetype-webapp
==============================================================================
--- websites/staging/maven/trunk/content/archetypes/maven-archetype-webapp (added)
+++ websites/staging/maven/trunk/content/archetypes/maven-archetype-webapp Mon Feb 5 23:15:38 2018
@@ -0,0 +1 @@
+link ../components/archetypes/maven-archetype-webapp
\ No newline at end of file
Propchange: websites/staging/maven/trunk/content/archetypes/maven-archetype-webapp
------------------------------------------------------------------------------
svn:special = *
Modified: websites/staging/maven/trunk/content/guides/plugin/guide-java-plugin-development.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/plugin/guide-java-plugin-development.html (original)
+++ websites/staging/maven/trunk/content/guides/plugin/guide-java-plugin-development.html Mon Feb 5 23:15:38 2018
@@ -321,7 +321,7 @@ public class GreetingMojo extends Abstra
*/
@Parameter( property = "sayhi.greeting", defaultValue = "Hello World!" )
private String greeting;</pre></div>
-<p>The portion before the annotations is the description of the parameter. The <tt>parameter</tt> annotation identifies the variable as a mojo parameter. The <tt>defaultValue</tt> parameter of the annotation defines the default value for the variable. This value can include expressions which reference the project, such as "<tt>${project.version}</tt>" (more can be found in the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html">"Parameter Expressions" document</a>). The <tt>property</tt> parameter can be used to allow configuration of the mojo parameter from the command line by referencing a system property that the user sets via the <tt>-D</tt> option.</p></div>
+<p>The portion before the annotations is the description of the parameter. The <tt>parameter</tt> annotation identifies the variable as a mojo parameter. The <tt>defaultValue</tt> parameter of the annotation defines the default value for the variable. This value can include expressions which reference the project, such as "<tt>${project.version}</tt>" (more can be found in the <a href="/ref/current/maven-core/apidocs/org/apache/maven/plugin/PluginParameterExpressionEvaluator.html">"Parameter Expressions" document</a>). The <tt>property</tt> parameter can be used to allow configuration of the mojo parameter from the command line by referencing a system property that the user sets via the <tt>-D</tt> option.</p></div>
<div class="section">
<h4><a name="Configuring_Parameters_in_a_Project"></a>Configuring Parameters in a Project</h4>
<p>Configuring the parameter values for a plugin is done in a Maven project within the <tt>pom.xml</tt> file as part of defining the plugin in the project. An example of configuring a plugin:</p>
Modified: websites/staging/maven/trunk/content/guides/plugin/guide-java-report-plugin-development.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/plugin/guide-java-report-plugin-development.html (original)
+++ websites/staging/maven/trunk/content/guides/plugin/guide-java-report-plugin-development.html Mon Feb 5 23:15:38 2018
@@ -157,14 +157,14 @@ Bertrand Martin" />
</plugins>
</reporting>
...</pre></div></li>
-<li> When <a href="/plugins/maven-site-plugin/"><tt>maven-site-plugin</tt></a> is invoked (for example with the <tt>mvn site</tt> command), the specified plugins are loaded and the <i>executeReport()</i> method of each class that extends <a href="/shared/maven-reporting-impl/apidocs/org/apache/maven/reporting/AbstractMavenReport.html"><i>AbstractMavenReport</i></a> is executed.</li>
-<li> The <i>executeReport()</i> method generates a document through Maven's <a href="/doxia/doxia/doxia-sink-api/">Doxia Sink API</a>. This document is comprised of basic elements like title, headings, text, links, tables, etc. This is where you will put the logic of your report, assembling elements, based on the content of the Maven project.</li>
-<li> These document elements are passed to Doxia to generate an HTML document, which itself gets wrapped into a <a href="/skins">Maven Skin</a>, as specified in the projects <a href="/guides/mini/guide-site.html"><tt>./src/site/site.xml</tt></a>.</li>
+<li> When <a href="/plugins/maven-site-plugin/"><tt>maven-site-plugin</tt></a> is invoked (for example with the <tt>mvn site</tt> command), the specified plugins are loaded and the <i>generate()</i> method of each class that implements <a href="/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html"><i>MavenReport</i></a> is executed.</li>
+<li> The <i>generate()</i> method generates a document through Maven's <a href="/doxia/doxia/doxia-sink-api/">Doxia Sink API</a>. This document is comprised of basic elements like title, headings, text, links, tables, etc. This is where you will put the logic of your report, assembling elements, based on the content of the Maven project.</li>
+<li> These document elements are passed to Doxia to generate an HTML document, which itself gets wrapped into a <a href="/skins/">Maven Skin</a>, as specified in the projects <a href="/guides/mini/guide-site.html"><tt>./src/site/site.xml</tt></a>.</li>
<li> The result produces an HTML file in the <tt>./target/site</tt> directory of your project.</li></ol>
<p><a href="/doxia/doxia-sitetools/doxia-site-renderer/">More details about Doxia Site Renderer</a></p></div>
<div class="section">
<h3><a name="Basic_Requirements_of_a_Report_Mojo"></a>Basic Requirements of a Report <i>Mojo</i></h3>
-<p>Each goal or <i>Mojo</i> is implemented with a separate Java class. For a <i>Mojo</i> to become a <i>report Mojo</i>, it needs to extend the <a href="/shared/maven-reporting-impl/apidocs/org/apache/maven/reporting/AbstractMavenReport.html"><i>org.apache.maven.reporting.AbstractMavenReport</i></a> class (instead of <i>org.apache.maven.plugin.AbstractMojo</i> for a regular <i>Mojo</i>).</p>
+<p>Each goal or <i>Mojo</i> is implemented with a separate Java class. For a <i>Mojo</i> to become a <i>report Mojo</i>, it needs to implement <a href="/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html"><i>MavenReport</i></a> (in addition to <a href="/ref/current/apidocs/org/apache/maven/plugin/Mojo.html"><i>org.apache.maven.plugin.Mojo</i></a>). An easy way to implement both interfaces is to extend the <a href="/shared/maven-reporting-impl/apidocs/org/apache/maven/reporting/AbstractMavenReport.html"><i>org.apache.maven.reporting.AbstractMavenReport</i></a> class (instead of <i>org.apache.maven.plugin.AbstractMojo</i> for a regular <i>Mojo</i>).</p>
<p>The class will also need to implement the following methods:</p>
<ul>
<li><tt>public String getOutputName()</tt>: returns the name of page that will be produced</li>
@@ -173,8 +173,8 @@ Bertrand Martin" />
<li><tt>protected void executeReport(Locale locale) throws MavenReportException</tt>: produces the actual report</li></ul>
<p>To build a Maven plugin that includes <i>report Mojos</i>, the <tt>pom.xml</tt> of your project will need declare the project as a regular plugin, and include specific dependencies required by the report <i>Mojos</i>:</p>
<ul>
-<li><a class="externalLink" href="https://mvnrepository.com/artifact/org.apache.maven.reporting/maven-reporting-impl"><tt>org.apache.maven.reporting:maven-reporting-impl:3.0.0</tt></a></li>
-<li><a class="externalLink" href="https://mvnrepository.com/artifact/org.apache.maven.reporting/maven-reporting-api"><tt>org.apache.maven.reporting:maven-reporting-api:3.0</tt></a></li></ul></div>
+<li><a href="/shared/maven-reporting-impl/dependency-info.html"><tt>org.apache.maven.reporting:maven-reporting-impl</tt></a></li>
+<li><a href="/shared/maven-reporting-api/dependency-info.html"><tt>org.apache.maven.reporting:maven-reporting-api</tt></a></li></ul></div>
<div class="section">
<h3><a name="A_.28Very.29_Simple_Report"></a>A (Very) Simple Report</h3>
<p>Let's write a very simple <i>report Mojo</i> in a very simple Maven plugin:</p>
@@ -253,7 +253,7 @@ Bertrand Martin" />
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
- <version>3.5</version>
+ <version>3.5.1</version>
<configuration>
<goalPrefix>simple</goalPrefix>
</configuration>
@@ -300,12 +300,8 @@ import org.apache.maven.reporting.MavenR
*/
@Mojo(
name = "simple",
- aggregator = false,
- executionStrategy = "always",
defaultPhase = LifecyclePhase.SITE,
requiresDependencyResolution = ResolutionScope.RUNTIME,
- requiresDirectInvocation = false,
- requiresOnline = false,
requiresProject = true,
threadSafe = true
)
@@ -372,7 +368,7 @@ public class SimpleReport extends Abstra
mainSink.paragraph_();
// Close
- mainSink.section1_();
+ mainSink.section1_();
mainSink.body_();
}
@@ -381,10 +377,9 @@ public class SimpleReport extends Abstra
<div class="section">
<h4><a name="Building_the_Simple_Plugin"></a>Building the Simple Plugin</h4>
<p>Building the plugin is done by executing the below command in the root directory of the plugin project:</p>
-<div class="source"><pre class="prettyprint linenums">$ mvn clean install</pre></div>
+<div class="source"><pre class="prettyprint linenums">$ mvn install</pre></div>
<p>This command will:</p>
<ul>
-<li>erase the content of the <tt>./target</tt> directory</li>
<li>compile your code</li>
<li>produces the plugin JAR artifact (<tt>./target/simple-maven-plugin-1.0-SNAPSHOT.jar</tt>)</li>
<li>copy the artifact to your local repository so that it can be "consumed" by other projects (which is the purpose of a plugin, right?).</li></ul>
@@ -432,7 +427,7 @@ simple:simple
<div class="section">
<h4><a name="The_Doxia_Sink_API"></a>The Doxia Sink API</h4>
<p>In your <i>executeReport()</i> method, you will leverage the <a href="/doxia/doxia/doxia-sink-api/">Doxia Sink API</a> to add elements to the report document.</p>
-<p>You will use the <a class="externalLink" href="https://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html"><i>Sink</i></a> object associated to the report:</p>
+<p>You will use the <a href="/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html"><i>Sink</i></a> object associated to the report:</p>
<div class="source"><pre class="prettyprint linenums">Sink sink = getSink();</pre></div>
<p>This object allows you to append new elements to the report document (initially empty). Unlike some DOM manipulation APIs, you cannot insert elements in already existing elements, or remove elements.</p>
<p>The elements that you append to the document will look familiar if you have basic knowledge of HTML. Most of the elements have opening and closing tags, like <i>sink.body()</i> (opening) and <i>sink.body_()</i> (closing).</p>
Modified: websites/staging/maven/trunk/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.