首页 » Maven实战 » Maven实战全文在线阅读

《Maven实战》15.5 创建自定义页面

关灯直达底部

15.4节介绍了如何自定义站点导航菜单并链接至特定的html页面,本节介绍如何创建自定义的站点页面。到目前为止,Maven支持得比较好的两种文档格式为APT和FML。

APT(Almost Plain Text)是一种类似于维基的文档格式,用户可以用它来快速地创建简单而又结构丰富的文档。例如,创建一个对应于15.4.4节提到的introduction.html的APT文档,首先要记住的是:所有APT文档必须位于src/site/apt/目录。这里创建文件introduction.apt,内容见代码清单15-11。

代码清单15-11 创建APT文档

代码清单15-11的第一部分是标题,它们必须缩进,且用多个连字号相隔。在接下来的内容中,“What is Maven?”和“Core Maven Concepts”没有缩进,它们是一级小节。“What is Maven?”下面的内容有缩进,表示一个段落。未缩进的且以星号开头的部分表示二级小节,因此上述代码中有Coordinate and Dependency、Repository和Plugin and Lifecycle 3个二级小节,它们都包含了一些段落,其中Repository下面有包含三个项的列表,它们用缩进的星号表示。

上述代码展示了如何编写一个简单的APT文档。笔者没有详细介绍所有APT文档格式的语法,如果读者有需要,可以参考http://maven.apache.org/doxia/references/apt-format.html。

上述APT文档展现后的效果如图15-16所示。

图15-16 APT文档效果

FML(FAQ Markup Language)是一种用来创建FAQ(Frequently Asked Questions,常见问题解答)页面的XML文档格式,下面创建一个对应于15.4.4节提到的faq.html页面的FML文档。就像APT文档需要放到src/site/apt/目录一样,FML文档需要放到src/site/fml/目录。在这里创建文件faq.fml,如代码清单15-12所示。

代码清单15-12 创建FML文档

上述XML文档的根元素为faqs,该元素的title属性定义了文档的标题。根元素下面使用part元素定义了两个文档部分,第一个是install,第二个是run。每个文档部分有自己的标题,以及用faq元素定义的问题项目,faq的子元素question用来定义问题,子元素answer用来定义答案,这种结构是非常清晰的。同样地,这里不会详细解释所有的FML文档语法,如果有需要,可以访问http://maven.apache.org/doxia/references/fml-format.html。

上述FML文档展现后的效果如图15-17所示。

图15-17 FML文档效果

到目前为止,站点的目录结构如下: