Name
tip — A suggestion to the user, set off from the text
Synopsis
tip ::=
((((title
? &
titleabbrev
?),
info
? db.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)+)
Attribute synopsis
Additional constraints
caution
must not occur among the children or descendants oftip
.important
must not occur among the children or descendants oftip
.note
must not occur among the children or descendants oftip
.tip
must not occur among the children or descendants oftip
.warning
must not occur among the children or descendants oftip
.
Description
A tip
is an admonition set off from the main
text.
In some types of documentation, the semantics of admonitions are
clearly defined (caution
might imply the possibility
of harm to equipment whereas warning
might imply harm
to a person), but DocBook makes no such assertions.
Processing expectations
Formatted as a displayed block. Often outputs the generated text
“Tip” 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
caution
, important
, note
, warning
Examples
<article xmlns='http://docbook.org/ns/docbook'> <title>Example tip</title> <tip> <para>If ...
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.