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
example
must not occur among the children or descendants ofexample
.figure
must not occur among the children or descendants ofexample
.table
must not occur among the children or descendants ofexample
.equation
must not occur among the children or descendants ofexample
.caution
must not occur among the children or descendants ofexample
.important
must not occur among the children or descendants ofexample
.note
must not occur among the children or descendants ofexample
.tip
must not occur among the children or descendants ofexample
.warning
must not occur among the children or descendants ofexample
.
Description
An example
is a formal example with a title.
Examples often contain programlisting
s or other large
block elements. Frequently, they are given xml:id
s and referenced from the text with
xref
or link
.
Processing expectations
Formatted as a displayed block. ...
Get DocBook 5: The Definitive Guide now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.