////
Header: Metadata
Included in:
- user-manual
////
// tag::intro[]
Document metadata, such as a description of the document, keywords, and the title, can be assigned to attributes in the header.
When converted to HTML, the values of these attributes will correspond to tags contained in the `` section of an HTML document.
// end::intro[]
==== Description
// tag::desc[]
You can include a description of the document using the `description` attribute.
[source]
----
include::ex-desc.adoc[tag=desc-base]
----
<1> If the document's description is long, you can break the attribute's value across several lines by ending each line with a backslash `\` that is preceded by a space.
When converted to HTML, the document description value is assigned to the HTML `` tag.
.HTML output
====
include::ex-desc.adoc[tag=desc-html]
====
//end::desc[]
// TODO: Add attribute continuation documentation to attributes section
==== Keywords
// tag::key[]
The `keywords` attribute contains a list of comma separated values that are assigned to the HTML `` tag.
[source]
----
include::ex-keyword.adoc[tag=key-base]
----
.HTML output
====
include::ex-keyword.adoc[tag=key-html]
====
// end::key[]
==== Title override
// tag::atitle[]
By default, {adr} uses the text of the document title as the value of the HTML `` tag.
You can override this behavior by setting the `title` attribute in the document header.
// end::atitle[]
==== Custom metadata, styles and functions
// tag::cmeta[]
You can add content, such as custom metadata, stylesheet, and script information, to the header of the output document using docinfo ("`document information`") files.
The <<user-manual#docinfo-file,docinfo file>> section details what these files can contain and how to use them.
// end::cmeta[]