虽然文档标题是可选的,但通常是文档头部的第一个元素。
标题语法
一个文档的标题是通过使用一个等号(=
),后跟一个空格,然后是标题文本来指定的。
Unresolved directive in title.adoc - include::example$document-title.adoc[]
在带有标题的文档中,注意文档标题和第一行散文之间的空行。那个空行是将文档头部与文档主体分开的。
文档类型和标题
从技术上讲,文档标题是一个0级节标题(=
)。article`和`manpage`文档类型(`doctype
)只能有一个0级节。
The book
document type permits multiple level 0 section titles. When the doctype
is book
, the title of the level 0 section in the header is used as the document’s title. Subsequent level 0 section titles in the document body are interpreted as part titles, unless labeled with a style.
隐藏或显示文档标题
在转换独立文档时,默认会显示文档标题。你可以通过 showtitle
属性控制是否显示文档标题。如果你不希望显示标题,可以在文档头部使用 showtitle!
,或者通过命令行界面(CLI)或应用程序接口(API)来取消设置 showtitle
属性。
当转换为可嵌入文档时,默认情况下不会显示文档标题。要在可嵌入文档中显示标题,请在文档头部设置`showtitle`或通过CLI或API设置。即使设置了`showtitle`,与独立文档不同,可嵌入版本的文档下方也不会显示作者和修订信息。
参考文档标题
在文档头部的0级别节标题,即其标题,会自动被分配给文档属性`doctitle`。你可以在文档中的任何地方引用`doctitle`属性,文档的标题就会被显示。
Unresolved directive in title.adoc - include::example$doctitle.adoc[]
doctitle` 属性也可以在头部通过一个属性条目显式设置并赋值。
"title"属性
默认情况下,文档标题的文本被用作HTML <title>
元素和主要DocBook <info>
元素的值。你可以通过在标题中设置属性条目来覆盖此行为。如果在标题中既没有指定0级节标题也没有指定`doctitle`,但指定了`title`,则使用其值作为备用文档标题。