《Maven官方指南》创建一个站点

原文链接

创建一个站点

创建内容

第一步,创建你的站点的内容。在Maven中,站点内容划分是有格式的,有这几个可用的:

+- src/
   +- site/
      +- apt/
      |  +- index.apt
      !
      +- markdown/
      |  +- index.md
      |
      +- xdoc/
      |  +- other.xml
      |
      +- fml/
      |  +- general.fml
      |  +- faq.fml
      |
      +- site.xml

你现在会注意到 ${basedir}/src/site 目录里包含着站点描述符,里面有各种各样的目录支持文档类型。让我们看看网站描述符和例子中各种文件类型。

APT格式中,“大多纯文本”,像维基格式一样允许你写简单的,结构化的文档并很快。一个APT 格式的参考是可以使用的。

FML格式是FAQ的格式。

其他格式是可用的,但是这三点的是最好的测试。也有几种可能的输出格式,但截至2,只有XHTML是可用的。

记录上面所有是可选的——一个索引文件是需要在输入树种的其中一个。每一个路径将合并一起从网站的根目录开始。

自定义外观

如果你想调整一下你网站的外观,你可以使用自定义的皮肤提供自己的CSS样式。如果这还不够的话,你可以稍微调整一下输出的Maven生成的站点文档模板。你可以浏览一下皮肤站看看一些皮肤并使用来改变你自己的网站外观。

生成网站

生成网站是很简单和很快的!

mvn site

通过默认,这个结果将在 target/site/…

为了更多Maven Site Pluhin信息,请看插件参考

发布网站

为了可以发布网站,你必须首先声明一个位置描述在你的pom.xml,与发布到仓库类似。

<project>
  ...
  <distributionManagement>
    <site>
      <id>website</id>
      <url>scp://www.mycompany.com/www/docs/project/</url>
    </site>
  </distributionManagement>
  ...
</project>

<id>元素定义在仓库中,所以你能与固定认证在你的setting.xml,使用<server>元素正如你设置任何一个仓库。

==<url>==元素给予地址为了发布。目前,只支持SSH,拷贝host www.mycompany.com在目录/www/docs/project .如果子项目继承网络位置的父级POM,他们讲自动追加他们的 <artifactId> 来自有效的发布路径。

发布站点是通过站点部署阶段生命周期而发布的。

mvn site-deploy

创建站点描述符

site.xml文件被使用做描述站点目录布局,和代替 Maven 1.x中使用的 navigation.xml

样品如下:

<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven">
  <bannerLeft>
    <name>Maven</name>
    <src>http://maven.apache.org/images/apache-maven-project.png</src>
    <href>http://maven.apache.org/</href>
  </bannerLeft>
  <bannerRight>
    <src>http://maven.apache.org/images/maven-small.gif</src>
  </bannerRight>
  <body>
    <links>
      <item name="Apache" href="http://www.apache.org/" />
      <item name="Maven 1.x" href="http://maven.apache.org/maven-1.x/"/>
      <item name="Maven 2" href="http://maven.apache.org/"/>
    </links>

    <menu name="Maven 2.0">
      <item name="Introduction" href="index.html"/>
      <item name="Download" href="download.html"/>
      <item name="Release Notes" href="release-notes.html" />
      <item name="General Information" href="about.html"/>
      <item name="For Maven 1.x Users" href="maven1.html"/>
      <item name="Road Map" href="roadmap.html" />
    </menu>

    <menu ref="reports"/>

    ...
  </body>
</project>

笔记:上面的==<menu ref=”reports”/>==元素。当构建站点时,这将被替换为带有已配置的所有报表的链接的菜单。

添加额外资源

你可以添加任何资源到你站点通过resource目录下。额外的CSS文件将被拾起时,他们被放置在resource目录内的css目录。

+- src/
   +- site/
      +- resources/
         +- css/
         |  +- site.css
         |
         +- images/
            +- pic1.jpg

site.css文件将被加入到默认的XHTML输出,所以它可以被调整默认Maven样式表如果被希望的话。

pic1.jpg是可用的通过从你站点的任意目录的相对引用images目录。

配置报表

Maven已经有几个报表了,你已经加入你的站点并显示项目当前的状态。这些报表来自插件,用于构建项目。

这有很多标准的报表,可以从POM中获取信息。当前,默认提供了这些:

  • 依赖报表
  • 邮件列表
  • 持续集成
  • 源码仓库
  • 版本跟踪
  • 项目团队
  • 许可证

为了找到更多请参考报表插件

为了加入这些报表到你的站点,你必须在POM中加入插件来指定==<reporting>==部分。通过下面的例子展示怎么配置标准项目信息报表和从POM中获取并友好格式显示信息:

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.8</version>
      </plugin>
    </plugins>
  </reporting>
  ...
</project>

如果你有包含适当的==<menu ref=”reports”/>标签在你的site.xml==描述符中,当你再次生成站点将会出现在菜单。

笔记 很多报表插件提供一个参数叫做outputDirectory 来指定输出的目的地。这参数只能是确切的,启动命令行调用如果报表插件启动了一个。相反,当报表生成了一部分的站点,Maven Site Plugin 的配置决定了有效输出目录来确定所有报表最后在一个中心路径。

国际化

国际化在Maven中很简单,正如这些报表你已经在使用了并特别语种定义的。为了支持多语言的概述和指令怎么加入更多语言,请看这个文章从Maven Site Plugin看国际化

为了可以多种语种,在你的POM加入配置类似的:

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>3.4</version>
        <configuration>
          <locales>en,fr</locales>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>

这将生产英语和翻译版本的站点。如果en是你当前语种,那么它将站点生成在根目录,而拷贝法语的翻译生成在==/fr==子目录。

若要为该翻译添加自己的内容,而不是使用默认值,请在站点目录中放置具有该区域名称的子目录,并在文件名中创建具有该名称的区域的新站点描述符。例如:

+- src/
   +- site/
      +- apt/
      |  +- index.apt     (Default version)
      |
      +- fr/
      |  +- apt/
      |     +- index.apt  (French version)
      |
      +- site.xml         (Default site descriptor)
      +- site_fr.xml      (French site descriptor)
+- src/
   +- site/
      +- apt/
      |  +- index.apt     (Default version)
      |
      +- fr/
      |  +- apt/
      |     +- index.apt  (French version)
      |
      +- site.xml         (Default site descriptor)
      +- site_fr.xml      (French site descriptor)

原创文章,转载请注明: 转载自并发编程网 – ifeve.com本文链接地址: 《Maven官方指南》创建一个站点

魔术师Carvendy

魔术师Carvendy

尘世间一小小Javaer , 还没吃饱呢。
魔术师Carvendy

Latest posts by 魔术师Carvendy (see all)

FavoriteLoading添加本文到我的收藏
  • Trackback 关闭
  • 评论 (0)
  1. 暂无评论

您必须 登陆 后才能发表评论

return top