Doxia 允许您以 Doxia 支持的任何格式编写用户手册和指南等书籍。结合 Doxia Book Maven 插件,您可以将手册直接包含在您生成的站点中,并带有 XDoc、PDF、RTF 和 LaTeX 等离线友好格式的链接。
Doxia Maven 插件有一个目标:
首先,您需要一个简单的书籍描述符,用于指定书籍的布局,即章节的顺序和章节的名称。有关描述符的引用,请参阅Book Descriptor Reference。
关于如何使用 Doxia Book Maven 插件的一般说明可以在使用页面上找到。下面给出的示例中描述了一些更具体的用例。最后但同样重要的是,用户偶尔会向插件的 wiki 页面提供额外的示例、提示或勘误表。
如果您对插件的使用仍有疑问,请查看常见问题解答并随时联系用户邮件列表。邮件列表中的帖子已存档,并且可能已经包含您问题的答案,作为旧线程的一部分。因此,也值得浏览/搜索邮件存档。
如果您觉得插件缺少功能或存在缺陷,您可以在我们的问题跟踪器中填写功能请求或错误报告。创建新问题时,请提供您所关注问题的全面描述。特别是对于修复错误,开发人员可以重现您的问题至关重要。出于这个原因,非常感谢附在问题上的整个调试日志、POM 或最好的小演示项目。当然,补丁也是受欢迎的。贡献者可以从我们的源代码库中查看该项目,并将在帮助使用 Maven 的指南中找到补充信息。
可以在此处查看已呈现到此站点的 Xdoc 输出示例。