maven-linkcheck-plugin/src/site/apt/usage.apt.vm

 ------
 Usage
 ------
 Vincent Siveton
 ------
 2009-07-31
 ------

~~ 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

Usage

  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 POM like other Maven reporting plugins, i.e.:

+-----+
<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-linkcheck-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          ...
        </configuration>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>
+-----+

 Here is a simple report:

[./images/sample.png] Sample report

* Running It As A Maven Plugin

  The Linkcheck Plugin can be put into a project's <<<pom.xml>>> as follows:

+-----+
<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-linkcheck-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          ...
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>
+-----+

  In this case, no report will be created, but the linkcheck files
  will be created in the <<<target/linkcheck>>> directory.

* Real life configuration

  If you want to see a real life configuration you can have a look at
  {{{http://svn.apache.org/repos/asf/maven/site/trunk/pom.xml}the POM for the Maven site}}.
  There is a profile near the end called <linkcheck>.