informalexample

informalexample — A displayed example without a title.

Synopsis

informalexample ::=

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • floatstyle
  • type
  • At most one of:
    • width (nonNegativeInteger)
    • pgwide (enumeration)
      • “0”
      • “1”

Additional Constraints

  • If this element is the root element, it must have a version attribute.

Description

An informalexample is a wrapper for an example without a title. Examples often contain programlistings or other large block elements.

Processing expectations

Formatted as a displayed block.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

floatstyle

Specifies style information to be used when rendering the float

pgwide

Indicates if the element is rendered across the column or the page

Enumerated values:
“0”

The element should be rendered in the current text flow (with the flow column width).

“1”

The element should be rendered across the full text page.

type

Identifies the type of example

width

Specifies the width (in characters) of the element

Parents

These elements contain informalexample: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, cover, danger, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, meta (db.meta.content), msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.

Children

The following elements occur in informalexample: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caption (db.caption), caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, 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, typedefsynopsis, unionsynopsis, variablelist, warning.

See Also

Related elements: equation, example, figure, informalequation, informalfigure, informaltable, table.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example informalexample</title>
   | 
   |<informalexample>
 5 |<programlisting>
   |sub print_content_model {
   |    my($self) = shift;
   |    local($_) = shift;
   |    local(*FILE) = shift;
10 | 
   |    my(@cm) = $self->format_content_model2($_);
   |    foreach $_ (@cm) {
   |        print FILE $self->make_links($_, 1, 1), "\n";
   |    }
15 |}
   |</programlisting>
   |</informalexample>
   | 
   |</article>

 1 | 
   |sub print_content_model {
   |    my($self) = shift;
   |    local($_) = shift;
 5 |    local(*FILE) = shift;
   | 
   |    my(@cm) = $self->format_content_model2($_);
   |    foreach $_ (@cm) {
   |        print FILE $self->make_links($_, 1, 1), "\n";
10 |    }
   |}