= Title Page Category Keys
:description: Reference list of the available title page category keys and their value types.
:navtitle: Title Page
:source-language: yaml

[#title-page]
== title-page

The keys in the `title-page` category control the title page and the arrangement and style of the elements on it.
See xref:title-pages.adoc[] for examples and more information.

NOTE: The `title-page` key is always written as single key rather than divided into `title` and `page`.
The nesting in the data structure typically only begins with secondary categories such as `authors` (i.e., the `authors` category key is nested under the `title-page` category key.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|xref:title-pages.adoc#background-color[background-color]
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
title-page:
  background-color: #EAEAEA

|xref:title-pages.adoc#background-image[background-image]
|xref:images.adoc#specify[image macro] {vbar} xref:images.adoc#specify[path] +
(default: _not set_)
|[source]
title-page:
  background-image: image:title.png[]

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
title-page:
  font-color: #333333

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
title-page:
  font-family: Noto Serif

|font-kerning
|`none` {vbar} `normal` +
(default: _inherit_)
|[source]
title-page:
  font-kerning: none

|font-size
|xref:text.adoc#font-size[Font size] +
(default: _inherit_)
|[source]
title-page:
  font-size: 13

|font-style
|xref:text.adoc#font-style[Font style] +
(default: _inherit_)
|[source]
title-page:
  font-style: bold

|line-height
|xref:language.adoc#values[Number] +
(default: `1.15`)
|[source]
title-page:
  line-height: 1

|text-align
|xref:text.adoc#text-align[Text alignment] +
(default: `center`)
|[source]
title-page:
  text-align: right

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
title-page:
  text-transform: uppercase

|title-page
|flag +
(default: _set when doctype is book_)
|[source]
title-page: false
|===

[#logo]
== title-page-logo

The keys in the `title-page-logo` category control the arrangement of a logo on the title page.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|align
|xref:blocks.adoc#align[Block alignment] +
(default: `$title-page-text-align`)
|[source]
title-page:
  logo:
    align: right

|xref:title-pages.adoc#logo-image[image]
|image macro {vbar} path +
(default: _not set_)
|[source]
title-page:
  logo:
    image: image:logo.png[pdfwidth=25%]

|<<logo-top,top>>
|xref:measurement-units.adoc[Measurement] +
(default: `10%`) +
|[source]
title-page:
  logo:
    top: 25%
|===

[#logo-top]
=== top

The absolute top position of the logo.
The `%` unit is a percentage of the content height, starting from the top of the content area.
The `vh` unit is a percentage of the page height, starting from the top of the page.

[#title]
== title-page-title

The keys in the `title-page-title` category control the display, arrangement and style of the title on the title page.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|display
|`none` +
(default: _not set_)
|[source]
title-page:
  title:
    display: none

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
title-page:
  title:
    font-color: #999999

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
title-page:
  title:
    font-family: Noto Serif

|font-kerning
|`none` {vbar} `normal` +
(default: _inherit_)
|[source]
title-page:
  title:
    font-kerning: none

|font-size
|xref:text.adoc#font-size[Font size] +
(default: `18`)
|[source]
title-page:
  title:
    font-size: $heading-h1-font-size

|font-style
|xref:text.adoc#font-style[Font style] +
(default: _inherit_)
|[source]
title-page:
  title:
    font-style: bold

|line-height
|xref:language.adoc#values[Number] +
(default: `$heading-line-height`)
|[source]
title-page:
  title:
    line-height: 0.9

|margin-bottom
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  title:
    margin-bottom: 5

|margin-top
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  title:
    margin-top: 13.125

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
title-page:
  title:
    text-transform: smallcaps

|<<title-top,top>>
|xref:measurement-units.adoc[Measurement] +
(default: `40%`)
|[source]
title-page:
  title:
    top: 55%
|===

[#title-top]
=== top

The absolute top position of the logo.
The `%` unit is a percentage of the content height, starting from the top of the content area.
The `vh` unit is a percentage of the page height, starting from the top of the page.

[#subtitle]
== title-page-subtitle

The keys in the `title-page-subtitle` category control the display, arrangement and style of the subtitle of the title page.
Subtitle partitioning of the document title is only enabled when the title page is also enabled.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|display
|`none` +
(default: _not set_)
|[source]
title-page:
  subtitle:
    display: none

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
title-page:
  subtitle:
    font-color: #181818

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
title-page:
  subtitle:
    font-family: Noto Serif

|font-kerning
|`none` {vbar} `normal` +
(default: _inherit_)
|[source]
title-page:
  subtitle:
    font-kerning: none

|font-size
|xref:text.adoc#font-size[Font size] +
(default: `14`)
|[source]
title-page:
  subtitle:
    font-size: $heading-h3-font-size

|font-style
|xref:text.adoc#font-style[Font style] +
(default: _inherit_)
|[source]
title-page:
  subtitle:
    font-style: bold_italic

|line-height
|xref:language.adoc#values[Number] +
(default: `$heading-line-height`)
|[source]
title-page:
  subtitle:
    line-height: 1

|margin-bottom
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  subtitle:
    margin-bottom: 5

|margin-top
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  subtitle:
    margin-top: 13.125

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
title-page:
  subtitle:
    text-transform: uppercase
|===

[#authors]
== title-page-authors

The keys in the `title-page-authors` category control the display, arrangement and style of the author information on the title page.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|<<content,content>>
|xref:quoted-string.adoc[Quoted AsciiDoc string] +
(default: `"\{author}"`)
|[source]
title-page:
  authors:
    content:
      name_only: "{author}"
      with_email: "{author} <{email}>"
      with_url: "{url}[{author}]"

|delimiter
|xref:quoted-string.adoc[Quoted string] +
(default: `', '`)
|[source]
title-page:
  authors:
    delimiter: '<br>'

|display
|`none` +
(default: _not set_)
|[source]
title-page:
  authors:
    display: none

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
title-page:
  authors:
    font-color: #181818

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
title-page:
  authors:
    font-family: Noto Serif

|font-kerning
|`none` {vbar} `normal` +
(default: _inherit_)
|[source]
title-page:
  authors:
    font-kerning: none

|font-size
|xref:text.adoc#font-size[Font size] +
(default: _inherit_)
|[source]
title-page:
  authors:
    font-size: 13

|font-style
|xref:text.adoc#font-style[Font style] +
(default: _inherit_)
|[source]
title-page:
  authors:
    font-style: bold_italic

|margin-bottom
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  authors:
    margin-bottom: 5

|margin-top
|xref:measurement-units.adoc[Measurement] +
(default: `12`)
|[source]
title-page:
  authors:
    margin-top: 13.125

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
title-page:
  authors:
    text-transform: uppercase
|===

[#content]
=== content

The `content` key accepts the optional keys `name_only`, `with_email`, and `with_url`.

[#revision]
== title-page-revision

The keys in the `title-page-revision` category control the display, arrangement and style of the revision information on the title page.

[cols="3,4,6a"]
|===
|Key |Value Type |Example

|delimiter
|xref:quoted-string.adoc[Quoted string] +
(default: `', '`)
|[source]
title-page:
  revision:
    delimiter: ': '

|display
|`none` +
(default: _not set_)
|[source]
title-page:
  revision:
    display: none

|font-color
|xref:color.adoc[Color] +
(default: _inherit_)
|[source]
title-page:
  revision:
    font-color: #181818

|font-family
|xref:font-support.adoc[Font family name] +
(default: _inherit_)
|[source]
title-page:
  revision:
    font-family: Noto Serif

|font-kerning
|`none` {vbar} `normal` +
(default: _inherit_)
|[source]
title-page:
  revision:
    font-kerning: none

|font-size
|xref:text.adoc#font-size[Font size] +
(default: _inherit_)
|[source]
title-page:
  revision:
    font-size: $base-font-size-small

|font-style
|xref:text.adoc#font-style[Font style] +
(default: _inherit_)
|[source]
title-page:
  revision:
    font-style: bold

|margin-bottom
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  revision:
    margin-bottom: 5

|margin-top
|xref:measurement-units.adoc[Measurement] +
(default: `0`)
|[source]
title-page:
  revision:
    margin-top: 13.125

|text-transform
|xref:text.adoc#transform[Text transform] +
(default: _inherit_)
|[source]
title-page:
  revision:
    text-transform: none
|===
