Home Prev Up NextDocBook 5: The Definitive Guide (Version 1.0.4 for DocBook V5.0)

sidebar

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

Synopsis

Attributes

Common attributes and common linking attributes.

Additional Constraints

  • sidebar must not occur in the 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.

Parents [+]

This element occurs in 73 elements.

Children [+]

This element contains 63 elements.

See Also

abstract, blockquote, epigraph

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example sidebar</title>
    
  4 <section><title>An Example Section</title>
    
  6 <para>Some narrative text.
    </para>
  8 
    <sidebar><title>A Sidebar</title>
 10 <para>Sidebar content.
    </para>
 12 </sidebar>
    
 14 <para>The continuing flow of the narrative text, as if the
    sidebar was not present.
 16 </para>
    
 18 </section>
    
 20 </article>
Prev Home Next
shortcut Up simpara
Last revised by Norman Walsh on 6 Jun 2011 (git hash: 6ffcc7640bbc5f852a318e452c9f210f03292cb9)

Copyright © 2010, 2011 Norman Walsh.