Topic and map specializations

<backmatter> , <booklists>

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/abbrevlist

The <abbrevlist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

For this element, the @href or @keyref attribute references a manual listing for the current element. If the element does not reference a topic or map, processors can choose to generate an appropriate listing for this element.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

Specifies how a processor should render a map or branch of a map. For example, it can be used to specify that individual topic documents should be rendered as a single document, or that a single document with multiple topics should be rendered as multiple documents.

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

Specifies the vertical dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

Specifies linking characteristics of a topic specific to the location of this reference in a map. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

Specifies whether the referenced resource is processed normally or treated as a resource that is only included in order to resolve references, such as key or content references. The following values are valid:

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

Specifies a percentage as an unsigned integer by which to scale the image in the absence of any specified image height or width; a value of 100 implies that the image should be presented at its intrinsic size. If a value has been specified for the @height or @width attribute (or both), the @scale attribute is ignored.

@scalefit

Specifies whether an image is scaled up or down to fit within available space. The allowable values are yes, no, and "-dita-use-conref-target". If @height, @width, or @scale is specified, those attributes determine the graphic size, and the @scalefit attribute is ignored. If none of those attributes are specified and scalefit="yes", then the image is scaled by the same factor in both dimensions, so that the graphic will just fit within the available height or width, whichever is more constraining.

The available width would be that of the prevailing column or table cell, that is, the width a paragraph of text would have if the graphic were a paragraph instead od text. The available height is implementation dependent, but if feasible, it is suggested to be the page or table cell height or some other reasonable value.

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

Specifies whether the target is available for searching. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid: yes, no, and -dita-use-conref-target.

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

Specifies whether a topic appears in the table of contents (TOC) based on the current map context. If the value is not specified locally, the value might cascade from another element in the map (for cascade rules, see Cascading of metadata attributes in a DITA map). The following values are valid:

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Specifies the horizontal dimension for the resulting display. The value of this attribute is a real number expressed in decimal notation, optionally followed by a unit of measure. The following units of measurement are supported: cm, em, in, mm, pc, pt, and px (centimeters, ems, inches, millimeters, picas, points, and pixels, respectively). The default unit is px (pixels). Possible values include:5, 5in, and 10.5cm.

Example

This section is non-normative.

The following code sample shows how to reference a list of abbreviations as part of a publication's back matter:

<backmatter>
  <booklists>
    <abbrevlist href="abbrev.dita"/>
    <indexlist/>
  </booklists>
</backmatter>

`<amendments>`

The <amendments> element either references a list of amendments or changes to the book, or it indicates to a processor that a list of changes should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <amendments> element, a processor could generate a list of amendments or updates made to the book.

Specialization hierarchy

The <amendments> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

Inheritance

- map/topicref bookmap/amendments

The <amendments> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample specifies that a change history list is generated in the publication front matter. The content of the change history list is contained in the DITA resource referenced by @href.

<frontmatter>
  <booklists>
    <amendments href="change-history.dita"/>
  </booklists>
</frontmatter>

`<appendices>`

The <appendices> element is an optional container for <appendix> elements.

Specialization hierarchy

The <appendices> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?, <appendix> *

Contained by

In order

Optional <topicmeta>
Zero or more <appendix>

Contained by

<bookmap>

Inheritance

- map/topicref bookmap/appendices

The <appendices> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how the <appendices> element functions as a container to hold several appendix topics for an HTML publication:

<bookmap>
  <booktitle>
    <mainbooktitle>About operating the widget</mainbooktitle>
  </booktitle>
  <frontmatter>
    <!-- TOC, preface, and other front matter -->
  </frontmatter>
  <part href="introduction.dita">
    <!-- Part with introductory material about the widget -->
  </part>
  <part href="using.dita">
    <!-- Part about using the widget -->
  </part>
  <part href="troubleshooting.dita">
    <!-- Troubleshooting information -->
  </part>
  <appendices toc="yes">
    <topicmeta>
      <navtitle>Appendices</navtitle>
    </topicmeta>
    <appendix href="return-codes.dita"/>
    <appendix href="messages.dita"/>
    <appendix href="extra-info.dita"/>
  </appendices>
  <backmatter>
    <booklists><indexlist/></booklists>
  </backmatter>
</bookmap>

`<appendix>`

An <appendix> element references a topic or map as an appendix within a book.

Specialization hierarchy

The <appendix> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

<appendices> , <bookmap>

In order

Optional <topicmeta>
Zero or more of the following
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

Inheritance

- map/topicref bookmap/appendix

The <appendix> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how two <appendix> elements are used to create two appendices for a publication:


<bookmap>
  <booktitle>
    <mainbooktitle>Developers guide to the widget</mainbooktitle>
  </booktitle>
  <frontmatter>
    <!-- TOC, preface, and other front matter -->
  </frontmatter>
  <chapter href="introduction.dita">
    <!-- Introductory material about the widget -->
  </chapter>
  <chapter href="extending.dita">
    <!-- How to extend the widget widget -->
  </chapter>
  <appendix href="intro.dita">
    <topicref href="caring.dita"/>
    <topicref href="feeding.dita"/>
  </appendix>
  <appendix href="setup.dita">
    <topicref href="prereq.dita"/>
    <topicref href="download.dita"/>
  </appendix>
</bookmap>

`<backmatter>`

The <backmatter> element is a container for material that follows the main body of a document and any appendices. Back matter might include items such as a colophon, legal notices, and book lists such as a glossary or an index.

Specialization hierarchy

The <backmatter> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

<amendments>
<booklists>
<colophon>
<dedication>
<ditavalref>
<keydef>
<mapref>
<mapresources>
<notices>
<topicgroup>
<topichead>
<topicref>

Contained by

<bookmap>

Inheritance

- map/topicref bookmap/backmatter

The <backmatter> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, universal attributes, @format, @keyref, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<bibliolist>`

The <bibliolist> element references a topic that contains a list of bibliographic entries for the publication.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <bibliolist> element, a processor could generate a list of bibliographic entries used in the book.

Specialization hierarchy

The <bibliolist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/bibliolist

The <bibliolist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how a <bibliolist> element is used to add a bibliography topic to the publication's back matter:

<bookmap>
  <!-- ... -->
  <backmatter>
    <amendments href="updatesToTheBook.dita"/>
    <booklists>
      <trademarklist href="listoftrademarks.dita"/>
      <bibliolist href="bibliography.dita"/>
      <indexlist/>
    </booklists>
  </backmatter>
</bookmap>

`<bookabstract>`

The <bookabstract> element references a topic that includes a brief summary of the book content.

Specialization hierarchy

The <bookabstract> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

<frontmatter>

Optional <topicmeta>

Contained by

<frontmatter>

Inheritance

- map/topicref bookmap/bookabstract

The <bookabstract> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how a <bookabstract> element can be added to the front matter to provide a book summary:

<bookmap xml:lang="en-us">
  <booktitle>
    <booklibrary>Book library</booklibrary>
    <mainbooktitle>Book title</mainbooktitle>
  </booktitle>
  <!-- ... Book metadata here ... -->
  <frontmatter>
    <booklists>
      <toc/>
      <figurelist/>
      <tablelist/>
    </booklists>
    <bookabstract href="book-summary.dita"/>
    <preface href="preface.dita"></preface>
  </frontmatter>
  <!-- ... Book content followed by back matter ... -->
</bookmap>

`<booklibrary>`

The <booklibrary> element contains information about the library, series, or collection of documents to which a book belongs.

Specialization hierarchy

The <booklibrary> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<booktitle>

Zero or more of the following

Text
<abbreviated-form>
<apiname>
<b>
<cite>
<cmdname>
<codeph>
<em>
<filepath>
<hwcontrol>
<i>
<image>
<keyword>
<line-through>
<markupname>
<menucascade>
<msgnum>
<msgph>
<numcharref>
<option>
<overline>
<parameterentity>
<parmname>
<partno>
<ph>
<q>
<strong>
<sub>
<sup>
<synph>
<systemoutput>
<term>
<text>
<textentity>
<tm>
<tt>
<u>
<uicontrol>
<userinput>
<varname>
<wintitle>
<xmlatt>
<xmlelement>
<xmlnsname>
<xmlpi>

Contained by

<booktitle>

Inheritance

- topic/ph bookmap/booklibrary

The <booklibrary> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how to use <booklibrary> to include this book as part of a larger library:

<bookmap>
  <booktitle>
    <booklibrary>Construction Equipment</booklibrary>
    <mainbooktitle>Bulldozer Service Manual</mainbooktitle>
    <booktitlealt>Models 1234-5678</booktitlealt>
  </booktitle>
  <!-- ... metadata, front matter, and book content ... -->
</bookmap>

`<booklist>`

The <booklist> element either references a topic that contains a list of items in the book, or it indicates to a processor that a list of items should be generated at this location in the book. This is a general purpose element designed for use in specializations.

Usage information

The <booklist> element is a general purpose element that references a topic or map containing a list of items within the book. For example, it could be used to reference a topic that contains a list of authors for the book. When a more specific element is already available, such as <tablelist> for a list of tables, use that element instead. If the element does not reference a topic or map, a processor might be able to generate a list of items based on an @outputclass or based on specialization ancestry.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. Because <booklist> is a general purpose element, the type of list would need to be specified for the processor; for example, it could be provided using @outputclass or by further specializing the element.

Specialization hierarchy

The <booklist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/booklist

The <booklist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how to use <booklist> to reference a topic that contains a list of authors of topics in this document:

<booklists>
  <toc/>
  <tablelist/>
  <booklist href="authors.dita"/>
</booklists>

`<booklists>`

The <booklists> element is a container for lists of various kinds within the book.

Processing expectations

The <booklists> element indicates to processors that lists are to be rendered or generated at that location in the front or back matter.

Specialization hierarchy

The <booklists> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

Contained by

Inheritance

- map/topicref bookmap/booklists

The <booklists> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, universal attributes, @format, @keyref, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample indicates that lists are generated in the front and back matter of the publication.

<bookmap>
  <booktitle>
    <mainbooktitle>Sample publication</mainbooktitle>
  </booktitle>
  <frontmatter>
    <booklists>
      <toc>
      <figurelist/>
      <tablelist/>
      <amendments/>
    </booklists>
  </frontmatter>
  ...
  <backmatter>
    <booklists>
      <abbrevlist/>
      <glossarylist/>
      <indexlist/>
    </booklists>
  </backmatter>
</bookmap>

`<bookmap>`

The <bookmap> element is a map specialization that is used to assemble DITA topics as a traditional book.

Usage information

Book maps consist of references to topics organized as book content. The topic references therefore are labeled according to the book components they point to, such as book title, front matter, chapter, and appendix.

Specialization hierarchy

The <bookmap> element is specialized from <map>. It is defined in the bookmap module.

Content model

( <title> | <booktitle> )?, <bookmeta> ?, <ditavalref> *, <mapresources> *, <frontmatter> ?, <chapter> *, <part> *, ( <appendices> ? | <appendix> *), <backmatter> ?, <reltable> *

Not contained by any element.

In order

Optionally one of the following
- <booktitle>
- <title>
Optional <bookmeta>
Zero or more <ditavalref>
Zero or more <mapresources>
Optional <frontmatter>
Zero or more <chapter>
Zero or more <part>
One of the following
- Optional <appendices>
- Zero or more <appendix>
Optional <backmatter>
Zero or more <reltable>

Not contained by any element.

Inheritance

- map/map bookmap/bookmap

The <bookmap> element is specialized from <map> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: architectural attributes, common map attributes, universal attributes, @format, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@DITAArchVersion (architectural attributes)

Specifies the version of the DITA architecture that is in use. This attribute is in the namespace http://dita.oasis-open.org/architecture/2005/. This attribute is specified in the topic and map modules, and it uses a default value of the current version of DITA. The current default is 2.0.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@specializations (architectural attributes)

Specifies the attribute-domain specializations that are included in the document-type shell. This attribute is set as a default within the document-type shell. The value varies depending on what domains are integrated into the document-type shell. For example, a grammar file that includes the specialized attributes @audience, @deliveryTarget, and @newBaseAtt would set the value to

@props/audience @props/deliveryTarget
                @base/newBaseAtt

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how a <bookmap> can be used to organize content into a common book structure:

<bookmap xml:lang="en-us">
  <booktitle>
    <booklibrary>Book library</booklibrary>
    <mainbooktitle>Book title</mainbooktitle>
  </booktitle>
  <bookmeta>
    <bookrights>
      <copyrfirst><year>2019</year></copyrfirst>
      <copyrlast><year>2023</year></copyrlast>
      <bookowner>
        <organization>OASIS</organization>
      </bookowner>
    </bookrights>
  </bookmeta>
  <frontmatter>
    <booklists>
      <toc/>
      <figurelist/>
      <tablelist/>
    </booklists>
    <bookabstract href="MyBookAbstract.dita"/>
    <preface href="preface.dita"></preface>
  </frontmatter>
  <chapter href="chapter1.dita">
    <topicref href="subchap1.dita"></topicref>
  </chapter>
  <chapter href="chapter2.dita">
    <topicref href="subchap2.dita"></topicref>
  </chapter>
  <appendix href="app1.dita">
    <topicref href="insideApp1.dita"></topicref>
  </appendix>
  <appendix href="app2.dita">
    <topicref href="insideApp2.dita"></topicref>
  </appendix>
  <backmatter>
    <amendments href="RevisionHistoryTable.dita"/>
    <booklists>
      <glossarylist href="listofterms.dita"/>
      <trademarklist href="listoftrademarks.dita"/>
      <indexlist/>
    </booklists>
  </backmatter>
</bookmap>

`<booktitle>`

The <booktitle> element contains the title information for a book, including the library title, main title, and any other alternative titles.

Specialization hierarchy

The <booktitle> element is specialized from <title>. It is defined in the bookmap module.

Content model

<booklibrary> ?, <mainbooktitle> , <booktitlealt> *

Contained by

In order

Contained by

<bookmap>

Inheritance

- topic/title bookmap/booktitle

The <booktitle> element is specialized from <title> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: ID and conref attributes, localization attributes, @base, @class, @outputclass, and @rev.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@base

Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

The @base attribute takes a space-delimited set of values. However, when serving as a container for generalized attributes, the attribute values will be more complex. See Attribute generalization for more details.

@class (not for use by authors)

This attribute is not for use by authors. If an editor displays @class attribute values, do not edit them. Specifies a default value that defines the specialization ancestry of the element. Its predefined values allow DITA tools to work correctly with specialized elements. In a generalized DITA document the @class attribute value in the generalized instance might differ from the default value for the @class attribute for the element as given in the DTD or schema. See The class attribute rules and syntax for more information. This attribute is specified on every element except for the <dita> container element. It is always specified with a default value, which varies for each element.

@conaction

Specifies how the element content will be pushed into a new location. The following values are valid:

mark: The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter: Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore: Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace: Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See STUB CONTENT for examples and details about the syntax.

@conkeyref

Specifies a key name or a key name with an element ID that acts as an indirect reference to reusable content. The referenced content is used in place of the content of the current element. See STUB CONTENT for more details about the syntax and behaviors.

@conref

Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See STUB CONTENT for examples and details about the syntax.

@conrefend

Specifies a URI that references the last element in a sequence of elements, with the first element of the sequence specified by @conref. The referenced sequence of elements is used in place of the content of the current element. See STUB CONTENT for examples and details about the syntax.

@dir

Identifies or overrides the text directionality. The following values are valid:

lro: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr: Indicates left-to-right.
rlo: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl: Indicates right-to-left.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@height

@id

Specifies an identifier for the current element. This ID is the target for references by @href and @conref attributes and for external applications that refer to DITA or LwDITA content. This attribute is defined with the XML data type NMTOKEN, except where noted for specific elements within the language reference.

See id attribute for more details.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@outputclass

Specifies a role that the element is playing. The role must be consistent with the basic semantic and expectations for the element. In particular, the @outputclass attribute can be used for styling during output processing; HTML output will typically preserve @outputclass for CSS processing.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rev

Specifies a revision level of an element that identifies when the element was added or modified. It can be used to flag outputs when it matches a run-time parameter. It cannot be used for filtering nor is it sufficient to be used for version control. If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@translate

Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

@xml:lang

Specifies the language and optional locale of the content that is contained in an element. Valid values are language tokens or the null string. The @xml:lang attribute and its values are described in the Extensible Markup Language 1.0 specification, fifth edition.

Example

This section is non-normative.

See the example in bookmap.

`<booktitlealt>`

The <booktitlealt> element contains an alternative title, subtitle, or short title for a book.

Specialization hierarchy

The <booktitlealt> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<booktitle>

Zero or more of the following

Text
<abbreviated-form>
<apiname>
<b>
<cite>
<cmdname>
<codeph>
<em>
<filepath>
<hwcontrol>
<i>
<image>
<keyword>
<line-through>
<markupname>
<menucascade>
<msgnum>
<msgph>
<numcharref>
<option>
<overline>
<parameterentity>
<parmname>
<partno>
<ph>
<q>
<strong>
<sub>
<sup>
<synph>
<systemoutput>
<term>
<text>
<textentity>
<tm>
<tt>
<u>
<uicontrol>
<userinput>
<varname>
<wintitle>
<xmlatt>
<xmlelement>
<xmlnsname>
<xmlpi>

Contained by

<booktitle>

Inheritance

- topic/ph bookmap/booktitlealt

The <booktitlealt> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows a <booktitlealt> element is used to provide a subtitle for the main book title:

<bookmap>
  <booktitle>
    <mainbooktitle>Product Z Installation, Operation, and Maintenance Manual</mainbooktitle>
    <booktitlealt>Getting to know Product Z</booktitlealt>
  </booktitle>
  <!-- ... -->
</bookmap>

`<chapter>`

The <chapter> element references a topic or map as a chapter within a book.

Specialization hierarchy

The <chapter> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

<bookmap> , <part>

In order

Optional <topicmeta>
Zero or more of the following
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

Inheritance

- map/topicref bookmap/chapter

The <chapter> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how two <chapter> elements are used to create two chapters within a publication:

<bookmap>
  <booktitle>
    <mainbooktitle>A book about one thing</mainbooktitle>
  </booktitle>
  <!-- ... metadata and front matter ... -->
  <chapter href="introduction.dita">
    <topicref href="getting-the-one-thing.dita"/>
    <topicref href="preparing-to-use-the-thing.dita"/>
  </chapter>
  <chapter href="setup.dita">
    <topicref href="before-you-use-the-thing.dita"/>
    <topicref href="steps-to-start-using-the-thing.dita"/>
  </chapter>
  <!-- ... more chapters and back matter ... -->
</bookmap>

`<colophon>`

The <colophon> element references a topic that describes how the document was created.

Specialization hierarchy

The <colophon> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

Inheritance

- map/topicref bookmap/colophon

The <colophon> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how the <colophon> element is used to add details about the book's production into the back matter:

<bookmap>
  <title>Sample book</title>
  <!-- ... -->
  <backmatter>
    <!-- ... other back matter ... -->
    <colophon href="ProductionNotes.dita" />
  </backmatter>
</bookmap>

`<dedication>`

The <dedication> element references a topic that contains a dedication for the book, such as to a person or group.

Specialization hierarchy

The <dedication> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

Inheritance

- map/topicref bookmap/dedication

The <dedication> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how a <dedication> element is used to supply content for the dedication within the book's frontmatter.

<frontmatter>
  <dedication href="dedication-to-mother.dita"/>
  <!-- ... -->
</frontmatter>

`<draftintro>`

The <draftintro> element references a topic used as an introduction to the current draft of a book.

Specialization hierarchy

The <draftintro> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

<frontmatter>

In order

Optional <topicmeta>
Zero or more of the following
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

<frontmatter>

Inheritance

- map/topicref bookmap/draftintro

The <draftintro> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample uses <draftintro> to provide an introductory draft section within the frontmatter of the book.

<frontmatter>
  <draftintro href="introducing-this-draft.dita"/>
  <!-- ... -->
</frontmatter>

`<figurelist>`

The <figurelist> element either references a topic that contains a list of figures in the book, or it indicates to a processor that a list of figures should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <figurelist> element, a processor typically generates a list of figures used in the book.

Specialization hierarchy

The <figurelist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/figurelist

The <figurelist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<frontmatter>`

The <frontmatter> element is a container for the material that precedes the main body of a document. Front matter might include items such as an abstract, a preface, and book lists such as a figure list or table of contents.

Specialization hierarchy

The <frontmatter> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

<bookabstract>
<booklists>
<colophon>
<dedication>
<ditavalref>
<draftintro>
<keydef>
<mapref>
<mapresources>
<notices>
<preface>
<topicgroup>
<topichead>
<topicref>

Contained by

<bookmap>

Inheritance

- map/topicref bookmap/frontmatter

The <frontmatter> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, universal attributes, @format, @keyref, @scope, and @type.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<glossarylist>`

The <glossarylist> element either references a topic or map that contains a list of glossary entries in the book, or it indicates to a processor that a list of glossary entries should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <glossarylist> element, a processor could generate a list of glossary entries used in the book.

Specialization hierarchy

The <glossarylist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

In order

Optional <topicmeta>
Zero or more of the following
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/glossarylist

The <glossarylist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<indexlist>`

The <indexlist> element either references a topic that contains an index for the book, or it indicates to a processor that an index should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <indexlist> element, a processor typically generates an index based on index terms used in the book.

Specialization hierarchy

The <indexlist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/indexlist

The <indexlist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<mainbooktitle>`

The <mainbooktitle> element contains the primary title for a book.

Specialization hierarchy

The <mainbooktitle> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<booktitle>

Zero or more of the following

Text
<abbreviated-form>
<apiname>
<b>
<cite>
<cmdname>
<codeph>
<em>
<filepath>
<hwcontrol>
<i>
<image>
<keyword>
<line-through>
<markupname>
<menucascade>
<msgnum>
<msgph>
<numcharref>
<option>
<overline>
<parameterentity>
<parmname>
<partno>
<ph>
<q>
<strong>
<sub>
<sup>
<synph>
<systemoutput>
<term>
<text>
<textentity>
<tm>
<tt>
<u>
<uicontrol>
<userinput>
<varname>
<wintitle>
<xmlatt>
<xmlelement>
<xmlnsname>
<xmlpi>

Contained by

<booktitle>

Inheritance

- topic/ph bookmap/mainbooktitle

The <mainbooktitle> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how to use <mainbooktitle> to provide the main title of the book:

<bookmap>
  <booktitle>
    <booklibrary>Construction Equipment</booklibrary>
    <mainbooktitle>Bulldozer Service Manual</mainbooktitle>
    <booktitlealt>Models 1234-5678</booktitlealt>
  </booktitle>
  <!-- ... metadata, front matter, and book content ... -->
</bookmap>

`<notices>`

The <notices> element references a topic that contains special notice information, such as legal notices about supplementary copyrights and trademarks associated with the book.

Specialization hierarchy

The <notices> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

In order

Optional <topicmeta>
Zero or more of the following
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

Inheritance

- map/topicref bookmap/notices

The <notices> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how to use a <notices> element to reference legal content:

<backmatter>
  <notices href="legal-notices.dita"/>
  <!-- ... Other back matter ... -->
</backmatter>

`<part>`

The <part> element references a topic or a map that acts as a part within a book.

Usage information

Use <part> to divide a document's chapters into logical groupings. For example, in a document that contains both guide and reference information, you can define two parts, one containing the guide information and the other containing the reference information.

Specialization hierarchy

The <part> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

In order

Optional <topicmeta>
Zero or more of the following
- <chapter>
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

<bookmap>

Inheritance

- map/topicref bookmap/part

The <part> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

The following code sample shows how <part> elements are used to group chapters in order to divide a book into two major sections for task and reference material:

<bookmap>
  <title>Using and maintaining Product Zed</title>
  <!-- ... metadata and front matter ... ->
  <part href="taskguide.dita">
    <chapter href="intro.dita">
      <topicref href="caring.dita"/>
      <topicref href="feeding.dita"/>
    </chapter>
    <chapter href="setup.dita">
      <topicref href="prereq.dita"/>
      <topicref href="download.dita"/>
    </chapter> 
  </part>
  <part href="reference.dita">
    <chapter href="commands.dita">
      <topicref href="care.dita"/>
      <topicref href="feed.dita"/>
    </chapter>
    <chapter href="apis.dita">
      <topicref href="acare.dita"/>
      <topicref href="afeed.dita"/>
    </chapter> 
  </part>
</bookmap>

`<preface>`

The <preface> element references a topic or map that contains introductory information about a book, such as the purpose and structure of the document.

Specialization hierarchy

The <preface> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

Contained by

<frontmatter>

In order

Optional <topicmeta>
Zero or more of the following
- <ditavalref>
- <keydef>
- <mapref>
- <mapresources>
- <topicgroup>
- <topichead>
- <topicref>

Contained by

<frontmatter>

Inheritance

- map/topicref bookmap/preface

The <preface> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<tablelist>`

The <tablelist> element either references a topic that contains a list of tables in the book, or it indicates to a processor that a list of tables should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <tablelist> element, a processor typically generates a list of tables used in the book.

When the @href attribute is not specified, a processor might generate a list of tables at the specified location in the map.

Specialization hierarchy

The <tablelist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/tablelist

The <tablelist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<toc>`

The <toc> element either references a topic that contains a table of contents for the book, or it indicates to a processor that a table of contents should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <toc> element, a processor typically generates a table of contents based on topics used in the book.

Specialization hierarchy

The <toc> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/toc

The <toc> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

`<trademarklist>`

The <trademarklist> element either references a topic that contains a list of trademarks in the book, or it indicates to a processor that a list of trademarks should be generated at this location in the book.

Processing expectations

When a list element in the bookmap module uses @href or @keyref to reference a topic or map, the referenced content provides the list content. When the list element does not reference a topic or map, a processor might generate a an appropriate list at the specified location in the map. For the <trademarklist> element, a processor could generate a list of trademarks used in the book.

Specialization hierarchy

The <trademarklist> element is specialized from <topicref>. It is defined in the bookmap module.

Content model

<topicmeta> ?

Contained by

Optional <topicmeta>

Contained by

<booklists>

Inheritance

- map/topicref bookmap/trademarklist

The <trademarklist> element is specialized from <topicref> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: common map attributes, link-relationship attributes, universal attributes, and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@cascade (common map attributes)

Specifies how metadata attributes cascade within a map. The specification defines the following values:

merge: Indicates that the metadata attributes cascade, and that the values of the metadata attributes are additive. This is the processing default for the @cascade attribute.
nomerge: Indicates that the metadata attributes cascade, but that they are not additive for <topicref> elements that specify a different value for a specific metadata attribute. If the cascading value for an attribute is already merged based on multiple ancestor elements, that merged value continues to cascade until a new value is encountered. That is, setting cascade="nomerge" does not undo merging that took place on ancestor elements.

Processors can also define custom, implementation-specific tokens for this attribute.

See Cascading of metadata attributes in a DITA map for more information about how this attribute interacts with metadata attributes.

@chunk (common map attributes)

The following values are valid:

combine: Instructs a processor to combine the referenced source documents for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document.
split: Instructs a processor to split each topic from the referenced source document into its own document for rendering purposes. This is intended for cases where a publishing process normally results in a single output artifact for each source XML document, regardless of how many DITA topics exist within each source document.

Processors can also define custom, implementation-specific tokens for this attribute.

For a detailed description of the @chunk attribute and its usage, see Chunking.

@collection-type (common map attributes)

Specifies how topics or links relate to each other. The processing default is unordered, although no default is specified in the OASIS-provided grammar files. The following values are valid:

unordered: Indicates that the order of the child topics is not significant.
sequence: Indicates that the order of the child topics is significant. Output processors will typically link between them in order.
choice: Indicates that one of the children should be selected.
family: Indicates a tight grouping in which each of the referenced topics not only relates to the current topic but also relate to each other.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@keyscope (common map attributes)

Specifies that the element marks the boundaries of a key scope.

See STUB CONTENT for information on using this attribute.

@linking (common map attributes)

targetonly: A topic can only be linked to and cannot link to other topics.
sourceonly: A topic cannot be linked to but can link to other topics.
normal: A topic can be linked to and can link to other topics. Use this to override the linking value of a parent topic.
none: A topic cannot be linked to or link to other topics.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@processing-role (common map attributes)

normal: Indicates that the resource is a readable part of the information set. It is included in navigation and search results. This is the default value for the <topicref> element.
resource-only: Indicates that the resource should be used only for processing purposes. It is not included in navigation or search results, nor is it rendered as a topic. This is the default value for the <keydef> element.

-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

If no value is specified but the attribute is specified on a containing element within a map or within the related-links section, the value cascades from the closest containing element.

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@search (common map attributes)

@subjectrefs (common map attributes)

Specifies one or more keys that are each defined by a subject definition in a subject scheme map. Multiple values are separated by white space.

@toc (common map attributes)

yes: The topic appears in a generated TOC.
no: The topic does not appear in a generated TOC.
-dita-use-conref-target: See STUB CONTENT for more information.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@width

Example

This section is non-normative.

See the example in bookmap.

Book map metadata elements

The book map specialization supports standard book production. This section contains the metadata elements used by bookmap to store book-related metadata.

`<approved>`

The <approved> element contains detailed information about a book approval, such as the revision that was approved, who approved the book, and when the approval occurred.

Usage information

Information within <approval> can apply to different aspects of the map, such as approval of the overall content or of a specific deliverable created from the map.

Specialization hierarchy

The <approved> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <organization> | <person> )*, <revisionid> ?, <started> ?, <completed> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <organization>
- <person>
Optional <revisionid>
Optional <started>
Optional <completed>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookchangehistory>

Inheritance

- topic/data bookmap/approved

The <approved> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <approved> element can be used to specify who approved the book and when it was approved:

<bookmeta>
  <bookchangehistory>
    <reviewed>
      <revisionid>2</revisionid>
      <started><year>2019</year><month>10</month></started>
      <completed><year>2020</year><month>01</month></completed>
    </reviewed>
    <approved>
      <organization>OASIS</organization>
      <completed><year>2020</year><month>05</month></completed>
    </approved>
  </bookchangehistory>
</bookmeta>

`<bookchangehistory>`

The <bookchangehistory> element contains publishing life-cycle information about the book.

Specialization hierarchy

The <bookchangehistory> element is specialized from <data>. It is defined in the bookmap module.

Content model

<reviewed> *, <edited> *, <tested> *, <approved> *, <bookevent> *

Contained by

In order

Zero or more <reviewed>
Zero or more <edited>
Zero or more <tested>
Zero or more <approved>
Zero or more <bookevent>

Contained by

<bookmeta>

Inheritance

- topic/data bookmap/bookchangehistory

The <bookchangehistory> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <bookchangehistory> element can be used to specify details about when the content was reviewed, edited, tested, approved, and indexed:

<bookmeta>
  <bookchangehistory>
    <reviewed>
      <revisionid>2</revisionid>
      <started><year>2019</year><month>10</month></started>
      <completed><year>2020</year><month>01</month></completed>
    </reviewed>
    <edited>
      <revisionid>1</revisionid>
      <person>Joe T. Editor</person>
      <completed><year>2019</year><month>03</month><day>15</day></completed>
      <summary>Corrected grammatical errors.</summary>
    </edited>
    <edited>
      <revisionid>3</revisionid>
      <person>Joe T. Editor</person>
      <completed><year>2022</year><month>06</month><day>30</day></completed>
    </edited>
    <tested>
      <organization>OASIS</organization>
      <completed><year>2023</year><month>04</month></completed>
    </tested>
    <approved>
      <organization>OASIS</organization>
      <completed><year>2023</year><month>08</month></completed>
    </approved>
    <bookevent>
      <bookeventtype name="indexed"/>
      <completed><year>2023</year><month>01</month></completed>
    </bookevent>
  </bookchangehistory>
</bookmeta>

`<bookevent>`

The <bookevent> element contains detailed information about a custom book event, such as the type of event, which book revision was part of the event, who was responsible for the event, and when the event occurred.

Usage information

This element is appropriate for specialization if the existing <reviewed>, <edited>, or <approved> event type elements do not meet the needs of the organization.

Specialization hierarchy

The <bookevent> element is specialized from <data>. It is defined in the bookmap module.

Content model

<bookeventtype> ?, ( <organization> | <person> )*, <revisionid> ?, <started> ?, <completed> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

In order

Optional <bookeventtype>
Zero or more of the following
- <organization>
- <person>
Optional <revisionid>
Optional <started>
Optional <completed>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookchangehistory>

Inheritance

- topic/data bookmap/bookevent

The <bookevent> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <bookevent> element can be used to specify that the book was indexed and when indexing was completed:


<bookmeta>
   <bookchangehistory>
      <bookevent>
         <bookeventtype name="indexed"/>
         <completed><month>09</month><year>2022</year></completed>
      </bookevent>
   </bookchangehistory>
</bookmeta>

`<bookeventtype>`

The <bookeventtype> element indicates a custom publication event, for example, updated, indexed, or deprecated.

Usage information

The @value attribute is used to indicate the event type.

Specialization hierarchy

The <bookeventtype> element is specialized from <data>. It is defined in the bookmap module.

Content model

EMPTY

Contained by

<bookevent>

Empty

Contained by

<bookevent>

Inheritance

- topic/data bookmap/bookeventtype

The <bookeventtype> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

For this element, the @value attribute specifies the type of book event.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

For this element, the @value attribute specifies the type of book event.

@width

Example

This section is non-normative.

The following code sample shows how the <bookeventtype> element can be used to specify a custom publication event:


<bookmeta>
   <bookchangehistory>
      <bookevent>
         <bookeventtype name="indexed"/>
          <completed><month>09</month><year>2022</year></completed>
      </bookevent>
   </bookchangehistory>
</bookmeta>

`<bookid>`

The <bookid> element contains publishing information used to identify the book, such as part number, edition number, or ISBN number.

Specialization hierarchy

The <bookid> element is specialized from <data>. It is defined in the bookmap module.

Content model

<bookpartno> *, <edition> ?, <isbn> *, <booknumber> *, <volume> *, <maintainer> ?, ( <data> | <sort-as> )*

Contained by

In order

Zero or more <bookpartno>
Optional <edition>
Zero or more <isbn>
Zero or more <booknumber>
Zero or more <volume>
Optional <maintainer>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookmeta>

Inheritance

- topic/data bookmap/bookid

The <bookid> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <bookid> element can be used to define detailed information that identifies the book:

<bookmeta>
  <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <volume>2</volume>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
</bookmeta>

`<bookmeta>`

The <bookmeta> element contains metadata about the book, such as information related to publishing, copyright details, and book identification.

Specialization hierarchy

The <bookmeta> element is specialized from <topicmeta>. It is defined in the bookmap module.

Content model

( <titlealt> | <navtitle> | <searchtitle> | <linktitle> | <subtitle> | <titlehint> )*, <shortdesc> ?, <author> *, <source> ?, <publisherinformation> *, <critdates> ?, <permissions> ?, ( <metadata> | <change-historylist> )*, <audience> *, <category> *, <keywords> *, <prodinfo> *, <othermeta> *, <resourceid> *, <ux-window> *, <bookid> ?, <bookchangehistory> *, <bookrights> *, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <linktitle>
- <navtitle>
- <searchtitle>
- <subtitle>
- <titlealt>
- <titlehint>
Optional <shortdesc>
Zero or more <author>
Optional <source>
Zero or more <publisherinformation>
Optional <critdates>
Optional <permissions>
Zero or more of the following
- <change-historylist>
- <metadata>
Zero or more <audience>
Zero or more <category>
Zero or more <keywords>
Zero or more <prodinfo>
Zero or more <othermeta>
Zero or more <resourceid>
Zero or more <ux-window>
Optional <bookid>
Zero or more <bookchangehistory>
Zero or more <bookrights>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookmap>

Inheritance

- map/topicmeta bookmap/bookmeta

The <bookmeta> element is specialized from <topicmeta> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <bookmeta> element can be used to specify publishing details, book identification details, and copyright details.

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <revisionid>2</revisionid>
        <started><month>01</month><year>2020</year></started>
        <completed><month>02</month><year>2023</year></completed>
      </published>
  </publisherinformation>
   <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <volume>2</volume>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
  <bookchangehistory>
    <reviewed>
      <person>Jack</person>
       <revisionid>1</revisionid>
      <completed><day>31</day><month>07</month><year>2022</year></completed>
    </reviewed>
    <edited>
      <organization>XYZ Editing</organization>
      <completed><day>18</day><month>01</month><year>2023</year></completed>
    </edited>
    <approved>
      <organization>OASIS</organization>
    </approved>
    <bookevent>
      <bookeventtype name="indexed"/>
      <completed><month>09</month><year>2022</year></completed>
    </bookevent>
  </bookchangehistory>
  <bookrights>
    <copyrfirst><year>2020</year></copyrfirst>
    <copyrlast><year>2023</year></copyrlast>
    <bookowner><organization>OASIS</organization></bookowner>
    <bookrestriction value="unclassified"/>
  </bookrights>
</bookmeta>

`<booknumber>`

The <booknumber> element contains the number used to identify a book that is part of a collection of works that belong to the same author.

Specialization hierarchy

The <booknumber> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

Contained by

<bookid>

Inheritance

- topic/data bookmap/booknumber

The <booknumber> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <booknumber> element can be used to identify this book among the author's works:

<bookmeta>
  <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <volume>2</volume>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
</bookmeta>

`<bookowner>`

The <bookowner> element specifies the person (<person>) or business unit (<organization>) that owns the copyrights to the book.

Specialization hierarchy

The <bookowner> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <organization> | <person> )*

Contained by

Zero or more of the following

Contained by

<bookrights>

Inheritance

- topic/data bookmap/bookowner

The <bookowner> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <bookowner> element can be used to specify the business unit that owns the copyrights to the book:

<bookmeta>
  <bookrights>
    <copyrfirst><year>2020</year></copyrfirst>
    <copyrlast><year>2023</year></copyrlast>
    <bookowner>
      <organization>OASIS</organization>
    </bookowner>
    <bookrestriction value="unclassified"/>
  </bookrights>
</bookmeta>

`<bookpartno>`

The <bookpartno> element contains the part number of the book, such as 99F1234.

Usage information

A publisher may use the <bookpartno> element to identify a book for tracking purposes.

Specialization hierarchy

The <bookpartno> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

Contained by

<bookid>

Inheritance

- topic/data bookmap/bookpartno

The <bookpartno> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <bookpartno> element can be used to identify the part number of the book:

<bookmeta>
  <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <volume>2</volume>
  </bookid>
</bookmeta>

`<bookrestriction>`

The <bookrestriction> element specifies whether the book is classified or restricted in some way.

Usage information

The @value attribute is required to specify whether there is a restriction on the book.

Specialization hierarchy

The <bookrestriction> element is specialized from <data>. It is defined in the bookmap module.

Content model

EMPTY

Contained by

Empty

Contained by

<bookrights>

Inheritance

- topic/data bookmap/bookrestriction

The <bookrestriction> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

For this element, the @value attribute specifies any restrictions on the use of the material, such as declaring the information confidential or for licensed use only.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

For this element, the @value attribute specifies any restrictions on the use of the material, such as declaring the information confidential or for licensed use only.

@width

Example

This section is non-normative.

The following code sample shows how the <bookrestriction> element can be used to specify the book restriction:

<bookrights>
  <copyrfirst><year>2016</year></copyrfirst>
  <copyrlast><year>2020</year></copyrlast>
  <bookowner><organization>Example Corporation</organization></bookowner>
  <bookrestriction value="unclassified"/>
</bookrights>

`<bookrights>`

The <bookrights> element contains information about the legal rights associated with the book, including copyright dates and owners.

Specialization hierarchy

The <bookrights> element is specialized from <data>. It is defined in the bookmap module.

Content model

<copyrfirst> ?, <copyrlast> ?, <bookowner> , <bookrestriction> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

In order

Optional <copyrfirst>
Optional <copyrlast>
<bookowner>
Optional <bookrestriction>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookmeta>

Inheritance

- topic/data bookmap/bookrights

The <bookrights> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <bookrights> element can be used to specify copyright information, who owns the book, and whether there are restrictions in place:

<bookmeta>
  <bookrights>
    <copyrfirst><year>2020</year></copyrfirst>
    <copyrlast><year>2023</year></copyrlast>
    <bookowner>
      <organization>OASIS</organization>
    </bookowner>
    <bookrestriction value="unclassified"/>
  </bookrights>
</bookmeta>

`<completed>`

The <completed> element indicates when a book event ended.

Specialization hierarchy

The <completed> element is specialized from <ph>. It is defined in the bookmap module.

Content model

(( <year> , <month> <day> ??) | ( <month> , <day> ?, <year> ) | ( <day> , <month> , <year> ))

Contained by

<approved> , <bookevent> , <edited> , <published> , <reviewed> , <tested>

One of the following

In order
1. <year>
2. Optional <month> Optional <day>
In order
1. <month>
2. Optional <day>
3. <year>
In order

Contained by

Inheritance

- topic/ph bookmap/completed

The <completed> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <completed> element can be used to specify when publishing and editing ended:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <revisionid>2</revisionid>
        <started><month>11</month><year>2022</year></started>
        <completed>
          <month>02</month><year>2023</year>
        </completed>
      </published>
  </publisherinformation>
  <bookchangehistory>
    <edited>
      <organization>XYZ Editing</organization>
      <started><month>08</month><year>2022</year></started>
      <completed>
        <month>10</month><year>2022</year>
      </completed>
    </edited>
</bookmeta>

`<copyrfirst>`

The <copyrfirst> element contains the copyright year, or the first copyright year within a multi-year copyright statement.

Specialization hierarchy

The <copyrfirst> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Contained by

<bookrights>

Inheritance

- topic/data bookmap/copyrfirst

The <copyrfirst> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <copyrfirst> element can be used to specify the first copyright year:

<bookmeta>
  <bookrights>
    <copyrfirst>
      <year>2020</year>
    </copyrfirst>
    <copyrlast><year>2023</year></copyrlast>
    <bookowner>
      <organization>OASIS</organization>
    </bookowner>
    <bookrestriction value="unclassified"/>
  </bookrights>
</bookmeta>

`<copyrlast>`

The <copyrlast> element contains the last copyright year within a multi-year copyright statement.

Specialization hierarchy

The <copyrlast> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Contained by

<bookrights>

Inheritance

- topic/data bookmap/copyrlast

The <copyrlast> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <copyrlast> element can be used to specify the last copyright year:

<bookmeta>
  <bookrights>
    <copyrfirst><year>2020</year></copyrfirst>
    <copyrlast>
      <year>2023</year>
    </copyrlast>
    <bookowner>
      <organization>OASIS</organization>
    </bookowner>
    <bookrestriction value="unclassified"/>
  </bookrights>
</bookmeta>

`<day>`

The <day> element denotes a day of the month.

Specialization hierarchy

The <day> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<completed> , <started>

Zero or more of the following

Contained by

Inheritance

- topic/ph bookmap/day

The <day> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

See the example in bookmeta.

`<edited>`

The <edited> element contains detailed information about a book edit, such as the revision that was edited, who completed the edit, and when the edit occurred.

Specialization hierarchy

The <edited> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <organization> | <person> )*, <revisionid> ?, <started> ?, <completed> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <organization>
- <person>
Optional <revisionid>
Optional <started>
Optional <completed>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookchangehistory>

Inheritance

- topic/data bookmap/edited

The <edited> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <edited> element can be used to show which revisions of the book were edited, who completed the edits, and when the edits occurred:

<bookmeta>
  <bookchangehistory>
    <reviewed>
      <revisionid>2</revisionid>
      <started><year>2019</year><month>10</month></started>
      <completed><year>2020</year><month>01</month></completed>
    </reviewed>
   <edited>
      <revisionid>1</revisionid>
      <person>Joe T. Editor</person>
      <completed><year>2020</year><month>03</month><day>15</day></completed>
    </edited>
    <edited>
      <revisionid>2</revisionid>
      <person>Joe T. Editor</person>
      <completed><year>2023</year><month>06</month><day>30</day></completed>
    </edited>
  </bookchangehistory>
</bookmeta>

`<edition>`

The <edition> element contains information used by a publisher to identify the edition of the book, such as First or Third edition.

Specialization hierarchy

The <edition> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

Contained by

<bookid>

Inheritance

- topic/data bookmap/edition

The <edition> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following example shows how the <edition> element can be used to specify the edition of the book:

<bookmeta>
  <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <volume>2</volume>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
</bookmeta>

`<isbn>`

The <isbn> element contains the International Standard Book Number (ISBN) for the book.

Specialization hierarchy

The <isbn> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

Contained by

<bookid>

Inheritance

- topic/data bookmap/isbn

The <isbn> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following example shows how the <isbn> element can be used to show to specify the ISBN for the book:

<bookmeta>
  <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <volume>2</volume>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
</bookmeta>

`<maintainer>`

The <maintainer> element contains the name of the person ( <person>) or business unit (<organization>) that maintains the book.

Specialization hierarchy

The <maintainer> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <person> | <organization> )*, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <organization>
- <person>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookid>

Inheritance

- topic/data bookmap/maintainer

The <maintainer> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following example shows how the <maintainer> element can be used identify the person that maintains the book:

<bookmeta>
  <bookid>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
</bookmeta>

`<month>`

The <month> element denotes a month of the year.

Specialization hierarchy

The <month> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<completed> , <started>

Zero or more of the following

Contained by

Inheritance

- topic/ph bookmap/month

The <month> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

See the example in bookmeta.

`<organization>`

The <organization> element contains the name of a business unit.

Specialization hierarchy

The <organization> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

<approved> , <bookevent> , <bookowner> , <edited> , <maintainer> , <published> , <publisherinformation> , <reviewed> , <tested>

Zero or more of the following

Contained by

Inheritance

- topic/data bookmap/organization

The <organization> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <organization> element can be used to specify the business units responsible for publishing, editing, and approving the book as well as the business unit that owns the copyrights to the book:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
  </publisherinformation>
   <bookid>
    <isbn>123-0-456-12345-1</isbn>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
  <bookchangehistory>
    <reviewed>
      <person>Jack</person>
      <completed><month>July</month><year>2022</year></completed>
    </reviewed>
    <edited>
      <organization>XYZ Editing</organization>
      <completed><month>January</month><year>2023</year></completed>
    </edited>
    <approved>
      <organization>OASIS</organization>
    </approved>
  </bookchangehistory>
  <bookrights>
    <copyrfirst><year>2020</year></copyrfirst>
    <copyrlast><year>2023</year></copyrlast>
    <bookowner>
      <organization>OASIS</organization>
    </bookowner>
  </bookrights>
</bookmeta>

`<person>`

The <person> element contains name of a person.

Specialization hierarchy

The <person> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

<approved> , <bookevent> , <bookowner> , <edited> , <maintainer> , <published> , <publisherinformation> , <reviewed> , <tested>

Zero or more of the following

Contained by

Inheritance

- topic/data bookmap/person

The <person> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <person> element can be used to specify who maintains the book and who reviewed the book:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
  </publisherinformation>
   <bookid>
    <isbn>123-0-456-12345-1</isbn>
    <maintainer>
      <person>John Smith</person>
    </maintainer>
  </bookid>
  <bookchangehistory>
    <reviewed>
      <person>Jack</person>
      <completed><month>July</month><year>2022</year></completed>
    </reviewed>
    <edited>
      <organization>XYZ Editing</organization>
      <completed><month>January</month><year>2023</year></completed>
    </edited>
    <approved>
      <organization>OASIS</organization>
    </approved>
  </bookchangehistory>
  <bookrights>
    <copyrfirst><year>2020</year></copyrfirst>
    <copyrlast><year>2023</year></copyrlast>
    <bookowner><organization>OASIS</organization></bookowner>
  </bookrights>
</bookmeta>

`<printlocation>`

The <printlocation> element indicates where the book was printed.

Usage information

Typically the print location includes only the country in which the book was printed.

Specialization hierarchy

The <printlocation> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

<publisherinformation>

Zero or more of the following

Contained by

<publisherinformation>

Inheritance

- topic/data bookmap/printlocation

The <printlocation> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <printlocation> element can be used to indicate where the book is printed:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <completed><year>2023</year></completed>
      </published>
  </publisherinformation>
</bookmeta>

`<published>`

The <published> element contains information about the publication, such as the published revision, the publication type, and when the book was published.

Specialization hierarchy

The <published> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <person> | <organization> )*, <publishtype> ?, <revisionid> ?, <started> ?, <completed> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

<publisherinformation>

In order

Zero or more of the following
- <organization>
- <person>
Optional <publishtype>
Optional <revisionid>
Optional <started>
Optional <completed>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<publisherinformation>

Inheritance

- topic/data bookmap/published

The <published> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <published> element can be used to specify the publication type, the published revision, and when the book was published:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <revisionid>2</revisionid>
        <completed><month>02</month><year>2023</year></completed>
      </published>
  </publisherinformation>
</bookmeta>

`<publisherinformation>`

The <publisherinformation> element contains information about who published the book, where it was printed, the publication type, which revision was published, and when it was published.

Usage information

Additional information about the publication history is found in the <bookchangehistory> element.

Specialization hierarchy

The <publisherinformation> element is specialized from <publisher>. It is defined in the bookmap module.

Content model

( <person> | <organization> )*, <printlocation> *, <published> *, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <organization>
- <person>
Zero or more <printlocation>
Zero or more <published>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookmeta>

Inheritance

- topic/publisher bookmap/publisherinformation

The <publisherinformation> element is specialized from <publisher> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <publisherinformation> element can be used to identity who published the book, where the book was printed, the published revision, the publication dates, and the publication type:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <revisionid>1</revisionid>
        <started><month>01</month><year>2020</year></started>
        <completed><month>02</month><year>2023</year></completed>
      </published>
  </publisherinformation>
</bookmeta>

`<publishtype>`

The <publishtype> element indicates whether there are any restrictions on the availability of the book.

Usage information

The @value attribute is required to specify the type of availability, for example, beta release, limited availability, or general availability.

Specialization hierarchy

The <publishtype> element is specialized from <data>. It is defined in the bookmap module.

Content model

EMPTY

Contained by

<published>

Empty

Contained by

<published>

Inheritance

- topic/data bookmap/publishtype

The <publishtype> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

For this element, the @value attribute specifies any restrictions on the availability of the publication.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

For this element, the @value attribute specifies any restrictions on the availability of the publication.

@width

Example

This section is non-normative.

The following code sample shows how the <publishtype> element can be used to specify any restrictions on the availability of the book. In this example, there are no restrictions.

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <revisionid>1</revisionid>
        <completed><month>02</month><year>2023</year></completed>
      </published>
  </publisherinformation>
</bookmeta>

`<reviewed>`

The <reviewed> element contains detailed information about a book review, such as the revision that was reviewed, who reviewed the book, and when the review occurred.

Specialization hierarchy

The <reviewed> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <organization> | <person> )*, <revisionid> ?, <started> ?, <completed> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <organization>
- <person>
Optional <revisionid>
Optional <started>
Optional <completed>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookchangehistory>

Inheritance

- topic/data bookmap/reviewed

The <reviewed> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <reviewed> element can be used to show which revision of the book was reviewed and when it was reviewed:

<bookmeta>
  <bookchangehistory>
    <reviewed>
      <revisionid>2</revisionid>
      <started><year>2019</year><month>10</month></started>
      <completed><year>2020</year><month>01</month></completed>
    </reviewed>
    <approved>
      <organization>OASIS</organization>
      <completed><year>2020</year><month>05</month></completed>
    </approved>
  </bookchangehistory>
</bookmeta>

`<revisionid>`

The <revisionid> element specifies the revision of the book.

Processing expectations

A processor determines how or whether the revision level is displayed. Common methods include using a dash, for example "-01", or a period, such as ".01".

Specialization hierarchy

The <revisionid> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<approved> , <bookevent> , <edited> , <published> , <reviewed> , <tested>

Zero or more of the following

Contained by

Inheritance

- topic/ph bookmap/revisionid

The <revisionid> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <revisionid> element can be used to specify the book revision that was published and the revisions that were edited:

<bookmeta>
  <publisherinformation>
    <organization>NY Publishing</organization>
    <printlocation>United States of America</printlocation>
    <published>
      <revisionid>2</revisionid>
      <completed><month>02</month><year>2023</year></completed>
    </published>
  </publisherinformation>
  <bookchangehistory>
    <edited>
      <revisionid>1</revisionid>
      <person>Joe T. Editor</person>
      <completed><year>2020</year><month>03</month><day>15</day></completed>
    </edited>
    <edited>
      <revisionid>2</revisionid>
      <person>Joe T. Editor</person>
      <completed><year>2023</year><month>06</month><day>30</day></completed>
    </edited>
  </bookchangehistory>
</bookmeta>

`<started>`

The <started> element indicates when a book event began.

Specialization hierarchy

The <started> element is specialized from <ph>. It is defined in the bookmap module.

Content model

(( <year> , <month> <day> ??) | ( <month> , <day> ?, <year> ) | ( <day> , <month> , <year> ))

Contained by

<approved> , <bookevent> , <edited> , <published> , <reviewed> , <tested>

One of the following

In order
1. In order
  1. <year>
2. Optional
  1. <month>
  Optional
  1. <day>
In order
1. In order
  1. <month>
2. Optional
  1. <day>
3. In order
  1. <year>
In order

Contained by

Inheritance

- topic/ph bookmap/started

The <started> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <started> element can be used to specify when publishing and editing began:

<bookmeta>
  <publisherinformation>
      <organization>NY Publishing</organization>
      <printlocation>United States of America</printlocation>
      <published>
        <publishtype value="general"/>
        <revisionid>2</revisionid>
        <started>
          <month>11</month><year>2022</year>
        </started>
        <completed><month>02</month><year>2023</year></completed>
      </published>
  </publisherinformation>
  <bookchangehistory>
    <edited>
      <organization>XYZ Editing</organization>
      <started>
        <month>08</month><year>2022</year>
      </started>
      <completed><month>10</month><year>2022</year></completed>
    </edited>
  </bookchangehistory>
</bookmeta>

`<summary>`

The <summary> element contains a brief summary related to a book event or to the copyrights of the book.

Specialization hierarchy

The <summary> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<approved> , <bookevent> , <bookrights> , <edited> , <published> , <reviewed> , <tested>

Zero or more of the following

Contained by

Inheritance

- topic/ph bookmap/summary

The <summary> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <summary> element can be used to provide a brief summary of the edits that were completed on two different revisions of the book:

<bookmeta>
  <bookchangehistory>
    <edited>
      <person>Joe T. Editor</person>
      <revisionid>1</revisionid>
      <completed><year>2020</year><month>03</month><day>15</day></completed>
      <summary>Added several new topics</summary>
    </edited>
    <edited>
      <person>Joe T. Editor</person>
      <revisionid>2</revisionid>
      <completed><year>2020</year><month>10</month><day>13</day></completed>
      <summary>Fixed a few typos</summary>
    </edited>
  </bookchangehistory>
</bookmeta>

`<tested>`

The <tested> element contains detailed information about book testing, such as the revision that was tested, who tested the book, and when testing occurred.

Specialization hierarchy

The <tested> element is specialized from <data>. It is defined in the bookmap module.

Content model

( <organization> | <person> )*, <revisionid> ?, <started> ?, <completed> ?, <summary> ?, ( <data> | <sort-as> )*

Contained by

In order

Zero or more of the following
- <organization>
- <person>
Optional <revisionid>
Optional <started>
Optional <completed>
Optional <summary>
Zero or more of the following
- <data>
- <sort-as>

Contained by

<bookchangehistory>

Inheritance

- topic/data bookmap/tested

The <tested> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following code sample shows how the <tested> element can be used to indicate who completed testing and when testing occurred:

<bookmeta>
  <bookchangehistory>
    <reviewed>
      <revisionid>2</revisionid>
      <started><year>2019</year><month>10</month></started>
      <completed><year>2020</year><month>01</month></completed>
    </reviewed>
    <tested>
      <organization>OASIS</organization>
      <completed><year>2020</year><month>04</month></completed>
    </tested>
    <approved>
      <organization>OASIS</organization>
      <completed><year>2020</year><month>05</month></completed>
    </approved>
  </bookchangehistory>
</bookmeta>

`<volume>`

The <volume> element contains the volume number of the book.

Specialization hierarchy

The <volume> element is specialized from <data>. It is defined in the bookmap module.

Content model

Contained by

Zero or more of the following

Contained by

<bookid>

Inheritance

- topic/data bookmap/volume

The <volume> element is specialized from <data> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: data-element attributes, link-relationship attributes, and universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@datatype (data-element attributes)

Specifies the type of data contained in the @value attribute or within the <data> element. A typical use of @datatype will be the identifying URI for an XML Schema datatype.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@name (data-element attributes)

Defines a unique name for the object.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

Describes the target of a reference. See STUB CONTENT for detailed information on supported values and processing implications.

@value (data-element attributes)

Specifies a value associated with the current property or element.

@width

Example

This section is non-normative.

The following example shows how the <volume> element can be used to indicate the volume number of the book:

<bookmeta>
  <bookid>
    <bookpartno>99F1234</bookpartno>
    <edition>Second</edition>
    <isbn>123-0-456-12345-1</isbn>
    <booknumber>SC21-1234-00</booknumber>
  <volume>2</volume>
  </bookid>
</bookmeta>

`<year>`

The <year> element denotes a year.

Specialization hierarchy

The <year> element is specialized from <ph>. It is defined in the bookmap module.

Content model

Contained by

<completed> , <copyrfirst> , <copyrlast> , <started>

Zero or more of the following

Contained by

Inheritance

- topic/ph bookmap/year

The <year> element is specialized from <ph> . It is defined in the bookmap module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

See the example in bookmeta.

Concept elements

Concept elements provide the fundamental structure for concept topics. Concept topics are useful for introducing the background or overview information for task or reference topics.

`<concept>`

The <concept> element is the top-level element for a topic that answers the question what is?

Usage information

Concepts provide background information that users must know before they can successfully work with a product or interface. Often, a concept is an extended definition of a major abstraction such as a process or function. It might also contain an example, image, or diagram.

Specialization hierarchy

The <concept> element is specialized from <topic>. It is defined in the concept module.

Attributes

The following attributes are available on this element: architectural attributes and universal attributes.

For this element, the @id attribute is required.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@DITAArchVersion (architectural attributes)

@height

@id

For this element, the @id attribute is required.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@specializations (architectural attributes)

@props/audience @props/deliveryTarget
                @base/newBaseAtt

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows a concept topic:

<concept id="concept">
  <title>DITA concept topic</title>
  <shortdesc>The concept topic answers the question <q>what is?</q></shortdesc>
    <conbody>
      <p>Concept topics provide background information that users must know
         before they can successfully work with a product or interface. Often,
         a concept is an extended definition of a major abstraction such as a
         process or function. It might also have an example or a graphic.</p>
    </conbody>
</concept>

`<conbody>`

The <conbody> element contains the main content of a concept topic.

Usage information

The <conbody> element allows paragraphs, lists, and other elements as well as sections and examples. However, <conbody> element has a restriction that a <section> or an <example> can be followed only by other sections, examples, or <conbodydiv> elements that group sections and examples.

Specialization hierarchy

The <conbody> element is specialized from <body>. It is defined in the concept module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

See <concept>.

`<conbodydiv>`

The <conbodydiv> element provides an container for content that might be grouped within a concept topic.

Usage information

There are no additional semantics attached to the <conbodydiv> element. It is purely a grouping element that is provided to help organize content for reuse.

The content model of the <conbodydiv> element only permits <section> and <example>.

Specialization hierarchy

The <conbodydiv> element is specialized from <bodydiv>. It is defined in the concept module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how a <conbodydiv>element can be used to group content for reuse:

<conbody>
  <conbodydiv id="concept-purpose-content-model">
    <section id="purpose">
      <title>Purpose</title>
        <p>Concept topics serve a variety of purposes:</p>
        <!-- ... -->
    </section>
    <section id="content-model">
      <title>Content model</title>
        <p>The body of a concept topic can contain the following document
          structures:</p>
        <!-- ... -->        
    </section>
  </conbodydiv>
</conbody>

Glossary entry elements

The glossary entry specialization contains markup that supports the development and delivery of glossaries. It also can be used in conjunction with the abbreviated-form domain to provide a solution for rendering different forms of a term on first and later usage in a publication.

`<glossAcronym>`

The <glossAcronym> element defines an acronym for the term that is specified in the <glossterm> element.

Usage information

This element can be used with the <abbreviated-form> element to display an expanded version of an acronym the first time that acronym appears in a set of text. See <abbreviated-form> for information on how the two elements interact.

Specialization hierarchy

The <glossAcronym> element is specialized from <title>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: ID and conref attributes, localization attributes, @base, @class, @outputclass, and @rev.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@base

Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

@class (not for use by authors)

@conaction

Specifies how the element content will be pushed into a new location. The following values are valid:

mark: The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter: Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore: Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace: Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See STUB CONTENT for examples and details about the syntax.

@conkeyref

@conref

Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See STUB CONTENT for examples and details about the syntax.

@conrefend

@dir

Identifies or overrides the text directionality. The following values are valid:

lro: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr: Indicates left-to-right.
rlo: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl: Indicates right-to-left.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@height

@id

See id attribute for more details.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@outputclass

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rev

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@translate

Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

@xml:lang

Example

This section is non-normative.

The following code sample shows how the <glossAcronym> element can be used:

<glossentry id="united-nations">
    <glossterm>United Nations</glossterm>
    <glossdef>The United Nations, referred to informally as the UN, is an
    intergovernmental organization whose stated purposes are to maintain
    international peace and security, develop friendly relations among
    nations, achieve international cooperation, and serve as a center for
    harmonizing the actions of nations.</glossdef>
  <glossBody>
    <glossSurfaceForm>United Nations (UN)</glossSurfaceForm>
    <glossAlt>
      <glossAcronym>UN</glossAcronym>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossAlt>`

The <glossAlt> element contains information about a variant for the term that is specified in the <glossterm> element. A variant might include an acronym or a synonym.

Usage information

The variant should have the same meaning as the term in the <glossterm> element; the variant is simply another way to refer to the same term. There might be many ways to refer to a term; each variant is placed in its own <glossAlt> element. The <glossUsage> element can be used within <glossAlt> to indicate when use of the alternate term is appropriate.

Specialization hierarchy

The <glossAlt> element is specialized from <section>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how a glossary entry topic might provide alternative forms of the term.

<glossentry id="usa">
  <glossterm>United States of America</glossterm>
  <glossdef>A federal republic in the northern Western Hemisphere comprising 48 contiguous 
     states, the District of Columbia, Alaska in North America, and Hawaii in the North 
     Pacific, and in some contexts considered along with its five inhabited island 
     territories (Puerto Rico, U.S. Virgin Islands, Guam, North Mariana Islands, American 
     Samoa).</glossdef>
  <glossBody>
    <glossAlt>
      <glossAcronym>US</glossSynonym>
      <glossUsage>Used as an adjective.</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossAcronym>USA</glossSynonym>
      <glossUsage>Used as a noun.</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossSynonym>America</glossSynonym>
      <glossUsage>Do not use; the American continents include other countries.</glossUsage>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossBody>`

The <glossBody> element contains information about the term that is specified in the <glossterm> element, such as a acronym, synonyms, or usage notes.

Specialization hierarchy

The <glossBody> element is specialized from <conbody>; it is defined in the glossary entry module. The <conbody> element is specialized from <body>; it is defined in the concept module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <glossBody> element contains a synonym for the term:

<glossentry id="sport-drink">
    <glossterm>Sport drink</glossterm>
    <glossdef>A soft drink designed or marketed for consumption in
    conjunction with sporting activity or strenuous exercise, and which
    typically contains electrolytes such as sodium, potassium, and
    chloride, and a high percentage of sugar to restore energy.</glossdef>
  <glossBody>
    <glossAlt>
      <glossSynonym>energy drink</glossSynonym>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossdef>`

The <glossdef> element defines the meaning of the term that is specified in the <glossterm> element.

Usage information

If a term has multiple meanings, create a separate <glossentry> topic for each.

Specialization hierarchy

The <glossdef> element is specialized from <abstract>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows the <glossdef> element can be used to define the meaning of the term "raster pattern":

<glossentry id="rasterpattern">
  <glossterm>raster pattern</glossterm>
  <glossdef>A series of picture elements (pels) arranged in scan lines to form
            an image.</glossdef>
</glossentry>

`<glossentry>`

The <glossentry> element is the top-level element for a topic that defines a glossary term.

Rendering expectations

Because the glossary entry specialization is designed for multiple purposes, it contains elements that typically are not intended to be rendered when a glossary is generated. In addition, when a collection of glossary entry topics is rendered as authoring guidance, generated text might be required for ease of reading. Specialized style sheets and processing are needed to ensure useful output.

Processing expectations

Processing expectations for glossary entry topics are highly implementation-specific and will depend on the output format.

For HTML-based output formats, one possible implementation of glossary entry topics is to generate hyperlinks for <term> elements that are associated by key reference with the glossary entry topic. The term definition might be displayed when someone hovers over or clicks on the hyperlink.

For PDF output, one possible implementation of glossary entry topics is to render acronyms or expanded acronyms for <abbreviated-form> elements that are associated by key reference with the glossary entry topics. The surface form is rendered on first usage, and the acronym is rendered on second or later usage.

Specialization hierarchy

The <glossentry> element is specialized from <concept>; it is defined in the glossary entry module. The <concept> element is specialized from <topic>; it is defined in the concept module.

Attributes

The following attributes are available on this element: architectural attributes and universal attributes.

For this element, the @id attribute is required.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@DITAArchVersion (architectural attributes)

@height

@id

For this element, the @id attribute is required.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@specializations (architectural attributes)

@props/audience @props/deliveryTarget
                @base/newBaseAtt

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code samples shows how a glossary entry topic provides information about a term that aids in terminology management:

<glossentry id="usbfd">
  <glossterm>USB flash drive</glossterm>
  <glossdef>A small portable drive.</glossdef>
  <glossBody>
    <glossUsage>Do not use this term in upper case (for example,  in "USB Flash Drive")
      because that suggests a trademark.</glossUsage>
    <glossAlt>
      <glossAcronym>UFD</glossAcronym>
    </glossAlt>
    <glossAlt id="memoryStick">
      <glossSynonym>memory stick</glossSynonym>
      <glossUsage>This is a colloquial term.</glossUsage>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossSurfaceForm>`

The <glossSurfaceForm> element specifies how the term that is specified by the <glossterm> element should appear in the text. The surface form is suitable to introduce the term in new contexts or as the first occurrence.

Usage information

The <glossSurfaceForm> element is most often used for terms that also specify the <glossAcronym> element. In that context, the <glossSurfaceForm> element contains the term in a manner that introduces both the term and the acronym, so that later references to the term can be replaced with the acronym alone.

See the <abbreviated-form> element for a full description of how the surface form is used together with acronyms.

Specialization hierarchy

The <glossSurfaceForm> element is specialized from <p>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following glossary entry topic defines the term "Anti-lock Braking System". Within the topic, the <glossSurfaceForm> element provides a version of the term that combines both the primary term and the acronym. The content of the <glossSurfaceForm> might be rendered in introductory contexts when the glossary entry topic is referenced from an <abbreviated-form> element.

<glossentry id="abs">
  <glossterm>Anti-lock Braking System</glossterm>
  <glossBody>
    <glossSurfaceForm>Anti-lock Braking System (ABS)</glossSurfaceForm>
    <glossAlt>
      <glossAcronym>ABS</glossAcronym>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossSymbol>`

The <glossSymbol> element identifies an image that is associated with the subject of the term that is specified by <glossterm> element.

Specialization hierarchy

The <glossSymbol> element is specialized from <image>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: universal attributes, @format, @href, @keyref, @scope, and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@scale

@scalefit

@width

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@format (link-relationship attributes)

Specifies the format of the resource that is referenced. See STUB CONTENT for detailed information on supported values and processing implications.

@height

@href (link-relationship attributes)

Specifies a reference to a resource. See STUB CONTENT for detailed information on supported values and processing implications.

@keyref

Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <glossSymbol> can be used to associate a regional classification icon with the Atlantic puffin:

<glossentry id="atlanticpuffin">
  <glossterm>Atlantic Puffin</glossterm>
  <glossdef>A sea bird that lives in the Atlantic
    <image href="puffinicon.jpg">
      <alt>Image of an atlantic puffin</alt>
    </image>
  </glossdef>
  <glossBody>
    <glossSymbol href="atlantic.jpg" scope="local">
      <alt>Icon denoting the Atlantic region</alt>
    </glossSymbol>
  </glossBody>
</glossentry>

`<glossSynonym>`

The <glossSynonym> element provides a term that is a synonym of the term that is specified by the <glossterm> element.

Usage information

The <glossSynonym> element should not be used to specify an acronym; use the <glossAcronym> element for that purpose.

Specialization hierarchy

The <glossSynonym> element is specialized from <title>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: ID and conref attributes, localization attributes, @base, @class, @outputclass, and @rev.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@base

Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

@class (not for use by authors)

@conaction

Specifies how the element content will be pushed into a new location. The following values are valid:

mark: The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter: Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore: Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace: Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See STUB CONTENT for examples and details about the syntax.

@conkeyref

@conref

Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See STUB CONTENT for examples and details about the syntax.

@conrefend

@dir

Identifies or overrides the text directionality. The following values are valid:

lro: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr: Indicates left-to-right.
rlo: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl: Indicates right-to-left.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@height

@id

See id attribute for more details.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@outputclass

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rev

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@translate

Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

@xml:lang

Example

This section is non-normative.

The following code sample shows how the <glossSynonym> element can be used to identify a synonym for the word automobile. In this case the synonym is enclosed in a term with @keyref, allowing a tool to optionally link to the other definition:

<glossentry id="automobile">
    <glossterm>Automobile</glossterm>
    <glossdef>A road vehicle, typically with four wheels, powered by an
    internal combustion engine or an electric motor.</glossdef>
  <glossBody>
    <glossAlt>
      <glossSynonym><term keyref="gloss.car">car</term></glossSynonym>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossterm>`

The <glossterm> element specifies the term that is defined by the glossary entry topic.

Specialization hierarchy

The <glossterm> element is specialized from <title>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: ID and conref attributes, localization attributes, @base, @class, @outputclass, and @rev.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@base

Specifies metadata about the element. It is often used as a base for specialized attributes that have a simple syntax for values, but which are not conditional processing attributes.

@class (not for use by authors)

@conaction

Specifies how the element content will be pushed into a new location. The following values are valid:

mark: The element acts as a marker when pushing content before or after the target, to help ensure that the push action is valid. The element with conaction="mark" also specifies the target of the push action with @conref. Content inside of the element with conaction="mark" is not pushed to the new location.
pushafter: Content from this element is pushed after the location specified by @conref on the element with conaction="mark". The element with conaction="pushafter" is the first sibling element after the element with conaction="mark".
pushbefore: Content from this element is pushed before the location specified by @conref on the element with conaction="mark". The element with conaction="pushbefore" is the first sibling element before the element with conaction="mark".
pushreplace: Content from this element replaces any content from the element referenced by the @conref attribute. A second element with conaction="mark" is not used when using conaction="pushreplace".
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See STUB CONTENT for examples and details about the syntax.

@conkeyref

@conref

Specifies a URI that references a DITA element. The referenced content is used in place of the content of the current element. See STUB CONTENT for examples and details about the syntax.

@conrefend

@dir

Identifies or overrides the text directionality. The following values are valid:

lro: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into left-to-right mode.
ltr: Indicates left-to-right.
rlo: Indicates an override of the Unicode Bidirectional Algorithm, forcing the element into right-to-left mode.
rtl: Indicates right-to-left.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

See The dir attribute for more information.

@height

@id

See id attribute for more details.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@outputclass

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rev

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@translate

Specifies whether the content of the element should be translated. The following values are valid: yes, no, and -dita-use-conref-target.

See Element-by-element recommendations for translators for suggested processing defaults for each element.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

@xml:lang

Example

This section is non-normative.

The following code sample shows how the <glossterm> element specifies the term that is defined in the <glossentry> topic:

<glossentry id="css">
    <glossterm>cascading style sheets</glossterm>
    <glossdef>Cascading Style Sheets is a style sheet language that is used
    for rendering the presentation of a document written in a markup
    language such as HTML or XML</glossdef>
  <glossBody>
    <glossSurfaceForm>cascading style sheets (CSS)</glossSurfaceForm>
    <glossAlt>
      <glossAcronym>CSS</glossAcronym>
    </glossAlt>
    <glossAlt>
      <glossSynonym>web style sheets</glossSynonym>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossUsage>`

The <glossUsage> element provides information about how to use the term that is specified in the <glossterm> element. It also can be used to provide usage information for acronyms or synonyms.

Specialization hierarchy

The <glossUsage> element is specialized from <note>. It is defined in the glossary entry module.

Attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <glossUsage> element is used to provide additional information about possible variants for the term "soft drink:"

<glossentry id="softdrink">
  <glossterm>soft drink</glossterm>
  <glossdef>A nonalcoholic drink, especially one that is carbonated.</glossdef>
  <glossBody>
    <glossAlt>
      <glossSynonym>pop</glossSynonym>
      <glossUsage>Used primarily in the North and Midwest</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossSynonym>soda</glossSynonym>  
      <glossUsage>Used primarily in the West and Northeast</glossUsage>
    </glossAlt>
    <glossAlt>
      <glossSynonym>Coke</glossSynonym>
      <glossUsage>Used primarily in the South</glossUsage>
    </glossAlt>
  </glossBody>
</glossentry>

`<glossgroup>`

A glossary group topic organizes related glossary entry topics within a single topic document.

Usage information

Glossary groups are primarily a convenience for authoring when it is useful to author multiple glossary entry topics in a single document.

Specialization hierarchy

The <glossgroup> element is specialized from <concept>; it is defined in the glossary group module. The <concept> element is specialized from <topic>; it is defined in the concept module.

Attributes

The following attributes are available on this element: architectural attributes and universal attributes.

For this element, the @id attribute is required.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@DITAArchVersion (architectural attributes)

@height

@id

For this element, the @id attribute is required.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@specializations (architectural attributes)

@props/audience @props/deliveryTarget
                @base/newBaseAtt

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

<glossgroup id="things" xml:lang="en">
  <title>Some terms</title>
  <glossentry id="bicycle">
    <glossterm>bicycle</glossterm>
    <glossdef>Human powered mode of transport
       with two wheels</glossdef>
  </glossentry>
  <glossentry id="fruitbat">
    <glossterm>Fruit bat</glossterm>
    <glossdef>A bat which likes fruit</glossdef>
  </glossentry>
</glossgroup>

Reference elements

Reference elements provide the fundamental structure for reference topics. Reference topics include specialized sections for programming language syntax and property lists, as well as standard elements such as sections, tables, and examples.

`<propdesc>`

The <propdesc> element contains content that describes the property type and its values.

Specialization hierarchy

The <propdesc> element is specialized from <stentry>. It is defined in the reference module.

Attributes

The following attributes are available on this element: table accessibility attributes, universal attributes, and the attribute defined below.

@rowspan: Specifies the number of rows that a cell is to span inside a simple table.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

Specifies which entries in the current table provide headers for this cell. The @headers attribute contains an unordered set of unique, space-separated tokens, each of which is an ID reference of an entry from the same table.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<propdeschd>`

The <propdeschd> element provides a label for the description column in a properties table.

Specialization hierarchy

The <propdeschd> element is specialized from <stentry>. It is defined in the reference module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<properties>`

A properties table describes the properties of a thing, such as an object, part, or category. Each property can include the type, value, and a description.

Usage information

A properties table typically is represented as a simple table with a maximum of three columns. The first column is for the property type, the second column can contain a value or values for the property, and the third column can contain a description.

An optional header row can provide labels for the columns, if an author does not want to use the default labels that might be provided by stylesheets.

Rendering expectations

If a properties table does not contain a header row, processors typically auto-generate labels for the columns in the properties table. The text for the labels is specified in stylesheets.

Specialization hierarchy

The <properties> element is specialized from <simpletable>. It is defined in the reference module.

Attributes

The following attributes are available on this element: universal attributes, display attributes, and simpletable attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@expanse (display attributes)

Specifies the horizontal placement of the element. The following values are valid:

column: Indicates that the element is aligned with the current column margin.
page: Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread: Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline: Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@frame (display attributes)

Specifies which portion of a border surrounds the element. The following values are valid:

all: Indicates that a line is rendered at the top, bottom, left, and right of the containing element.

bottom: Indicates that a line is rendered at the bottom of the containing element.

none: Indicates that no lines are rendered.

sides: Indicates that a line is rendered at the left and right of the containing element.

top: Indicates that a line is rendered at the top of the containing element.
topbot: Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@height

@keycol (simpletable attributes)

Specifies the column that contains the content that represents the key to the tabular structure. If @keycol is present and assigned a numerical value, the specified column is treated as a vertical header.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@relcolwidth (simpletable attributes)

Specifies the width of each column in relationship to the width of the other columns. The value is a space-separated list of relative column widths. Each column width is specified as a positive integer or decimal number followed by an asterisk character.

For example, the value relcolwidth="1* 2* 3*" gives a total of 6 units across three columns. The relative widths are 1/6, 2/6, and 3/6 (16.7%, 33.3%, and 50%). Similarly, the value relcolwidth="90* 150*" causes relative widths of 90/240 and 150/240 (37.5% and 62.5%).

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

Specifies the percentage by which fonts are resized in relation to the normal text size. The value of this attribute is a positive integer. When used on <table> or <simpletable>, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

If the @scale attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the <image> element.

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Examples

This section is non-normative.

This section contains examples of how the <properties> element can be used.

Example 2. Properties table with spanned cells

`<property>`

The <property> element represents a single property in a properties table.

Specialization hierarchy

The <property> element is specialized from <strow>. It is defined in the reference module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<prophead>`

The <prophead> element contains elements that provide labels for the columns in a properties table.

Rendering expectations

If a properties table does not contain a header row, processors typically auto-generate labels for the columns in the properties table. The text for the labels is specified in stylesheets.

Specialization hierarchy

The <prophead> element is specialized from <sthead>. It is defined in the reference module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<proptype>`

The <proptype> element contains content that describes the type of the property.

Specialization hierarchy

The <proptype> element is specialized from <stentry>. It is defined in the reference module.

Attributes

The following attributes are available on this element: table accessibility attributes, universal attributes, and the attribute defined below.

@rowspan: Specifies the number of rows that a cell is to span inside a simple table.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<proptypehd>`

The <proptypehd> element provides a label for the type column in a properties table.

Specialization hierarchy

The <proptypehd> element is specialized from <stentry>. It is defined in the reference module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<propvalue>`

The <propvalue> element contains content that indicates a value for the property type.

Specialization hierarchy

The <propvalue> element is specialized from <stentry>. It is defined in the reference module.

Attributes

The following attributes are available on this element: table accessibility attributes, universal attributes, and the attribute defined below.

@rowspan: Specifies the number of rows that a cell is to span inside a simple table.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<propvaluehd>`

The <propvaluehd> element provides a label for the value column in a properties table.

Specialization hierarchy

The <propvaluehd> element is specialized from <stentry>. It is defined in the reference module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<refbody>`

The <refbody> element contains the main content of a reference topic.

Specialization hierarchy

The <refbody> element is specialized from <body>. It is defined in the reference module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

See <reference>.

`<refbodydiv>`

The <refbodydiv> element provides a container for contiguous content in a reference topic. There is no additional semantic meaning.

Usage information

The <refbodydiv> element is useful primarily for reuse and as a specialization base.

Specialization hierarchy

The <refbodydiv> element is specialized from <bodydiv>. It is defined in the reference module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how a <refbodydiv> element can be used to group content for reuse

<reference id="sample-refbodydiv" xml:lang="en">
 <title>Sample for refbody</title>
 <shortdesc>This shows how refbodydiv might be used.</shortdesc>
 <refbody>
  <refbodydiv id="widget1">
   <section>This is one part of the sample</section>
   <refsyn>Syntax for this part</refsyn>
  </refbodydiv> 
  <refbodydiv id="widget2">
    <section>This is another part of the sample</section>
    <refsyn>Syntax for this part</refsyn>
  </refbodydiv>
 </refbody>
</reference>

`<reference>`

The <reference> element is the top-level element for a reference topic. A reference topic can include specialized sections for programming syntax and property tables, as well as standard sections, tables, and examples.

Usage information

For information about the purpose and content model of a reference topic, see Reference.

Specialization hierarchy

The <reference> element is specialized from <topic>. It is defined in the reference module.

Attributes

The following attributes are available on this element: architectural attributes and universal attributes.

For this element, the @id attribute is required.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@DITAArchVersion (architectural attributes)

@height

@id

For this element, the @id attribute is required.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@specializations (architectural attributes)

@props/audience @props/deliveryTarget
                @base/newBaseAtt

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how a reference topic can be used:

<reference id="requiredTools">
  <title>Tools required to maintain Acme machinery</title>
  <refbody>
    <section>
      <title>Small tools</title>
      <ul>
        <li>Hard hat</li>
        <li>Hammer</li>
        <li>Nail</li>
        <li>Metal polish</li>
        <!-- .... -->
      </ul>
    </section>
    <section>
      <title>Expensive tools</title>
      <!-- .... -->
    </section>
  </refbody>
</reference>

`<refsyn>`

The <refsyn> element contains content that describes the syntax of a command.

Specialization hierarchy

The <refsyn> element is specialized from <section>. It is defined in the reference module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <refsyn> element can be used to document the syntax for the Windows mkdir command:

<refsyn>
  <title>Syntax</title>
  <codeblock>mkdir <varname>drive</varname> <varname>directory</varname></codeblock>
  <parml>
    <plentry>
      <pt><varname>drive</varname></pt>
      <pd>Specifies the drive on which the new directory is created. This is an optional
          parameter.</pd>
    </plentry>
    <plentry>
      <pt><varname>path</varname></pt>
      <pd>Specifies the fully-qualified name of the new directory. This is a required
          parameter.</pd>
    </plentry>
  </parml>
</refsyn>

Task elements

Task elements provide the fundamental structure for task topics. The task topic includes sections for describing the context, prerequisites, actual steps, expected results, troubleshooting, example, and expected next steps for a task.

`<chdesc>`

The <chdesc> element provides the content of the second cell in a choice table row. This content describes the option that people can take to complete the step, and it explains the result of the choice, if it is not immediately obvious.

Specialization hierarchy

The <chdesc> element is specialized from <stentry>. It is defined in the task module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<chdeschd>`

The <chdeschd> element provides a label for the second column in a choice table.

Rendering expectations

The contents of the <chdeschd> element is typically rendered in a bold font.

Specialization hierarchy

The <chdeschd> element is specialized from <stentry>. It is defined in the task module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<chhead>`

The <chhead> element contains elements that provide labels for the columns in a choice table.

Rendering expectations

Labels provided by the <chhead> element override any default headings for the <choicetable> that might be provided by stylesheets.

Specialization hierarchy

The <chhead> element is specialized from <sthead>. It is defined in the task module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<choice>`

A <choice> element describes a way to complete the current step.

Specialization hierarchy

The <choice> element is specialized from <li>. It is defined in the task module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

See <choices>

`<choices>`

The <choices> element contains a list of choices. Each choice represents a way to complete the current step.

Usage information

The <choices> element provides information when there is more than one way to complete a step. It is a list.

Specialization hierarchy

The <choices> element is specialized from <ul>. It is defined in the task module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

The following code sample shows how the <choices> element can be used when different operating systems have different keyboard shortcuts. In this scenario, flagging is used to render labels for the different operating systems.

<step>
  <cmd>To edit the attributes, select the element and press the
       applicable keyboard shortcut for your operating system:</cmd>
  <choices>
    <choice platform="mac-os"><uicontrol>option + return</uicontrol></choice>
    <choice platform="windows"><uicontrol>Alt + Enter</uicontrol></choice>
  </choices>
  <stepresult>The <wintitle>Attributes</wintitle> view is displayed.</stepresult>
</step>

The rendered output might look like the following:

`<choicetable>`

A choice table provides information about a set of options for completing a step.

Usage information

A choice table provides information when there is more than one way to complete a step. It is a simple table with two columns. The first cell in a row labels the option, and the second cell in the row describes the option that a user can take to complete the step.

An optional header row can provide labels for the columns, if an author does not want to use the default labels that might be provided by stylesheets.

Rendering expectations

If a choice table does not contain a header row, processors typically auto-generate labels for the columns in the choice table. The text for the labels is specified in stylesheets.

Specialization hierarchy

The <choicetable> element is specialized from <simpletable>. It is defined in the task module.

Attributes

The following attributes are available on this element: universal attributes, display attributes, and simpletable attributes.

For this element, the @keycol attribute has a default value of 1.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@expanse (display attributes)

Specifies the horizontal placement of the element. The following values are valid:

column: Indicates that the element is aligned with the current column margin.
page: Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
spread: Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
textline: Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

For <table>, in place of the @expanse attribute that is used by other DITA elements, the @pgwide attribute is used in order to conform to the OASIS Exchange Table Model.

Some processors or output formats might not support all values.

@frame (display attributes)

Specifies which portion of a border surrounds the element. The following values are valid:

all: Indicates that a line is rendered at the top, bottom, left, and right of the containing element.

bottom: Indicates that a line is rendered at the bottom of the containing element.

none: Indicates that no lines are rendered.

sides: Indicates that a line is rendered at the left and right of the containing element.

top: Indicates that a line is rendered at the top of the containing element.
topbot: Indicates that a line is rendered at the top and bottom of the containing element.
-dita-use-conref-target: See Using the -dita-use-conref-target value for more information.

Some processors or output formats might not support all values.

@height

@keycol (simpletable attributes)

For this element, the @keycol attribute has a default value of 1.

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@relcolwidth (simpletable attributes)

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

This attribute is primarily useful for print-oriented display. Some processors might not support all values.

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Examples

This section is non-normative.

This section contains examples of how the <choicetable> element can be used.

Example 4. Choice table with a header row

`<choption>`

The <choption> element contains the content of the first cell in a choice table row. This content labels the option that people can take to complete the step.

Rendering expectations

Unless the @keycol attribute on the <choicetable> element is set to 0, the contents of the <choiceoption> element is typically rendered in a bold font.

Specialization hierarchy

The <choption> element is specialized from <stentry>. It is defined in the task module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<choptionhd>`

The <choptionhd> element provides a label for the first column in a choice table.

Rendering expectations

The contents of the <chdeschd> element is typically rendered in a bold font.

Specialization hierarchy

The <choptionhd> element is specialized from <stentry>. It is defined in the task module.

Attributes

The following attributes are available on this element: table accessibility attributes and universal attributes

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@headers

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@scope (link-relationship attributes)

Specifies the closeness of the relationship between the current document and the referenced resource. The following values are valid: local, peer, external, and -dita-use-conref-target.

See STUB CONTENT for detailed information on supported values and processing implications.

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.

`<chrow>`

The <chrow> element represents a row in a choice table. It contains a pair of elements: <choption> and <chdesc>.

Specialization hierarchy

The <chrow> element is specialized from <strow>. It is defined in the task module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes and the attributes defined below.

@align

Controls the horizontal alignment of an image when @placement is specified as break. Common values include left, right, and center.

@height

@othertype

Specifies an alternate note type. This value is used as the user-provided note label when the @type attribute value is set to other.

@placement

Indicates whether an image is displayed inline or on a separate line. The default value is inline. Allowable values are inline, break, and "-dita-use-conref-target".

@rowspan

Specifies the number of rows that a cell is to span inside a simple table.

@scale

@scalefit

@type

Specifies the type of a note. This differs from the @type attribute on many other DITA elements. The following are the allowable values:

attention
caution
danger
important
note
notice
other
remember
restriction
tip
trouble
warning
-dita-use-conref-target

@width

Example

This section is non-normative.