Question

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

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

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

或者，我也在考虑：我可以编写一个自己的报告插件，这样做，然后我只需要在＆＃34; reporting / plugins＆＃34;中指定这个插件。 POM中的部分，就像我为其他报告插件所做的那样。有了这个解决方案，我可以在＆＃34;项目报告＆＃34;中创建一个额外的条目。与所有其他报告插件一样，这是朝着正确方向迈出的一步。但我需要几个条目（因为有几个链接文件），或者一个条目＆＃34;附加文件＆＃34;与子条目。

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

Answer 1

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

的src /站点/ 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>

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

创建文档页面

的src /站点/公寓/ docs.apt：

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

Documentation

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

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

Answer 2

保持默认行为的第一件事是使用something in your site descriptor:

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

您使用自动将文件复制到目标的内容是resources as you can read in the docs。

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

Maven站点文档：添加指向其他文档的链接

2 个答案: