Difference between revisions of "Template:Tip"

From relax wiki
Jump to navigation Jump to search
(Created a Tip template - this comes from the FlightGear project from the template of the same name: http://wiki.flightgear.org/Template:Tip .)
 
(Converted the {{tip}} template to use the new {{MessageBox}} meta-template transclusion.)
Line 1: Line 1:
{| cellspacing="0" style="border: 1px solid #0c6; border-left-width: 10px; margin: 1em auto; width: {{{width|90%}}}; background-color: #e0ffe8; padding: 2px;"
+
{{MessageBox
| style="padding-left:5px;"| '''<span class="smallcaps" style="font-variant:small-caps;">Tip</span>'''&ensp; {{{1|Add message}}}
+
| message = {{{1|Add message}}}
|}
+
| title  = Tip
 +
| border  = thin solid #0c6
 +
| bgcolor = #e0ffe8
 +
}}
 +
 
 +
<noinclude>
 +
 
 +
== Goal ==
 +
 
 +
To provide a tip to the reader.
 +
 
 +
== Usage ==
 +
 
 +
<nowiki>{{</nowiki>'''tip'''|message<nowiki>}}</nowiki>
 +
 
 +
; message : The obligatory text of the tip.
 +
 
 +
== Example ==
 +
 
 +
<nowiki>{{tip|This is a test message to give a handy tip}}</nowiki>
 +
 
 +
{{tip|This is a test message to give a handy tip}}
 +
 
 +
{{MessageBox/doc inform series}}
 +
 
 +
</noinclude>

Revision as of 18:05, 15 October 2015

Tip  Add message


Goal

To provide a tip to the reader.

Usage

{{tip|message}}
message 
The obligatory text of the tip.

Example

{{tip|This is a test message to give a handy tip}}


Tip  This is a test message to give a handy tip


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}}.