tip

tip — A suggestion to the user, set off from the text.

Synopsis

tip ::= [-]

Additional Constraints

  • caution must not occur among the children or descendants of tip
  • important must not occur among the children or descendants of tip
  • note must not occur among the children or descendants of tip
  • tip must not occur among the children or descendants of tip
  • warning must not occur among the children or descendants of tip
  • If this element is the root element, it must have a version attribute.

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.

Examples

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

<tip>
<para>If you tie your shoelaces, you're less likely to trip and 
fall down.
</para>
</tip>

</article>

Tip

If you tie your shoelaces, you're less likely to trip and fall down.

Last revised by Norman Walsh on (git hash: 32232d73aaed8bf7134470f3f72f9e1dc6874d38 68abf83671c42c0ef5e0aed2f171edf1c3b1bdcd)