Firebird Docwriting Guide German

• 语言: 德语
• 格式: .pdf
• 来源: firebirdsql.org

摘要

Das Dokument bietet einen Leitfaden für die Erstellung von Dokumentationen für das Firebird-Projekt im Format DocBook XML. Es erläutert voraussetzungen, die Wahl des Themas, die Strukturierung des Dokuments und die grundlegenden Konzepte von DocBook XML. Darüber hinaus behandelt es die praktische Umsetzung des Schreibens, die Nutzung von Werkzeugen, die Einbindung von Sprachhändlungen und die Vorgehensweise zur Veröffentlichung der Dokumente im Internet. Das Dokument bezieht sich auf die Public Documentation License und erklärt, wie man Dokumente in verschiedenen Sprachen veröffentlicht und welche Dateipfade verwendet werden sollen.

AI总结

### 《Firebird Docwriting Guide German》文档总结

#### 1. **文档概述**
- **目的**：本指南旨在帮助编写Firebird项目的文档，目标读者是希望为Firebird项目撰写文档的人。
- **格式要求**：使用DocBook XML格式编写文档。

#### 2. **前提条件**
- **基础知识**：读者需要了解以下内容：
- Firebird manual模块的概念。
- CVS（代码版本控制系统）的使用，包括如何通过CVS客户端下载最新的manual模块。
- 当前Firebird文档的基本功能。
- **建议**：如果不熟悉上述内容，建议先阅读《Firebird Docbuilding Howto》。

#### 3. **主要内容**
- **主题涵盖**：
- firebird-docs邮件列表的使用。
- 文档主题的选择。
- 文档大纲的创建。
- **DocBook XML基础**：
- **什么是DocBook XML**：一种用于文档编写的标记语言。
- **选择DocBook XML的原因**：因为它具有灵活性、可扩展性和广泛支持。
- **常用工具**：包括XML编辑器（如XMLMind、Oxygen）、文本编辑器（如SciTE）等。
- **写作指南**：
- 文档结构的创建。
- 使用DocBook XML元素（如chapter、section、para）。
- 语言和风格建议。
- 版权和公共文档许可（Public Documentation License）。

#### 4. **文档提交与发布**
- **提交流程**：
- 将完成的文档提交到Firebird项目的手动模块。
- 如果没有提交权限，需联系项目成员获取。
- **发布**：
- HTML和PDF版本的文档需发布到Firebird官方网站的指定位置。

#### 5. **附录**
- **文档历史**：
- 包含版本更新记录，如从0.1到1.2的修改内容。
- **许可说明**：
- 文档内容受《Public Documentation License Version 1.0》约束。
- 版权信息：原作者为Paul Vinkenoog，德文版翻译由Martin Köditz完成。

#### 6. **注意事项**
- **技术细节**：
- XML标签需用引号括起来。
- 章节和子章节中避免使用para元素。
- 建议使用专业的XML编辑器。
- **语言与格式**：
- 使用emphasis、citetitle、firstterm等元素来强调内容。
- 使用quote和literal元素处理引文和代码片段。

#### 7. **其他信息**
- **文档存储路径**：
- 英文文档存放在`manual/src/docs/firebirddocs`。
- 其他语言文档存放在对应的子目录（如`firebirddocs-fr`）。
- **多语种支持**：
- 提供多种语言的文档示例，如德文、法文、日文等。

总结：本指南为Firebird文档编写提供了全面的指导，从基础知识到实际操作，帮助贡献者高效完成文档编写并顺利提交和发布。