View source for Template:Correct title/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

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|< > [ ] { }]]), 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 |, pass the {{para|reason|vbar}} parameter. Use {{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 <code>|edit=</code> parameter providing the correct wording.

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

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

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

===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, and vbar (for |).",
			"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"
		}
	},
	"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"
	]
}
</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>