一个可选的副标题可以添加到文档标题

Note
HTML 5 转换器目前在从AsciiDoc生成HTML时,不会将副标题从文档标题中分离出来。文档标题仅在DocBook、EPUB 3和PDF转换器的输出中被分割为主标题和副标题。然而,副标题仍然可以通过API获得,因此你可以通过扩展HTML 5转换器来添加对它的支持。

字幕语法

当文档标题包含一个冒号后跟一个空格(即 : ),最后一个冒号-空格序列后的文本被视作副标题。

一份文档的标题和副标题
= 主标题:副标题

分隔符是从文本的末尾开始搜索的。因此,只有分隔符的最后一次出现(即`: `)被用于划分标题。

一个包含多个冒号-空格序列的文档标题
= 主标题:主标题继续:副标题

修改标题分隔符

您可以通过在文档标题上方明确指定`separator`块属性来改变标题分隔符。分隔符值后将自动添加一个空格。

将分隔符分配给文档标题
分隔符为::
= 主标题:: 子标题

你也可以在头部使用文档属性`title-separator`来分配一个分隔符。

将标题分隔符分配给文档标题
= 主标题:: 子标题
标题分隔符::

title-separator` 也可以通过命令行界面进行赋值。

$ asciidoctor -a title-separator=:: document.adoc

使用API分割标题

您可以在调用Document上的`doctitle`方法时,从API中划分标题:

检索分区的文档标题
title_parts = document.doctitle partition: true
puts title_parts.title
puts title_parts.subtitle

您可以通过将分隔符作为值传递给partition选项来以任意方式划分标题。在这种情况下,partition选项既激活了字幕分割功能,又传入了自定义分隔符。

使用自定义分隔符检索分区文档的标题
title_parts = document.doctitle partition: '::'
puts title_parts.title
puts title_parts.subtitle