如何让我的自定义 Maven 报告插件出现在生成站点的项目报告下？

Question

我编写了一个新的 maven 报告插件，它在站点生成并生成和输出 html 文件时执行。

如何让网站的项目报告部分包含指向它的链接？

Answer 1

作为一种解决方法，您可以在自定义 site.xml 中手动重新定义项目报告部分：

    <!-- Inherit this menu for sub modules. -->
    <menu name="Module Documentation" inherit="top" >
        <item name="Overview" href="index.html" >
        </item>

        <item name="Information" href="project-info.html" >
            <item name="Dependencies" href="dependencies.html" />
            <item name="Project Plugins" href="plugins.html" />
            <item name="Project Summmary" href="project-summary.html" />
            ...
        </item>

        <item name="Reports" href="project-reports.html" >
            <item name="Checkstyle" href="checkstyle.html" />
            <item name="Your Report" href="your-report.html" />
            ...
        </item>
    </menu>

缺点是：

• 您必须指定每个报告。
• 您还必须提供 project-reports.html（例如通过 project-reports.apt），您将丢失自动生成的包含所有报告的概览页面。
• 如果某些模块不包含所有报告，您必须提供单独的 site.xml 文件，以便它们覆盖父 site.xml。

请参阅站点插件文档中的Configuring the Site Descriptor。