LDP 作者指南

Jorge Godoy

Emma Jane Hogbin

Mark F. Komarinski

David C. Merrill

david -AT- lupercalia.net

2005-03-04

修订历史
修订 4.84.74.64.54.44.34.24.12006-04-202005-03-042005-01-232004-07-142004-04-192004-04-042004-04-022004-01-27修订者:MGejhejhejhejhejhejhejh
添加了关于首选提交格式的注释,修正了链接,打包了模板。修正了示例 DocBook 标记中的错别字。添加了新的基于网络的创作工具以及关于 LaTeX 到 DocBook 转换的信息。修正了 xmlto 注释和 book 模板中的错别字。将关于支持 DocBook 的文字处理工具的信息复制到“将文档转换为 DocBook XML”附录中;添加了新的 XML 编辑器;以及关于将其他格式转换为 DocBook XML 的工具的信息。更新了关于 CVS 账户以及连接到 CVS 服务器的信息。在“使用 DocBook”部分添加了编辑器署名要求。更新了提交流程。现在,只有在成功完成每次必需的审查之后,才能由审查协调员之一添加新文档。删除了“为 LDP 贡献”部分(已替换为“LDP 流程摘要”)。在参考书目中添加了 LyX 到 DocBook 转换的参考文献。更新了许可证要求,并将其添加到目录中(从子部分移出)。

本指南描述了向 Linux 文档项目 (TLDP) 提交和发布文档的流程。它包括关于 TLDP 使用的工具、工具链和格式的信息。本文档的主要受众是新的 TLDP 作者,但也包含面向经验丰富的文档作者的信息。


目录
1. 关于本指南
1.1. 关于本指南
1.2. 关于 LDP
1.3. 反馈
1.4. 版权和商标
1.5. 致谢
1.6. 文档约定
2. 创作 TLDP 文档:简介
2.1. LDP 流程摘要
2.2. 邮件列表
3. 编写您的提案
3.1. 选择主题
3.2. 文档范围
3.3. 未维护和过时的文档
3.4. 制定大纲
3.5. 研究
4. 编写
4.1. 撰写文本
4.2. 编辑和校对文本
4.3. 用于编写、编辑和维护文档的工具
5. 标记
5.1. 标记:概述
5.2. DocBook:它是什么以及我们为什么使用它
5.3. XML 和 SGML:我们为什么使用 XML
5.4. TLDP 接受的标记语言
6. 分发您的文档
6.1. 分发文档之前
6.2. 许可和版权
6.3. 致谢
6.4. TLDP 审查流程
6.5. 提交到 LDP 以供发布
7. 维护
7.1. 维护您的文档
7.2. 修正错误
参考文献
A. 模板
A.1. 文档模板
A.2. 样式表
A.3. GNU 自由文档许可证
B. 系统设置:编辑器、验证和转换
B.1. 操作系统工具
B.2. 编辑工具
B.3. 验证
B.4. 转换
B.5. DocBook DTD
B.6. 格式化文档
C. 并发版本系统 (CVS)
C.1. 获取 CVS 帐户
C.2. 使用 CVS
C.3. CVS 资源
D. DocBook:示例标记
D.1. 通用技巧
D.2. <section><sectN>:有什么区别?
D.3. 命令提示符
D.4. 编码索引
D.5. 插入图片
D.6. 元数据标记
D.7. 参考书目
D.8. 实体(快捷方式、文本宏和可重用文本)
D.9. 自定义 HTML 文件
E. 将文档转换为 DocBook XML
E.1. 文本到 DocBook
E.2. OpenOffice.org 到 DocBook
E.3. Microsoft Word 到 DocBook
E.4. LaTeX 到 DocBook
E.5. LyX 到 DocBook
E.6. DocBook 到 DocBook 转换
词汇表
F. GNU 自由文档许可证
F.1. 0. 前言
F.2. 1. 适用性和定义
F.3. 2. 逐字复制
F.4. 3. 批量复制
F.5. 4. 修改
F.6. 5. 合并文档
F.7. 6. 文档集合
F.8. 7. 与独立作品的聚合
F.9. 8. 翻译
F.10. 9. 终止
F.11. 10. 本许可证的未来修订
F.12. 附录
表格列表
D-1. 有用的标记
图表列表
B-1. epcEdit 屏幕截图
B-2. nedit 屏幕截图
B-3. 向 nedit 添加 shell 命令
B-4. nsgmls 成功输出
示例列表
B-1. 设置 SGML_CATALOG_FILES 和 XML_CATALOG_FILES 环境变量
B-2. SGML 目录示例
B-3. XML 目录文件示例
B-4. 使用 xmllint 调试示例
B-5. "安装" DSSSL 样式表
B-6. 创建 HTML 输出示例
B-7. "安装" DocBook 文档类型定义
B-8. 在文章中插入摘要的样式表
B-9. 配置外部实体以包含索引
D-1. 带有 programlisting 的命令提示符
D-2. 带有 screen 的命令提示符
D-3. 生成索引的代码
D-4. 属性 zone 的使用
D-5. 在属性 class 上使用值 startofrangeendofrange
D-6. 插入图片
D-7. 使用 <imageobject>
D-8. 其他署名
D-9. 编辑
D-10. 元数据示例
D-11. 参考书目
D-12. 添加实体
D-13. 参数实体的使用