问题标签 [doxia]

我想使用Doxia生成一些文档，但使用 Ant 调用它（不，Maven 不是一个选项）。我一直在寻找一些指针，但经过几次谷歌搜索后什么都没有弹出。

是否有人已经在 Ant 环境中使用过 Doxia，结果如何？

我正在为一些相关项目编写 Maven 站点文档，并且我想创建一个从一个站点的文档到另一个站点文档的超链接。问题在于链接目标的 URL 依赖于 Maven 属性。

我试过这个：

但是 ${some-prop} 占位符不会被替换，然后 APT 处理器会被第一个 '}' 混淆。转义 { 和 } 字符（例如$\{some-prop\}）没有帮助，以下也不起作用：

还有其他方法可以完成这项任务吗？例如，有没有一种方法可以定义一个 Doxia 宏，该宏可用于替换已扩展占位符的 URL？

我想在我的 maven 站点文档中使用片段宏，以便允许使用 JUnit 测试我的示例代码片段。但我不希望 Eclipse 为我的所有项目显示红色的“存在构建错误”标记（因为 m2eclipse 无法识别片段宏）。我确实希望为 Eclipse 中的项目启用 maven 依赖管理，因此完全禁用 maven 集成不是一种选择。迁移到不同的 IDE 也不是一种选择，因为我不能强迫我的所有同事也从 Eclipse 切换。

我想要一个解决方案：

• 使 (m2)Eclipse 中的 Doxia 集成识别或忽略片段宏
• 让 Eclipse 完全忽略 apt 文件中的错误

精简版

我们需要一个能够生成好看的 PDF 的 Maven Doxia 替代方案（至少代码片段应该正确缩进并具有可配置的字体大小）。Maven 家伙在DOXIA-419中提出了maven-pdf-plugin，但它也有同样的问题。上述 DOXIA-419 详细介绍了我们在使用 Doxia 时遇到的困难。

详细版

我们开发了一个 BIG 产品，提供 Java/C/C++/C#/etc API。数十个客户定制分支同时维护/开发。我们需要一个工具来促进满足这些要求的自动文档生成：

1. 包括来自 Java/XML/etc 示例的任意片段。Confluence Snippet Plugin 就是这个特性的一个很好的例子。

2. 生成好看的可打印文档（例如 PDF）。

3. 生成具有可点击交叉引用等的在线文档（例如 HTML）。

4. 无人值守模式（例如应该很容易从 Ant 脚本运行文档生成过程）。

5. 文档源内容（稍后从中生成 PDF/等）应以易于阅读的格式保存。

6. 文档源内容应保存在单独的文件中（而不是 Java 源）。

7. 支持 (Java/xml/etc) 语法高亮。

更新： 8. Windows 操作系统兼容性。

我知道可以使用 Markdown 编写我的 Maven 站点，例如

http://code.google.com/p/doxia-module-markdown/wiki/Usage

是否也可以创建用 markdown 或 rest 编写的书籍？如中所述，我无法使用书籍描述符来完成这项工作

http://maven.apache.org/doxia/book/index.html

我如何告诉 doxia 我的部分是用哪种标记语言编写的？

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

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

但是，我找不到以一种好的方式格式化代码的方法。是否有代码标签或类似的东西，可以用来包含一些源代码？我知道我可以使用 FML，但这不太理想。

谢谢

使用Doxia APT格式，我想在表格中包含逐字文本或片段。

但是，由于 doxia逐字文本和宏都必须是非缩进的，并且表格需要前面的标记，我不确定是否有一种简单的方法来实现这一点。

更具体地说，我使用 Maven 3 生成带有 apt 文档的站点文档。我想在表格列中包含多行 JSON 表示。

作为一种解决方法，每一行都是等宽的，并且必须对几个 json 字符进行转义，这不容易阅读或维护（尽管呈现的页面看起来很好）。例如：

理想情况下，为了保持表格的可读性，我更喜欢使用 doxia 片段或类似的宏来动态插入代码，但也可以使用逐字文本。例如，我希望能够执行以下无效的操作：

有没有办法做到这一点？

我想在使用 maven-site-plugin 和 markdown (doxia-module-markdown) 生成的代码范围内显示一个美元符号。

在代码范围之外，我使用了数字代码$并解决了问题。但是在一个代码跨度（4个空格）内，数字代码没有被解码，这实际上并不令人惊讶：

在代码块中，与号 (&) 和尖括号（< 和 >）会自动转换为 HTML 实体。

（来自http://daringfireball.net/projects/markdown/syntax#code）

我还尝试将美元符号 ( $$) 加倍、转义 ( \$)、魅力 ( <3$)，但没有任何效果！

有人有什么想法吗？

在 Maven 站点文档中，我对部分使用如下代码：

如何告诉 Doxia 我希望部分名称/标题成为 HTML 本地锚？http://maven.apache.org/doxia/references/doxia-apt.html#Anchors确实谈到了这一点，但我一直无法将它应用于<section>s。

想象一下，我有三个 apt 文件：

main.apt

child1.apt

child2.apt

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

我尝试过使用片段（首先生成带有 id 的站点文档，然后添加对这些 id 的引用）：

并使用生成的站点

，但这不起作用，因为它插入了未格式化为 html 的 html 文本块。我还尝试了片段中的逐字参数，它没有帮助。

也许有人有这个问题的解决方案和/或面临同样的问题？请告诉我你的故事，建议。解决方案可以节省我的时间:)