O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

example — A formal example, with a title

Synopsis

example ::= ((((title & titleabbrev?), infodb.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)+, captiondb.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 of example.

  • figure must not occur among the children or descendants of example.

  • table must not occur among the children or descendants of example.

  • equation must not occur among the children or descendants of example.

  • caution must not occur among the children or descendants of example.

  • important must not occur among the children or descendants of example.

  • note must not occur among the children or descendants of example.

  • tip must not occur among the children or descendants of example.

  • warning must not occur among the children or descendants of example.

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. ...

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required