Difference between revisions of "Template:Example/doc"

From EVE University Wiki
Jump to: navigation, search
m (Rewrite doc.)
m (Add the actual syntax.)
 
Line 7: Line 7:
  
 
; Syntax
 
; Syntax
 +
: {{T|Example|content|3= width= width}}
 
:; Parameters
 
:; Parameters
 
::; content : The note text inside the box. All wiki-formatting (bold, text color, links, etc) work as normal. If the text you would like to use include an equals sign (<code>=</code>), you need to explicitly declare your text as a numbered parameter (i.e. put <code>1=</code> before your text), otherwise the template will display nothing.
 
::; content : The note text inside the box. All wiki-formatting (bold, text color, links, etc) work as normal. If the text you would like to use include an equals sign (<code>=</code>), you need to explicitly declare your text as a numbered parameter (i.e. put <code>1=</code> before your text), otherwise the template will display nothing.

Latest revision as of 12:24, 14 March 2024

Description
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 (e.g. 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}}).
Dependencies
Uses
{{Color box}}
Syntax
{{Example|<content>|<width= width>}}
Parameters
content
The note text inside the box. All wiki-formatting (bold, text color, links, etc) work as normal. 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 text), otherwise the template will display nothing.
width
Sets the width of the box. It's recommended to set this as a percentage (of the paragraph width), so 50% will produce a text box half as wide as the surrounding paragraph. If omitted, the text box will be as wide as the surrounding paragraph. When width is set to less than 100%, the box will be centered.
Examples
{{Example|An example to ''illustrate'' my article with a link to the [[Venture]].}}

gives ...

An example to illustrate my article with a link to the Venture.


{{Example|How not to put the formula 2+2=4 into an example.}}

gives ...

An example!


{{Example|1= How to put the formula 2+2=4 into an example.}}

gives ...

How to put the formula 2+2=4 into an example.


See also