sidebar

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

Synopsis

sidebar ::=

Sequence of:
- One of:
  - Sequence of:
    - Interleave of:
    - info? (db.titleforbidden.info)
  - info? (db.info)
- One or more of:
  - empty
  - empty
  - revhistory
  - speakernotes
  - Admonition elements
    note
  - Formal elements
    example
    figure
    table (db.cals.table)
    table (db.html.table)
  - Graphic elements
    mediaobject
  - Informal elements
    informaltable (db.cals.informaltable)
    informaltable (db.html.informaltable)
  - List elements
    itemizedlist
    orderedlist
    variablelist
  - Paragraph elements
    para
  - Publishing elements
    blockquote
    epigraph
    sidebar
  - Verbatim elements
    literallayout
    programlisting

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

Parents

These elements contain sidebar: abstract, bibliodiv, bibliography, blockquote, caption (db.caption), entry, example, figure, foil, foilgroup, footnote, itemizedlist, legalnotice, listitem, note, orderedlist, revdescription, section, sidebar, slides, speakernotes, td, textobject, th, variablelist.

Children

The following elements occur in sidebar: blockquote, epigraph, example, figure, info (db.info), info (db.titleforbidden.info), informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, note, orderedlist, para, programlisting, revhistory, sidebar, speakernotes, subtitle, table (db.cals.table), table (db.html.table), title, titleabbrev, variablelist.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example sidebar</title>
   | 
   |<section><title>An Example Section</title>
 5 | 
   |<para>Some narrative text.
   |</para>
   | 
   |<sidebar><title>A Sidebar</title>
10 |<para>Sidebar content.
   |</para>
   |</sidebar>
   | 
   |<para>The continuing flow of the narrative text, as if the
15 |sidebar was not present.
   |</para>
   | 
   |</section>
   | 
20 |</article>