Access Keys:
Skip to content (Access Key - 0)

Q: How do I add tip, note, info, and warning boxes to articles?

Answer

Tip, note, warning, and info boxes are specified by wiki markup. Simply put the {note}, {tip}, {warning}, or {info} markup tag on each side of the text you want included in the box. In the examples below you can see the wiki markup and the resulting box it creates.

Example tip wiki markup:

{tip} *Tip:* Save early and often when creating and editing articles.  If your browser crashes 
or you accidentally navigate away from a page you could lose data.
{tip}

Resulting tip:

Tip: Save early and often when creating and editing articles. If your browser crashes or you accidentally navigate away from a page you could lose data.

Example note wiki markup:

{note} *Note:* The Knowledge Base is a shared resource.  Other authors may edit your articles.  You 
can track changes to articles you create by putting a watch on them.  For more information 
about watches, see [handbook:Watching Articles].  
{note}

Resulting note:

Note: The Knowledge Base is a shared resource. Other authors may edit your articles. You can track changes to articles you create by putting a watch on them. For more information about watches, see Watching Articles.

Example warning wiki markup:

{warning} *Warning/Important:* Do not delete Knowledge Base articles.  Deleted articles can not 
be restored.  Instead move outdated articles to the Archive space.  They won't be accessible 
by customers viewing the Knowledge Base, but they can be restored or reviewed later if the information 
is needed for historical reasons or somebody is running an outdated configuration.  For 
more information on moving articles between spaces, see [handbook:How do I move a Knowledge Base 
article to a different space?]
{warning}

Resulting warning:

Warning/Important: Do not delete Knowledge Base articles. Deleted articles can not be restored. Instead move outdated articles to the Archive space. They won't be accessible by customers viewing the Knowledge Base, but they can be restored or reviewed later if the information is needed for historical reasons or somebody is running an outdated configuration. For more information on moving articles between spaces, see How do I move a Knowledge Base article to a different space?

Example info wiki markup:

{info:title=Title/Header}
These boxes are useful for highlighting key information in articles, but use them sparingly.  Too many
colored boxes in an article makes it cluttered and hard to read.
{info}

Resulting info:

Title/Header
These boxes are useful for highlighting key information in articles, but use them sparingly. Too many
colored boxes in an article makes it cluttered and hard to read.

The K.B. Handbook

Documentation and information about using The Knowledge Base


Last Modified:

April 22, 2015

Get Help

Request help
from the Help Desk
Report a security incident
to the Security Team
Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.
Feedback
This product/service is:
Easy to use
Average
Difficult to use

This article is:
Helpful
Inaccurate
Obsolete
Adaptavist Theme Builder (4.2.3) Powered by Atlassian Confluence 3.5.13, the Enterprise Wiki