o updated documentation
git-svn-id: https://svn.apache.org/repos/asf/maven/plugins/trunk@799842 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index d3d745f..de447c6 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- January 2008
+ 2009-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -28,7 +28,8 @@
Maven Linkcheck Plugin
- This plug-in allows you to generate a linkcheck report of your project's documentation.
+ 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
diff --git a/src/site/apt/limitations.apt b/src/site/apt/limitations.apt
deleted file mode 100644
index 61b5335..0000000
--- a/src/site/apt/limitations.apt
+++ /dev/null
@@ -1,37 +0,0 @@
- ------
- Known Bugs and Limitations
- ------
- Vincent Siveton
- ------
- 24 September 2007
- ------
-
-~~ Licensed to the Apache Software Foundation (ASF) under one
-~~ or more contributor license agreements. See the NOTICE file
-~~ distributed with this work for additional information
-~~ regarding copyright ownership. The ASF licenses this file
-~~ to you under the Apache License, Version 2.0 (the
-~~ "License"); you may not use this file except in compliance
-~~ with the License. You may obtain a copy of the License at
-~~
-~~ http://www.apache.org/licenses/LICENSE-2.0
-~~
-~~ Unless required by applicable law or agreed to in writing,
-~~ software distributed under the License is distributed on an
-~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-~~ KIND, either express or implied. See the License for the
-~~ specific language governing permissions and limitations
-~~ under the License.
-
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
-
-Known Bugs and Limitations
-
- Just a brief selection...
-
-* Current limitations
-
- * The Linkcheck report should run in the post-site phase.
-
- * Running the Linkcheck plugin automatically during a build doesn't work.
\ No newline at end of file
diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt
index c4220bd..0e5dbe0 100644
--- a/src/site/apt/usage.apt
+++ b/src/site/apt/usage.apt
@@ -3,7 +3,7 @@
------
Vincent Siveton
------
- 24 September 2007
+ 2009-07-31
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -26,70 +26,60 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Using the Linkcheck plugin
+Using The Linkcheck Plugin
- The Maven Linkcheck Plugin allows you generate a link check report of your documentation.
+ The Maven Linkcheck Plugin allows you to generate a link check report of your documentation generated by the
+ {{{http://maven.apache.org/plugins/maven-site-plugin}Maven Site Plugin}}.
-* Using the Linkcheck plugin from the command-line
+* Running It As A Maven Report
- The Linkcheck plugin can be called to execute from the command-line without any
- additional configurations. Like the other plugins, to run the Linkcheck plugin,
- you use:
+ You need to configure the reporting section in your project like other Maven plugins report, i.e.:
-+-----
++-----+
<project>
- [...]
+ ...
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-linkcheck-plugin</artifactId>
- <version>1.0</version>
+ <configuration>
+ ...
+ </configuration>
</plugin>
</plugins>
</reporting>
- [...]
+ ...
</project>
-+-----
-
- The Linkcheck plugin needs to call the <<<site>>> phase twice:
-
-+-----
- mvn site (to generate the site phase, i.e. the documentation)
- mvn site (to analyze the result of the generated documentation)
-+-----
++-----+
Here is a simple report:
[./images/sample.png] Sample report
-~~
-~~ * Running the Linkcheck plugin automatically during a build
-~~
-~~ The Linkcheck plugin can be put into a project's pom.xml so that it gets executed
-~~ everytime the project is built. Below is a sample pom.xml for running the
-~~ Linkcheck plugin in the <<<post-site>>> phase everytime the project is built:
-~~
-~~ +-----
-~~ <project>
-~~ [...]
-~~ <build>
-~~ <plugins>
-~~ <plugin>
-~~ <artifactId>maven-linkcheck-plugin</artifactId>
-~~ <version>1.0</version>
-~~ <executions>
-~~ <execution>
-~~ <id>site-linkcheck</id>
-~~ <phase>post-site</phase>
-~~ <goals>
-~~ <goal>linkcheck</goal>
-~~ </goals>
-~~ </execution>
-~~ </executions>
-~~ </plugin>
-~~ </plugins>
-~~ </build>
-~~ [...]
-~~ </project>
-~~ +-----
\ No newline at end of file
+* Running It As A Maven Plugin
+
+ The Linkcheck Plugin can be put into a project's pom.xml as the following:
+
++-----+
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-linkcheck-plugin</artifactId>
+ <configuration>
+ ...
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
++-----+
+
+ <<Note 1>>: In this case, no report will be created, only linkcheck files in <<<target/linkcheck>>> dir
+ by default.
+
+ <<Note 2>>: The execution configuration is inadvisable, i.e. you can't use it in a specific phase.
diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
new file mode 100644
index 0000000..af3a031
--- /dev/null
+++ b/src/site/fml/faq.fml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+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"
+ 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>
+ <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.
+ </p>
+ </answer>
+ </faq>
+ </part>
+</faqs>
\ No newline at end of file
diff --git a/src/site/resources/images/sample.png b/src/site/resources/images/sample.png
index 5d1cfba..0b044e7 100644
--- a/src/site/resources/images/sample.png
+++ b/src/site/resources/images/sample.png
Binary files differ
diff --git a/src/site/site.xml b/src/site/site.xml
index 962281e..5a213ef 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -19,15 +19,19 @@
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>
+ <links>
+ <item name="Linkcheck Tool" href="http://maven.apache.org/doxia/doxia-tools/doxia-linkcheck/"/>
+ </links>
<menu name="Overview">
<item name="Introduction" href="index.html"/>
<item name="Goals" href="linkcheck-mojo.html"/>
<item name="Usage" href="usage.html"/>
- <item name="Limitations" href="limitations.html"/>
+ <item name="FAQ" href="faq.html"/>
</menu>
</body>
