Difference between revisions of "Template:Note box/doc"

From EVE University Wiki
Jump to: navigation, search
m
m (Fix typo.)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
<noinclude>{{main|Template:Note box}}</noinclude>
+
; Description
−
== Usage ==
+
: This template creates a text box, which is useful if you would like to add a note into your article, drawing attention to certain details, or to better explain the context of an article or section. 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, which is useful if you would like to add a note into your article, drawing attention to certain details, or to better explain the context of an article or section. Keep in mind that large number of these templates can make a page look cluttered, so use them judiciously.
 
−
<pre>{{ 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>{{ note box | The E-UNI does not run [[Incursion_sites#Mothership_sites|Incursion Mothership sites]]. }}:</pre>
 
−
{{note box|The E-UNI does not run [[Incursion_sites#Mothership_sites|Incursion Mothership sites]].}}
 
  
 +
; Dependencies
 +
:; Uses
 +
:: {{T|Color box}}
  
−
<pre>{{ note box | This article includes three ''Wombles''. For articles with more than three ''Wombles'', see
+
; Syntax
 +
: {{T|Note box|content|3= width= percentage|4= 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 example 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>{{Note box|The E-UNI does not run [[Incursion sites#Mothership sites|Incursion Mothership sites]].}}</nowiki>}} gives ...
 +
{{Note box|The E-UNI does not run [[Incursion sites#Mothership sites|Incursion Mothership sites]].}}
 +
 
 +
 
 +
: {{Code|<nowiki>{{Note box|1= Putting a mathematical formula (2+2=4) inside a text box requires a 1= before the text.}}</nowiki>}} gives ...
 +
{{Note box|1= Putting a mathematical formula (2+2=4) inside a text box requires a 1= before the text.}}
 +
 
 +
 
 +
: {{Code|<nowiki>{{Note box|A smaller, centered note box|width= 80%}}</nowiki>}} gives ...
 +
{{Note box|A smaller, centered note box|width= 80%}}
 +
 
 +
 
 +
<pre style="margin-left: 2em;">{{note box | This article includes three ''Wombles''. For articles with more than three ''Wombles'', see
 
* A Box of Wombles
 
* A Box of Wombles
 
* Boatload of Wombles
 
* Boatload of Wombles
−
* {{co|red|Tons of Wombles}} | italics=no }}:</pre>
+
* {{co|red|Tons of Wombles}}
−
{{note box|This article includes three ''Wombles''. For articles with more than three ''Wombles'', see
+
|italics= no}}</pre> gives ...
 +
{{Note box|This article includes three ''Wombles''. For articles with more than three ''Wombles'', see
 
* A Box of Wombles
 
* A Box of Wombles
 
* Boatload of Wombles
 
* Boatload of Wombles
−
* {{co|red|Tons of Wombles}} | italics=no }}
+
* {{co|red|Tons of Wombles}}
 +
|italics= no}}
  
  
−
<pre>{{ note box | 1=Putting a mathematical formula (2+2=4) inside a text box requires a 1= before the text. }}:</pre>
+
; See also
−
{{note box|1=Putting a mathematical formula (2+2=4) inside a text box requires a 1= before the text.}}
+
* {{T|Important note box}}, a variation on this template, designed for warnings and other important notes.
 +
* {{T|Example}}, a text box for examples.
 +
* {{T|Color box}}, the general template for creating colored boxes with text in them.
  
−
== See also ==
 
−
*<code>{{t|important note box}}</code>, a variation on this template, designed for warnings and other important notes.
 
−
*<code>{{t|example}}</code>, a text box for examples.
 
−
*<code>{{t|color box}}</code>, the general template for creating coloured 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 13:29, 5 February 2024

Description
This template creates a text box, which is useful if you would like to add a note into your article, drawing attention to certain details, or to better explain the context of an article or section. Keep in mind that large number of these templates can make a page look cluttered, so use them judiciously.
Dependencies
Uses
{{Color box}}
Syntax
{{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 example 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
{{Note box|The E-UNI does not run [[Incursion sites#Mothership sites|Incursion Mothership sites]].}}
gives ...
The E-UNI does not run Incursion Mothership sites.


{{Note box|1= Putting a mathematical formula (2+2=4) inside a text box requires a 1= before the text.}}
gives ...
Putting a mathematical formula (2+2=4) inside a text box requires a 1= before the text.


{{Note box|A smaller, centered note box|width= 80%}}
gives ...
A smaller, centered note box 


{{note box | This article includes three ''Wombles''. For articles with more than three ''Wombles'', see
* A Box of Wombles
* Boatload of Wombles
* {{co|red|Tons of Wombles}}
|italics= no}}

gives ...

This article includes three Wombles. For articles with more than three Wombles, see
  • A Box of Wombles
  • Boatload of Wombles
  • Tons of Wombles


See also
  • {{Important note box}}, a variation on this template, designed for warnings and other important notes.
  • {{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:Note_box/doc&oldid=212571"