Template:Correct title/doc

This is a documentation subpage for Template:Correct title.
It contains usage information, categories and other content that is not part of the original page.

This template uses material from the Wikipedia template Template:Correct title/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors).

This template uses Lua:

Module:Correct title categories

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

For titles exceeding the 256 character length limit, pass the |reason=length parameter.

At The Boy Bands Have Won:

{{correct title|The Boy Bands Have Won, and All the Copyists and the Tribute Bands and the TV Talent Show Producers Have Won, If We Allow Our Culture to Be Shaped by Mimicry, Whether from Lack of Ideas or from Exaggerated Respect. You Should Never Try to Freeze Culture. What You Can Do Is Recycle That Culture. Take Your Older Brother's Hand-Me-Down Jacket and Re-Style It, Re-Fashion It to the Point Where It Becomes Your Own. But Don't Just Regurgitate Creative History, or Hold Art and Music and Literature as Fixed, Untouchable and Kept Under Glass. The People Who Try to 'Guard' Any Particular Form of Music Are, Like the Copyists and Manufactured Bands, Doing It the Worst Disservice, Because the Only Thing That You Can Do to Music That Will Damage It Is Not Change It, Not Make It Your Own. Because Then It Dies, Then It's Over, Then It's Done, and the Boy Bands Have Won.|reason=length}}

The template can also be used without a reason. For example, at Robot Face:

{{Correct title|<{{!}}°_°{{!}}>}}

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
Parameter		Description	Type	Status
Correct title	`1` `title`	The correct name of the page.	Line	required
Reason	`reason`	The reason the correct title cannot be used as the page title. Possible reasons are #, :, bracket, vbar (for \|), and length. Example #	Line	optional
Substitution or omission	`edit`	Override the word used to describe the difference between the correct title and the actual page title.	Line	optional

Examples

TemplateData

See also