Template:Admon/tip/doc

This is a documentation subpage for Template:Admon/tip.
It contains usage information, categories and other content that is not part of the original template page.

Usage

{{Admon/tip}} creates an information box with a custom text denoting that something is to be considered as a tip/help text. The box will show at the position on the page where you put the template.

To use the template, type {{Admon/tip|text}}.

Parameters

There is only one parameter, the custom text.

Custom text

The text inside the box can be formatted using wiki-code.

Header

The first line of the box's textual part functions as the header, and is automatically formatted as bold text. Any text wiki-formatted to show in bold will be inverted (i.e. show as plain text). If you don't want to use a header, start the custom text part with an empty line.

Body text

The lines beneath the first line are not pre-formatted.

Examples

Only header

The string

{{Admon/tip|The first line is automatically formatted as bold text.}}

will show as

The first line is automatically formatted as bold text.

No header

The string

{{Admon/tip|
This is shown as plain text.}}

will show as

This is shown as plain text.

Text with header

The string

{{Admon/tip|This is the header


This is the body text.}}

will show as

This is the header

This is the body text.

Wiki-coding

The string

{{Admon/tip|''Wiki-formatting'' for '''bold text''' is inverted in the '''''header'''''
The ''other rows'', however, '''behave as''' you are '''''used to'''''. <br />
You can use wiki-code to, e.g.
[[link to stuff]],
* list things,
make text <small>small</small> or <big>big</big>,
 and include pre-format boxes.
You can also


insert empty rows.}}

will show as

Wiki-formatting for bold text is inverted in the header

The other rows, however, behave as you are used to.
You can use wiki-code to, e.g. link to stuff,

• list things,

make text small or big,

and include pre-format boxes.

You can also

insert empty rows.

See also

• {{Admon/caution}}
• {{Admon/important}}
• {{Admon/note}}