tip

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

Synopsis

Additional Constraints

  • caution must not occur in the descendants of tip
  • important must not occur in the descendants of tip
  • note must not occur in the descendants of tip
  • tip must not occur in the descendants of tip
  • warning must not occur in the descendants of tip

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

ChangeLog

This alpha reference page is $Revision: 1.4 $ published $Date: 2005/10/31 12:31:57 $.