Template:Tip

From relax wiki
Jump to: navigation, search
Tip  Add message

Template documentation

The Template:Tip MessageBox

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

Categories of MessageBoxes

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


The Header MessageBox Series

These are a series of specific message boxes for using at the top of articles. The derive via transclusion from the {{MessageBox}} template.

The Stub MessageBox Series

The stub template is {{stub}}. The result of using this template will be:

This article is a stub. Please help to improve the relax wiki by expanding the article.