Skip to main content
The NCI Community Hub will be retiring in May 2024. For more information please visit the NCIHub Retirement Page:https://ncihub.cancer.gov/groups/ncihubshutdown/overview
close

Help: Admonitions

Search

Search pages

Wiki

Tools

Version
by (unknown)
Version 2
by (unknown)

Deletions or items before changed

Additions or items after changed

1 -
 
 +
Admonitions are used to make some text stand out or to point out something which doesn't fit in the normal flow of the text.
2 +
3 +
There are five different admonitions currently supported by the Modern theme. They are warning, caution, important, note and tip. Below is an example of the caution admonition.
4 +
5 +
{{{
6 +
{{{#!wiki caution
7 +
'''Don't overuse admonitions'''
8 +
9 +
Admonitions should be used with care. A page riddled with admonitions will look restless and will be harder to follow then a page where admonitions are used sparingly.
10 +
}}}
11 +
}}}
12 +
13 +
{{{#!wiki caution
14 +
'''Don't overuse admonitions'''
15 +
16 +
Admonitions should be used with care. A page riddled with admonitions will look restless and will be harder to follow then a page where admonitions are used sparingly.
17 +
}}}
18 +
19 +
The other admonition styles are:
20 +
21 +
{{{#!wiki warning
22 +
'''Warning'''
23 +
24 +
Use warnings when there is a risk of bodily harm or dataloss.
25 +
}}}
26 +
27 +
{{{#!wiki important
28 +
'''Important'''
29 +
30 +
Remember that in the new wiki-syntax the terminating `} }}` need to be on a separate line.
31 +
}}}
32 +
33 +
{{{#!wiki note
34 +
'''Note'''
35 +
36 +
You can use normal ''markup'' and [HelpOnAdmonitions links] in the admonition.
37 +
}}}
38 +
39 +
{{{#!wiki tip
40 +
'''Tip'''
41 +
42 +
For syntax examples, please read the raw source markup of this page.
43 +
}}}