3,860
edits
Template:Admon/note/doc: Difference between revisions
no edit summary
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
__NOTOC__ | |||
==Usage== | |||
{{tl|Admon/note}} creates an information box with a custom text denoting that something is to be considered as a note/commentary text. The box will show at the position on the page where you put the template. | |||
To use the template, type <code><nowiki>{{Admon/note|text}}</nowiki></code>. | |||
==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== | ==Examples== | ||
===Only header=== | |||
The string | |||
<nowiki>{{Admon/note|The first line is automatically formatted as bold text.}}</nowiki> | |||
will show as | |||
{{Admon/note|The first line is automatically formatted as bold text.}} | |||
===No header=== | |||
The string | |||
<nowiki>{{Admon/note| | |||
This is shown as plain text.}}</nowiki> | |||
will show as | |||
{{Admon/note| | |||
This is shown as plain text.}} | |||
===Text with header=== | |||
The string | |||
<nowiki>{{Admon/note|This is the header | |||
This is the body text.}}</nowiki> | |||
will show as | |||
{{Admon/note|This is the header | |||
This is the body text.}} | |||
===Wiki-coding=== | |||
The string | |||
<nowiki>{{Admon/note|''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.}}</nowiki> | |||
will show as | |||
{{Admon/note|''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.}} | |||
==See also== | ==See also== | ||
* {{tl|Admon/caution}} | |||
* {{tl|Admon/important}} | |||
* {{tl|Admon/tip}} | |||