diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2022-06-01 23:52:32 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2022-06-02 02:32:43 -0600 |
| commit | 9117b986a3b6c1954b3705ddfcdfe99407533a79 (patch) | |
| tree | d7ce1bf47132c845efffa71d03d04a1737d33620 /docs/modules | |
| parent | f16276d489c78ca4905fe7eddd0449aab56f4bd4 (diff) | |
change name of notitle page to Hide Section Titles and rewrite intro
Diffstat (limited to 'docs/modules')
| -rw-r--r-- | docs/modules/ROOT/pages/notitle.adoc | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/modules/ROOT/pages/notitle.adoc b/docs/modules/ROOT/pages/notitle.adoc index 63faca23..397868f5 100644 --- a/docs/modules/ROOT/pages/notitle.adoc +++ b/docs/modules/ROOT/pages/notitle.adoc @@ -1,12 +1,16 @@ -= Notitle Option += Hide Section Titles :description: The notitle option hides a section title in the document body. It can also add a preamble, preface, or imported PDF entry to the TOC. -The `notitle` option hides a section title in the body of a document, but displays the title in the TOC and allows the anchor resulting from that title to still be referencable. -It can also be used to add a TOC entry for a preamble, anonymous preface, and imported PDF pages. +Asciidoctor PDF adds support for the `notitle` option on a section as a way to express that you want the title of that section to be hidden in the document body. +This option can also be used to add a TOC entnry for a preamble, anonymous preface, or imported PDF page. -== Hide a section title +== notitle option -You can hide a section title in the body of a document using the `notitle` option. +When the `notitle` option is set on a section, the converter will hide the section title in the body of the document, but still display it in the TOC and in cross references to that section. +To hide a section title, add the `notitle` option on the section. + +You can set the notitle option using either the the named attribute syntax, `opts=notitle`, or the shorthand syntax, `%notitle` (preferred). +The following example shows how to use the shorthand syntax. [,asciidoc] ---- |