Template:About-canon/doc

From TSP Encyclopedia
Revision as of 03:19, 4 January 2022 by Pronoun (talk | contribs) (documentation is good!)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

{{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}}
  • {{About-canon|p|n}}
  • {{About-canon|custom1|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.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:About-canon in articles based on its TemplateData.

TemplateData for About-canon

This template is a hatnote in the format "This page is about … For other uses …".

Template parameters

ParameterDescriptionTypeStatus
Page description1

What the page this template is placed on is about ("This page is about …")

Stringsuggested
Other page 1 description2

What the first other page is about. If unused or blank, defaults to "For other uses".

Stringsuggested
Other page 1 title3

The title of the first other page. If unused, defaults to "[page title] (disambiguation)".

Page namesuggested
Other page 2 description4

What the second other page is about.

Stringoptional
Other page 2 title5

The title of the second other page. If unused or blank and parameter 4 exists, defaults to "[page title] (disambiguation)".

Page nameoptional
Other page 3 description6

What the third other page is about.

Stringoptional
Other page 3 title7

The title of the third other page. If unused or blank and parameter 6 exists, defaults to "[page title] (disambiguation)".

Page nameoptional
Other page 4 description8

What the fourth other page is about.

Stringoptional
Other page 4 title9

The title of the fourth other page. If unused or blank and parameter 8 exists, defaults to "[page title] (disambiguation)".

Page nameoptional
sectionsection

Pass "yes" in this parameter to get wording appropriate for use at the top of a section.

Auto value
yes
Stringoptional
Custom texttext

Text to be appended to the end.

Stringoptional



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