Author: vsiveton
Date: Wed Aug 5 12:23:17 2009
New Revision: 801171
URL: http://svn.apache.org/viewvc?rev=801171&view=rev
Log:
o fixed ambiguous links
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.vm
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/sitedescriptor.apt
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt.vm
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt.vm
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
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=801171&r1=801170&r2=801171&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
Wed Aug 5 12:23:17 2009
@@ -77,7 +77,7 @@
-------------------
If you have included the appropriate <<<\<menu ref="reports"/\>>>> tag in
your
- {{{sitedescriptor.html}site descriptor}}, then when you regenerate the site
+ {{{./sitedescriptor.html}site descriptor}}, then when you regenerate the site
those items will appear in a menu called "Project Reports".
<<Note:>> Many report plugins provide a parameter called
<<<outputDirectory>>>
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm?rev=801171&r1=801170&r2=801171&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/creating-content.apt.vm
Wed Aug 5 12:23:17 2009
@@ -96,7 +96,7 @@
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}}.
+ {{{./sitedescriptor.html}the site descriptor documentation}}.
* Adding Extra Resources
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=801171&r1=801170&r2=801171&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
Wed Aug 5 12:23:17 2009
@@ -208,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 use a specific 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:
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt.vm?rev=801171&r1=801170&r2=801171&view=diff
==============================================================================
--- maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt.vm
(original)
+++ maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/siterun.apt.vm
Wed Aug 5 12:23:17 2009
@@ -29,7 +29,7 @@
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
+ 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 can have the following configuration in your POM:
Modified:
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt.vm
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt.vm?rev=801171&r1=801170&r2=801171&view=diff
==============================================================================
---
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt.vm
(original)
+++
maven/plugins/trunk/maven-site-plugin/src/site/apt/examples/templatefile.apt.vm
Wed Aug 5 12:23:17 2009
@@ -37,7 +37,7 @@
<<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
- this as a {{{creatingskins.html}skin}} instead.
+ this as a {{{./creatingskins.html}skin}} instead.
For version 2.0-beta-5 and later you would add something like this to your
<<<pom.xml>>>:
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=801171&r1=801170&r2=801171&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 Wed Aug 5
12:23:17 2009
@@ -36,66 +36,66 @@
The Site Plugin has seven goals:
- * {{{site-mojo.html}site:site}} is used generate a site for a single
project.
+ * {{{./site-mojo.html}site:site}} is used generate a site for a single
project.
Note that links between module sites in a multi module build will <<not>>
work.
- * {{{deploy-mojo.html}site:deploy}} is used to deploy the generated site
using <<<scp>>> or <<<file>>> protocol to
+ * {{{./deploy-mojo.html}site:deploy}} is used to deploy the generated site
using <<<scp>>> or <<<file>>> protocol to
the site URL specified in the <<<\<distributionManagement\>>>> section of
the POM.
- * {{{run-mojo.html}site:run}} starts the site up, rendering documents as
requested for faster editing. It uses Jetty
+ * {{{./run-mojo.html}site:run}} starts the site up, rendering documents as
requested for faster editing. It uses Jetty
as the web server.
- * {{{stage-mojo.html}site:stage}} generates a site in a local staging or
mock directory based on the site URL
+ * {{{./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. It
can be used
to test that links between module sites in a multi module build works.
- * {{{stage-deploy-mojo.html}site:stage-deploy}} deploys the generated site
to a staging or mock directory to the site
+ * {{{./stage-deploy-mojo.html}site:stage-deploy}} deploys the generated
site to a staging or mock directory to the site
URL specified in the <<<\<distributionManagement\>>>> section of the POM.
It supports <<<scp>>> and <<<file>>>
protocols for deployment.
- * {{{attach-descriptor-mojo.html}site:attach-descriptor}} adds the site
descriptor (<<<site.xml>>>) to the list of
+ * {{{./attach-descriptor-mojo.html}site:attach-descriptor}} adds the site
descriptor (<<<site.xml>>>) to the list of
files to be installed/deployed. For more references of the site
descriptor,
- {{{examples/sitedescriptor.html}here's a link}}.
+ {{{./examples/sitedescriptor.html}here's a link}}.
- * {{{jar-mojo.html}site:jar}} bundles the site output into a JAR so that it
can be deployed to a repository.
+ * {{{./jar-mojo.html}site:jar}} bundles the site output into a JAR so that
it can be deployed to a repository.
* Usage
- General instructions on how to use the Site Plugin can be found on the
{{{usage.html}usage page}}. Some more
+ General instructions on how to use the Site Plugin can be found on the
{{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not
least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Site+Plugin}plugin's wiki
page}}.
- In case you still have questions regarding the plugin's usage, please have a
look at the {{{faq.html}FAQ}} and feel
- free to contact the {{{mail-lists.html}user mailing list}}. The posts to the
mailing list are archived and could
+ In case you still have questions regarding the plugin's usage, please have a
look at the {{{./faq.html}FAQ}} and feel
+ free to contact the {{{./mail-lists.html}user mailing list}}. The posts to
the mailing list are archived and could
already contain the answer to your question as part of an older thread.
Hence, it is also worth browsing/searching
- the {{{mail-lists.html}mail archive}}.
+ the {{{./mail-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can
fill a feature request or bug report in our
- {{{issue-tracking.html}issue tracker}}. When creating a new issue, please
provide a comprehensive description of your
+ {{{./issue-tracking.html}issue tracker}}. When creating a new issue, please
provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can
reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to
the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project
from our
- {{{source-repository.html}source repository}} and will find supplementary
information in the
+ {{{./source-repository.html}source repository}} and will find supplementary
information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to
helping with Maven}}.
* Examples
The following examples show how to use the Site Plugin in more advanced
usecases:
- * {{{examples/creating-content.html}Creating Content}}
+ * {{{./examples/creating-content.html}Creating Content}}
- * {{{examples/sitedescriptor.html}Configuring the Site Descriptor}}
+ * {{{./examples/sitedescriptor.html}Configuring the Site Descriptor}}
- * {{{examples/configuring-reports.html}Configuring Reports}}
+ * {{{./examples/configuring-reports.html}Configuring Reports}}
- * {{{examples/siterun.html}Configuring Site Run}}
+ * {{{./examples/siterun.html}Configuring Site Run}}
- * {{{examples/templatefile.html}Changing the Template File}}
+ * {{{./examples/templatefile.html}Changing the Template File}}
- * {{{examples/creatingskins.html}Creating Skins}}
+ * {{{./examples/creatingskins.html}Creating Skins}}
- * {{{examples/moduleexcludes.html}Excluding Document Formats}}
+ * {{{./examples/moduleexcludes.html}Excluding Document Formats}}
- * {{{examples/site-deploy-to-sourceforge.net.html}Deploying to
sourceforge.net}}
+ * {{{./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=801171&r1=801170&r2=801171&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 Wed Aug 5
12:23:17 2009
@@ -32,11 +32,11 @@
Usage
You can put additional content (e.g. documentation, resources, etc.) in your
- site. See {{{examples/creating-content.html}Creating Content}} for more
+ site. See {{{./examples/creating-content.html}Creating Content}} for more
information on this. If you want to change the menus, breadcrumbs, links or
logos on your pages you need to add and configure a
- {{{examples/sitedescriptor.html}site descriptor}}. If you like, you also can
- let Maven generate some {{{examples/configuring-reports.html}reports}} for
you,
+ {{{./examples/sitedescriptor.html}site descriptor}}. If you like, you also can
+ let Maven generate some {{{./examples/configuring-reports.html}reports}} for
you,
based on the contents of your POM.
* Generating a Site
@@ -93,7 +93,7 @@
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
+ Now you can execute the <<<{{{./deploy-mojo.html}site:deploy}}>>> goal from
your project directory.
<<Note:>> A site must be generated first before executing <<<site:deploy>>>.
@@ -117,7 +117,7 @@
a specific directory. It will use the <<<\<distributionManagement\>>>>
element or the project hierarchy to link the
project and its modules.
- Just execute the <<<{{{stage-mojo.html}site:stage}}>>> goal from your project
+ Just execute the <<<{{{./stage-mojo.html}site:stage}}>>> goal from your
project
with the <<<stagingDirectory>>> parameter as shown below:
+-----+
@@ -126,7 +126,7 @@
<<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
+ 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
id <<<stagingSite>>> for deployment. So if you need to add your username or
password in <<<settings.xml>>>, you should use <<<\<id\>stagingSite\</id\>>>>
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=801171&r1=801170&r2=801171&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 Wed Aug 5
12:23:17 2009
@@ -85,8 +85,8 @@
</p>
<p>
If you want to test this, prior to deployment, you can run the
- <a href="stage-mojo.html"><code>site:stage</code></a> goal as
- described in the <a href="usage.html">usage documentation</a>
+ <a href="./stage-mojo.html"><code>site:stage</code></a> goal as
+ described in the <a href="./usage.html">usage documentation</a>
instead.
</p>
</answer>
