DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

sidebar

sidebar — A portion of a document that is isolated from the main narrative flow.

Synopsis

sidebar ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • floatstyle

Additional Constraints

  • sidebar must not occur among the children or descendants of sidebar
  • If this element is the root element, it must have a version attribute.

Description

A sidebar is a short piece of text, rarely longer than a single column or page, that is presented outside the narrative flow of the main text.

Sidebars are often used for digressions or interesting observations that are related, but not directly relevant, to the main text.

Processing expectations

Formatted as a displayed block. Sometimes sidebars are boxed or shaded.

DocBook does not specify the location of the sidebar within the final displayed flow of text. The wrapper may float or remain where it is located.

Attributes

Common attributes and common linking attributes.

floatstyle

Specifies style information to be used when rendering the float

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example sidebar</title>

<section><title>An Example Section</title>

<para>Some narrative text.
</para>

<sidebar><title>A Sidebar</title>
<para>Sidebar content.
</para>
</sidebar>

<para>The continuing flow of the narrative text, as if the
sidebar was not present.
</para>

</section>

</article>