diff options
| author | Sarah White <graphitefriction@gmail.com> | 2022-05-10 16:33:04 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-10 16:33:04 -0600 |
| commit | 35917117cc605b56ea53abdf229e2ea19e1dbebf (patch) | |
| tree | 4ead3d25f17f81b9a2ed89876e6c2d338137fbdc /docs/modules/ROOT | |
| parent | 80b24612688df6fd052591550bfa012a596a85e0 (diff) | |
add title page and covers examples (PR #2154)
Diffstat (limited to 'docs/modules/ROOT')
| -rw-r--r-- | docs/modules/ROOT/pages/title-page.adoc | 20 | ||||
| -rw-r--r-- | docs/modules/ROOT/pages/whats-new.adoc | 6 |
2 files changed, 25 insertions, 1 deletions
diff --git a/docs/modules/ROOT/pages/title-page.adoc b/docs/modules/ROOT/pages/title-page.adoc index 9f6e4744..0fe538b8 100644 --- a/docs/modules/ROOT/pages/title-page.adoc +++ b/docs/modules/ROOT/pages/title-page.adoc @@ -5,7 +5,8 @@ The title page contains the doctitle, author, date, and revision info. If a front cover image is specified, the title page comes after the front cover. The title page can be styled using the theme and reserved page attributes. -== Enable the title page +[#activate] +== Activate the title page The title page is enabled if one of these conditions is met: @@ -13,3 +14,20 @@ The title page is enabled if one of these conditions is met: * The `title-page` attribute is set (with an empty value) in the document header. When the title page is enabled, the table of contents also gets its own page (or pages, if necessary). + +[#notitle-attribute] +== Deactivate with notitle attribute + +For documents that declare the `book` doctype, the title page can be omitted by setting the `notitle` attribute in the AsciiDoc document header. +(Its counterpart, `:!showtitle:`, does not work with Asciidoctor PDF.) + +[,asciidoc] +---- += Document Title +:doctype: book +:notitle: +---- + +The title page can also be xref:theme:title-pages.adoc#deactivate[deactivated from the theme] by setting the value of the `title-page` category key to `false`. +For all other doctypes, the title page is not added by default. +In that case, setting the `:notitle:` attribute only removes the document title from the first page of content. diff --git a/docs/modules/ROOT/pages/whats-new.adoc b/docs/modules/ROOT/pages/whats-new.adoc index 139dba8e..ccb28657 100644 --- a/docs/modules/ROOT/pages/whats-new.adoc +++ b/docs/modules/ROOT/pages/whats-new.adoc @@ -138,6 +138,12 @@ See xref:theme:block-image.adoc#caption[Block Image Category Keys] for the list PDF outline title and levels:: You can now deactivate the PDF outline by unsetting the `outline` document attribute (`:!outline:`) as well as customize its title with `outline-title` and the section level depth and expansion with `outlinelevels`. See xref:pdf-outline.adoc[] for details. +== Covers and title page + +Front and back cover images:: The front and back cover images can now be xref:theme:covers.adoc[defined in the theme] and the target can be a data URI. + +Deactivate title page:: The xref:theme:title-pages.adoc#deactivate[title page can now be deactivated from the theme] by assigning `false` to the `title-page` category key. + == Running content and page numbering xref:theme:add-running-content.adoc#start-at[Select the page where running content starts]:: Specify the page on which the running content starts being displayed by assigning an integer to the `start-at` theme key on the `running-content` category. |
