15.4. 站点目录结构

Maven将所有的站点文档放在src/site目录下。同格式的文档则被放在其子目录下。所有的APT文档应该放到src/site/apt下,所有的FML文档应该被放到src/site/fml下,所有的XDoc文档应该被放到src/site/xdoc下。站点描述符是文件src/site/site.xml,所有的资源应该存储在src/site/resources。Maven Site插件构建web站点的时候,它会从资源目录复制所有文件至站点的根目录。如果你存储了一个文件src/site/resources/images/test.png,那么你就能够在你的站点文档中使用相对路径images/test.png引用该图片。

下面的例子展示了一些文件的位置,包含了APT, FML, HTML, XHTML, 和XDoc。注意XHTML内容直接存放在src/site/resources目录。architecture.html文件不会被Doxia处理,它会被直接复制到输出目录,如果你想要包含不被处理的HTML内容,你可以使用这种方式,而不使用Doxia和Maven Site插件的模板和格式化功能。

sample-project
+- src/
   +- site/
      +- apt/
      |  +- index.apt
      |  +- about.apt
      |  |
      |  +- developer/
      |     +- embedding.apt
      |
      +- fml/
      |  +- faq.fml
      |
      +- resources/
      |  +- images/
      |  |  +- banner-left.png
      |  |  +- banner-right.png
      |  |
      |  +- architecture.html
      |  +- jira-roadmap-export-2007-03-26.html
      |
      +- xdoc/
      |  +- xml-example.xml
      |
      +- site.xml

注意开发者文档存储在src/site/apt/developer/embedding.aptapt目录下的子目录会被反映到站点中最终HTML页面的相对位置上。在Site插件渲染目录src/site/apt内容的时候,它会对应的在站点根目录生成HTML输出。如果一个文件在apt目录中,它对应就会生成到web站点的根目录中。如果一个文件在apt/developer目录中,它就会被生成到web站点的developer/目录下。