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

caution — A note of caution

Synopsis

caution ::= ((((title? & titleabbrev?), infodb.titleforbidden.info) | info db.titleonly.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)+)

Additional constraints

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

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

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

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

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

Description

A caution is an admonition, usually set off from the main text.

In some types of documentation, the semantics of admonitions are clearly defined (a caution might imply the possibility of harm to equipment whereas a warning might imply harm to a person). However, DocBook makes no such assertions.

Processing expectations

Formatted as a displayed block. Often outputs the generated text Caution or some other visible indication of the type of admonition, especially if a title is not present. Sometimes outputs a graphical icon or other symbol as well.

See Also

important, note, tip, warning

Examples

<article xmlns='http://docbook.org/ns/docbook'> <title>Example caution</title> ...

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