3.4. Admonitions

3.4. Admonitions
Prev	Chapter 3. Fedora Documentation Guidelines	Next

There are five types of admonitions in DocBook: caution, important, note, tip, and warning. All of the admonitions have the same structure: an optional title followed by paragraph-level elements. The DocBook DTD does not impose any specific semantics on the individual admonitions. For example, DocBook does not mandate that a warning is reserved for cases where bodily harm can result.

3.4.1. Creating a `note`, `tip`, `caution`, `important`, or `warning`

There are several ways to bring attention to text within a document. A note is used to bring additional information to the users' attention. A tip is used to show the user helpful information or another way to do something. A caution is used to show the user they must be careful when attempting a certain step. An important tag set can be used to show the user a piece of information that should not be overlooked. While this information may not change anything the user is doing, it should show the user that this piece of information could be vital. A warning is used to show the reader that their current setup will change or be altered, such as files being removed, and they should not choose this operation unless they are alright with the consequences.

The following lines of code show the basic setup for each case mentioned above, along with its appearance in HTML.

<note>
  <title>Note</title>
  <para>Body of text goes here.</para>
</note>

	Note
	Body of text goes here.

<tip>
  <title>Tip</title>
  <para>Body of text goes here.</para>
</tip>

	Tip
	Body of text goes here

<caution>
  <title>Caution</title>
  <para>Body of text goes here.</para>
</caution>

	Caution
	Body of text goes here.

<important>
  <title>Important</title>
  <para>Body of text goes here.</para>
</important>

	Important
	Body of text goes here.

<warning>
  <title>Warning</title>
  <para>Body of text goes here.</para>
</warning>

	Warning
	Body of text goes here.

Prev	Up	Next
3.3. XML Tags	Home	3.5. Screenshots

3.4. Admonitions

3.4.1. Creating a note, tip, caution, important, or warning

3.4.1. Creating a `note`, `tip`, `caution`, `important`, or `warning`