Difference between revisions of "Template:About/doc"

From SpiralKnights

Jump to: navigation, search
m (created)
 
m (→‎Required)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation subpage}}</noinclude>
 
==Usage==
 
==Usage==
 
For clearing up confusion due to extremely similar names, odd naming convention, and/or disambiguation issues.  
 
For clearing up confusion due to extremely similar names, odd naming convention, and/or disambiguation issues.  
Line 4: Line 5:
 
==Code==
 
==Code==
 
<pre>
 
<pre>
−
{{about}}
+
{{About|USE1|PAGE or PAGES}}
 
</pre>
 
</pre>
  
 
==Parameters==
 
==Parameters==
 
===Required===
 
===Required===
−
*None
+
|1
 +
:Summarize the article briefly.
  
−
===Optional===
+
|2
−
*1
+
:The name of the page or pages linked to. It is prudent to link to the relevant (disambiguation).
−
:Defaults to <nowiki>{{PAGENAME}}</nowiki>. Should be the article title, can be changed as needed for clarity.
+
−
 
+
−
*2
+
−
:Defaults to a phrase "a specific." Can be changed as needed for clarity.
+
−
 
+
−
*3
+
−
:Defaults to a search function. The result is similar to pressing "search" under the search bar instead of "go." Can be changed to direct to a disambiguation page if editors feel that is prudent.
+
  
 
==Example==
 
==Example==
−
<pre>
+
For examples of this template in action, see [http://wiki.spiralknights.com/index.php?title=Special%3AWhatLinksHere&limit=500&target=Template%3AAbout&namespace=0 what links here].
−
{{about|Coat}}
+
−
</pre>
+
−
 
+
−
;Produces
+
−
 
+
−
{{about|Coat}}
+
  
 
==Notes==
 
==Notes==
−
Please use sparingly. It is the norm for items in SK to be closely related with similar names, so using a template like this really interrupts the flow and core function of pages. For a long time editors have used redirects to get players where they need to go on average - but that's an average. Without a template like this, some things can be confusing for new players searching for one type of thing but ending up somewhere else. This should help with future article issues too, if more furniture items share names with tokens and gear and whatnot.
+
Please use sparingly. It is the norm for items in SK to be closely related with similar names, so using hatnote templates tends to interrupt the flow and core function of pages. Editors use redirects to get players where they need to go on average - but that's an average. Without a template like this, some things can be confusing for new players searching for one type of thing but ending up somewhere else.  
  
−
See [http://wiki.spiralknights.com/Special:WhatLinksHere/Template:About What links here] to keep track of this template and to see more examples of its usage.
+
For further reading, see [https://en.wikipedia.org/wiki/Template:About Wikipedia's "About" template].

Latest revision as of 18:36, 11 September 2015

Template-info.png This is a documentation subpage for Template:About (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Usage

For clearing up confusion due to extremely similar names, odd naming convention, and/or disambiguation issues.

Code

{{About|USE1|PAGE or PAGES}}

Parameters

Required

|1

Summarize the article briefly.

|2

The name of the page or pages linked to. It is prudent to link to the relevant (disambiguation).

Example

For examples of this template in action, see what links here.

Notes

Please use sparingly. It is the norm for items in SK to be closely related with similar names, so using hatnote templates tends to interrupt the flow and core function of pages. Editors use redirects to get players where they need to go on average - but that's an average. Without a template like this, some things can be confusing for new players searching for one type of thing but ending up somewhere else.

For further reading, see Wikipedia's "About" template.

Retrieved from "https://wiki.spiralknights.com/index.php?title=Template:About/doc&oldid=215411"
Personal tools