Help:Templates: Difference between revisions

From The Reed and Rite
m Removed background color to allow dynamic color shift in dark mode.
 
(119 intermediate revisions by the same user not shown)
Line 1: Line 1:
<center><span style="font-size: 125%;">'''Table of Contents'''</span></center>
{{HelpContents}}
{{HelpContents}}


== Introduction ==
== Introduction ==
'''Templates''' are a customizable tool that can make complex editing easier to do by creating a shortcut. This means that instead of rewriting complex elements every time you need it, you can use a simple text tag that will do (most) of the work for you. In this article we'll go over the basics of using templates, some useful templates that are built in, and an introduction to creating your own templates. For a more in depth guide on templates, check out [https://www.mediawiki.org/wiki/Help:Templates Mediawiki's Help article].
'''Templates''' are standard wiki pages whose content is designed to be [https://www.mediawiki.org/wiki/Transclusion transcluded] (embedded) inside other pages. They enable a user to simplify complex and repetitive processes. You embed this content into other pages through the use of a coded tag. In this article we'll go over the basics of using templates, some useful templates that are already available, and an introduction to creating your own templates. For a more in depth guide on templates, check out [https://www.mediawiki.org/wiki/Help:Templates Mediawiki's Help article].


== Basics of Templates  ==
== Basics of Templates  ==
Templates are easy to recognize as they are enclosed by double curly braces. (<code>{{</code> and <code>}}</code>) To use one you must first indicate the name of the template you want to use, and then define various parameters. All of the elements between the double curly braces are separated by vertical bars. (<code>|</code>) The number and type of parameters will vary depending on the template.
Templates use coded tags which are easy to recognize as they are enclosed by double curly braces. (<code>{{</code> and <code>}}</code>) To use one you must first indicate the name of the template you want to use, and then define various parameters. All of the elements between the double curly braces are separated by vertical bars. (<code>|</code>) The number and type of parameters will vary depending on the template.


Some templates will be written in a single line of text, but some may span multiple lines. The more complex it is, the more likely it spans multiple lines. This is to help with clarity in usage. For example:
Some templates will be written in a single line of text, but some may span multiple lines. The more complex it is, the more likely it is to span multiple lines—this is to help with clarity in usage. For example:


{| class="wikitable" style="width: 100%; text-align: left;"
{| class="wikitable" style="width: 100%; text-align: left;"
Line 23: Line 22:


=== Parameters ===
=== Parameters ===
Parameters come in two varieties: '''Named''' and '''Unnamed'''.
Parameters come in two varieties: '''Named''' and '''Unnamed''' (also sometimes called "Anonymous"). Templates will use one or the other, or sometimes even both. You can see the exact parameters a template uses by checking out its [[:Category:Templates|template page]].


;Named Parameters
;Named Parameters
Line 33: Line 32:
:Unnamed parameters should be completely replaced by your input. For example:
:Unnamed parameters should be completely replaced by your input. For example:
::<code><nowiki>{{template name|INPUT}}</nowiki></code>
::<code><nowiki>{{template name|INPUT}}</nowiki></code>
:In this example <code>INPUT</code> is an unnamed parameter. Note that no other text is required beyond your input.
:In this example <code>INPUT</code> is an unnamed parameter, and would be replaced by your input. Note that '''no other text''' is required beyond your input.


=== Example ===
=== Parameter Examples ===
Let's look at an example using a infobox template. (You can find more details on inboxes in the next section.) Note that this template makes use of named parameters.
Let's take a look at some templates in action.


{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
|-
|-
! colspan="2" style="text-align: center;" | Example: Infobox Template
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Example: Named Parameters</span><br><div style="text-align: left;"><span style="font-weight: normal;">This example demonstrates a {{t|Character}} infobox template, which uses named parameters. Note that the name of the template comes first. ("<code><nowiki>{{character</nowiki></code>"), followed by the named parameters.</span></div>
|-
|-
| width=50%|'''You Type'''
| width=50%|'''You Type'''
|'''You Get'''
|'''You Get'''
|-
|-
| width=50%|<pre>
| width=50%; |<pre>
{{character
{{character
|name=Pen
|name=Beth Brower
|image=Pen.png
|image=Beth Brower-2.jpg
|caption=Image Caption Here
|caption=Our Undaunted Author
|introduced=First Appearance
|profession=Author, Owner of Cat
|titles=''The Right Honorable Beth''
}}
}}
</pre>
</pre>
|{{example
|{{character
|name=Pen
|name=Beth Brower
|image=Pen.png
|image=Beth Brower-2.jpg
|caption=Image Caption Here
|caption=Our Undaunted Author
|introduced=First Appearance
|profession=Author, Owner of Cat
|titles=''The Right Honorable Beth''
}}
}}
|}
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
|-
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Example: Unnamed Parameters</span><br><div style="text-align: left;"><span style="font-weight: normal;">This example demonstrates  a {{t|Quote}} template, which uses unnamed parameters.</span></div>
|-
| width=50%|'''You Type'''
|'''You Get'''
|-
| width=50%; |<pre>{{quote|My existence of the last three years has been nothing but incident.|Emma M. Lion}}</pre>
|{{quote|My existence of the last three years has been nothing but incident.|Emma M. Lion}}
|}
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
|-
! colspan="2" style="text-align: center;" | <span style="font-size: 115%;">Example: Mix of Parameters</span><br><div style="text-align: left;"><span style="font-weight: normal;">This example demonstrates  an {{t|Image}} template, which uses a mix of named and unnamed parameters.</span></div>
|-
| width=50%|'''You Type'''
|'''You Get'''
|-
| width=50%; |<pre>{{image|Pen.png|A pen nib silhouette.|align=left|width=200px}}</pre>
|{{image|Pen.png|A pen nib silhouette.|align=left|width=200px}}
|}
|}


== Types of Templates ==
== Types of Templates ==
Let's go over the common types of templates you may encounter and make use of.
{{for|:Category:Templates|a comprehensive list of templates|Category:Templates}}
Next we'll go over the most common templates you will encounter. The explanations below give only a brief description of their function. To learn how to use or implement a particular template into the content of an article, please visit the linked templates page:


=== Information Boxes ===
=== Information Boxes ===
Called '''infoboxes''' for short, these templates create the tables at the upper right hand corner of articles. They display important facts and details which are common to articles of the same category. Infoboxes are ''placed at the start of the article''. There are infobox templates for all of the high level content categories, and a few others that are more specific. Common examples include {{t|book}}, {{t|character}}, {{t|magic system}}, and {{t|location}}.
{{for|Help:Infoboxes|more details on Infoboxes|post=For a list of available infobox templates, see [[:Category:Infoboxes]]}}


For more detailed help on infoboxes in general see [[:Help: Infoboxes]] and for a full list of infobox templates, see [[:Category: Infoboxes]].
'''Information boxes''', or as they're more commonly known, '''Infoboxes''', are templates that add a table of basic information related to the subject of that page to the top right of the page. There are infoboxes for each of the main content categories (e.g., {{t|book}}, {{t|character}}, {{t|location}}), but there are a few other more specialized ones.


=== Navigation Boxes ===
=== Navigation Boxes ===
Called '''navboxes''' for short, these templates create the tables at the bottom of pages that link to other important articles that are related to the same book or series. Most series or standalone books have a navbox that refers to important characters, places, etc. Navboxes are placed at the end of the article, directly after the <code><nowiki><references /></nowiki></code> tag. Common examples include {{t|Cosmere}}, {{t|Stormlight}}, and {{t|Reckoners}}.
{{for|:Category:Navigation|a full list of navigation templates|Category:Navigation}}
 
'''Navigation boxes''', also called '''navboxes''', are templates that create a table of links related to the book/series of that page. Navboxes are placed in the Notes section of articles, between the <code><nowiki><references /></nowiki></code> tag and any [[:Help:Categories#Quality_Tags|quality tags]].
For a full list of navbox templates, see [[:Category:Navbars]].


=== Notices ===
=== Notices ===
Notice templates alert users and editors of important information regarding the page itself. Some notable notice templates are listed below. For a full list of notice templates, see [[:Category:Notices]].
{{for|:Category:Notices|a full list of notice templates|Category:Notices}}
Notice templates are used to alert users and editors of important information. The table below gives a brief description of a few notices:


;{{t|attention}}  
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
: Makes note at top of page that article needs attention and categorizes the article accordingly. Place directly after infobox.  
|-
 
! width=20%|Template
;{{t|copyright}}
!Description
: Asks users not to copy the content on the article.  
|-
 
| style="text-align: center;" | {{t|urgent}}  
;{{t|theory}}  
| Adds a red quill indicator icon ([[File:Quill-red.png|20px|link=|An red quill icon.]]) to the top right of a page and adds the article to the category [[:Category:Articles in Need of Attention]]. Place directly after the infobox.
: Warns that the article or section contains speculation and should not be considered canon. Place directly after infobox or directly after section heading.  
|-
 
| style="text-align: center;" | {{t|spoiler}}  
;{{t|spoilers}}  
| Warns that an article or section contains information pertaining to recently published material that many users may not have read yet. Place directly after infobox or at the top of the relevant section..  
: Warns that the article contains information pertaining to recently published material that many users may not have read yet. Place directly after infobox.  
|-
 
| style="text-align: center;" | {{t|claim}}  
;{{t|delete}}  
| Warns other users that a page or section has been claimed for editing and asks that they collaborate with that user before making any edits. Place at the top of the page, after the infobox (if present), or at the top of the claimed section.
: Requests that an administrator delete the page.  
|-
 
| style="text-align: center;" | {{t|copyright}}  
;{{t|move}}  
| Notifies users that a page or section contains copyrighted material that is used with permission and to warn them against reusing it.
: Requests that an administrator move the page (change the title). An unnamed parameter may be included to indicate which page it should be moved ''to''.
|-
 
| style="text-align: center;" | {{t|theory}}
;Quality Tags
| Warns that the article or section contains speculation and should not be considered canon. Place directly after infobox or directly after section heading.  
: Quality tags are simple templates that indicate the level of completion/quality of an article and categorize it accordingly. These are discussed in detail on the [[:Help:Categories#Quality_Tags|Help:Categories]] page and include {{t|incomplete}}, {{t|partial}}, and {{t|complete}}
|-
| style="text-align: center;" | {{t|delete}}  
| Requests that an administrator delete the page.  
|-
| style="text-align: center;" | {{t|rename}}  
| Requests that an administrator rename the page. An unnamed parameter may be included to indicate the new proposed name.
|-
| style="text-align: center;" | '''[[:Help:Categories#Quality_Tags|Quality Tags]] '''
| Quality tags are simple templates that indicate the level of completion/quality of an article and categorize it accordingly. These are discussed in detail on the [[:Help:Categories#Quality_Tags|Help:Categories]] page and include {{t|stub}}, {{t|partial}}, and {{t|complete}}
|}


=== Reference Templates ===
=== Reference Templates ===
Reference templates are used to cite the source of information in an article. They create a superscript number that links to the footnotes in the "Notes" section, where the full reference is provided. For more on reference templates, see [[:Help:References]].
{{for|:Help:References|more on Reference Templates|Help:References}}


=== Link Macros ===
'''Reference Templates''' are used to create footnotes and references in an article.  Wherever the template is used, a superscripted number is added that links to the full reference in the "Notes" section. Additionally, hovering over the superscripted number for a brief second will trigger a popup window where one can also see the linked footnote without having to click the link.
Link macros are templates which link to something that's related to the input. They often categorize the article as well. For a full list of link macros, see [[:Category:Link macros]].


=== Editorial Notations ===
=== Editorial Notations ===
Editorial notations are used to highlight information which is unsupported, ambiguous, or questionable. For more, see [[:Help:References#Editorial_Notations|Help:References]].  
{{for|:Help:References#Editorial Notations|more on Editorial Notations|Help:References}}
 
'''Editorial Notations''' are used to highlight statements in articles that may need attention. This typically is applied to information that is unsupported, ambiguous, or questionable.


=== Other Templates ===
=== Other Templates ===
:: ''For more details on each templates usage, see the linked template page.''
Some other notable templates include the following:
Some other notable templates include the following:


;{{t|b}}
{| style="width: 100%; text-align: left; margin: auto;" class="wikitable"
: This is a simple template that outputs a full book or series title given an abbreviated or shorthand reference. For example, "<code><nowiki>{{b|sa1}}</nowiki></code>" returns "{{b|e1}}"
|-
 
! width=15%|Template
;{{t|columns}}  
!Description
: Use the {{t|columns}} template to create columns. Use <code><nowiki>{{columns|count=N|TEXT}}</nowiki></code>, where <code>N</code> is the desired number of columns and <code>TEXT</code> is the content to be split up into columns. Separate items in <code>TEXT</code> by using line breaks or lists. Note that <code>|count=N</code> may be omitted; the number of columns is 3 by default.
|-
: {| width=100% class=wikitable
| style="text-align: center;" | {{t|columns}}
| The {{t|columns}} template is used to create a list of items that spans the width of the page instead of creating a line break between each item in the list. The default number of columns is three, but can be customized to any number the user wishes.
|-
| style="text-align: center;" | {{t|quote}}
| The {{t|quote}} template creates a stylized quote block. Users have the option to add a [[:Help:References#Reference Templates|reference]] to the source. The default width of the quote block is 100%, but there are optional parameters to define width and alignment to allow a user to insert quotes in blocks of text.
|-
|-
| width=50%|This...
| style="text-align: center;" | {{t|for}}
|...produces:
| Use the {{t|for}} template to provide a link to a related topic or page. The output of this template is "''For________, see [LINK]"''. You can see this template in use several times on this very page.
|-
|-
|<pre style="white-space:pre-wrap; width:200px">
| style="text-align: center;" | {{t|b}}
{{columns|count=2|
| The {{t|b}} template converts an abbreviated reference into a full book or series title. (e.g., Writing "<code><nowiki>{{b|e1}}</nowiki></code>" will output: "{{b|e1}}".) Thereby simplifying and speeding up the process of including full titles in articles.
* Item 1
* Item 2
* Item 3
* Item 4
* Item 5
}}
</pre>
|{{columns|count=2|
* Item 1
* Item 2
* Item 3
* Item 4
* Item 5
}}
|}
|}
;{{t|quote}}
: Use {{t|quote}} to highlight some text as a quote. Use <code><nowiki>{{quote|TEXT|SOURCE}}</nowiki></code>, where <code>TEXT</code> is the quote itself and <code>SOURCE</code> is the source of the quote (typically the name of the speaker or a short description of the context, followed by a [[:Help:References|reference]]). <code><nowiki>{{quote|Do or do not. There is no try.|Yoda}}</nowiki></code> produces:
: {{quote|Do or do not. There is no try.|Yoda}}
;{{t|sidequote}}
: {{sidequote|Do or do not. There is no try.|Yoda|side=right|size=300px}} Use {{t|sidequote}} to place a quote on one side of the page, with text floating around it. Use <code><nowiki>{{sidequote|TEXT|SOURCE|POSITION|WIDTH}}</nowiki></code>, where <code>TEXT</code> is the quote itself, <code>SOURCE</code> is the source of the quote, <code>POSITION</code> is the alignment of the quote (<code>left</code> or <code>right</code>), and <code>WIDTH</code> is some number followed by "px", to specify the width of the quote in pixels. When placed at the top of this paragraph, <code><nowiki>{{sidequote|Do or do not. There is no try.|Yoda|side=right|size=300px}}</nowiki></code> produces the quote to the right.
;{{t|for}}
: This template provides a quick and clean way to refer to other articles. It generally takes one unnamed parameter, <code>{{{1}}}</code>, as input. By default, it returns "For more information, see <code>{{{1}}}</code>", where <code>{{{1}}}</code> is a link to the referenced article. A second unnamed parameter will replace "more information" and a third will replace the text which refers to the linked article. For example, <code><nowiki>{{for|cosmere|oodles of information|this page about the cosmere}}</nowiki></code> produces:
: {{for|cosmere|oodles of information|this page about the cosmere}}
== Template Pages ==
Templates are created just like articles and categories: you create a page for one in the Template namespace. You should find documentation for a template on this page. It will provide a description of what the template does, a list of required and acceptable parameters, and occasionally some examples.


== Editing Templates ==
== Editing Templates ==
Editing templates (or creating one from scratch) is definitely not a task for beginners. But we'll go over some of the basics.
Creating and editing templates is quite an advanced topic. For extensive instructions on building templates, check out [https://www.mediawiki.org/wiki/Help:Templates MediaWiki's Help Manual]. Feel free to make use of the {{t|test}} template to experiment with edits to existing templates or in creating new ones.
 
=== Includeonly and Noinclude ===
;<code><nowiki><includeonly></nowiki></code> Tag
: Everything you want the template to do when used on other pages should be sandwiched between <code><nowiki><includeonly></nowiki></code> and <code><nowiki></includeonly></nowiki></code> tags.
 
;<code><nowiki><noinclude></nowiki></code> Tag
: The template's documentation, and anything else you want to show up on the template page itself, must be sandwiched between <code><nowiki><noinclude></nowiki></code> and <code><nowiki></noinclude></nowiki></code> tags.
 
=== Parameters ===
;Named Parameters
: ''Named'' parameters are referred to by their name in triple braces. For example, the named parameter "books"  in the {{t|character}} template is referred to as <code>{{{books}}}</code>.
 
;Unnamed Parameters
: ''Unnamed'' parameters are referred to by the order they are entered. For example, the first unnamed parameter that is entered in the {{t|book ref}} template is referred to as <code>{{{1}}}</code>, while the second is referred to as <code>{{{2}}}</code>.
 
;Defaults
: Provide a default value for parameters by including a vertical bar (<code>|</code>) followed by the default value. To use a null default value, enter nothing after the vertical bar. For example, if you want the first unnamed parameter to have a default value of "Sanderson", use <code><nowiki>{{{1|Sanderson}}}</nowiki></code>.
 
=== Parser Functions ===
There are a number of functions that can be used to generate different results based on the input provided. For an extensive list, see [https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions MediaWiki's Parser Functions] page. Here are some of the basics:
 
;Uppercasing Text
: This function converts a string of text to all uppercase.
: ''Use:'' <code><nowiki>{{uc: TEXT}}</nowiki></code>, where <code>TEXT</code> is the text to be converted.
: ''Example:'' <code><nowiki>{{uc: heLLo}}</nowiki></code> produces <code>HELLO</code>.
 
;Lowercasing Text
: This function converts a string of text to all lowercase.
: ''Use:'' <code><nowiki>{{lc: TEXT}}</nowiki></code>, where <code>TEXT</code> is the text to be converted.
: ''Example:'' <code><nowiki>{{lc: heLLo}}</nowiki></code> produces <code>hello</code>.
 
;String Compare
: This function compares two strings of text and provides one of two results.
: ''Use:'' <code><nowiki>{{#ifeq: A|B|Result1|Result2}}</nowiki></code>, where <code>A</code> and <code>B</code> are the strings of text. If <code>A=B</code> then <code>Result1</code> is returned; otherwise, <code>Result2</code> is returned.
: ''Example:'' <code><nowiki>{{#ifeq: dog|dog|same|different}}</nowiki></code> produces <code>same</code> and <code><nowiki>{{#ifeq: dog|cat|same|different}}</nowiki></code> produces <code>different</code>.
 
;If-Then
: This function checks if a parameter exists and provides one of two results.
: ''Use:'' <code><nowiki>{{#if: A|Result1|Result2}}</nowiki></code>, where <code>A</code> is some parameter. If <code>A</code> exists (i.e. it isn't null) then <code>Result1</code> is returned; otherwise, <code>Result2</code> is returned.
: ''Example:'' If a second unnamed parameter is provided, <code><nowiki>{{#if: {{{2|}}}|hello|goodbye}}</nowiki></code> produces <code>hello</code>. If not, it produces <code>goodbye</code>.
 
;Case-Switch
: This function performs a series of string compares until a "true" result is found.
: ''Use:'' <code><nowiki>{{#switch: X|A=Result1|B=Result2|C=Result3|etc.|Default}}</nowiki></code>, where <code>X</code> is compared to <code>A</code>, <code>B</code>, and so on. The first match provides the corresponding result. A final, default result may be provided in case no match is found.
: ''Example:'' <code><nowiki>{{#switch: cat|dog=bark|cat=meow|growl}}</nowiki></code> produces <code>meow</code> and <code><nowiki>{{#switch: bear|dog=bark|cat=meow|growl}}</nowiki></code> produces <code>growl</code>.
 
=== System Variables ===
There are a few system variables which provide different values as needed. These are given in all caps between double curly braces. For an extensive list, see [https://www.mediawiki.org/wiki/Help:Magic_words MediaWiki's Magic Words] page. The two most common are:
 
;Pagename
: <code><nowiki>{{PAGENAME}}</nowiki></code> provides the name of the page/article. If used in this page it would yield <code>Templates</code>.
 
;Namespace
: <code><nowiki>{{NAMESPACE}}</nowiki></code> provides the name of the page's namespace. If used in this page it would yield <code>Help</code>.
 
=== Comments ===
Comments inside of <code><nowiki><includeonly></nowiki></code> tags can be provided between <code><nowiki><!--</nowiki></code> and <code><nowiki>--></nowiki></code>.
 
Note: You might see a lot of these in existing templates, at the beginning and end of each line. White space can do strange things in templates, and so it is best to eliminate unnecessary white space by putting it inside of comments. One notable exception is inside tables, between the <code>|-</code> and the first cell <code>|</code>, which means the infobox {{t|row/kv}} (et al) can be nicely spaced without consequence.




{| style="width: 50%; margin: auto; font-size: 125%; text-align: center;" class="wikitable"
{| style="width: 50%; margin: auto; font-size: 110%; text-align: center;" class="wikitable"
|-
|-
| style="width: 33.33%; vertical-align: middle;" | ❮ [[Help: Categories | Categories]]
| style="width: 33.33%; vertical-align: middle;" | ❮ [[Help: Categories | Categories]]
Line 221: Line 175:
| style="width: 33.33%; vertical-align: middle;" | [[Help: What's Next?|What's Next?]] ❯  
| style="width: 33.33%; vertical-align: middle;" | [[Help: What's Next?|What's Next?]] ❯  
|}
|}
<br>


[[Category:Help]]
[[Category:Help]]

Latest revision as of 22:13, 27 May 2025

Table of Contents
Contents | Introduction | Guidelines | Markup | References | Images | Categories | Templates | What's Next?

Introduction

Templates are standard wiki pages whose content is designed to be transcluded (embedded) inside other pages. They enable a user to simplify complex and repetitive processes. You embed this content into other pages through the use of a coded tag. In this article we'll go over the basics of using templates, some useful templates that are already available, and an introduction to creating your own templates. For a more in depth guide on templates, check out Mediawiki's Help article.

Basics of Templates

Templates use coded tags which are easy to recognize as they are enclosed by double curly braces. ({{ and }}) To use one you must first indicate the name of the template you want to use, and then define various parameters. All of the elements between the double curly braces are separated by vertical bars. (|) The number and type of parameters will vary depending on the template.

Some templates will be written in a single line of text, but some may span multiple lines. The more complex it is, the more likely it is to span multiple lines—this is to help with clarity in usage. For example:

A Single Line Template A Multi-Line Template
{{template name|parameter1|parameter2|parameter3}}
{{template name
|parameter1
|parameter2
|parameter3
}}

Parameters

Parameters come in two varieties: Named and Unnamed (also sometimes called "Anonymous"). Templates will use one or the other, or sometimes even both. You can see the exact parameters a template uses by checking out its template page.

Named Parameters
Named parameters can be recognized by their use of an equals sign (=), which is required with a named parameter. The equals sign is followed by your input. For example:
{{template name|parameter1=INPUT}}
In this example parameter1= is a named parameter because of its use of an equals sign. INPUT would be replaced by your input.
Unnamed Parameters
Unnamed parameters should be completely replaced by your input. For example:
{{template name|INPUT}}
In this example INPUT is an unnamed parameter, and would be replaced by your input. Note that no other text is required beyond your input.

Parameter Examples

Let's take a look at some templates in action.

Example: Named Parameters
This example demonstrates a {{Character}} infobox template, which uses named parameters. Note that the name of the template comes first. ("{{character"), followed by the named parameters.
You Type You Get
{{character
|name=Beth Brower
|image=Beth Brower-2.jpg
|caption=Our Undaunted Author
|profession=Author, Owner of Cat
|titles=''The Right Honorable Beth''
}}
Beth Brower
Our Undaunted Author
Our Undaunted Author
Our Undaunted Author
ProfessionAuthor, Owner of Cat
TitlesThe Right Honorable Beth


Example: Unnamed Parameters
This example demonstrates a {{Quote}} template, which uses unnamed parameters.
You Type You Get
{{quote|My existence of the last three years has been nothing but incident.|Emma M. Lion}}
“

My existence of the last three years has been nothing but incident. ”

—Emma M. Lion


Example: Mix of Parameters
This example demonstrates an {{Image}} template, which uses a mix of named and unnamed parameters.
You Type You Get
{{image|Pen.png|A pen nib silhouette.|align=left|width=200px}}
A pen nib silhouette.

Types of Templates

Next we'll go over the most common templates you will encounter. The explanations below give only a brief description of their function. To learn how to use or implement a particular template into the content of an article, please visit the linked templates page:

Information Boxes

Information boxes, or as they're more commonly known, Infoboxes, are templates that add a table of basic information related to the subject of that page to the top right of the page. There are infoboxes for each of the main content categories (e.g., {{book}}, {{character}}, {{location}}), but there are a few other more specialized ones.

Navigation Boxes

Navigation boxes, also called navboxes, are templates that create a table of links related to the book/series of that page. Navboxes are placed in the Notes section of articles, between the <references /> tag and any quality tags.

Notices

Notice templates are used to alert users and editors of important information. The table below gives a brief description of a few notices:

Template Description
{{urgent}} Adds a red quill indicator icon (An red quill icon.) to the top right of a page and adds the article to the category Category:Articles in Need of Attention. Place directly after the infobox.
{{spoiler}} Warns that an article or section contains information pertaining to recently published material that many users may not have read yet. Place directly after infobox or at the top of the relevant section..
{{claim}} Warns other users that a page or section has been claimed for editing and asks that they collaborate with that user before making any edits. Place at the top of the page, after the infobox (if present), or at the top of the claimed section.
{{copyright}} Notifies users that a page or section contains copyrighted material that is used with permission and to warn them against reusing it.
{{theory}} Warns that the article or section contains speculation and should not be considered canon. Place directly after infobox or directly after section heading.
{{delete}} Requests that an administrator delete the page.
{{rename}} Requests that an administrator rename the page. An unnamed parameter may be included to indicate the new proposed name.
Quality Tags Quality tags are simple templates that indicate the level of completion/quality of an article and categorize it accordingly. These are discussed in detail on the Help:Categories page and include {{stub}}, {{partial}}, and {{complete}}

Reference Templates

Reference Templates are used to create footnotes and references in an article. Wherever the template is used, a superscripted number is added that links to the full reference in the "Notes" section. Additionally, hovering over the superscripted number for a brief second will trigger a popup window where one can also see the linked footnote without having to click the link.

Editorial Notations

Editorial Notations are used to highlight statements in articles that may need attention. This typically is applied to information that is unsupported, ambiguous, or questionable.

Other Templates

For more details on each templates usage, see the linked template page.

Some other notable templates include the following:

Template Description
{{columns}} The {{columns}} template is used to create a list of items that spans the width of the page instead of creating a line break between each item in the list. The default number of columns is three, but can be customized to any number the user wishes.
{{quote}} The {{quote}} template creates a stylized quote block. Users have the option to add a reference to the source. The default width of the quote block is 100%, but there are optional parameters to define width and alignment to allow a user to insert quotes in blocks of text.
{{for}} Use the {{for}} template to provide a link to a related topic or page. The output of this template is "For________, see [LINK]". You can see this template in use several times on this very page.
{{b}} The {{b}} template converts an abbreviated reference into a full book or series title. (e.g., Writing "{{b|e1}}" will output: "The Unselected Journals of Emma M. Lion: Volume 1".) Thereby simplifying and speeding up the process of including full titles in articles.

Editing Templates

Creating and editing templates is quite an advanced topic. For extensive instructions on building templates, check out MediaWiki's Help Manual. Feel free to make use of the {{test}} template to experiment with edits to existing templates or in creating new ones.


❮ Categories Templates What's Next? ❯