参与贡献本文档

非常欢迎您为本文档做出贡献。无论您发现错别字还是编写了全新的章节,与我们联系的最佳方式是通过 Bugzilla。请查看错误列表并提交新的错误

编辑保留修改提交内容的权利。任何实质性更改当然会首先与提交者讨论——除非明确要求,否则不会讨论次要的错别字更正和格式修复。

本文档根据知识共享署名-相同方式共享 4.0 国际许可证授权。如果这存在问题,请不要提交任何内容。

本文档使用 DevBook XML 构建系统生成。您可以从 Git 下载系统的快照以及相关的 XML 文件,请参阅下一节。如果您更愿意使用纯文本,那也很好——格式化工作可以由其他人(即我们)轻松完成。

在哪里找到源代码

目前,源代码托管在git.gentoo.org上。对于当前的 Gentoo 开发人员,可以通过git+ssh://[email protected]/proj/devmanual.git访问。非开发人员可以通过键入git clone git://anongit.gentoo.org/proj/devmanual.git克隆存储库。对于那些更喜欢使用拉取请求提交补丁的人,源代码也托管在GitHub上。

要构建 devmanual,只需在存储库的顶级目录中运行make。您需要xsltproc(来自dev-libs/libxslt)用于 XML 到 HTML 的转换,xmllint(来自dev-libs/libxml2)用于验证,以及rsvg-convert(来自gnome-base/librsvg)用于本文档中某些图形的 SVG 到 PNG 转换。

要检查文档的 XML 是否有效,请在顶层目录中运行make validate,这将使用xmllint验证所有 XML 文件。

DevBook XML 快速入门

DevBook XML 很大程度上基于 GuideXML,许多标签是类似的,如果不是相同的话。主要区别在于布局,旨在使用分层树系统更轻松地生成和管理大型出版物。在开始之前,您确实应该首先深入了解DevBook XML 指南

与 GuideXML 的区别

缩进
在需要时缩进——您不应该缩进任何章节流元素,例如<subsection>,但要缩进表格、列表和定义列表。不要缩进普通段落块中的文本。
代码示例
当您不需要语法高亮时,可以使用正常的 GuideXML 标签<pre>。当您需要语法高亮时,请使用<codesample>标签以及lang属性——通常您希望将其设置为ebuild以突出显示 ebuild 代码片段。
层次结构
整个文档被组织成一棵树。每个目录可以包含一个文档。每个文档可以使用<include>标记继承多个子文档。您必须确保每个文档中的self标记正确指向从根节点到文档的相对路径,以便树遍历算法能够正常工作。

风格指南

  • 本文档使用英国英语。欢迎使用其他类型的英语提交,但可能会更正拼写。
  • 应使用第三人称形式而不是第一人称。
  • 这不是正式文件。写作风格旨在专业易读。