section-ref.adoc 2.33 KB
Newer Older
1
2
3
4
5
6
7
8
= Section Attributes and Styles Reference

== Section attributes

[%autowidth]
|===
|Feature |Attribute |Value(s) |Notes

Dan Allen's avatar
Dan Allen committed
9
|xref:appendix.adoc#caption[Appendix label]
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|`appendix-caption`
|_Appendix_ (default) or user defined text
|

|xref:chapters.adoc#chapter-label[Chapter label]
|`chapter-label`
|_Chapter_ (default) or user defined text
|`book` doctype only; Asciidoctor PDF only

|xref:discrete-titles.adoc[Discrete title]
|`discrete`
|NA
|

|xref:id-prefix-and-separator.adoc#prefix[ID prefix]
|`idprefix`
|`_` (default) or user defined text
|Set by default
//Set to prepend string to generated section ID

|xref:id-prefix-and-separator.adoc#separator[ID word separator]
|`idseparator`
|`_` (default) or user defined character
|Set by default
//Set to insert character between words in generated section ID

|xref:part-numbers-and-labels.adoc#part-label[Part label]
|`part-label`
|_Part_ (default) or user defined text
|`book` doctype only

|xref:part-numbers-and-labels.adoc[Part numbers]
|`partnums`
|NA
|`book` doctype only

|xref:title-links.adoc#anchor[Section anchor]
|`sectanchors`
|NA
|

|xref:ids.adoc[Section ID]
|`sectids`
|NA
|Set by default
//Autogenerates section IDs by default

|xref:title-links.adoc#link[Section link]
|`sectlinks`
|NA
|

|xref:numbers.adoc[Section numbers] and xref:special-section-numbers.adoc[special section numbers]
|`sectnums`
|empty (default) or `all`
|Can be toggled on or off in the flow of the document
// replaces numbered in AsciiDoc.py

|xref:numbers.adoc#numlevels[Section numbers level depth]
|`sectnumlevels`
|`3` (default) when `sectnums` is set; 0 through 5
|Value of `0` is the same as `sectnums!`

|xref:special-section-titles.adoc[Hide special section title]
|`options` or `%`
|`untitled`
|DocBook only; can only be set on special sections
|===

== Section styles

[%autowidth]
|===
|Feature |Style Name |Doctypes |Converters

|xref:abstract.adoc[Abstract]
|`abstract`
|`article`
|All

|Acknowledgments
|`acknowledgments`
|`book`
|All

|xref:appendix.adoc[Appendix]
|`appendix`
|All
|All

|xref:bibliography.adoc[Bibliography]
|`bibliography`
|All
|All

|xref:colophon.adoc[Colophon]
|`colophon`
|`book`
|All

|xref:dedication.adoc[Dedication]
|`dedication`
|`book`
|All

|xref:glossary.adoc[Glossary]
|`glossary`
|All
|All

|xref:index.adoc[Index]
|`index`
|All
|DocBook

|xref:preface.adoc[Preface]
|`preface`
|`book`
|All
|===