diff options
| author | Dan Allen <dan.j.allen@gmail.com> | 2022-07-26 23:59:35 -0600 |
|---|---|---|
| committer | Dan Allen <dan.j.allen@gmail.com> | 2022-07-27 03:15:50 -0600 |
| commit | 7ddd4a0fc70c637cdcfc524d16e2b697ba4711c3 (patch) | |
| tree | 642df70e6c3a770c3f1708fb3b3e627c3ae070dd /docs | |
| parent | 0e1ee686a93d94f1bdc79e4f274218f4f2136e6d (diff) | |
be more clear about what's included in the embedded output
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/modules/api/pages/convert-strings.adoc | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/docs/modules/api/pages/convert-strings.adoc b/docs/modules/api/pages/convert-strings.adoc index 2a1181d5..25efb655 100644 --- a/docs/modules/api/pages/convert-strings.adoc +++ b/docs/modules/api/pages/convert-strings.adoc @@ -70,11 +70,14 @@ This default was chosen to make Asciidoctor consistent with other lightweight ma Here's what's included in an embedded document: -* The document title, but only if the `showtitle` attribute is set (no attribution and revision information) -* The table of contents if the `toc` attribute is enabled (and not macro or preamble) +* The document title if the `showtitle` attribute is set +* The table of contents if the `toc` attribute is set and the value is not `preamble` * The converted document body * The footnotes unless the `nofootnotes` attribute is set +The author and revision information is never shown in an embedded document. +If you need to display that information, you can use attribute references such as `\{author}` and `\{revnumber}`. + The embedded document is intended to be included in a template, such as one provided by a static site generator. That template is responsible for providing the styles and library integrations needed for the content to render properly. |
