Author: dennisl
Date: Sun Mar 8 13:54:54 2009
New Revision: 751423
URL: http://svn.apache.org/viewvc?rev=751423&view=rev
Log:
o Improve the documentation.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/configuring-reports.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/site-deploy-to-sourceforge.net.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-site-plugin/src/site/site.xml
maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/configuring-reports.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/configuring-reports.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/configuring-reports.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/configuring-reports.apt
Sun Mar 8 13:54:54 2009
@@ -3,7 +3,7 @@
------
Dennis Lundberg
------
- 2008-03-23
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -33,7 +33,7 @@
current state of the project. These reports take the form of plugins, just
like those used to build the project.
- There are many standard reports that are available by gleaning information
+ There are many standard reports that are available by extracting information
from the POM. Currently these are provided by default:
* Continous Integration
@@ -52,10 +52,10 @@
[]
- To find out more please refer to the
+ To find out more please see to the
{{{http://maven.apache.org/plugins/maven-project-info-reports-plugin/}Project
Info Reports Plugin}}.
- To add these reports to your site, you must add the plugin to a special
+ To add these reports to your site, you must add the plugin to the
<<<\<reporting\>>>> element in the POM. The following example shows how to
configure the standard Project Info Reports that display information from the
POM in a friendly format:
@@ -68,7 +68,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
- <version>2.0.1</version>
+ <version>2.1.1</version>
</plugin>
</plugins>
</reporting>
@@ -78,7 +78,7 @@
If you have included the appropriate <<<\<menu ref="reports"/\>>>> tag in
your
{{{sitedescriptor.html}site descriptor}}, then when you regenerate the site
- those items will appear in the menu.
+ those items will appear in a menu called "Project Reports".
<<Note:>> Many report plugins provide a parameter called
<<<outputDirectory>>>
or similar to specify the destination for their report outputs. This
parameter
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt
Sun Mar 8 13:54:54 2009
@@ -3,7 +3,7 @@
------
Dennis Lundberg
------
- 2008-03-23
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -30,7 +30,7 @@
Creating Content
Now it's time to create some content for your site. In Maven 2, the site
- content is separated by format, as there are several formats supported.
+ content is structured by format, as there are several formats supported.
Here's an example of a directory structure for a site:
@@ -40,19 +40,19 @@
+- apt/
| +- index.apt
|
- +- xdoc/
- | +- other.xml
- |
+- fml/
| +- general.fml
| +- faq.fml
|
+ +- xdoc/
+ | +- other.xml
+ |
+- site.xml
--------------------
You notice the <<<$\{basedir\}/src/site>>> directory which contains a site
descriptor along with various directories corresponding to the supported
- document formatss. Let's take a look at examples of the various document
+ document formats. Let's take a look at examples of the various document
formats.
The APT format, "Almost Plain Text", is a wiki-like format that allows you to
@@ -78,7 +78,25 @@
Note that all of the above is optional - just one index file is required in
one of the input trees. The paths under each format will be merged together
- to form the root directory of the site.
+ to form the root directory of the site. After running '<<<mvn site:site>>>'
+ on the example above you will end up with this in your <<<target>>>
directory:
+
+-------------------
++- target/
+ +- site/
+ +- css/
+ |
+ +- images/
+ |
+ +- index.html
+ +- general.html
+ +- faq.html
+ +- other.html
+--------------------
+
+ The <<<css>>> and <<<images>>> directories contains stylesheets and images
+ from the skin being used. You can read more about skins in
+ {{{sitedescriptor.html}the site descriptor documentation}}.
* Adding Extra Resources
@@ -158,7 +176,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>2.0-beta-6</version>
+ <version>2.0</version>
<configuration>
<locales>en,fr</locales>
</configuration>
@@ -175,8 +193,9 @@
subdirectory.
To add your own content for that translation instead of using the default,
- place a subdirectory with that locale name in your site directory and create
- a new site descriptor with the locale in the file name. For example:
+ create a subdirectory with that locale's name in your site directory and
+ create a new site descriptor with the name of the locale in the file name.
+ For example:
-------------------
+- src/
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creatingskins.apt
Sun Mar 8 13:54:54 2009
@@ -2,8 +2,9 @@
Creating Skins
------
Brett Porter
+ Dennis Lundberg
------
- May 11, 2005
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -30,22 +31,22 @@
Creating Skins
If you want to tune the way your site looks, you can use a custom skin to
- provide your own CSS styles. If that is still not enough, you can even tweak
+ provide your own CSS stylesheets. If that is still not enough, you can even
tweak
the output templates that Maven uses to generate the site documentation.
-~~ TODO: The following link is currently unavailable. Restore it when it
becomes available again
-~~ For an in-depth discussion of site customization, please have a look at the
-~~ {{{http://www.sonatype.com/book/site-generation.html} Maven User Guide,
Chapter 9, "Site Generation"}}.
+ For an in-depth discussion of site customization, please have a look at
+ {{{http://www.sonatype.com/books/maven-book/reference/site-generation.html}
Maven: The Definitive Guide, Chapter 15. Site Generation}}
+ provided by Sonatype.
* About
- A Maven 2 site skin contains the following elements:
+ A skin contains the following elements:
- * Resources to copy into each project (such as images used by the CSS).
+ * Resources to copy into each project (such as images used by the CSS)
- * A couple of CSS files, containing the visual styling.
+ * A couple of CSS files, containing the visual styling
- * An optional Velocity template for an alternate HTML rendering of the
site.
+ * An optional Velocity template for an alternate HTML rendering of the site
* Building
@@ -58,22 +59,26 @@
* Constructing the CSS
- <<More information is needed here on constructing the CSS.>>
+~~ @todo More information is needed here on constructing the CSS
If you are interested in constructing your own CSS, it is recommended that
- you copy an existing skin's <<<maven-theme.css>>> file and modify it to suit
- your needs.
+ you copy the file
+
{{{https://svn.apache.org/repos/asf/maven/skins/trunk/maven-default-skin/src/main/resources/css/maven-theme.css}<<<maven-theme.css>>>}}
+ from Maven Default Skin and modify it to suit your needs.
* Customizing the HTML Output with a Velocity Template
- <<Details on the Velocity template variables and use should be included>>.
-
The format of the Velocity template is currently out of scope for this
document. To attempt this, start by copying
<<<{{{https://svn.apache.org/repos/asf/maven/doxia/doxia-sitetools/trunk/doxia-site-renderer/src/main/resources/org/apache/maven/doxia/siterenderer/resources/default-site.vm}default-site.vm}}>>>
to <<<src/main/resources/META-INF/maven/site.vm>>> in your project and then
modify it to your needs.
+ For more information about how to write Velocity templates see the
+
{{{http://velocity.apache.org/engine/releases/velocity-1.5/user-guide.html}Velocity
User Guide}}
+ and
+
{{{http://velocity.apache.org/engine/releases/velocity-1.5/vtl-reference-guide.html}Velocity
Template Language Reference Guide}}.
+
* Examples of Existing Skins
A list of links to skins that can be used as inspiration can be found on
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/moduleexcludes.apt
Sun Mar 8 13:54:54 2009
@@ -1,9 +1,9 @@
------
- Excluding Modules
+ Excluding Document Formats
------
Maria Odea Ching
------
- July 2006
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -27,9 +27,9 @@
~~ http://maven.apache.org/doxia/references/apt-format.html
-Excluding Modules
+Excluding Document Formats
- To exclude specific modules from the site to be generated, you can use the
<<<excludeModules>>> parameter.
+ To exclude specific document formats from the generated site, you can use
the <<<excludeModules>>> parameter.
For example, you have the following site content in your POM
@@ -45,8 +45,9 @@
`-- pom.xml
+-----+
- and you want to exclude the whole fml module from the site to be generated,
you need to set the following in your POM
- then execute "<<<mvn site>>>".
+ and you want to exclude all the documents in the fml format from the
+ generated site, you need to set the following in your POM and then execute
+ "<<<mvn site>>>".
+-----+
<project>
@@ -56,6 +57,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
+ <version>2.0</version>
<configuration>
<excludeModules>fml</excludeModules>
</configuration>
@@ -66,4 +68,4 @@
</project>
+-----+
- You will see that no <<<sample-fml.html>>> will be generated with the site.
\ No newline at end of file
+ You will see that no <<<sample-fml.html>>> will be present in the generated
site.
\ No newline at end of file
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/site-deploy-to-sourceforge.net.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/site-deploy-to-sourceforge.net.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/site-deploy-to-sourceforge.net.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/site-deploy-to-sourceforge.net.apt
Sun Mar 8 13:54:54 2009
@@ -1,31 +1,33 @@
------
- Deployment of site to web.sourceforge.net
+ Deploying to sourceforge.net
------
Barrie Treloar
------
- 8 November 2008
+ 2009-03-08
------
-Deployment of site to web.sourceforge.net
+Deploying to sourceforge.net
This {{{http://sourceforge.net/community/forum/topic.php?id=3518&page}sf.net
announcement}} indicates that the
- new hostname for project web file management has changed. The new hostname
for file management is: web.sourceforge.net and
- the new accepted methods are: SFTP, SCP, rsync over SSH. Unfortunately
web.sourceforge.net also has a restricted shell
- environment and does not allow remote commands to be executed.
+ new hostname for project web file management has changed. The new hostname
for file management is:
+ <<<web.sourceforge.net>>> and
+ the new accepted methods are: SFTP, SCP, rsync over SSH. Unfortunately
<<<web.sourceforge.net>>> also has a restricted
+ shell environment and does not allow remote commands to be executed.
- In addition shell access to shell.sourceforge.net now requires creation of a
shell before it can be accessed.
+ In addition shell access to <<<shell.sourceforge.net>>> now requires the
creation of a shell before it can be
+ accessed.
- Both of these mean that if you attempt to deploy without following these
steps you will get an error.
+ Both of these mean that if you attempt to deploy your site without following
these steps you will get an error.
-Quick Start
+* Quick Start
- * Create a shell to shell.sourceforge.net with your username and project
group.
+ * Create a shell on <<<shell.sourceforge.net>>> with your username and
project group
---
ssh -t <username>,<project name>@shell.sf.net create
---
- * Use <<<shell.sourceforge.net>>> (instead of web.sourceforge.net) in you
site url.
+ * Use <<<shell.sourceforge.net>>> (instead of <<<web.sourceforge.net>>>) in
you site URL
---
...
@@ -38,19 +40,18 @@
</distributionManagement>
---
- * run <<<mvn site:deploy>>>.
+ * Run <<<mvn site:deploy>>>
- * verify you have a working web site.
-
- Open a browser to http://your_project.sf.net
+ * Verify that you have a working web site by opening a browser to
<<<http://your_project.sf.net>>>
[]
-Detailed Instructions with Examples
+* Detailed Instructions with Examples
- The following examples will use the <<<qifcon>>> project and the user
<<<barrie>>> as detailed examples.
+ The following examples will use the <<<qifcon>>> project and the user
<<<barrie>>>.
+ Substitute these with your own project name and user name.
-* Create a shell to shell.sourceforge.net with your username and project group.
+** Create a shell on <<<shell.sourceforge.net>>> with your username and
project group
+---+
$ ssh -t barrie,qif...@shell.sf.net create
@@ -67,9 +68,9 @@
-bash-3.2$
+---+
-* Use <<<shell.sourceforge.net>>> (instead of web.sourceforge.net) in you site
url.
+** Use <<<shell.sourceforge.net>>> (instead of <<<web.sourceforge.net>>>) in
you site URL
- In the projects <<<pom.xml>>>:
+ In the project's <<<pom.xml>>>:
+---+
...
@@ -80,9 +81,10 @@
<url>scp://shell.sourceforge.net/home/groups/q/qi/qifcon/htdocs</url>
</site>
</distributionManagement>
+ ...
+---+
-* run <<<mvn site:deploy>>>.
+** Run <<<mvn site:deploy>>>
+---+
C:\ide\Finance\qifcon\site>mvn site:deploy
@@ -115,26 +117,26 @@
[INFO] ------------------------------------------------------------------------
+---+
-* verify you have a working web site.
+** Verify you have a working web site
- Open a browser to http://qifcon.sf.net
+ Open a browser to <<<http://qifcon.sf.net>>>.
-Trouble Shooting
+* Troubleshooting
-* Trying to deploy to web.sourceforge.net
+** Trying to deploy to <<<web.sourceforge.net>>>
- The accepted methods for deploying to web.sourceforge.net are: SFTP, SCP,
rsync over SSH.
+ The accepted methods for deploying to <<<web.sourceforge.net>>> are: SFTP,
SCP, rsync over SSH.
- This will mean that the zipped archive created by wagon can be uploaded but
the commands
- wagon uses to create directories, unzip and chmod files will fail silently.
+ This will mean that the zipped archive created by Wagon can be uploaded, but
the commands
+ that Wagon uses to create directories, unzip and chmod files will fail
silently.
- There are two types of failures.
+ There are two types of failures:
[[1]] No such file or directory
This will occur if you are deploying into a subdirectory that does not yet
exist.
- The cause is the mkdir command has failed silently.
+ The cause is that the <<<mkdir>>> command has failed silently.
An example of this error:
@@ -169,10 +171,10 @@
[INFO] ------------------------------------------------------------------------
+---+
- [[2]] Unable to unzip the wagon.zip file
+ [[2]] Unable to unzip the zip file created by Wagon
- If the directory exists then the wagon.zip file can be uploaded
site:deploy will appear to
- succeed but the web site will not work since the wagon.zip can not be
unzipped.
+ If the directory exists then the Wagon zip file can be uploaded and
<<<site:deploy>>> will appear to
+ succeed, but the web site will not work since the Wagon zip file can not
be unzipped.
+---+
C:\ide\Finance\qifcon\site>mvn site:deploy
@@ -207,9 +209,9 @@
[]
-* No shell created error
+** No shell created error
- If you try to run ssh without first creating a shell you will get the
following error:
+ If you try to run <<<ssh>>> without first creating a shell you will get the
following error:
+---+
$ ssh barrie,qif...@shell.sf.net
@@ -228,4 +230,4 @@
ssh -t USER,proj...@shell.sourceforge.net create
Connection to shell.sf.net closed.
-+---+
\ No newline at end of file
++---+
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
Sun Mar 8 13:54:54 2009
@@ -4,8 +4,9 @@
Vincent Siveton
<vincent.sive...@gmail.com>
Maria Odea Ching
+ Dennis Lundberg
------
- 2008-09-07
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -40,17 +41,21 @@
<<<navigation.xml>>> file has been replaced by the site descriptor in Maven
2.
The format is nearly the same, so you can probably reuse most of your old
file.
- There is also an
+ There is an
{{{http://maven.apache.org/doxia/doxia-sitetools-1.0.x/doxia-decoration-model/decoration.html}XML
Schema Reference for the site descriptor}}
available.
The XML Schema for the site descriptor is published at
{{http://maven.apache.org/xsd/decoration-1.0.0.xsd}}.
+ Have a look at the
+
{{{http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/site/site.xml}site
descriptor for Maven Site Plugin}}
+ for a real life example.
+
* Title
The title of each generated page will be a combination of the <site title>
and the title of the current page. By default the Site Plugin will use the
- value of <<<$\{project.name\}>>> from your <<<pom.xml>>> file as the
+ value of the <<<\<name\>>>> element from your <<<pom.xml>>> file as the
site title. The complete title for this page is "Maven Site Plugin -
Configuring
the Site Descriptor".
@@ -74,7 +79,7 @@
+-----+
<project>
...
- <publishDate format="yyyy-MM-dd" position="right"/>
+ <publishDate position="right"/>
...
</project>
+-----+
@@ -92,9 +97,14 @@
</project>
+-----+
+ The format of the "Last Published" date is the ISO date format that is
+ {{{http://www.w3.org/QA/Tips/iso-date}recommended by the W3C}}. Because the
+ web has an international, cross-cultural audience it is recommended to <not>
+ change the date format.
+
* Version
- You can show the "Version" of your project on the site, by addding a
<<<\<version\>>>> element to your
+ You can show the "Version" of your project on the site, by adding a
<<<\<version\>>>> element to your
<<<site.xml>>> like this:
+-----+
@@ -145,7 +155,7 @@
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 in the menu it will be
placed after inheritance. For example:
+ be either <<<top>>> or <<<bottom>>>, indicating where the inherited menu
will be placed. For example:
+-----+
<project>
@@ -198,7 +208,7 @@
* Skinning
Skins can be created to customize the look and feel of a site in a
consistent way. For more information on creating a
- skin, see {{{creatingskins.html}Creating a Skin}}. To reference a skin in
your project, you use the <<<skin>>>
+ skin, see {{{creatingskins.html}Creating a Skin}}. To use a specific skin in
your project, you use the <<<skin>>>
element of the site descriptor. This is a regular artifact or
dependency-like element. For example, to use the
{{{http://maven.apache.org/skins/maven-classic-skin/}Maven Classic Skin}},
you would include:
@@ -214,11 +224,16 @@
</project>
+-----+
- <<Note:>> The <<<\<version\>>>> element is optional and, like plugins, if
omitted the latest version available will be used.
+ <<Note:>> The <<<\<version\>>>> element is optional and, like plugins, if
+ omitted the latest version available will be used. It is recommended that you
+ always specify a version so that your site is reproducible over time.
This skin will copy the necessary resources including CSS and if necessary
use the included alternate Velocity
template to render the site.
+ If you don't specify a skin, the Site Plugin will use
+ {{{http://maven.apache.org/skins/maven-default-skin/}Maven Default Skin}}.
+
* Expressions
The <<<site.xml>>> can contain some expressions, like
<<<$\{project.name\}>>>.
@@ -235,6 +250,6 @@
[]
<<Note:>> Support for some expressions, like <<<$\{project.name\}>>> is
present in
- version 2.0-beta-5 of this plugin. Full support is only available since
version
+ version 2.0-beta-5 of this plugin. Full support is available since version
2.0-beta-6.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt
(original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt Sun
Mar 8 13:54:54 2009
@@ -3,7 +3,7 @@
------
Maria Odea Ching
------
- July 2006
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,13 +26,13 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-
+
Configuring Site Run
For the <<<{{{run-mojo.html}site:run}}>>> goal, you can configure which port
to use to start up the site as well as the directory where
the pages for the site will be rendered.
- For example, you have the following configuration in your POM:
+ For example, you can have the following configuration in your POM:
+-----+
<project>
@@ -40,12 +40,13 @@
<build>
<plugins>
<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-site-plugin</artifactId>
- <configuration>
- <port>9000</port>
-
<tempWebappDirectory>${basedir}/target/site/tempdir</tempWebappDirectory>
- </configuration>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>2.0</version>
+ <configuration>
+ <port>9000</port>
+
<tempWebappDirectory>${basedir}/target/site/tempdir</tempWebappDirectory>
+ </configuration>
</plugin>
</plugins>
</build>
@@ -55,4 +56,4 @@
When you execute "<<<mvn site:run>>>", you will see in the command line that
the Jetty server is started at port 9000.
To access the site, type <<<http://localhost:9000>>> in your browser. You
will also see that the dummy web application is
- generated in the <<<$\{basedir\}/target/site/tempdir>>> directory as
specified in the <<<tempWebappDirectory>>> parameter.
+ generated in the <<<$\{basedir\}/target/site/tempdir>>> directory as
specified by the <<<tempWebappDirectory>>> parameter.
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt
Sun Mar 8 13:54:54 2009
@@ -5,7 +5,7 @@
<vincent.sive...@gmail.com>
Maria Odea Ching
------
- July 2006
+ 2009-03-08
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -50,7 +50,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
- <version>2.0-beta-5</version>
+ <version>2.0</version>
<configuration>
<templateFile>${basedir}/maven-site.vm</templateFile>
</configuration>
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/index.apt Sun Mar 8
13:54:54 2009
@@ -83,15 +83,19 @@
The following examples show how to use the Site Plugin in more advanced
usecases:
- * {{{examples/sitedescriptor.html}Configuring the Site Descriptor}}
+ * {{{examples/creating-content.html}Creating Content}}
- * {{{examples/templatefile.html}Changing the Template File}}
+ * {{{examples/sitedescriptor.html}Configuring the Site Descriptor}}
- * {{{examples/moduleexcludes.html}Excluding Modules}}
+ * {{{examples/configuring-reports.html}Configuring Reports}}
* {{{examples/siterun.html}Configuring Site Run}}
- * {{{examples/creatingskins.html}Creating a Skin for the Maven Site Plugin}}
+ * {{{examples/templatefile.html}Changing the Template File}}
+
+ * {{{examples/creatingskins.html}Creating Skins}}
+
+ * {{{examples/moduleexcludes.html}Excluding Document Formats}}
* {{{examples/site-deploy-to-sourceforge.net.html}Deploying to
sourceforge.net}}
Modified: maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/usage.apt Sun Mar 8
13:54:54 2009
@@ -52,7 +52,7 @@
<<Note:>> If you have a multi module project, then the links between the
parent and child modules will <not> work when you use '<<<mvn site>>>' or
'<<<mvn site:site>>>'. If you want to use those links, you should use
- '<<<mvn site:stage>>>' instead. You read more about that goal further down on
+ '<<<mvn site:stage>>>' instead. You can read more about that goal further
down on
this page in the section called '<Staging a Site>'.
* Deploying a Site
@@ -81,12 +81,12 @@
The <<<\<url\>>>> gives the location to deploy to. Currently, the <<<scp>>>
and <<<file>>> protocols are supported. In the example above we copy to the
- host <<<www.mycompany.com>>> in the path <<</www/docs/project/>>>. If
+ host <<<www.mycompany.com>>> using the path <<</www/docs/project/>>>. If
subprojects inherit the site URL from a parent POM, they will automatically
append their <<<\<artifactId\>>>> to form their effective deployment
location.
Now you can execute the <<<{{{deploy-mojo.html}site:deploy}}>>> goal from
- your project.
+ your project directory.
<<Note:>> A site must be generated first before executing <<<site:deploy>>>.
@@ -131,6 +131,12 @@
-DstagingSiteURL=scp://www.mycompany.com/www/project/
+-----+
+ <<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
+ of Maven you use. The current 2.0.x releases of Maven use a version where
+ this bug is still present.
+
* Running a Site
The Site Plugin can also be used to start up the site in Jetty. To do this,
Modified: maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/fml/faq.fml Sun Mar 8
13:54:54 2009
@@ -114,7 +114,7 @@
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-module-twiki</artifactId>
- <version>1.0-alpha-11</version>
+ <version>1.0</version>
</dependency>
</dependencies>
</plugin>
Modified: maven/plugins/trunk/maven-site-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/site.xml?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/site.xml Sun Mar 8 13:54:54
2009
@@ -19,7 +19,9 @@
under the License.
-->
-<project>
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0";
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0
http://maven.apache.org/xsd/decoration-1.0.0.xsd";>
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
@@ -28,7 +30,7 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Configuration">
- <item name="Internationalization" href="i18n.html"/>
+ <item name="Internationalization" href="i18n.html"/>
</menu>
<menu name="Examples">
@@ -38,8 +40,8 @@
<item name="Configuring Site Run" href="/examples/siterun.html"/>
<item name="Changing the Template File"
href="/examples/templatefile.html"/>
<item name="Creating Skins" href="/examples/creatingskins.html"/>
- <item name="Excluding Modules" href="/examples/moduleexcludes.html"/>
- <item name="Deploy to sourceforge.net"
href="/examples/site-deploy-to-sourceforge.net.html"/>
+ <item name="Excluding Document Formats"
href="/examples/moduleexcludes.html"/>
+ <item name="Deploying to sourceforge.net"
href="/examples/site-deploy-to-sourceforge.net.html"/>
</menu>
</body>
</project>
Modified: maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml?rev=751423&r1=751422&r2=751423&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml (original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/xdoc/i18n.xml Sun Mar 8
13:54:54 2009
@@ -34,7 +34,7 @@
that is needed is to download a couple of properties files and start
translating the texts in them. If you want to provide a patch for an
unsupported language, there are
- <a href="#Instructions for Translators">detailed instructions</a>
below.
+ <a href="#Instructions_for_Translators">detailed instructions</a>
below.
</p>
<p>
@@ -56,7 +56,7 @@
<th>Languages available</th>
<th>Site Plugin</th>
<th>Project Info Reports Plugin</th>
- <th>Doxia Tools</th>
+ <th>Maven Doxia Tools</th>
</tr>
<tr>
<td>Brazilian Portuguese</td>
@@ -83,7 +83,7 @@
</td>
</tr>
<tr>
- <td>Chinese simplified</td>
+ <td>Chinese (China)</td>
<td>
<a
href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_zh_CN.properties";>See</a>
</td>
@@ -95,6 +95,18 @@
</td>
</tr>
<tr>
+ <td>Chinese (Taiwan)</td>
+ <td>
+ <a
href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_zh_TW.properties";>See</a>
+ </td>
+ <td>
+ <a
href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-report_zh_TW.properties";>See</a>
+ </td>
+ <td>
+ <a
href="http://svn.apache.org/repos/asf/maven/shared/trunk/maven-doxia-tools/src/main/resources/site-tool_zh_TW.properties";>See</a>
+ </td>
+ </tr>
+ <tr>
<td>Czech</td>
<td>
<a
href="http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin/src/main/resources/site-plugin_cs.properties";>See</a>
@@ -324,14 +336,14 @@
<li>
Rename the files to the wanted locale. For example,
<code>site-plugin_de.properties</code> for a new German
- translation for the Maven Site Plugin.
+ translation for Maven Site Plugin.
</li>
<li>
Translate the files contents using your preferred text editor.
The files must use US-ASCII encoding. For characters that are not
included in US-ASCII you must use Unicode escapes, like "\u8ff0".
See the tools section below for examples of tools that can help
- you to convert your texts to use Unicode escapes.
+ you to convert your texts to use Unicode escapes.
</li>
<li>
To test your localization
@@ -339,13 +351,13 @@
<li>Checkout the latest source for
<a href="source-repository.html">Site Plugin</a>,
<a
href="http://maven.apache.org/plugins/maven-project-info-reports-plugin/source-repository.html";>Project
Info Reports Plugin</a> and
- <a
href="http://maven.apache.org/shared/maven-doxia-tools/source-repository.html";>Doxia
Tools</a></li>
+ <a
href="http://maven.apache.org/shared/maven-doxia-tools/source-repository.html";>Maven
Doxia Tools</a></li>
<li>Include your files in <code>src/main/resources</code> for
each one</li>
<li>Run "<code>mvn install</code>" for each one</li>
<li>Configure a project to produce a site in several
locales</li>
<li>Make sure that it is using the latest SNAPSHOT version of
each of the above artifacts</li>
- <li>Run "<code>mvn site</code>" on that project to test it</li>
+ <li>Run "<code>mvn site</code>" on that project and test
it</li>
</ul>
</li>
<li>
@@ -360,7 +372,7 @@
<subsection name="References and Tools">
<p>
Please refer to the
- <a target="_blank"
href="http://java.sun.com/j2se/corejava/intl/index.jsp";>
+ <a target="_blank"
href="http://java.sun.com/javase/technologies/core/basic/intl/";>
Java Internationalization home page</a> for an introduction to the
topic.
</p>
