Difference between revisions of "Template:Note"

From relax wiki
Jump to navigation Jump to search
(Converted the {{note}} template to use the new {{MessageBox}} meta-template transclusion.)
(Transcluded the {{Template info}} template.)
Line 7: Line 7:
  
 
<noinclude>
 
<noinclude>
 
+
{{Template info |1=
 
== Goal ==
 
== Goal ==
  
Line 14: Line 14:
 
== Usage ==
 
== Usage ==
  
  <nowiki>{{</nowiki>'''note'''|message<nowiki>}}</nowiki>
+
  <nowiki>{{</nowiki>'''note'''&#124;message<nowiki>}}</nowiki>
  
 
; message : The obligatory note to the reader.
 
; message : The obligatory note to the reader.
Line 26: Line 26:
 
{{MessageBox/doc inform series}}
 
{{MessageBox/doc inform series}}
  
 +
}}
 
</noinclude>
 
</noinclude>

Revision as of 19:00, 15 October 2015

Note  Add message


Template documentation

Goal

To provide a highly visible note to the reader.

Usage

{{note|message}}
message 
The obligatory note to the reader.

Example

{{note|Please take note of this}}


Note  Please take note of this


The Inform MessageBox Series

Note  This idea of using a meta-template transclusion was suggested by Johan G. on the FlightGear wiki. The {{tip}}, {{note}}, {{caution}}, and {{warning}} message box colour scheme and names were also devised by Johan, based on a "typical flight manual/pilot operating handbook and cockpit indicator use, all sometimes defined by regulation to be used for notes of importance, cations about risk of damaging equipment or minor physical injuries and warnings about major damage to equipment, major physical injuries or death".


The following are a series of message boxes for helping to inform the reader:

For example if you use:

{{tip|If you do it this way, your life will be easier.}}
{{note|Do not forget to run this command.}}
{{caution|If you run this command incorrectly, your harddrive will be erased.}}
{{warning|Do not delete all files from your harddrive.}}

The result will be:


Tip  If you do it this way, your life will be easier.
Note  Do not forget to run this command.


Caution  If you run this command incorrectly, your harddrive will be erased.
Warning  Do not delete all files from your harddrive.

These message boxes all use transclusion from {{MessageBox}}.