    | DocBook: The Definitive Guide 2.0.17 (Alpha) |
| | DocBook: The Definitive Guide 2.0.17 (Alpha) |
$Revision: 1666 $
$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $
example — A formal example, with a title
example ::= (blockinfo?, (%formalobject.title.content;), (%example.mix;)+)
Name | Type | Default |
| width | CDATA | None |
| floatstyle | CDATA | None |
| label | CDATA | None |
The following parameter entities contain example:
| Parameter Entities | ||
%admon.mix; | %bookcomponent.content; | %component.mix; |
%divcomponent.mix; | %formal.class; | %glossdef.mix; |
%para.mix; | %qandaset.mix; | %refcomponent.mix; |
%revdescription.mix; | %sidebar.mix; | |
Example is a formal example with a title. Examples often
contain ProgramListings or other large, block elements.
Frequently they are given IDs and referenced from the text with
XRef or Link.
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.
These elements contain example:
answer, appendix, article, bibliodiv, bibliography, blockquote, callout, caution, chapter, constraintdef, glossary, glossdef, glossdiv, important, index, listitem, msgexplan, msgtext, note, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, task, taskprerequisites, taskrelated, tasksummary, tip, warning.
The following elements occur in example:
address, beginpage, bibliolist, blockinfo, blockquote, calloutlist, classsynopsis, cmdsynopsis, constructorsynopsis, destructorsynopsis, fieldsynopsis, formalpara, funcsynopsis, glosslist, graphic, graphicco, indexterm, informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, mediaobjectco, methodsynopsis, orderedlist, para, procedure, programlisting, programlistingco, screen, screenco, screenshot, segmentedlist, simpara, simplelist, synopsis, title, titleabbrev, variablelist.
Label specifies an identifying string for presentation purposes.
Generally, an explicit Label attribute is
used only if the processing system is incapable of generating the label
automatically. If present, the Label
is normative; it will used even
if the processing system is capable of automatic labelling.
Width specifies the width (in characters)
of the longest line in this Example (formatters may use
this value to determine scaling or rotation).
<!DOCTYPE example PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<example><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>Example 31. A DSSSL Function
(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))))))
For additional examples, see also
remark.
| | | |
| errortype | | exceptionname |