经常问的问题

一般的

  1. mvn site和mvn site:site有什么区别？
  2. 如何将静态 (X)HTML 页面集成到我的 Maven 站点中？
  3. 如何包含自定义 Doxia 模块，例如 Twiki？
  4. 如何验证我的 xdoc/fml 源文件？
  5. 站点插件如何使用 POM 中的 <url> 元素？

具体问题

  1. 为什么我的绝对链接会被翻译成相对链接？
  2. 为什么我运行“”时父模块和子模块之间的链接不起作用mvn site？
  3. 我可以在 xdoc/fml 源文件中使用实体吗？

一般的

mvn site和mvn site:site有什么区别？
mvn网站
使用关联阶段（即站点前、站点、站点后、站点部署） 调用站点生命周期。请参阅生命周期参考。
mvn 站点：站点
从站点插件调用站点目标。请参阅站点：站点。
[最佳]
如何将静态 (X)HTML 页面集成到我的 Maven 站点中？

您可以按照以下步骤集成静态页面：

  • 将您的静态页面放在资源目录中，${basedir}/src/site/resources
  • 创建site.xml并放入${basedir}/src/site
  • 通过修改菜单部分链接到静态页面，创建项目并将它们映射到静态页面的文件名
[最佳]
如何包含自定义 Doxia 模块，例如 Twiki？

该站点插件处理开箱即用的 apt、xdoc 和 fml 格式。如果你想使用像 Twiki 这样的自定义格式，你需要指定 Doxia Twiki 依赖，即： 

<project>
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <dependencies>
          <dependency>
            <groupId>org.apache.maven.doxia</groupId>
            <artifactId>doxia-module-twiki</artifactId>
            <version>1.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
  ...
</project>

[最佳]
如何验证我的 xdoc/fml 源文件？

从站点插件的 2.1.1 版本开始，有一个validate 配置参数可以打开 xml 验证（默认为关闭）。请注意，在 Doxia 使用的解析器的当前实现中，验证需要独立的解析运行，因此在打开验证时每个源文件实际上都会被解析两次。

如果启用验证，所有xml 源文件都需要正确的模式和/或 DTD 定义。请参阅有关 验证 xdocs的 Doxia 文档，以及xdoc 和 fml的模式定义 。

[最佳]
站点插件如何使用 POM 中的 <url> 元素？

站点插件使用 POM 中的 <url> 元素为生成的站点创建相对链接。如果您的项目有一个用于部署生成站点的 URL，则将该 URL 放入 <url> 元素中。如果项目的站点未部署在任何地方，则从 POM 中删除 <url> 元素。

在多模块构建中，父模块和子模块具有不同的URL 很重要。如果它们具有相同的 URL，则组合站点中的链接将不起作用。

[最佳]

具体问题

为什么我的绝对链接会被翻译成相对链接？

发生这种情况是因为站点插件会在可能的情况下尝试使所有 URL 相对。如果您在以下内容中定义了类似的内容 pom.xml： 

<url>http://www.your.site.com/</url>
site.xml并在您的（只是一个示例） 中创建链接，如下所示：
<links>
  <item name="Your Site" href="http://www.your.site.com/"/>
  <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links>
您将看到“您的站点”的链接将是一个相对链接，但“Maven 2”的链接将是一个绝对链接。

JIRA 中有一个 问题，您可以在其中阅读更多相关信息。

[最佳]
为什么我运行“”时父模块和子模块之间的链接不起作用mvn site？

mvn site在多项目构建中， “ ”将为您做的mvn site就是为父级及其所有模块单独运行“” 。父子之间的链接在 这里不起作用。但是，当您部署站点时， 它们将起作用。

如果您想在部署之前对此进行测试，您可以 按照使用文档site:stage中的描述运行目标 。

[最佳]
我可以在 xdoc/fml 源文件中使用实体吗？

是的。Doxia 1.1 版中添加了实体解析，可在站点插件 2.1 及更高版本中使用。

但是有一个问题。在当前实现中（从 site-plugin-2.1.1 开始），实体仅由独立的 验证运行解决。因此，如果您想使用实体，您必须为您的 xml 源文件打开验证。见MSITE-483。

[最佳]