Name
example — A formal example, with a title
Synopsis
example ::=
((((title &
titleabbrev?),
info? db.titleforbidden.info) |
info db.titleonlyreq.info),
(annotation | bridgehead |
remark | revhistory | Indexing inlines | Admonition elements | Formal elements | Graphic elements | Informal elements | List elements | Paragraph elements | Publishing elements | Synopsis elements | Technical elements | Verbatim elements)+,
caption? db.caption)
Attribute synopsis
Common attributes and common linking attributes.
Additional attributes:
floatstyle
label
At most one of:
width (nonNegativeInteger)
pgwide (enumeration) = “0” | “1”
Additional constraints
examplemust not occur among the children or descendants ofexample.figuremust not occur among the children or descendants ofexample.tablemust not occur among the children or descendants ofexample.equationmust not occur among the children or descendants ofexample.cautionmust not occur among the children or descendants ofexample.importantmust not occur among the children or descendants ofexample.notemust not occur among the children or descendants ofexample.tipmust not occur among the children or descendants ofexample.warningmust not occur among the children or descendants ofexample.
Description
An example is a formal example with a title.
Examples often contain programlistings or other large
block elements. Frequently, they are given xml:ids and referenced from the text with
xref or link.
Processing expectations
Formatted as a displayed block.
DocBook does not specify the location of the example within the final displayed flow of text; it may float or remain where it is located.
A list of examples may be generated at the beginning of a document.
If a label is specified,
that label will be used for identifying the example and in generated
cross-references. If unspecified, examples are
often, but not always, numbered.
If a width is specified,
formatters may use this value to determine scaling or rotation.
Attributes
Common attributes and common linking attributes.
- floatstyle
Specifies style information to be used when rendering the float
- label
Specifies an identifying string for presentation purposes
- 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.
- width
Specifies the width (in characters) of the element
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example example</title>
<example xml:id="ex.dssslfunction">
<title>A DSSSL Function</title>
<programlisting>
(define (node-list-filter-by-gi nodelist gilist)
;; Returns the node-list that contains every element of the original
;; nodelist whose gi is in gilist
(let loop ((result (empty-node-list)) (nl nodelist))
(if (node-list-empty? nl)
result
(if (member (gi (node-list-first nl)) gilist)
(loop (node-list result (node-list-first nl))
(node-list-rest nl))
(loop result (node-list-rest nl))))))
</programlisting>
</example>
</article>