diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2022-05-04 18:14:26 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2022-05-04 18:14:26 -0600 |
| commit | 5fe7d4b9dd817451dfa9a4ccb2afa04b47ef8472 (patch) | |
| tree | ff2693bd3b3a84e94112510da27e7ee21080482b | |
| parent | 320efa9f81f0b593cbab1debdb51716a0a38e65f (diff) | |
add documentation for the title-style key on the Add Running Content page [no ci]
| -rw-r--r-- | docs/modules/theme/pages/add-running-content.adoc | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/modules/theme/pages/add-running-content.adoc b/docs/modules/theme/pages/add-running-content.adoc index b34fbda1..5d878d4f 100644 --- a/docs/modules/theme/pages/add-running-content.adoc +++ b/docs/modules/theme/pages/add-running-content.adoc @@ -101,6 +101,10 @@ In addition, the following attributes are also available when defining the conte * `section-title` * `section-or-chapter-title` +The value of the `+*-title+` attributes in the running content matches the text as it appears in the table of contents. +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. +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). + If you reference an attribute which is not defined, all the text on that same line in the running content will be dropped. This feature allows you to have alternate lines that are selected when all the attribute references are satisfied. One case where this is useful is when referencing the `page-number` attribute. |