sidebar
sidebar — A portion of a document that is isolated from the main narrative flow.
Synopsis
sidebar ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Sequence of:
- One of:
- One or more of:
bridgeheaddialoguedramapoetryremarkrevhistory- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
- List elements
- Paragraph elements
- Publishing elements
- Technical elements
- Verbatim elements
- One of:
Attributes
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
Attributes
Common attributes and common linking attributes.
- floatstyle
Specifies style information to be used when rendering the float
Parents
These elements contain sidebar: acknowledgements, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption, chapter, colophon, cover, dedication, dialogue, drama, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, index, informalexample, informalfigure, itemizedlist, legalnotice, linegroup, listitem, note, orderedlist, para, partintro, poetry, preface, procedure, qandadiv, qandaset, question, revdescription, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, textobject, toc, variablelist.
Children
The following elements occur in sidebar: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, 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, title, titleabbrev, variablelist.
See Also
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>