Apache OFBiz Documentation Guidelines Version trunk

### Apache OFBiz 文档编写指南总结 1. **基本规则** - 独立发布的文档（如开发者手册、用户手册）应包含一致的配置，确保输出格式统一。 - 如果文档仅作为父文档的一部分，无需额外配置，可继承父文档的配置。 2. **文档配置** - **全局配置**：在`build.gradle`文件中设置以下全局选项： - `doctype`: `book` - `revnumber`: `Trunk` - `experimental`: 空值 - `icons`: `font` - `sectnums`: 空值 - `chapter-label`: 空值 - `toc`: 空值 - `toclevels`: `5` - **文档头配置**：在文档开头添加以下配置： - 图片目录：`:imagesdir: ./images` - PDF渲染配置： ``` ifdef::backend-pdf[] :title-logo-image: image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=4.25in, align=center] :source-highlighter: rouge endif::[] ``` 3. **文件包含** - 使用标签包含部分文件： ```adoc # tag::tagname[] This should be included! # end::tagname[] ``` 在其他文件中使用： ```adoc include::docs/asciidoc/resource/article.adoc[tags=tagname] ``` 4. **图片导入** - 导入图片：`image::OFBiz-Logo.svg[Apache OFBiz Logo, pdfwidth=3.0in, align=left]` - 图片路径需在文档头配置中指定。 - 行内图片：`image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%]` 5. **FAQ 和 glossary 编写** - FAQ 和 glossary 以带标签的列表形式编写，每个条目需有唯一 ID。 - 示例： ```adoc <> <> ``` 6. **代码格式化** - 支持多种语言的语法高亮（如 Java、Groovy、XML、CSS、JavaScript 等）。 - 示例： ```adoc [source,java] ---- public class Foo { public String bar; public String bar() { return bar; } } ``` 7. **参考资料** - 官方AsciiDoc指南：[AsciiDoc User Guide](http://asciidoc.org/userguide.html) - AsciiDoctor文档：[AsciiDoctor Writers Guide](https://asciidoctor.org/docs/asciidoctor-writers-guide/) - Apache OFBiz文档团队维基：[OFBiz Documentation Team](https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team)