Apache OFBiz Documentation Guidelines 22.01

• 语言: 英语
• 格式: .pdf
• 来源: nightlies.apache.org

摘要

文档提供了《Apache OFBiz Documentation Guidelines 22.01》的编写指南，涵盖了文档配置、结构、内容规范、FAQ和 glossary 的组织，以及代码和图像的处理方法。文档强调使用一致的配置和Asciidoc格式，确保输出格式统一，并提供了详细的配置示例和使用说明。

AI总结

《Apache OFBiz Documentation Guidelines 22.01》提供了编写文档的规范和示例，主要内容包括：

1. **文档配置规则**
- 独立发布的文档（如开发者手册、用户手册）需要包含统一的配置，以确保输出格式一致。
- 嵌入式文档（作为父文档的一部分）无需独立配置，可继承父文档的配置。

2. **全局配置选项**
- 在`build.gradle`文件中设置了以下全局选项：
- `doctype`: 'book'
- `revnumber`: 'Trunk'
- `icons`: 'font'
- `sectnums`: ''
- `chapter-label`: ''
- `toc`: ''
- `toclevels`: '5'

3. **图片导入规则**
- 使用`image::`语法导入图片。
- HTML输出中可添加`alt`文本，PDF输出中可调整图片宽度和对齐方式。
- 嵌入式图片使用`image:`语法，例如：`image:OFBiz-Logo.svg[Apache OFBiz Logo, width=40%]`。

4. **FAQ和GLOSSARY编写规范**
- FAQ和GLOSSARY应以带标签的列表形式编写，并为每个条目分配唯一ID以便链接。
- GLOSSARY条目ID需大写，空格替换为下划线（如`GLOSSARY_ENTRY`）。

5. **代码格式化支持**
- 支持多种语言的代码高亮，包括Java、Groovy、XML、CSS、JavaScript、JSON、Properties、SQL和HTML。
- 示例包括代码块高亮、编号代码和带注释的代码。

6. **引用资源**
- 文档引用了以下外部资源：
- [AsciiDoc User Guide](http://asciidoc.org/userguide.html)
- [AsciiDoc Writers Guide](https://asciidoctor.org/docs/asciidoc-writers-guide/)
- [AsciiDoc Quick Reference](https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
- [AsciiDoc Recommended Practices](https://asciidoctor.org/docs/asciidoc-recommended-practices/)
- [OFBiz Documentation Team Wiki](https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team)

7. **其他示例**
- 包括CSS样式、JavaScript函数、图标示例和多种格式的代码示例，展示了文档的输出效果和格式规范。

总结：该指南为编写OFBiz文档提供了详细的配置、格式和排版规范，适用于开发者和贡献者，旨在确保文档的一致性和可读性。