Difference between revisions of "Template:Note"

From relax wiki
Jump to navigation Jump to search
m (1 revision imported)
 
(Undo revision 6875 by Parnikkapore (talk))
 
Line 1: Line 1:
{| cellspacing="0" style="border: 1px solid #1992ff; border-left-width: 10px; width: {{{width|90%}}}; background-color: #e0f2ff; padding: {{{padding|2px}}}; margin: {{{margin|1em auto}}};"
+
{{MessageBox
| style="padding-left: 5px"| '''<span class="smallcaps" style="font-variant:small-caps;">{{LangSwitch
+
| message = {{{1|Add message}}}
| de = Bemerkung
+
| title  = <span style="font-variant:small-caps;">Note</span>
| en = Note
+
| border = thin solid #1992ff
| fr = Note
+
| bgcolor = #e0f2ff
  | it = Nota
+
}}<noinclude>
| th = นี่!
 
}}</span>'''&ensp; {{{1|Add message}}}
 
|}<noinclude>{{Informative template |1=
 
__NOTOC__
 
== Goal ==
 
Use this template to add a note about something important.
 
  
== Usage ==
+
{{MessageBox/doc
{{obr}}'''note'''
+
| name    = {{FULLPAGENAME}}
{{!}} message
+
| goal    = To provide a highly visible note to the reader.
{{!}} ''width''   =
+
| usage   =
  {{!}} ''padding'' =
+
  <nowiki>{{</nowiki>'''note'''&#124;message<nowiki>}}</nowiki>
{{!}} ''margin''  =
 
{{cbr}}
 
  
; width : Width of the messagebox, preferably as a percentage of the width of the page content. This defaults to {{param||90%}}.
+
; message : The obligatory note to the reader.
 
+
| example =
; padding: The padding CSS setting for the message box.  This defaults to {{param||2px}}.
+
  <nowiki>{{note|Please take note of this}}</nowiki>
 
 
; margin: The margin CSS setting for the message box.  This defaults to {{param||1em auto}}.
 
 
 
== Example ==
 
<nowiki>{{note|The gyro compass may drift.  Compare the gyro compass against the wet compass at regular intervals.}}</nowiki>
 
{{note|The gyro compass may drift.  Compare the gyro compass against the wet compass at regular intervals.}}
 
 
 
  <nowiki>{{note|The gyro compass may drift.  Compare the gyro compass against the wet compass at regular intervals.|width=50%}}</nowiki>
 
{{note|The gyro compass may drift.  Compare the gyro compass against the wet compass at regular intervals.|width=50%}}
 
 
 
== Known issues ==
 
Adding external links must be done like below. Specifically note the '''1{{=}}'''.
 
<pre style="white-space: pre-wrap;"><nowiki>{{note|1=For instruction on how to add screenshots to a forum post, see [http://forum.flightgear.org/viewtopic.php?f=19&t=8873 this forum sticky].}}</nowiki></pre>
 
 
 
{{note|1=For instruction on how to add screenshots to a forum post, see [http://forum.flightgear.org/viewtopic.php?f=19&t=8873 this forum sticky].}}
 
 
 
== Related templates ==
 
=== Messagebox templates ===
 
* {{tl|warning}} &ndash; When a virtual aircraft might crash or when real equipment or ones health might be jeopardized
 
* {{tl|caution}} &ndash; When there might be damages to the virtual aircraft or to real equipment
 
* {{tl|tip}} &ndash; For helpful tips
 
 
 
=== Inline italic templates ===
 
{{inote|If there is a need for a warning use a messagebox template instead.}}
 
* {{tl|icaution}}
 
* {{tl|inote}}
 
* {{tl|itip}}
 
  
 +
{{note|Please take note of this}}
 
}}
 
}}
  
[[Category:Messagebox templates]]
+
[[Category:MessageBox templates]]
 +
[[Category:InformBox templates]]
 
</noinclude>
 
</noinclude>

Latest revision as of 21:14, 6 September 2017

Note  Add message

Template documentation

The Template:Note MessageBox

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

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.