You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by lt...@apache.org on 2011/03/05 23:26:26 UTC
svn commit: r1078375 - in /maven/plugins/branches/maven-site-plugin-3.x: ./
src/site/apt/examples/multimodule.apt
src/site/apt/examples/sitedescriptor.apt src/site/apt/usage.apt
src/site/site.xml
Author: ltheussl
Date: Sat Mar 5 22:26:25 2011
New Revision: 1078375
URL: http://svn.apache.org/viewvc?rev=1078375&view=rev
Log:
merge r1060289 from trunk
Added:
maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/multimodule.apt
- copied, changed from r1060289, maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt
Modified:
maven/plugins/branches/maven-site-plugin-3.x/ (props changed)
maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/sitedescriptor.apt
maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/usage.apt
maven/plugins/branches/maven-site-plugin-3.x/src/site/site.xml
Propchange: maven/plugins/branches/maven-site-plugin-3.x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Sat Mar 5 22:26:25 2011
@@ -1 +1 @@
-/maven/plugins/trunk/maven-site-plugin:801155,801171,801470,806898-806906,807943-808180,809252,810298,884137,886844,886847,890094,890124,891014,891688,920027,920041,942622,943455,944145,950463,956681,984466,984960,984991,984996,1029307,1033379,1037476,1039137,1039143,1049020,1051139-1051449,1055019,1055033,1055047,1055089
+/maven/plugins/trunk/maven-site-plugin:801155,801171,801470,806898-806906,807943-808180,809252,810298,884137,886844,886847,890094,890124,891014,891688,920027,920041,942622,943455,944145,950463,956681,984466,984960,984991,984996,1029307,1033379,1037476,1039137,1039143,1049020,1051139-1051449,1055019,1055033,1055047,1055089,1060289
Copied: maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/multimodule.apt (from r1060289, maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt)
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/multimodule.apt?p2=maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/multimodule.apt&p1=maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt&r1=1060289&r2=1078375&rev=1078375&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/multimodule.apt (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/multimodule.apt Sat Mar 5 22:26:25 2011
@@ -69,8 +69,8 @@ Building multi-module sites
<<<{{{../attach-descriptor-mojo.html}site:attach-descriptor}}>>>
goal to attach the site descriptor to your project's main artifact.
- In Maven 2 the site descriptor is attached automatically for projects with
- packaging set to "pom".
+ In Maven 3 you must attach the site descriptor yourself, even for projects
+ with packaging set to "pom".
By default, only the basic settings are inherited. From the body, <<only>>
the links and breadcrumbs are inherited, and these accumulate to contain all the parents'
Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/sitedescriptor.apt
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/sitedescriptor.apt?rev=1078375&r1=1078374&r2=1078375&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/sitedescriptor.apt (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/examples/sitedescriptor.apt Sat Mar 5 22:26:25 2011
@@ -147,35 +147,7 @@ Configuring the Site Descriptor
* Inheritance
- Site descriptors are inherited along the same lines as project descriptors
- are. If you want your project's site descriptor to be inherited, you need to
- attach it to the project's main artifact. You use the
- <<<site:attach-descriptor>>> goal to attach the site descriptor to your
- project's main artifact.
-
- In Maven 3 you must attach the site descriptor yourself, even for projects
- with packaging set to "pom".
-
- By default, only the basic settings are inherited. From the body, <<only>>
- the links are inherited, and these accumulate to contain all the parents'
- site descriptor links.
-
- However, it is possible to inherit menus as well. To do so, use the <<<inherit>>> attribute in the site descriptor. This can
- be either <<<top>>> or <<<bottom>>>, indicating where the inherited menu will be placed. For example:
-
-+-----+
-<project>
- ...
- <body>
- ...
- <menu name="My Inherited Menu" inherit="top">
- ...
- </menu>
- ...
- </body>
- ...
-</project>
-+-----+
+ See {{{./multimodule.html} Building multi-module sites}}.
* Including Generated Content
Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/usage.apt?rev=1078375&r1=1078374&r2=1078375&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/usage.apt (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/apt/usage.apt Sat Mar 5 22:26:25 2011
@@ -118,6 +118,15 @@ mvn site-deploy
project and its modules.
Just execute the <<<{{{./stage-mojo.html}site:stage}}>>> goal from your project
+
++-----+
+mvn site:stage
++-----+
+
+ <<Note:>> Since version 2.3, a site must be generated first before executing <<<site:stage>>>.
+
+ By default, the site will be staged in a directory <<<target/staging/>>>.
+ A different staging location can be chosen
with the <<<stagingDirectory>>> parameter as shown below:
+-----+
@@ -135,10 +144,11 @@ mvn site:stage -DstagingDirectory=C:\ful
for more information on this.
+-----+
-mvn site:stage-deploy -DstagingDirectory=C:\fullsite \
- -DstagingSiteURL=scp://www.mycompany.com/www/project/
+mvn site:stage-deploy -DstagingSiteURL=scp://www.mycompany.com/www/project/
+-----+
+ <<Note:>> Since version 2.3, a site must be generated first before executing <<<site:stage-deploy>>>.
+
<<Note:>> Due to a bug in Wagon, the password is not always picked up when
you run the <<<site:stage-deploy>>> goal. The bug has been fixed, but the
version of Wagon that is used by the Site Plugin is determined by the version
Modified: maven/plugins/branches/maven-site-plugin-3.x/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/branches/maven-site-plugin-3.x/src/site/site.xml?rev=1078375&r1=1078374&r2=1078375&view=diff
==============================================================================
--- maven/plugins/branches/maven-site-plugin-3.x/src/site/site.xml (original)
+++ maven/plugins/branches/maven-site-plugin-3.x/src/site/site.xml Sat Mar 5 22:26:25 2011
@@ -38,6 +38,7 @@ under the License.
<menu name="Examples">
<item name="Creating Content" href="/examples/creating-content.html"/>
<item name="Configuring the Site Descriptor" href="/examples/sitedescriptor.html"/>
+ <item name="Building a multi-module site" href="/examples/multimodule.html"/>
<item name="Configuring Reports" href="/examples/configuring-reports.html"/>
<item name="Configuring Site Run" href="/examples/siterun.html"/>
<item name="Changing the Template File" href="/examples/templatefile.html"/>