Skip to content

Commit 0ce0982

Browse files
committed
document the chapter-numeral and part-numeral attributes in running content
1 parent c11b95d commit 0ce0982

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/modules/theme/pages/add-running-content.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,15 @@ In addition, the following attributes are also available when defining the conte
9898
* `document-title`
9999
* `document-subtitle`
100100
* `part-title`
101+
* `part-numeral` (only set on part title page when part numbering is enabled)
101102
* `chapter-title`
103+
* `chapter-numeral` (only set on chapter title page when section numbering is enabled)
102104
* `section-title`
103105
* `section-or-chapter-title`
104106

105107
The value of the `+*-title+` attributes in the running content matches the text as it appears in the table of contents.
106108
You can control the style of the text stored in these attributes using the `title-style` key on the periphery category (`header` or `footer`) in the theme.
107-
The key accepts the values `toc` (as the title appears in the TOC), `document` (as the title appears in the document), and `basic` (title only, no signifier or number prefix).
109+
The `title-style` key accepts the values `toc` (as the title appears in the TOC), `document` (as the title appears in the document), and `basic` (title only, no signifier or number prefix).
108110

109111
If you reference an attribute which is not defined, all the text on that same line in the running content will be dropped.
110112
This feature allows you to have alternate lines that are selected when all the attribute references are satisfied.

0 commit comments

Comments
 (0)