Template:About-canon/doc: Difference between revisions

From TSP Encyclopedia
Jump to navigation Jump to search
VisualWikitext
(documentation is good!)
 
(update modules, remove templatedata)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{High-use}}
{{ombox|type=content|text=This template should be used on articles only if other topics and articles exist with very similar names. For most articles, this is not true, so do not use this template on them.}}
{{ombox|type=content|text=This template should be used on articles only if other topics and articles exist with very similar names. For most articles, this is not true, so do not use this template on them.}}
{{Lua|Module:About}}
{{Lua|Module:About-canon}}
{{Tlc|About-canon}} is a [[wikipedia:WP:Hatnote|hatnote template]] that  
{{Tlc|About-canon}} is a [[wikipedia:WP:Hatnote|hatnote template]] that  


Line 24: Line 23:
For reference, see [[wikipedia:Wikipedia:hatnote]] and documentation below.
For reference, see [[wikipedia:Wikipedia:hatnote]] and documentation below.
{{Hatnote templates}}
{{Hatnote templates}}
==TemplateData==
{{TemplateData header}}
<!-- Should this mention the existence of "and"? It's something of a can of worms, since it only looks as though it only works in certain combinations of the other page 2/3/4 description fields... -->
<templatedata>
{
"description": "This template is a hatnote in the format \"This page is about … For other uses …\".",
"params": {
"1": {
"label": "Page description",
"type": "string",
"description": "What the page this template is placed on is about (\"This page is about …\")",
"suggested": true
},
"2": {
"label": "Other page 1 description",
"type": "string",
"description": "What the first other page is about. If unused or blank, defaults to \"For other uses\".",
"suggested": true
},
"3": {
"label": "Other page 1 title",
"type": "wiki-page-name",
"description": "The title of the first other page. If unused, defaults to \"[page title] (disambiguation)\".",
"suggested": true
},
"4": {
"label": "Other page 2 description",
"type": "string",
"description": "What the second other page is about."
},
"5": {
"label": "Other page 2 title",
"type": "wiki-page-name",
"description": "The title of the second other page. If unused or blank and parameter 4 exists, defaults to \"[page title] (disambiguation)\"."
},
"6": {
"label": "Other page 3 description",
"type": "string",
"description": "What the third other page is about."
},
"7": {
"label": "Other page 3 title",
"type": "wiki-page-name",
"description": "The title of the third other page. If unused or blank and parameter 6 exists, defaults to \"[page title] (disambiguation)\"."
},
"8": {
"label": "Other page 4 description",
"type": "string",
"description": "What the fourth other page is about."
},
"9": {
"label": "Other page 4 title",
"type": "wiki-page-name",
"description": "The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to \"[page title] (disambiguation)\"."
},
"section": {
"type": "string",
"description": "Pass \"yes\" in this parameter to get wording appropriate for use at the top of a section.",
"autovalue": "yes"
},
        "text": {
"label": "Custom text",
"type": "string",
"description": "Text to be appended to the end."
}
}
}
</templatedata>
<!-- To add more other pages, continue with this alternating pattern using increasing numbers, starting with 6 for the next page description. -->


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||

Revision as of 03:21, 4 January 2022

{{About-canon}} is a hatnote template that

and should be placed at the top of an article (but following {{Short description}}, if present), linking the reader to other articles with similar titles or concepts that they may have been seeking instead. It is similar to {{About}} but takes simplified parameters specific to TSP Encyclopedia.

Example usage:

  • {{About-canon|o}} →
    This template is about About-canon/doc in NationStates. For About-canon/doc in the Pacifica canon, see About-canon/doc (Pacifica).
  • {{About-canon|p|n}} →
    This template is about About-canon/doc in NationStates. For About-canon/doc in the Pacifica canon, see About-canon/doc (Pacifica). For About-canon/doc in NationStates, see About-canon/doc.
  • {{About-canon|custom1|custom2}} →
    This template is about About-canon/doc in NationStates. For About-canon/doc in the custom1 canon, see About-canon/doc (custom1). For About-canon/doc in the custom2 canon, see About-canon/doc (custom2).

Currently supported shorthand (all case-insensitive): p for Pacifica pages, n or m for NationStates pages, and a for A1-0 pages.

This template automatically detects (from the text in parentheses at the end of the article, if any) whether the current page is about NationStates or which roleplay canon the page is about. One possibly unexpected behavior as a result is that pages not in the article namespace, that have no disambiguator at the end, will be classified as NationStates articles.

Some additional features of {{About}} are also supported. For example:

A |text= option adds text to the end; this should only be used when truly necessary, when the other hatnote templates listed below don't suffice. This template supports |selfref= (see {{self reference}} and MOS:SELFREF for details).

For reference, see wikipedia:Wikipedia:hatnote and documentation below.



Lua error in Module:Effective_protection_level at line 63: attempt to index field 'TitleBlacklist' (a nil value).

Retrieved from "https://wiki.thesouthpacific.org/index.php?title=Template:About-canon/doc&oldid=13631"