You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2008/03/22 23:54:46 UTC
svn commit: r640115 - in /maven/plugins/trunk/maven-site-plugin: ./
src/site/apt/ src/site/apt/examples/ src/site/fml/ src/site/xdoc/
Author: dennisl
Date: Sat Mar 22 15:54:43 2008
New Revision: 640115
URL: http://svn.apache.org/viewvc?rev=640115&view=rev
Log:
[MSITE-281] Employ consistent typesetting/formatting
Submitted by: Benjamin Bentmann
Reviewed by: Dennis Lundberg
Modified:
maven/plugins/trunk/maven-site-plugin/pom.xml
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/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/xdoc/i18n.xml
Modified: maven/plugins/trunk/maven-site-plugin/pom.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/pom.xml?rev=640115&r1=640114&r2=640115&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/pom.xml (original)
+++ maven/plugins/trunk/maven-site-plugin/pom.xml Sat Mar 22 15:54:43 2008
@@ -30,7 +30,7 @@
<artifactId>maven-site-plugin</artifactId>
<version>2.0-beta-7-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
- <name>Maven Site plugin</name>
+ <name>Maven Site Plugin</name>
<description>
The Maven Site Plugin is a plugin that generates a site for the current project.
</description>
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -33,9 +33,9 @@
A Maven 2 site 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.
@@ -56,7 +56,7 @@
you copy an existing skin's <<<maven-theme.css>>> file and modify it to suit
your needs.
-* Customizing the HTML output with a Velocity template
+* Customizing the HTML Output with a Velocity Template
<<Details on the Velocity template variables and use should be included>>.
@@ -66,7 +66,7 @@
to <<<src/main/resources/META-INF/maven/site.vm>>> in your project and then
modify it to your needs.
-* Examples of existing skins
+* Examples of Existing Skins
A list of links to skins that can be used as inspiration can be found on
{{{http://docs.codehaus.org/display/MAVENUSER/Maven+Skins}the wiki}}.
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -31,7 +31,7 @@
To exclude specific modules from the site to be generated, you can use the <<<excludeModules>>> parameter.
- For example, you have the following site content in your pom
+ For example, you have the following site content in your POM
+-----+
Module1
@@ -45,8 +45,8 @@
`-- 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 the whole fml module from the site to be generated, you need to set the following in your POM
+ then execute "<<<mvn site>>>".
+-----+
<project>
@@ -66,4 +66,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 generated with the site.
\ 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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -38,14 +38,14 @@
* 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
+ 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
- "Site title". The title for this page is <"Maven Site plugin - Configuring
- the Site Descriptor">.
+ site title. The complete title for this page is "Maven Site Plugin - Configuring
+ the Site Descriptor".
- If you want to use a different "Site title", but don't want to change the
- <<<\<name\>>>> in your <<<pom.xml>>>, you can configure this in your
+ If you want to use a different site title, but do not want to change the
+ <<<\<name\>>>> element in your <<<pom.xml>>>, you can configure this in your
<<<site.xml>>>, like this:
+-----+
@@ -82,7 +82,7 @@
</project>
+-----+
-* Powered by logo
+* "Powered by" Logo
You can add your own "Powered by" logo to your site.
To do this, you add a <<<\<poweredBy\>>>> element in your <<<site.xml>>> like
@@ -157,14 +157,14 @@
<<Note:>> The old syntax using <<<$\{reports\}>>>, <<<$\{parent\}>>> and
<<<$\{modules\}>>> has been deprecated and you are encouraged to use the new
syntax instead. The support for the old syntax will be removed in a future
- version of maven-site-plugin.
+ version of the Site Plugin.
* Skinning
- Skins can be created to customise the look and feel of a site in a consistent way. For more information on creating a
+ 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>>>
- element of the site descriptor. This is a regular artifact or dependency-like element. For example, to use the Classic
- Maven skin, you'd include:
+ 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:
+-----+
<project>
@@ -178,7 +178,7 @@
</project>
+-----+
- <<Note:>> The <<<\<version\>>>> 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.
This skin will copy the necessary resources including CSS and if necessary use the included alternate Velocity
template to render the site.
@@ -198,7 +198,7 @@
[]
- <<Note:>> Support for some expressions, like <<<$\{project.name\}>>> are present in
- version 2.0-beta-5 of this plugin. Full support will be available in version
+ <<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
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -29,10 +29,10 @@
Configuring Site Run
- For the <<<site:run>>> goal, you can configure which port to use to start up the site as well as the directory where
+ 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.
- Example, you have the following configuration in your pom:
+ For example, you have the following configuration in your POM:
+-----+
<project>
@@ -53,6 +53,6 @@
</project>
+-----+
- 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.
+ 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.
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -33,7 +33,7 @@
It is possible to change the Velocity template used for creating the site.
Save your custom template in a directory of your choice and configure the
- site plugin accordingly.
+ Site Plugin accordingly.
<<Note:>> If you use this method then skins and the default templates, CSS
and images are disabled. It is therefor highly recommended that you package
@@ -88,9 +88,9 @@
mvn site
+-----+
- If you don't want to start from scratch you can start with the
+ If you do not want to start from scratch you can start with the
{{{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 template}}
- that is used by the site plugin.
+ that is used by the Site Plugin.
For more information about Velocity, see
{{{http://velocity.apache.org/}http://velocity.apache.org/}}.
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -29,32 +29,32 @@
Maven 2 Site Plugin
- The Maven 2 Site plugin is used to generate a site for the project. The generated site also includes the project's reports
+ The Maven 2 Site Plugin is used to generate a site for the project. The generated site also includes the project's reports
that were configured in the <<<\<reporting\>>>> section of the pom.
* Goals Overview
The Site Plugin has seven goals:
+ * {{{site-mojo.html}site:site}} is used generate a site for the project.
+
* {{{deploy-mojo.html}site:deploy}} is used to deploy the generated site using <<<scp>>> or <<<file>>> protocol to the site
specified in the <<<\<distributionManagement\>>>> section of the pom.
- * {{{attach-descriptor-mojo.html}site:attach-descriptor}} adds the site descriptor to the list of files to be
- installed/deployed. For more references of the site descriptor,
- {{{examples/sitedescriptor.html}here's a link}}.
-
- * {{{site-jar.html}site:jar}} is used to bundle the site output into a jar.
-
- * {{{site-mojo.html}site:site}} is used generate a site for the project.
-
* {{{run-mojo.html}site:run}} starts the site up, rendering documents as requested for faster editing. It uses Jetty
as the webapp server.
+ * {{{stage-mojo.html}site:stage}} generates a site in a local staging or mock directory based on the site url specified
+ in the <<<\<distributionManagement\>>>> section of the pom.
+
* {{{stage-deploy-mojo.html}site:stage-deploy}} deploys the generated site in a staging or mock directory on the site
specified in the <<<\<distributionManagement\>>>> section of the pom. It also supports <<<scp>>> and <<<file>>> protocol for deployment.
- * {{{stage-mojo.html}site:stage}} generates a site in a local staging or mock directory based on the site url specified
- in the <<<\<distributionManagement\>>>> section of the pom.
+ * {{{attach-descriptor-mojo.html}site:attach-descriptor}} adds the site descriptor to the list of files to be
+ installed/deployed. For more references of the site descriptor,
+ {{{examples/sitedescriptor.html}here's a link}}.
+
+ * {{{site-jar.html}site:jar}} is used to bundle the site output into a jar.
* Usage
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -49,7 +49,7 @@
The <<<{{{deploy-mojo.html}site:deploy}}>>> goal supports the <<<scp>>> and
<<<file>>> protocols. To deploy the generated site, you first need to specify
where the site will be deployed. This can be set in the
- <<<\<distributionManagement\>>>> section of the pom as shown below.
+ <<<\<distributionManagement\>>>> section of the POM as shown below.
+-----+
<project>
@@ -83,7 +83,7 @@
* Staging a Site
- <<Note:>> This goal is available in version 2.0-beta-5 or later of the site plugin.
+ <<Note:>> This goal is available in version 2.0-beta-5 or later of the Site Plugin.
To review/test the generated web site before an official deploy, you can stage the site in
a specific directory. It will use the <<<\<distributionManagement\>>>> element or the project hierarchy to link the
@@ -96,7 +96,7 @@
mvn site:stage -DstagingDirectory=C:\fullsite
+-----+
- <<Note:>> <<<stagingDirectory>>> can not be dynamic, i.e. <<<stagingDirectory=$\{basedir\}\fullsite>>>
+ <<Note:>> <<<stagingDirectory>>> cannot be dynamic, i.e. <<<stagingDirectory=$\{basedir\}\fullsite>>>
To stage a site and to deploy it, just execute the <<<{{{stage-deploy-mojo.html}site:stage-deploy}}>>> goal from your project
with the required parameters. The <<<site:stage-deploy>>> goal will use the
@@ -113,20 +113,20 @@
* Running a Site
- The site plugin can also be used to start up the site in Jetty. To do this,
+ The Site Plugin can also be used to start up the site in Jetty. To do this,
execute:
+-----+
mvn site:run
+-----+
- The server will, by default, be started on http://localhost:8080/. See
+ The server will, by default, be started on <<<http://localhost:8080/>>>. See
{{{http://jetty.mortbay.org/}http://jetty.mortbay.org/}} for more information about
the Jetty server.
* Filtering
- <<Note:>> This feature is available in version 2.0-beta-6 or later of the site plugin.
+ <<Note:>> This feature is available in version 2.0-beta-6 or later of the Site Plugin.
To filter properties into any supported documentation format, add a <<<.vm>>>
extension to the filename.
@@ -137,7 +137,7 @@
property set in the
{{{http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml}POM}}.
- <<Note:>> Velocity is used to apply the filtering. Because Velocity uses a
+ <<Note:>> {{{http://velocity.apache.org/}Velocity}} is used to apply the filtering. Because Velocity uses a
dot-notation internally you can <<not>> use dots in your properties. So if
you declare a property like 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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -37,8 +37,8 @@
</p>
</answer>
</faq>
- <faq id="How do I integrate static (x)html pages into my Maven site">
- <question>How do I integrate static (x)html pages into my Maven site?</question>
+ <faq id="How do I Integrate static (X)HTML pages into my Maven site">
+ <question>How do I Integrate static (X)HTML pages into my Maven site?</question>
<answer>
<p>
You can integrate your static pages by following these steps:
@@ -54,7 +54,7 @@
<question>Why do my absolute links get translated into relative links?</question>
<answer>
<p>
- This happens because the site plugin tries to make all URLs relative,
+ This happens because the Site Plugin tries to make all URLs relative,
when possible. If you have something like this defined in your
<code>pom.xml</code>:
<source>
@@ -66,8 +66,8 @@
<item name="Your Site" href="http://www.your.site.com/"/>
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links></source>
- You will see that the link to 'Your site' will be a relative one, but
- that the link to 'Maven 2' will be an absolute link.
+ You will see that the link to "Your site" will be a relative one, but
+ that the link to "Maven 2" will be an absolute link.
</p>
<p>
There is an
@@ -76,12 +76,12 @@
</p>
</answer>
</faq>
- <faq id="Why don't the links between parent and child modules work when I run 'mvn site'?">
- <question>Why don't the links between parent and child modules work when I run 'mvn site'?</question>
+ <faq id="Why don't the links between parent and child modules work when I run "mvn site"?">
+ <question>Why don't the links between parent and child modules work when I run "<code>mvn site</code>"?</question>
<answer>
<p>
- What <code>'mvn site'</code> will do for you, in a multi-project
- build, is to run <code>'mvn site'</code> for the parent and all its
+ What "<code>mvn site</code>" will do for you, in a multi-project
+ build, is to run "<code>mvn site</code>" for the parent and all its
modules <b>individually</b>. The links between parent and child will
<b>not</b> work here. They <b>will</b> however work when you deploy
the site.
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=640115&r1=640114&r2=640115&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 Sat Mar 22 15:54:43 2008
@@ -25,11 +25,11 @@
<author email="vincent.siveton@gmail.com">Vincent Siveton</author>
</properties>
<body>
- <section name="Supported languages">
+ <section name="Supported Languages">
<p>
<ul>
<li>
- Maven-site-plugin
+ Maven Site Plugin
<br />
<table>
<tr>
@@ -178,7 +178,7 @@
<br />
</li>
<li>
- Maven-project-info-reports-plugin
+ Maven Project Info Reports Plugin
<br />
<table>
<tr>
@@ -334,12 +334,12 @@
</p>
</section>
- <section name="Unsupported languages - Patches welcome!">
- <section name="Prerequisites">
+ <section name="Unsupported Languages - Patches welcome!">
+ <subsection name="Prerequisites">
<p>
- Please refer to
+ Please refer to the
<a target="_blank" href="http://java.sun.com/j2se/corejava/intl/index.jsp">
- Java Internationalization home page</a>.
+ Java Internationalization home page</a> for an introduction to the topic.
</p>
<p>
You could find here some useful tools to help you with charset questions:
@@ -347,11 +347,11 @@
<li>
<b>Tools to know the charset of a file</b>: Unix <i>file</i> command,
<a href="http://cpdetector.sourceforge.net/">cpdetector</a>,
- <a href="http://plugins.intellij.net/plugin/?id=24">Intellij ShowEncodingPlugin</a>...
+ <a href="http://plugins.intellij.net/plugin/?id=24">IntelliJ IDEA ShowEncodingPlugin</a>, ...
</li>
<li>
<b>Tools to write a file in a given charset like UTF-8</b>: any editor like Notepad,
- Eclipse, Intellij...
+ Eclipse, IntelliJ IDEA, ...
</li>
<li>
<b>Tools to convert a file from one encoding to another encoding</b>:
@@ -364,8 +364,8 @@
<a href="http://developers.sun.com/global/technology/standards/reference/faqs/determining-file-encoding.html">
How Can I Determine the Encoding of a File?</a>.
</p>
- </section>
- <section name="Instructions for translators">
+ </subsection>
+ <subsection name="Instructions for Translators">
<p>
If your language is not currently supported and you want to contribute a translation,
follow these steps:
@@ -375,17 +375,17 @@
instance, the English file.
</li>
<li>
- Rename the file with the wanted locale. For example, site-plugin_de.properties for a
- new German translation for the Maven-site-plugin.
+ Rename the file with the wanted locale. For example, <code>site-plugin_de.properties</code> for a
+ new German translation for the Maven Site Plugin.
</li>
<li>
Translate the file contents using your preferred text editor.
<b>Make sure you save the file with UTF-8 encoding</b>.
</li>
<li>
- To test the translation, checkout the site plugin, include your file in
- <code>src/main/resources</code>, and run <code>mvn install</code>
- on the plugin, then <code>mvn site</code> on a project to test it.
+ To test the translation, checkout the Site Plugin, include your file in
+ <code>src/main/resources</code>, and run "<code>mvn install</code>"
+ on the plugin, then "<code>mvn site</code>" on a project to test it.
</li>
<li>
When happy with it, create a new issue in
@@ -397,7 +397,7 @@
<p>
You could also refer to the <a href="l10n-status.html">L10n Status report</a>.
</p>
- </section>
+ </subsection>
</section>
</body>
</document>