You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2009/08/07 23:27:54 UTC
svn commit: r802205 - in /maven/plugins/trunk/maven-help-plugin/src/site:
apt/index.apt apt/usage.apt fml/faq.fml site.xml
Author: vsiveton
Date: Fri Aug 7 21:27:39 2009
New Revision: 802205
URL: http://svn.apache.org/viewvc?rev=802205&view=rev
Log:
o fixed ambiguous links
o added Doxia xsd
Modified:
maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-help-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt?rev=802205&r1=802204&r2=802205&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/index.apt Fri Aug 7 21:27:39 2009
@@ -38,46 +38,46 @@
The Help plugin has 8 goals:
- * {{{active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
+ * {{{./active-profiles-mojo.html}help:active-profiles}} lists the profiles which are currently active for the build.
- * {{{all-profiles-mojo.html}help:all-profiles}} lists the available profiles under the current project.
+ * {{{./all-profiles-mojo.html}help:all-profiles}} lists the available profiles under the current project.
- * {{{describe-mojo.html}help:describe}} describes the attributes of a Plugin and/or a Mojo (Maven plain Old Java
+ * {{{./describe-mojo.html}help:describe}} describes the attributes of a Plugin and/or a Mojo (Maven plain Old Java
Object).
- * {{{effective-pom-mojo.html}help:effective-pom}} displays the effective POM as an XML for the current build, with
+ * {{{./effective-pom-mojo.html}help:effective-pom}} displays the effective POM as an XML for the current build, with
the active profiles factored in.
- * {{{effective-settings-mojo.html}help:effective-settings}} displays the calculated settings as an XML for the
+ * {{{./effective-settings-mojo.html}help:effective-settings}} displays the calculated settings as an XML for the
project, given any profile enhancement and the inheritance of the global settings into the user-level settings.
- * {{{evaluate-mojo.html}help:evaluate}} evaluates Maven expressions given by the user in an interactive mode.
+ * {{{./evaluate-mojo.html}help:evaluate}} evaluates Maven expressions given by the user in an interactive mode.
- * {{{expressions-mojo.html}help:expressions}} displays the supported Plugin expressions used by Maven.
+ * {{{./expressions-mojo.html}help:expressions}} displays the supported Plugin expressions used by Maven.
- * {{{system-mojo.html}help:system}} displays a list of the platform details like system properties and environment
+ * {{{./system-mojo.html}help:system}} displays a list of the platform details like system properties and environment
variables.
[]
* Usage
- General instructions on how to use the Help Plugin can be found on the {{{usage.html}usage page}}. Some more
+ General instructions on how to use the Help 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/Help+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
@@ -85,6 +85,6 @@
To provide you with better understanding on some usages of the Help plugin, you can take a look into the
following example(s):
- * {{{examples/describe-configuration.html}Configuring Describe Goal}}
+ * {{{./examples/describe-configuration.html}Configuring Describe Goal}}
[]
Modified: maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt?rev=802205&r1=802204&r2=802205&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/apt/usage.apt Fri Aug 7 21:27:39 2009
@@ -34,7 +34,7 @@
* The <<<help:active-profiles>>> Goal
- The <<<{{{active-profiles-mojo.html}active-profiles}}>>> goal is used to discover which profiles have been
+ The <<<{{{./active-profiles-mojo.html}active-profiles}}>>> goal is used to discover which profiles have been
applied to the projects currently being built. For each project in the build session, it will output a list of
profiles which have been applied to that project, along with the source of the profile (POM, <<<settings.xml>>>
or <<<profiles.xml>>>).
@@ -49,7 +49,7 @@
* The <<<help:all-profiles>>> Goal
- The <<<{{{all-profiles-mojo.html}all-profiles}}>>> goal is used to discover all available profiles under the
+ The <<<{{{./all-profiles-mojo.html}all-profiles}}>>> goal is used to discover all available profiles under the
current project.
You can execute this goal using the following command:
@@ -62,7 +62,7 @@
* The <<<help:describe>>> Goal
- The <<<{{{describe-mojo.html}describe}}>>> goal is used to discover information about Maven plugins. Given either
+ The <<<{{{./describe-mojo.html}describe}}>>> goal is used to discover information about Maven plugins. Given either
a <<<plugin>>> or a <<<groupId>>>, an <<<artifactId>>> and optionally a <<<version>>>, the mojo will lookup that
plugin and output details about it. If the user also specifies which <<<mojo>>> to describe, the <<<describe>>>
mojo will limit output to the details of that mojo, including parameters.
@@ -80,7 +80,7 @@
* The <<<help:effective-pom>>> Goal
- The <<<{{{effective-pom-mojo.html}effective-pom}}>>> goal is used to make visible the POM that results from the
+ The <<<{{{./effective-pom-mojo.html}effective-pom}}>>> goal is used to make visible the POM that results from the
application of interpolation, inheritance and active profiles. It provides a useful way of removing the guesswork
about just what ends up in the POM that Maven uses to build your project. It will iterate over all projects in the
current build session, printing the effective POM for each.
@@ -95,7 +95,7 @@
* The <<<help:effective-settings>>> Goal
- The <<<{{{effective-settings-mojo.html}effective-settings}}>>> goal is used to view the settings that Maven
+ The <<<{{{./effective-settings-mojo.html}effective-settings}}>>> goal is used to view the settings that Maven
actually uses to run the build. These settings are a result of merging the global file with the user's file,
with the user's file taking precedence.
@@ -109,7 +109,7 @@
* The <<<help:system>>> Goal
- The <<<{{{system-mojo.html}system}}>>> goal is used to view the system informations like system properties and
+ The <<<{{{./system-mojo.html}system}}>>> goal is used to view the system informations like system properties and
environment variables.
You can execute this goal using the following command:
@@ -123,7 +123,7 @@
* The <<<expressions>>> Goal
When you develop a new Maven Plugin, you could need to use some expressions given by Maven. To list them, just call
- the {{{expressions-mojo.html}expressions}} goal:
+ the {{{./expressions-mojo.html}expressions}} goal:
+-----+
# mvn help:expressions
@@ -153,7 +153,7 @@
* The <<<help:evaluate>>> Goal
You could use this interactive goal to evaluate some Maven expressions. To do it, just call the
- {{{evaluate-mojo.html}help:evaluate}} goal:
+ {{{./evaluate-mojo.html}help:evaluate}} goal:
+-----+
# mvn help:evaluate -Dartifact=org.apache.maven.plugins:maven-help-plugin
Modified: maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml?rev=802205&r1=802204&r2=802205&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/fml/faq.fml Fri Aug 7 21:27:39 2009
@@ -19,7 +19,11 @@
under the License.
-->
-<faqs id="FAQ" title="Frequently Asked Questions">
+
+<faqs xmlns="http://maven.apache.org/FML/1.0.1"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd"
+ id="FAQ" title="Frequently Asked Questions">
<part id="General">
<faq id="What is a Mojo">
<question>What is a Mojo</question>
Modified: maven/plugins/trunk/maven-help-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-help-plugin/src/site/site.xml?rev=802205&r1=802204&r2=802205&view=diff
==============================================================================
--- maven/plugins/trunk/maven-help-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-help-plugin/src/site/site.xml Fri Aug 7 21:27:39 2009
@@ -19,7 +19,10 @@
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"
+ name="Maven Help plugin">
<body>
<menu name="Overview">
<item name="Introduction" href="index.html"/>