1

我想使用 Maven 站点插件生成项目文档。“项目信息”和“项目报告”的默认布局、结构和功能对我来说是可以的。但是我想添加一个额外的（第三个）部分“附加文档”，如果项目中有这样的文档，它会链接到更多的文档。

我可以创建一个目录 src/site/resources/otherDocu，然后文件将根据需要复制到该 target/site/otherDocu 目录中。但是，生成的站点不会链接到它们。

我想要第三部分“附加文档”，其中列出并链接了上述目录中的文件。我想用尽可能小的开销来做到这一点。具体来说，如果可以避免，我不想像site.xml许多解决方案中描述的那样包含自己的，以及 css 等。如何使用默认站点配置并仅“注入”一部分？或者，如果这是唯一的方法，那么应该可以site.xml在父 POM 中只配置一次文件（比如 ）并为所有其他项目继承它。我怎样才能让它列出找到的文件src/site/resources/otherDocu并显示它们的链接？

或者，我也在考虑：我可以编写一个自己的报告插件，它可以做到这一点，然后我只需要在 POM 的“报告/插件”部分指定这个插件，就像我为其他报告插件所做的那样. 使用此解决方案，我可能可以在“项目报告”部分创建一个附加条目，就像其他所有报告插件一样，这是朝着正确方向迈出的一步。但是我需要几个条目（因为有几个链接的文档），或者一个带有子条目的条目“附加文档”。

哪条路更容易走？您有推荐或类似的解决方案吗？有没有人有一个文件（site.xml或类似文件）已经做了一些列表，不需要所有其他资源（图像等）并且可以继承？

4

2 回答 2

2

这就是我所做的......相对简单：

源代码/站点/site.xml：

<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="${project.name}">
    <body>
        <menu name="Menu Title">
            <item name="Documentation" href="docs.html"/>
        </menu>
    </body>
</project>

上面创建了一个到 docs.html 页面的链接。然后使用 apt（或其他可能的语言）创建文档页面

src/site/apt/docs.apt：

    -------------
    Documentation
    -------------

Documentation

    Some text {{{/path/to/doc}document}}.

如果您不想创建单独的页面，您可以只在 site.xml 中插入指向文档的链接。

于 2015-01-06T17:25:54.867 回答
1

保持默认行为的第一件事是在站点描述符中使用某些内容：

  <body>
     <menu ref="reports"/>
     <menu ref="modules"/>
  </body>

您用来自动将文件复制到目标的东西被认为是资源，您可以在 docs 中阅读。

此外，要自动创建文档，您需要通过报告插件进行操作。

于 2015-01-07T08:57:33.747 回答