Doxia Apt格式的格式代码

时间:2011-09-22 14:20:32

标签: maven documentation apt doxia

我目前正在为我们的一个项目编写文档。为简单起见,我们选择使用Almost Plain Text(APT)格式,请在此处查看更多信息: http://maven.apache.org/doxia/references/apt-format.html

APT是一种很棒的文档格式,因为它使用了最小的语法,因此在不了解APT的情况下很容易创建和更改文档。

然而,我找不到一种方法来以一种很好的方式格式化代码。是否有代码标签或类似标签,可用于包含一些源代码?我知道我可以使用FML,但这不太可取。

谢谢

5 个答案:

答案 0 :(得分:11)

对于那些仍然想知道如何在APT中制作代码片段的人:

     This is regular text
+---------------------
This is a code snippet
+---------------------
      More regular text

答案 1 :(得分:3)

Apache Maven Fluido皮肤高亮显示开箱即用的语法。 Here你可以找到一个例子。关于Fluido中语法高亮的信息:“源代码部分由Google Code Prettify增强,用户可以选择启用Fluido网站上的行号渲染(默认情况下禁用)”。

答案 2 :(得分:3)

+---------------------
code
+---------------------

语法是正确的。正如其他人所提到的,Fluido确实突然使用Prettify开箱即用。

但是,Site Plugin 3.3中的Doxia更改打破了Fluido。 MSKINS-86解决了这个问题,但尚未发布。

变通方法

  1. 使用site.xml workaround <body> <head> <script type="text/javascript"> $(document).ready(function () { $("div.source pre").addClass("prettyprint"); prettyPrint(); }); </script> </head> </body>
  2. 使用网站插件3.2
  3. 构建包含MSKINS-86修复版的未发布的Fluido 1.4并使用它代替1.3.1

答案 3 :(得分:2)

我最终使用了“Doxia宏指南”中的代码段宏:http://maven.apache.org/doxia/macros/index.html#Snippet_Macro

它将来自代码段文件的代码放在逐字框中。但是,它不提供语法突出显示。

答案 4 :(得分:-1)

doxia版本1.0包括宏不在maven central但是以下版本是: http://mvnrepository.com/artifact/org.tinyjee.dim/doxia-include-macro