src/site/apt/examples/custom-report.apt.vm

 ------
 Customize the Text Reports
 ------
 Vincent Siveton
 ------
 2010-10-30
 ------

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

Customize the Text Reports

  Currently, all reports have a static renderer, only texts could be changed.

+-----------------+
<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <!-- By default -->
          <customBundle>\${project.basedir}/src/site/custom/project-info-reports.properties</customBundle>
        </configuration>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>
+-----------------+

  To change texts in the reports, you should import the default Project Info report bundles from
  {{http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/}}
  and edit them. For example, if you want to modify the Mailing Lists introduction, you should edit the <<<report.mailing-lists.intro>>> property.

  Extract of the default bundle {{{http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-project-info-reports-plugin/src/main/resources/project-info-reports.properties}project-info-reports.properties}}:

+-----------------+
report.mailing-lists.intro = These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.
+-----------------+

  Extract of a custom bundle <<<$\{project.basedir\}/src/site/custom/project-info-reports.properties>>> for the Apache Commons project:

+-----------------+

report.mailing-lists.intro = These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.\
        <p>\
            Questions related to the usage of Commons components should be posted to the\
            <a href="http://mail-archives.apache.org/mod_mbox/commons-user/" class="externalLink">User List</a>.\
            <br>\
            The <a href="http://mail-archives.apache.org/mod_mbox/commons-dev/" class="externalLink">Developer List</a>\
            is for questions and discussion related to the development of Commons components.\
            <br>\
            Please do not cross-post; developers are also subscribed to the user list.\
            Read the archives first in case your question has already been answered.\
            If not, then subscribe to the appropriate list and post your question.\
        </p>\
        <p>
            <strong>Note:</strong> please don't send patches or attachments to any of the mailing lists.\
            Patches are best handled via the <i>Issue Tracking</i> system.\
            Otherwise, please upload the file to a public server and include the URL in the mail.\
        </p>\
        <p>\
            Please read the <a href="http://www.apache.org/foundation/public-archives.html" class="externalLink">Public Forum Archive Policy</a>\
            and <a href="http://www.apache.org/dev/contrib-email-tips.html" class="externalLink">Tips for email contributors</a>.\
            <br>\
            For further information on Apache mailing lists please read\
            <a href="http://www.apache.org/foundation/mailinglists.html" class="externalLink">General mailing list information</a>\
            in particular the section entitled\
            <a href="http://www.apache.org/foundation/mailinglists.html#subscribe" class="externalLink">Subscribing and Unsubscribing</a>\
        </p>

+-----------------+

  <<Notes:>>

  [[1]] You could also use Maven properties (i.e. <<<$\{project.artifactId\}>>>) in the messages.

  [[2]] If a bundle property is not defined in your custom bundle, the default will be displayed.

  []