    | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
| | DocBook: The Definitive Guide 0.0.12 for DocBook V5.0b1 (Alpha) |
sidebar — A portion of a document that is isolated from the main narrative flow
sidebar ::=
addressanchorannotationbibliolistblockquotebridgeheadcalloutlistcautionclasssynopsiscmdsynopsisconstraintdefconstructorsynopsisdestructorsynopsisepigraphequationexamplefieldsynopsisfigureformalparafuncsynopsisglosslisthtml:formimportantindexterm (db.indexterm.endofrange)indexterm (db.indexterm.singular)indexterm (db.indexterm.startofrange)informalequationinformalexampleinformalfigureinformaltable (db.cals.informaltable)informaltable (db.html.informaltable)itemizedlistliterallayoutmediaobjectmethodsynopsismsgsetnoteorderedlistparaprocedureproductionsetprogramlistingprogramlistingcoqandasetremarkrevhistoryscreenscreencoscreenshotsegmentedlistsidebarsimparasimplelistsynopsistable (db.cals.table)table (db.html.table)tasktipvariablelistwarningA 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.
Formatted as a displayed block.
Sidebars are sometimes boxed.
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.
These elements contain sidebar: annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.
The following elements occur in sidebar: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, html:form, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, mediaobject, methodsynopsis, msgset, note, orderedlist, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, variablelist, warning.
<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>
| | | |
| shortcut | | simpara |