Template:Correct title/doc

From The Goon Show Depository

< Template:Correct title

Revision as of 18:34, 25 July 2022 by en>Dinoguy1000 (little bit of dogfooding)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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=bracket}}

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

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

For issues with |, pass the |reason=vbar parameter. Use {{!}} 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:

TemplateData

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

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

Title changing or correcting templates + magic word [<span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>]
Wiki markup
Transclusion from template:
Involves Correct name Actual article name
{{Italic title}} Title in italics To Kill a Mockingbird To Kill a Mockingbird
{{Italic title|all=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes}}

Complete title in italics, including parentheses Randall and Hopkirk (Deceased) Randall and Hopkirk (Deceased)
{{Italic title|string=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Ally McBeal}}

Phrase of |string= in italics List of Ally McBeal episodes List of Ally McBeal episodes
{{Italic title|all=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes|string= Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Fringe}}

Phrase of |string= in italics; also looks in parentheses Peter (Fringe episode) Peter (Fringe episode)
{{Italic dab}} Disambiguation in italics The End (Lost) The End (Lost)
{{Lowercase title}} Lowercase first character eBay EBay
{{Lowercase title|italic=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes}}

Lowercase first character and place title in italics, not including disambiguation iCarly (soundtrack) ICarly (soundtrack)
{{Lowercase title|italic=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes|force= Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes}}

Lowercase first character and place title in italics, including disambiguation
{{Lowercase title|dab=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes}}

Lowercase first character and place disambiguation in italics iSpy (Modern Family) ISpy (Modern Family)
{{Correct title|reason=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.bracket}}

< > [ ] { } Benzo[a]pyrene Benzo(a)pyrene
{{Correct title|reason=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.#}}

# Pilot #5 Pilot No. 5
{{Correct title|reason=

Error: The retired template {{Template:Correct title/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.:}}

: DK: King of Swing DK King of Swing
Magic word:
{{DISPLAYTITLE}} Various _NSAKEY NSAKEY