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

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

Children

The following elements occur in sidebar: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, caution, danger, db:stagedir, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.info), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandaset, remark, revhistory, sidebar, simpara, simplelist, subtitle, table, task, tip, title, titleabbrev, variablelist, warning.

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>
Last revised by Norman Walsh on (git hash: c3457cab689d8fd89ba4252de204cf9a14e40acd 6a501344525f32f9834f0e4a5c3c3f8131803fa4 47fe34b28bad7941a61b9c1c17d47f6eed36cd04)