包括从一个apt到另一个apt的文本

时间:2013-03-19 10:07:31

标签: java maven documentation-generation apt doxia

想象一下,我有三个apt文件:

main.apt

Info, details, etc..

    some text

Configuration

    some text

child1.apt

Info, details, etc..

    some text

Configuration

    [Same text as MAIN.APT configuration]

child2.apt

Info, details, etc..

    some text

Configuration

    [Same text as MAIN.APT configuration]

我想遵循DRY(不要重复自己)原则并重用main.apt中的文本并将其添加到child1.apt和child2.apt。这真的有助于编写文档。

我尝试过使用代码段(首先使用id's生成网站文档,然后添加对这些内容的引用):

~~START SNIPPET: id
~~END SNIPPET: id
%{snippet|id=id|url=http://svn.example.com/path/to/main.html}

使用

生成网站
     mvn site:stage

,但这不起作用,因为它插入了html文本块,而不是格式化为html。我也尝试了片段中的verbatim参数,它没有帮助。

也许某人有解决此问题的方法和/或遇到同样的问题?请告诉我你的故事,建议。解决方案可以节省我的一天:)

1 个答案:

答案 0 :(得分:0)

使用Velocity。将child1.apt和child2.apt分别重命名为child1.apt.vm和child2.apt.vm。然后替换

[Same text as MAIN.APT configuration]

#parse("main.apt")

site.xml 中包含与其他子页面类似的子页面:

<item name="child 1" href="child1.html"/>