tip

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

Synopsis

tip ::=

Attributes

Common attributes and common linking attributes.

No additional attributes.

Additional Constraints

  • caution must not occur among the children or descendants of tip
  • danger 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.

Attributes

Common attributes and common linking attributes.

any attribute

Any attribute in any other explicit namespace

Parents

These elements contain tip: abstract, acknowledgements, annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, danger, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, meta (db.meta.content), msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, result, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, topic, variablelist, warning.

Children

The following elements occur in tip: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, typedefsynopsis, unionsynopsis, variablelist, warning.

See Also

Related elements: caution, important, note, warning.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<title>Example tip</title>
   | 
   |<tip>
 5 |<para>If you tie your shoelaces, you're less likely to trip and 
   |fall down.
   |</para>
   |</tip>
   | 
10 |</article>
☞
Tip

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