Boost C++ 库

文档信息块有几种不同类型的属性。它们都是可选的。

Quickbook 特定的元数据

[quickbook 1.7]

quickbook 属性声明了文档所编写的 quickbook 版本。如果省略，则假定版本为 1.1。建议您使用 [quickbook 1.7]，这是此处描述的版本。

	注意
	quickbook 版本还会对生成的标记进行一些更改。最值得注意的是，标题和章节自动生成的 ID 在后续版本中有所不同。为了尽量减少干扰，您可以使用 compatibility-mode 属性来生成与旧版本类似的标记 [article Article that was original written in quickbook 1.3 [quickbook 1.7] [compatibility-mode 1.3] ] 此功能不应用于新文档，仅用于将旧文档移植到新版本。

quickbook 和 compatibility-mode 标签都可以放在文件开头，在文档信息块之前，也可以放在没有文档信息块的文件中。

[source-mode teletype]

source-mode 属性设置初始 源模式。如果省略，则使用默认值 c++。

Boostbook/Docbook 根元素属性

[id foo]

id 指定文档元素的 ID。如果未指定，则 ID 会根据标题自动生成。此 ID 也用于生成嵌套 ID。

[lang en]

lang 指定文档语言。Docbook 使用它来本地化文档。请注意，Boostbook 没有本地化支持，因此如果您使用它来生成参考文档，它将始终为英文。

它应该是一个来自 ISO 639 的语言代码（可能带有来自 ISO 3166 的国家代码，如 en-US）。

[dirname foo]

dirname 用于指定存储库中库的目录名称。这是 Boostbook 的扩展，因此仅对 library 文档块有效。它用于某些 Boostbook 功能，但对于纯 Quickbook 文档没有实际作用。

Docbook 元数据

version、copyright、authors、license、last-revision 和 bibliod 是可选信息。

Boostbook 元数据

purpose 和 category 是 Boostbook 属性，仅对 library 文档有效。如果您将它们用于其他文档类型，Quickbook 会发出警告，但仍会使用它们，生成无效标记，这仅会被样式表忽略。

转义的 Docbook

从 Quickbook 1.7 开始，可以在 docinfo 块中包含 转义的 Boostbook 或 Docbook

[article Some article
[quickbook 1.7]
'''<author>
    <firstname>John</firstname>
    <surname>Doe</surname>
    <email>john.doe@example.com</email>
</author>'''
]

转义的 Docbook 始终放在 docinfo 块的末尾，因此不应假定它会与 Quickbook 生成的标记交错。混合使用 Quickbook 和 Docbook 属性来表示相同的信息将不起作用。

Docinfo 块只能出现在 Quickbook 文件的开头，因此要创建更复杂的文档，您需要使用多个 Quickbook 文件并使用 include 标签 来嵌套它们。例如，假设您想创建一本包含引言和章节的书，首先为这本书创建一个文件

[book Simple example
[quickbook 1.7]
]

[include introduction.qbk]
[include chapter.qbk]

	注意
	像这样组织文档是在 Quickbook 1.6 中引入的，因此需要 [quickbook 1.6] 或更高版本的 docinfo 字段。

引言的适当文档类型是 preface，因此 introduction.qbk 的内容应该类似

[preface Introduction
[quickbook 1.7]
]

Write the introduction to the book here....

以及 chapter.qbk

[chapter A chapter
[quickbook 1.7]
]

Chapter contents....