Difference between revisions of "Template:Important note box/doc"

From EVE University Wiki
Jump to: navigation, search
m
m (Rewrite doc.)
 
Line 1: Line 1:
−
<noinclude>{{main|Template:Important note box}}</noinclude>
+
; Description
−
== Usage ==
 
 
This template creates a text box for important content or warnings, to avoid it getting lost in the flow of an article. Keep in mind that large number of these templates can make a page look cluttered, so use them judiciously.
 
This template creates a text box for important content or warnings, to avoid it getting lost in the flow of an article. Keep in mind that large number of these templates can make a page look cluttered, so use them judiciously.
−
<pre>{{ important note box | text | italics = no }}</pre>
 
−
;text
 
−
:The note text inside the box. By default, this text is rendered in italics, but all other wiki-formatting (bold, text color, links, etc) work as normal. If the text you would like to use include an equals sign (<code>=</code>), you need to explicitly declare your text as a numbered parameter (i.e. put <code>1=</code> before your example text), otherwise the template will display nothing.
 
−
;italics
 
−
:Add the parameter <code>italics=no</code> to the template to render the text as non-italic (i.e. normal text). Use this parameter if you would like to have more control over the text formatting (for instance, if you would like to use italics selectively in your note). In most cases, you can omit this parameter.
 
−
=== Examples ===
 
−
<pre>{{ important note box | Before undocking for PvP, make sure your medical clone is up to date! }}:</pre>
 
−
{{ important note box | Before undocking for PvP, make sure your medical clone is up to date! }}
 
  
 +
; Dependencies
 +
:; Uses
 +
:: {{T|Color box}}
  
−
<pre>{{ important note box | '''WARNING!'''
+
; Syntax
 +
:: {{T|Important note box| content |4= width= percentage  |5= italics= no }}
 +
:; Parameters
 +
::; content : The note text inside the box. By default, this text is rendered in italics, but all other wiki-formatting (bold, text color, links, etc) work as normal. If the text you would like to use include an equals sign (<code>=</code>), you need to explicitly declare your text as a numbered parameter (i.e. put <code>1=</code> before your text), otherwise the template will display nothing.
 +
::; width : Sets the width of the box.  It's recommended to set this as a percentage (of the paragraph width), so <code>50%</code> will produce a text box half as wide as the surrounding paragraph. If omitted, the text box will be as wide as the surrounding paragraph. When width is set to less than <code>100%</code>, the box will be centered.
 +
::; italics : Add the parameter <code>italics= no</code> to the template to render the text as non-italic (i.e. normal text). Use this parameter if you would like to have more control over the text formatting (for instance, if you would like to use italics selectively in your note). In most cases, you can omit this parameter.
 +
 
 +
; Examples
 +
: {{Code|<nowiki>{{Important note box| Before undocking for PvP, make sure your medical clone is up to date!}}</nowiki>}} gives ...
 +
{{Important note box|  Before undocking for PvP, make sure your medical clone is up to date!}}
 +
 
 +
 
 +
: {{Code|<nowiki>{{Important note box |1= No matter what they say, 1+1=2, but it still needs a "1=" before the text.</nowiki>}} gives ...
 +
{{important note box |1= No matter what they say, 1+1=2, but it still needs a "1=" before the text.}}
 +
 
 +
 
 +
: {{Code|<nowiki>{{Important note box| This is a smaller, centered box|width= 80%}}</nowiki>}} gives ...
 +
{{Important note box| This is a smaller, centered box|width= 80%}}
  
−
Taking your Carrier into low-sec without support is a ''very'' bad idea.
 
  
−
Don't be an expensive killmail! | italics=no }}:</pre>
+
<pre style="margin-left: 2em;">{{Important note box
−
{{ important note box | '''WARNING!'''
+
|'''WARNING!'''
  
 
Taking your Carrier into low-sec without support is a ''very'' bad idea.  
 
Taking your Carrier into low-sec without support is a ''very'' bad idea.  
  
−
Don't be an expensive killmail! | italics=no }}
+
Don't be an expensive killmail!
 +
|italics= no}}</pre> gives ...
 +
{{Important note box
 +
|'''WARNING!'''
  
 +
Taking your Carrier into low-sec without support is a ''very'' bad idea.
  
−
<pre>{{ important note box | 1=No matter what they say, 1+1=2, but it still needs a "1=" before the text. }}:</pre>
+
Don't be an expensive killmail!
−
{{ important note box | 1=No matter what they say, 1+1=2, but it still needs a "1=" before the text. }}
+
|italics= no}}
  
 
== See also ==
 
== See also ==
−
*<code>{{t|note box}}</code>, a variation on this template, designed for general notes and explanations.  
+
* {{T|Note box}}, a variation on this template, designed for general notes and explanations.  
−
*<code>{{t|example}}</code>, a text box for examples.
+
* {{T|Example}}, a text box for examples.
−
*<code>{{t|color box}}</code>, the general template for creating coloured boxes with text in them.
+
* {{T|Color box}}, the general template for creating colored boxes with text in them.
  
 
<includeonly>[[Category:Formatting templates]]</includeonly>
 
<includeonly>[[Category:Formatting templates]]</includeonly>
 
<noinclude>[[Category:Template documentation]]</noinclude>
 
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 12:26, 5 February 2024

Description

This template creates a text box for important content or warnings, to avoid it getting lost in the flow of an article. Keep in mind that large number of these templates can make a page look cluttered, so use them judiciously.

Dependencies
Uses
{{Color box}}
Syntax
{{Important note box|< content >|<width= percentage>|<italics= no>}}
Parameters
content
The note text inside the box. By default, this text is rendered in italics, but all other wiki-formatting (bold, text color, links, etc) work as normal. If the text you would like to use include an equals sign (=), you need to explicitly declare your text as a numbered parameter (i.e. put 1= before your text), otherwise the template will display nothing.
width
Sets the width of the box. It's recommended to set this as a percentage (of the paragraph width), so 50% will produce a text box half as wide as the surrounding paragraph. If omitted, the text box will be as wide as the surrounding paragraph. When width is set to less than 100%, the box will be centered.
italics
Add the parameter italics= no to the template to render the text as non-italic (i.e. normal text). Use this parameter if you would like to have more control over the text formatting (for instance, if you would like to use italics selectively in your note). In most cases, you can omit this parameter.
Examples
{{Important note box| Before undocking for PvP, make sure your medical clone is up to date!}}
gives ...
Before undocking for PvP, make sure your medical clone is up to date!


{{Important note box |1= No matter what they say, 1+1=2, but it still needs a "1=" before the text.
gives ...
No matter what they say, 1+1=2, but it still needs a "1=" before the text.


{{Important note box| This is a smaller, centered box|width= 80%}}
gives ...
This is a smaller, centered box 


{{Important note box
|'''WARNING!'''

Taking your Carrier into low-sec without support is a ''very'' bad idea. 

Don't be an expensive killmail!
|italics= no}}

gives ...

WARNING!

Taking your Carrier into low-sec without support is a very bad idea.

Don't be an expensive killmail!

See also

  • {{Note box}}, a variation on this template, designed for general notes and explanations.
  • {{Example}}, a text box for examples.
  • {{Color box}}, the general template for creating colored boxes with text in them.
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:Important_note_box/doc&oldid=212566"