sidebar
sidebar — A portion of a document that is isolated from the main narrative flow.
Synopsis
- Sequence of:
- One of:
- One or more of:
annotation
bridgehead
remark
revhistory
- Indexing inlines
- Admonition elements
- Formal elements
- Graphic elements
- Informal elements
informalequation
informalexample
informalfigure
informaltable
(db.cals.informaltable)informaltable
(db.html.informaltable)
- List elements
- Paragraph elements
- Publishing elements
- Synopsis elements
- Technical elements
- Verbatim elements
- One of:
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
sidebar
s 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
- floatstyle
Specifies style information to be used when rendering the float
This element occurs in 75 elements.
This element contains 64 elements.
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>