Special Elements

These elements provide a variety of information ranging from warnings that the reader should not neglect to supplementary information and tips that will simply enhance their reading experience.

Tip Used to point out helpful ideas, some not-so-obvious features, quick or alternate ways to get a particular job done, and techniques you might not discover by yourself. The Tip List special element is used when multiple tips are used.

Note: Used to highlight certain information for the reader. Generally, the Note

element provides additional information on the current topic. The Notes: special element is used when multiple notes are required.

Important:

Used for information that is considered more pertinent to the reader than information presented in Note elements.

Caution:

Used as a hazard light in documents. Information included in a Caution element could save the reader from hours of lost work.

Document Conventions

11

Page 14
Image 14
Nvidia FreeBSD Server to FreeBSD v2 Server manual Special Elements