LDP 使用一系列脚本将文档转换为其发布格式。为了使这些脚本能够工作,文档必须使用有效的标记并包含特定的元数据。元数据是关于文档的信息,包括作者信息、版权、许可和文档的修订历史。
目前,元数据和标记审查将由一位审查协调员进行,并将成为新文档的三个审查中的最后一个。成功完成元数据和标记审查后,审查协调员会将文档的版本号更新为 1.0,并将文档提交以在文集(collection)中发布。
提交到 TLDP 文档库的文档必须验证为以下格式之一
DocBook XML 版本 4.2(首选),4.1.2
DocBook SGML 版本 4.2、4.1 或 3.x
LinuxDoc SGML
![]() | 作者不必以 DocBook 格式提交文档 |
---|---|
作者不必以必需的标记语言之一提交其初始文档。将分配一名志愿者来转换任何未以有效标记提交的文档。作者必须以必需的格式之一维护其文档。当然,可以为作者提供帮助。Linux 文档项目的主要目标是提供高质量的文档,而不是强迫作者学习标记语言。 |
以下元素都是必需的
articleinfo 或 bookinfo。如果您正在编写较短的 HOWTO(这将是大多数文档),您需要使用articleinfo,如果您正在编写更长的指南,您将需要使用bookinfo.
title。每个文档都必须包含一个简短、描述性的标题。它应该具有合理的唯一性;检查文集中的其他文档,以确保您的文档标题与所有其他文档都不同。虽然不是必需的,但大多数 "HOWTO" 文档在标题中都包含 "HOWTO" 这个词。
abstract。您的文档的简短描述必须包含在abstract中。此描述通常为一到两个句子的长度。
author。每个文档都必须有一位作者。如果有多个作者,您可以使用authorgroup。如果文档是由没有个人作者的组织准备的,请使用authorcorp代替。
editor。每个新文档都必须经过审查过程,并列出技术、语言和元数据/标记审查编辑。在某些情况下,其中两项审查可能由同一个人进行。应包括编辑的姓名以及进行审查的版本。有关此标记的更多信息,请阅读作者指南的元数据标记中的注释。
pubdate。文档的发布日期。日期应采用 YYYY-MM-DD 的 ISO 标准格式。
copyright。作者将始终保留其提交给 LDP 的任何文档的版权。虽然不是必需的,但可以包含版权声明。但是,始终需要许可证。
修订历史 (revhistory)。文档中应包含修订摘要。有关其标记的更多信息,请阅读作者指南的元数据标记中的注释。
文档的初始版本应标记为 1.0 版。后续更新应适当增加版本号。首选格式为 Major.Minor.Bugfix,其中每个部分都是整数。一些作者使用 Alan Cox 风格的版本(例如 1.4pre-3),一些作者包含其他信息(例如 1.3beta)。这是可以接受的,但不鼓励。最重要的是我们有一个版本号,以便我们知道我们正在处理哪个版本!一旦文档通过审查,它应该根据引入的更改量增加次版本号或补丁版本号。
许可证和法律声明。需要许可证。LDP 目前接受根据 GFDL、知识共享许可和 LDP 许可获得许可的文档。如果您使用的许可证未列出,则需要我们的志愿者对其进行审查后才能接受该文档。需要许可证的全文。链接是不够的。您可能希望将免责声明作为法律声明的一部分包含在内。作者指南中提供了标准免责声明。
email。LDP 必须能够通过电子邮件联系到任何文档的作者。电子邮件地址应包含在author标签中,但也可以作为注释包含在 DocBook 源代码中。没有电子邮件地址的文档将不被文集接受。如果 LDP 无法联系到作者,则文档可能会从文集中删除。
致谢和其他鸣谢。极少有文档仅由一个人编写。感谢那些在文档的写作、研究、测试或审查方面帮助过您的人是一种良好的形式。如果有人添加了标记,或将您的文档翻译成另一种语言,也应给予他们鸣谢。