Difference between revisions of "Template:Note"

From SoftMC-Wiki
Jump to: navigation, search
m (Draft)
(OK)
Line 11: Line 11:
 
{{Template
 
{{Template
 
|description=
 
|description=
This is the base template for all safety notes.  
+
When used directly, this template produces an information note.
It is not meant to be used directly.
+
 
Instead please use one of the templates in the [[:Category:Template:Notes]].
+
To produce specialized safety notes, this can be used as base template. Therefore the icon and the title have to be specified.  
 +
 
 +
{{Note|The [[:Category:Template:Notes]] gives an overview of all note templates.}}
  
 
|template=
 
|template=
 
<nowiki>
 
<nowiki>
{{Note
+
{{Note|text
 
|icon=
 
|icon=
 
|title=
 
|title=
|text
 
 
}}
 
}}
 
</nowiki>
 
</nowiki>
  
 
|parameters=
 
|parameters=
;icon
 
: Icon in the File: namespace.
 
;title
 
: The bold title over the note.
 
 
;text
 
;text
 
: The actual note text.
 
: The actual note text.
 +
;icon (optional)
 +
: Icon in the File: namespace. If not set, [[:File:NOTE-Info.svg]] is used.
 +
;title (optional)
 +
: The bold title over the note. If not set, '''NOTE''' is used.
  
 
|examples=
 
|examples=
In this way this template should be used in all specialized sub-templates:
+
For simple usage:
<pre>
+
;Input
{{Note
+
<pre>{{Note|watch your head!}}</pre>
|icon=File:Note-Danger.svg
+
;Output
|title=Danger
+
{{Note|watch your head!}}
|text={{{1}}}
 
}}
 
</pre>
 
  
{{Note|watch your head!}}
 
  
{{Note|Your Text
+
In specialized sub-templates the following syntax should be used:
|icon=File:DANGER.svg
+
<pre>
 +
{{Note|{{{1}}}
 +
|icon=File:DANGER-Electricity.svg
 
|title=DANGER
 
|title=DANGER
 
}}
 
}}
 
+
</pre>
 
 
  
 
}}
 
}}

Revision as of 12:05, 19 October 2010

When used directly, this template produces an information note.

To produce specialized safety notes, this can be used as base template. Therefore the icon and the title have to be specified.

NOTE-Info.svgNOTE
The Category:Template:Notes gives an overview of all note templates.

Template

{{Note|text
|icon=
|title=
}}

Parameters

text
The actual note text.
icon (optional)
Icon in the File: namespace. If not set, File:NOTE-Info.svg is used.
title (optional)
The bold title over the note. If not set, NOTE is used.

Examples

For simple usage:

Input
{{Note|watch your head!}}
Output
NOTE-Info.svgNOTE
watch your head!


In specialized sub-templates the following syntax should be used:

{{Note|{{{1}}}
|icon=File:DANGER-Electricity.svg
|title=DANGER
}}

For more examples refer to pages, which use this template: What links here.

Help:Templates describes general usage of templates, including treatment of special characters.