example

example — A formal example, with a title

Synopsis

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • floatstyle
  • label
  • width

Additional Constraints

  • example must not occur in the descendants of example
  • figure must not occur in the descendants of example
  • table must not occur in the descendants of example
  • table must not occur in the descendants of example
  • caution must not occur in the descendants of example
  • important must not occur in the descendants of example
  • note must not occur in the descendants of example
  • tip must not occur in the descendants of example
  • warning must not occur in the descendants of example

Description

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.

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.

Attributes

Common attributes and common linking attributes.

floatstyle

Specifies style information to be used when rendering the float

label

FIXME:

width

FIXME:

See Also

equation, figure, informalequation, informalexample, informalfigure, informaltable, table

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>

Example 9. 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))))))

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:54 $.