Difference between revisions of "Template:Note"

From irefindex
(Fixed template rule, adopting the warning template's rule.)
(→‎Usage: Added note about method 1.)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="true" valign="top">}}<span style="position: relative; top: -2px;">[[Image:Bulbgraph.png|18px|Note|link=]]</span> '''Note''': {{#if: {{{1|}}}|</td><td valign="top" style="padding-left:0.5em;">{{{1|}}}</td></tr></table>}}<noinclude>
+
{{#if: {{{1|}}}|<table cellspacing="0" cellpadding="0" border="0" style="background: transparent;"><tr><td nowrap="true" valign="center" style="padding-right: 0.5em">}}[[Image:Bulbgraph.png|18px|Note|link=]]{{#if: {{{1|}}}|'''{{{2|Note}}}'''</td><td valign="top" style="padding:0.5em; border: 1px solid #aaa; background-color: #f9f9f9">{{{1|}}}</td></tr></table>|'''{{{2|Note:}}}''' }}<noinclude>
  
 
== Usage ==
 
== Usage ==
 +
 +
{{Note|The labelling feature in method 1 doesn't work, despite various approaches being tried after consulting the [http://meta.wikimedia.org/wiki/Help:Template#Parameters MediaWiki template documentation]}}
  
 
=== Method 1 ===
 
=== Method 1 ===
  
 
The following displays the note icon and the word 'Note:'.  You can follow this with whatever text/images/markup you like, and it works in-line, within a paragraph.
 
The following displays the note icon and the word 'Note:'.  You can follow this with whatever text/images/markup you like, and it works in-line, within a paragraph.
  Monsters are green. <nowiki>{{note}}</nowiki> this is an in-line note, to remind you that some monsters are orangey-purple.
+
 
 +
  Monsters are green. <nowiki>{{Note}}</nowiki> this is an in-line note, to remind you that some monsters are orangey-purple.
  
 
Monsters are green. {{Note}} this is an in-line note, to remind you that some monsters are orangey-purple.
 
Monsters are green. {{Note}} this is an in-line note, to remind you that some monsters are orangey-purple.
 +
 +
Specifying a second parameter explicitly lets you change the label:
 +
 +
This uses a template. <nowiki>{{Note||Be aware}}</nowiki> that MediaWiki's templates are quite nasty.
 +
 +
This uses a template. <nowiki>{{Note||Be aware}}</nowiki> that MediaWiki's templates are quite nasty.
  
 
=== Method 2 ===
 
=== Method 2 ===
Line 18: Line 27:
  
 
{{Note|Here is a long note, which is sufficiently wordy to run onto a second line, which would normally cause it to wrap round the icon, but because we passed it as a parameter it keeps its left alignment straight.}}
 
{{Note|Here is a long note, which is sufficiently wordy to run onto a second line, which would normally cause it to wrap round the icon, but because we passed it as a parameter it keeps its left alignment straight.}}
 +
 +
<nowiki>{{Note|Although these long notes look good, external links cause them not to work for some reason.
 +
So, beware of that when using them - it must be a MediaWiki limitation deep in the source code.|Caution}}</nowiki>
 +
 +
{{Note|Although these long notes look good, raw external links (plain URLs not using any kind of link syntax) cause them not to work for some reason. So, beware of that when using them - it must be a MediaWiki limitation deep in the source code.|Caution}}
  
 
{{Languages|Template:Note}}
 
{{Languages|Template:Note}}

Latest revision as of 16:33, 1 July 2010

NoteNote:

Usage

NoteNoteThe labelling feature in method 1 doesn't work, despite various approaches being tried after consulting the MediaWiki template documentation

Method 1

The following displays the note icon and the word 'Note:'. You can follow this with whatever text/images/markup you like, and it works in-line, within a paragraph.

Monsters are green. {{Note}} this is an in-line note, to remind you that some monsters are orangey-purple.

Monsters are green. NoteNote: this is an in-line note, to remind you that some monsters are orangey-purple.

Specifying a second parameter explicitly lets you change the label:

This uses a template. {{Note||Be aware}} that MediaWiki's templates are quite nasty.

This uses a template. {{Note||Be aware}} that MediaWiki's templates are quite nasty.

Method 2

The following includes the text passed to the template, and uses a table to stop the text flowing round the icon. These always force a newline before and after the note.

{{Note|Here is a long note, which is sufficiently wordy to run onto a second line, 
 which would normally cause it to wrap round the icon, but because we passed it as a parameter 
 it keeps its left alignment straight.}} 
NoteNoteHere is a long note, which is sufficiently wordy to run onto a second line, which would normally cause it to wrap round the icon, but because we passed it as a parameter it keeps its left alignment straight.
{{Note|Although these long notes look good, external links cause them not to work for some reason.
 So, beware of that when using them - it must be a MediaWiki limitation deep in the source code.|Caution}}
NoteCautionAlthough these long notes look good, raw external links (plain URLs not using any kind of link syntax) cause them not to work for some reason. So, beware of that when using them - it must be a MediaWiki limitation deep in the source code.