打开节编号
默认情况下,章节不会被编号。不过,你可以通过设置属性`sectnums`来启用这个功能。
= 标题
:sectnums:
当设置了 sectnums
,从1级(==
)到3级(====
)的章节标题会以 1., 1.1. 等形式加上阿拉伯数字前缀。章节编号可以通过文档头部、命令行界面(CLI)和应用程序接口(API)设置和取消。一旦你设置了 sectnums
,可以通过 sectnumlevels attribute 调整在整个文档中获得编号的章节级别,减少或增加。你也可以控制是否按章节逐个为章节编号。
切换每个部分的章节编号开启或关闭
sectnums` 属性是一个独特的属性。它是一个[.term]灵活属性,这意味着即使通过API或CLI启用,它也可以在文档中途设置和取消设置。这允许你在整个文档中切换编号的开启和关闭。
若想关闭一个或多个章节的编号,请在您希望编号停止的章节上方插入该属性,并通过在其名称末尾添加一个感叹号来取消设置它。若想在中途重新开启章节编号,需在您希望编号继续的章节上方重新设置该属性。
Unresolved directive in numbers.adoc - include::example$section.adoc[tag=num-off]
在文档的不进行章节编号的区域,章节编号将不会增加。根据上述例子,章节编号将如下所示:
Unresolved directive in numbers.adoc - include::example$section.adoc[tag=num-out]
在文档的部分区域中关闭了章节编号的情况下,章节编号不会增加。
章节编号的优先级顺序
如果在命令行或API中设置了`sectnums`,它将覆盖文档头部设置的值,但它不会阻止文档对文档的某些部分进行值的切换。
如果在命令行或API中未设置(sectnums!
),那么无论文档内的设置如何,编号都将被禁用。
指定哪些节的标题需要编号
当设置了`sectnums`时,默认情况下,1级(==
)到3级(====
)的节标题会被编号。您可以通过设置`sectnumlevels`属性来增加或减少节级别的限制,并为其指定您希望编号的节级别。`sectnumlevels`属性接受从0到5的值,并且只能在文档头部设置。
Unresolved directive in numbers.adoc - include::example$section.adoc[tag=sectnuml]
-
当`sectnumlevels`属性被赋值为`2`时,第3级至第5级的小节标题将不会被编号。
当文档类型是`book`时,一级章节变成章。因此,`sectnumlevels`为`4`意味着在每个章节内有3个级别的编号章节。