Template:Correct title/doc

From blackwiki
Jump to navigation Jump to search

This is a Wikipedia maintenance template that produces an article hatnote to help explain to readers that restrictions on titles containing colons, periods, and some other characters (noted at Wikipedia:Naming conventions (technical restrictions)) affect the page name of the page they are reading.

The first unnamed parameter takes the correct name of the page. Do not include any disambiguation-resolving terms within brackets.

Examples

For issues with the (#) sign, pass the |reason=# parameter. If the stored page title length is 1 less than the correct title provided to the template, the wording "omission" is produced. Otherwise, the wording "substitution" is produced by default. If this is not correct for a particular page, add a |edit= parameter providing the correct wording.

At Coffee 1:
{{Correct title|Coffee #1|reason=#}}
At The No.1s:
{{Correct title|The #1s|reason=#}}

For issues with any of (< > [ ] { }), pass the |reason=bracket parameter. If the stored page title length is 2 less than the correct title provided to the template, the wording "omission" is produced. If both titles are of same length, the wording "substitution" is produced by default. If this is not correct for a particular page, add a |edit= parameter providing the correct wording.

At Benzo(a)pyrene:
{{Correct title|Benzo[a]pyrene|reason=bracket}}
At (an imitation) blood orange:
{{Correct title|[(an imitation)] blood orange|reason=backet}}

For issues with :, pass the |reason=: parameter:

{{Correct title|DK: King of Swing|reason=:}}

Template:Namespace detect

For issues with |, pass the |reason=vbar parameter. Use Template:T instead of | while providing the correct title in the template (since | characters are not allowed in template parameters). If the stored page title length is 1 less than the correct title provided to the template, the wording "omission" is produced. Otherwise, the wording "substitution" is produced by default. If this is not correct for a particular page, add a |edit= parameter providing the correct wording.

At Europa – Fira station:
{{Correct title|Europa {{!}} Fira station|reason=vbar}}
At DE9 Transitions:
{{Correct title|DE9 {{!}} Transitions|reason=vbar}}


The template can also be used without a reason, which produces:

Template:Namespace detect

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Correct title

This is a Wikipedia maintenance template that produces an article hatnote to help explain to readers that restrictions on titles containing colons, periods, and some other characters (noted at WP:NCTR) affect the page name of the page they are reading.

Template parameters

ParameterDescriptionTypeStatus
Correct title1 title

The correct name of the page.

Linerequired
Reasonreason

The reason the correct title cannot be used as the page title. Possible reasons are #, :, bracket, and vbar (for |).

Example
#
Lineoptional
Substitution or omissionedit

Override the word used to describe the difference between the correct title and the actual page title.

Lineoptional

See also

Template Involves Correct name Actual article name
{{Italic title}} Title in italics To Kill a Mockingbird To Kill a Mockingbird
{{Lowercase title}} Lowercase first character eBay EBay
{{Correct title|reason=bracket}} < > [ ] { } Benzo[a]pyrene Benzo(a)pyrene
{{Correct title|reason=#}} # Pilot #5 Pilot No. 5
{{Correct title|reason=:}} / : DK: King of Swing DK King of Swing
{{DISPLAYTITLE}} Various _NSAKEY NSAKEY