View source for Template:Correct title/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{rdf|Template:Title|Template:Correct|a template to set the HTML <code>title</code> attribute|Template:Tooltip}}
{{Lua|Module:Correct title categories|Module:String}}
This is a [[Wikipedia:Maintenance|Wikipedia maintenance]] template that produces an article [[Wikipedia:Hatnote|hatnote]] to help explain to readers that restrictions on titles containing [[Colon (punctuation)|colons]], [[Full stop|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 [[WP:DISAMBIG|disambiguation]]-resolving terms within brackets. 

===Examples===
For issues with the ([[Number sign|#]]) sign, pass the {{para|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 <code>|edit=</code> parameter providing the correct wording.

:At [[Coffee 1]]:
:<code><nowiki>{{Correct title|Coffee #1|reason=#}}</nowiki></code>
{{Correct title|Coffee #1|reason=#|demopage=Coffee 1}}

:At [[The No. 1s]]:
:<code><nowiki>{{Correct title|The #1s|reason=#}}</nowiki></code>
{{Correct title|The #1s|reason=#|demopage=The No. 1s}}

For issues with any of ([[bracket|<nowiki>[ ] { }</nowiki>]]), or (<nowiki>< ></nowiki>) when used as brackets, pass the {{para|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 <code>|edit=</code> parameter providing the correct wording.
:At [[Benzo(a)pyrene|Benzo(''a'')pyrene]]:
:<code><nowiki>{{Correct title|Benzo[''a'']pyrene|reason=bracket}}</nowiki></code>
{{Correct title|Benzo[''a'']pyrene|reason=bracket|demopage=Benzo(a)pyrene}}

:At ''[[(an imitation) blood orange]]'':
:<code><nowiki>{{Correct title|''[(an imitation) blood orange]''|reason=bracket}}</nowiki></code>
{{Correct title|''[(an imitation) blood orange]''|reason=bracket|demopage=(an imitation) blood orange}}

For issues with :, pass the {{para|reason|:}} parameter:
:At ''[[DK King of Swing]]'':
:<code><nowiki>{{Correct title|''DK: King of Swing''|reason=:}}</nowiki></code>
{{Correct title|''DK: King of Swing''|reason=:|demopage=DK King of Swing}}

For issues with {{pipe}}, pass the {{para|reason|vbar}} parameter. Use {{tl|pipe}} instead of {{pipe}} while providing the correct title in the template (since {{pipe}} 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 <code>|edit=</code> parameter providing the correct wording.

:At [[Europa – Fira station]]:
:<code><nowiki>{{Correct title|Europa {{pipe}} Fira station|reason=vbar}}</nowiki></code>
{{Correct title|Europa {{pipe}} Fira station|reason=vbar|demopage=Europa – Fira station}}

:At ''[[DE9 Transitions]]'':
:<code><nowiki>{{Correct title|''DE9 {{pipe}} Transitions''|reason=vbar}}</nowiki></code>
{{Correct title|''DE9 {{pipe}} Transitions''|reason=vbar|demopage=DE9 Transitions}}

For titles exceeding the 256 byte length limit, pass the {{para|reason|length}} parameter.

:At ''[[The Boy Bands Have Won]]'':
:<code><nowiki>{{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}}</nowiki></code>
{{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|demopage=The Boy Bands Have Won}}

The template can also be used without a reason. For example, at ''[[Robot Face]]'':
:<code><nowiki>{{Correct title|<{{pipe}}°_°{{pipe}}>}}</nowiki></code>
{{Correct title|<{{pipe}}°_°{{pipe}}>|demopage=Robot Face}}

In some special cases, the word "incorrectly" can be replaced with "differently" to avoid confusion. For example, at [[Period (album)|''Period'' (Kesha album)]]:
:<code><nowiki>{{Correct title|.|reason=.|nocat=1}}</nowiki></code>
{{Correct title|.|reason=.|demopage=Period (Kesha album)}}

===TemplateData===
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Correct title",
			"description": "The correct name of the page.",
			"type": "line",
			"required": true,
			"aliases": [
				"title"
			]
		},
		"reason": {
			"label": "Reason",
			"description": "The reason the correct title cannot be used as the page title. Possible reasons are #, :, ., bracket, vbar (for |), and length.",
			"example": "#",
			"type": "line"
		},
		"edit": {
			"label": "Substitution or omission",
			"description": "Override the word used to describe the difference between the correct title and the actual page title.",
			"type": "line"
		},
		"nocat": {
			"label": "Suppress categorization in special cases",
			"description": "In rare cases related to dots and slashes (WP:NC-SLASH) a page may be automatically and mistakenly placed into 'Pages using technically valid titles in correct title hatnotes' category. Avoid this by using nocat=1",
			"type": "line"
		}
	},
	"description": "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.",
	"paramOrder": [
		"1",
		"reason",
		"edit",
		"nocat"
	]
}
</templatedata>

=== See also ===
* [[Wikipedia:Naming conventions (technical restrictions)]]
* {{tl|Technical reasons}}
* [[:Category:Restricted titles]]
* Similar templates:
{{Correct title examples}}

<includeonly>{{sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Correct title templates]]

}}</includeonly>