导航链接

• 介绍

  简介是插件文档的首页。这是放置任何需要强调的部分和页面的好地方。也建议将生成的插件参数配置链接到这里。下面是推荐的src/site/apt/index.apt模板

   ------
   Introduction
   ------
   Author
   ------
   YYYY-MM-DD
   ------
  
  
  Plugin Name
  
    Plugin introduction, description, and other relevant information.
  
  * Goals Overview
  
    General information about the goals.
  
    * {{{<goal>.html}prefix:goal}} short description for this plugin goal.
  
  * Usage
  
    General instructions on how to use the Plugin Name 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/Plugin+Name}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 {{{mailing-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 {{{mailing-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-management.html}issue management system}}. 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
    {{{scm.html}source repository}} and will find supplementary information in the
    {{{/guides/development/guide-helping.html}guide to helping with Maven}}. 
  
  * Examples
  
    To provide you with better understanding of some usages of the Plugin Name,
    you can take a look into the following examples:
  
    * {{{./examples/example-one.html}Example Description One}}
  
    * {{{./examples/example-two.html}Example Description Two}}
   

• 目标

  plugin-info.html由 Maven Plugin Plugin 生成。在 Maven 站点插件更新之前，最好将其拉出到主菜单以获得更大的可见性。这包含目标及其描述以及配置参数的链接。该信息基于插件的注释和注释。

• 用法（以前称为 Howto）

  使用页面描述了插件目标的基本用例，其中包括示例 POM 配置和目标如何工作的解释。

• 常问问题

  一个有据可查的项目总是整理常见问题，这些问题通常位于src/site/fml/faq.fml. 以下示例为您的常见问题解答提供了模板：

  <?xml version="1.0" encoding="UTF-8"?>
  <faqs id="FAQ" title="Frequently Asked Questions">
    <part id="General">
      <faq id="question">
        <question>Question?</question>
        <answer>
          <p>
            Answer
          </p>
        </answer>
      </faq>
    </part>
  </faqs>

• 例子

  使用页面中未涵盖的高级配置和示例位于此处。想要最大限度地使用插件的高级用户可以在这里查看项目。关于如何有效使用插件的提示也是一个好东西放在这里。

  有关“示例”下的项目示例，请查看以下插件站点：

  • Maven Javadoc 插件示例
  • Maven 战争插件示例