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 2010/07/27 13:21:37 UTC
svn commit: r979643 - in
/maven/plugins/trunk/maven-linkcheck-plugin/src/site: apt/index.apt
apt/usage.apt.vm fml/faq.fml site.xml
Author: dennisl
Date: Tue Jul 27 11:21:36 2010
New Revision: 979643
URL: http://svn.apache.org/viewvc?rev=979643&view=rev
Log:
o Polish the site
Modified:
maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/index.apt
maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/usage.apt.vm
maven/plugins/trunk/maven-linkcheck-plugin/src/site/fml/faq.fml
maven/plugins/trunk/maven-linkcheck-plugin/src/site/site.xml
Modified: maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/index.apt?rev=979643&r1=979642&r2=979643&view=diff
==============================================================================
--- maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/index.apt Tue Jul 27 11:21:36 2010
@@ -28,33 +28,31 @@
Maven Linkcheck Plugin
- This plug-in allows you to generate a linkcheck report of your project's documentation using the
+ This plug-in allows you to generate a Linkcheck report of your project's documentation using the
{{{http://maven.apache.org/doxia/doxia-tools/doxia-linkcheck/}Doxia Linkcheck Tool}}.
* Goals Overview
- The Linkcheck Plugin only has two goals.
+ The Linkcheck Plugin only has one goal.
* {{{./linkcheck-mojo.html}linkcheck:linkcheck}} Generates a Linkcheck report.
- * {{{./clean-mojo.html}linkcheck:clean}} Delete Linkcheck files.
-
* Usage
- General instructions on how to use the Linkcheck Plugin can be found on the {{{usage.html}usage page}}.
+ General instructions on how to use the Linkcheck Plugin can be found on the {{{./usage.html}usage page}}.
Last but not least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/Linkcheck+Plugin}plugin's wiki page}}.
In case you still have questions regarding the plugin's usage, please feel
- free to contact the {{{mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
+ 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}}.
Modified: maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/usage.apt.vm?rev=979643&r1=979642&r2=979643&view=diff
==============================================================================
--- maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/plugins/trunk/maven-linkcheck-plugin/src/site/apt/usage.apt.vm Tue Jul 27 11:21:36 2010
@@ -26,14 +26,14 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Using The Linkcheck Plugin
+Usage
- The Maven Linkcheck Plugin allows you to generate a link check report of your documentation generated by the
+ The Maven Linkcheck Plugin allows you to generate a Linkcheck report of your documentation generated by the
{{{http://maven.apache.org/plugins/maven-site-plugin}Maven Site Plugin}}.
* Running It As A Maven Report
- You need to configure the reporting section in your project like other Maven plugins report, i.e.:
+ You need to configure the reporting section in your POM like other Maven reporting plugins, i.e.:
+-----+
<project>
@@ -60,7 +60,7 @@ Using The Linkcheck Plugin
* Running It As A Maven Plugin
- The Linkcheck Plugin can be put into a project's pom.xml as the following:
+ The Linkcheck Plugin can be put into a project's <<<pom.xml>>> as follows:
+-----+
<project>
@@ -81,7 +81,7 @@ Using The Linkcheck Plugin
</project>
+-----+
- <<Note 1>>: In this case, no report will be created, only linkcheck files in <<<target/linkcheck>>> dir
+ <<Note 1>>: In this case, no report will be created, only linkcheck files in the <<<target/linkcheck>>> directory
by default.
<<Note 2>>: The execution configuration is inadvisable, i.e. you can't use it in a specific phase.
Modified: maven/plugins/trunk/maven-linkcheck-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-linkcheck-plugin/src/site/fml/faq.fml?rev=979643&r1=979642&r2=979643&view=diff
==============================================================================
--- maven/plugins/trunk/maven-linkcheck-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-linkcheck-plugin/src/site/fml/faq.fml Tue Jul 27 11:21:36 2010
@@ -20,17 +20,17 @@ under the License.
-->
-<faqs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns="http://maven.apache.org/FML/1.0"
- xsi:schemaLocation="http://maven.apache.org/FML/1.0 http://maven.apache.org/xsd/fml-1.0.xsd"
+<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="Why the plugin invokes the site goal">
- <question>Why the plugin invokes the site goal?</question>
+ <faq id="Why does the plugin invoke the site goal">
+ <question>Why does the plugin invoke the site goal?</question>
<answer>
<p>
- By safety, the plugin generates the site goal in a separate space to be sure that the number of
- documents analyzed are the same than the generated documents.
+ The plugin executes the site goal in a separate space to make sure that the number of
+ documents analyzed are the same as the generated documents.
</p>
</answer>
</faq>
Modified: maven/plugins/trunk/maven-linkcheck-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-linkcheck-plugin/src/site/site.xml?rev=979643&r1=979642&r2=979643&view=diff
==============================================================================
--- maven/plugins/trunk/maven-linkcheck-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-linkcheck-plugin/src/site/site.xml Tue Jul 27 11:21:36 2010
@@ -29,10 +29,9 @@ under the License.
<menu name="Overview">
<item name="Introduction" href="index.html"/>
- <item name="Goals" href="linkcheck-mojo.html"/>
+ <item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<item name="FAQ" href="faq.html"/>
</menu>
-
</body>
</project>