Difference between revisions of "Template:Example"
(Update formatting to make it more subtle and better suited for its purpose (for a template similar to the previous iteration, use Template:Note box)) |
m (Oops - no it isn't! :)) |
||
Line 1: | Line 1: | ||
<div style="background-color:#161626; border: 1px solid #6666a8; padding:0.8em; text-align:left; color:#ffffff; overflow:hidden; font-size:90%;">{{{1|An example!}}}</div><noinclude> | <div style="background-color:#161626; border: 1px solid #6666a8; padding:0.8em; text-align:left; color:#ffffff; overflow:hidden; font-size:90%;">{{{1|An example!}}}</div><noinclude> | ||
== Documentation == | == Documentation == | ||
− | As the name suggests, this template produces a colored box, which is used when you want to give an example on a page. You can use common wiki-formatting (eg bold, links) if you wish | + | As the name suggests, this template produces a colored box, which is used when you want to give an example on a page. You can use common wiki-formatting (eg bold, links) if you wish. The formatting of this template is kept subtle on purpose, so as not to interfere too much with the general flow of a page (if you want a stronger emphasis for your text, you can use <code>{{t|note box}}</code> or even <code>{{t|important note box}}</code>). |
If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put <code>1=</code> before your example text), otherwise the template will display nothing. | If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put <code>1=</code> before your example text), otherwise the template will display nothing. | ||
Line 7: | Line 7: | ||
=== Examples === | === Examples === | ||
− | <code><nowiki>{{example|An example to | + | <code><nowiki>{{example|An example to ''illustrate'' my article with a link to the [[Venture]].}}</nowiki></code> gives: |
− | {{example|An example to | + | {{example|An example to ''illustrate'' my article with a link to the [[Venture]].}} |
<code><nowiki>{{example|How not to put the formula 2+2=4 into an example.}}</nowiki></code> gives: | <code><nowiki>{{example|How not to put the formula 2+2=4 into an example.}}</nowiki></code> gives: |
Revision as of 11:32, 20 May 2014
Documentation
As the name suggests, this template produces a colored box, which is used when you want to give an example on a page. You can use common wiki-formatting (eg bold, links) if you wish. The formatting of this template is kept subtle on purpose, so as not to interfere too much with the general flow of a page (if you want a stronger emphasis for your text, you can use {{note box}}
or even {{important note box}}
).
If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put 1=
before your example text), otherwise the template will display nothing.
Examples
{{example|An example to ''illustrate'' my article with a link to the [[Venture]].}}
gives:
{{example|How not to put the formula 2+2=4 into an example.}}
gives:
{{example|1=How to put the formula 2+2=4 into an example.}}
gives:
See also
{{note box}}
and{{important note box}}
, designed for general notes and warnings on pages.{{color box}}
, the general template for creating coloured boxes with text in them.