1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
|
<refentry id="sidebar.element">
<?dbhtml filename="sidebar.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>sidebar</secondary></indexterm>
<refentrytitle>sidebar</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sidebar</refname>
<refpurpose>&sidebar.purpose;</refpurpose>
</refnamediv>
&sidebar.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>
A <sgmltag>Sidebar</sgmltag> 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.
</para>
<para>
Sidebars are often used for digressions or interesting observations that
are related, but not directly relevant, to the main text.
</para>
<refsect2><title>Processing expectations</title>
<para>
&format.block; <sgmltag>Sidebar</sgmltag>s are sometimes boxed.
</para>
<para>
DocBook does not specify the location of the <sgmltag>Sidebar</sgmltag> within the
final displayed flow of text. The wrapper may float or remain where it is
located.
</para>
</refsect2>
&sidebar.parents.gen;
&sidebar.children.gen;
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
&sidebar.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>
<informalexample role="example-source">
<programlisting>&sidebar.example.1.txt;</programlisting>
</informalexample>
&sidebar.example.seealso.gen;
</refsect1>
</refentry>
|