Editing Module:Bad title suggestion/doc

{{documentation subpage}}
{{Used in system}}
{{Module rating|protected}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

This module implements title suggestions for the "Bad title" interface message at [[MediaWiki:Title-invalid-characters]]. When the user asks for a page with invalid characters, this module checks for a page with the given title up to the first invalid character. If it exists, {{tl|Did you mean box}} is displayed.

== Usage ==
<code><nowiki>{{#invoke:Bad title suggestion|main|invalid_char|bad_title_encoded}}</nowiki></code>

In the case of [[MediaWiki:Title-invalid-characters]], this is:

<code><nowiki>{{#invoke:Bad title suggestion|main|$1|$2}}</nowiki></code>

== Examples ==
*[{{canonicalurl:Foobar}}%3E Foobar>]: <code><nowiki>{{#invoke:Bad title suggestion|main|>|Foobar&amp;#62;}}</nowiki></code>
{{#invoke:Bad title suggestion|main|>|Foobar&#62;}}

*[{{canonicalurl:Wikipedia:Village pump}}%7D Wikipedia:Village pump}}]: <code><nowiki>{{#invoke:Bad title suggestion|main|}|Wikipedia:Village pump&amp;#125;&amp;#125;}}</nowiki></code>
{{#invoke:Bad title suggestion|main|}|Wikipedia:Village pump&#125;&#125;}}

*[{{canonicalurl:Main Page}}%7Ctitle_text%21 Main Page|title text!]: <code><nowiki>{{#invoke:Bad title suggestion|main|||Main Page&amp;#124;title text!}}</nowiki></code>
{{#invoke:Bad title suggestion|main|||Main Page&#124;title text}}

*[{{canonicalurl:This page absolutely does not exist}}%3E This page absolutely does not exist>]: <code><nowiki>{{#invoke:Bad title suggestion|main|>|This page absolutely does not exist&amp;#62;}}</nowiki></code>
{{#invoke:Bad title suggestion|main|>|This page absolutely does not exist&#62;}}(nothing displayed)

*[{{canonicalurl:Category:Contents}}%3E Category:Contents>]: <code><nowiki>{{#invoke:Bad title suggestion|main|>|Category:Contents&amp;#62;}}</nowiki></code>
{{#invoke:Bad title suggestion|main|>|Category:Contents&#62;}}

*[{{SERVER}}/wiki/%3CFoobar%3E <Foobar>]: <code><nowiki>{{#invoke:Bad title suggestion|main|<|#60;Foobar#62;}}</nowiki></code>
{{#invoke:Bad title suggestion|main|<|&60;Foobar&#62;}}(nothing displayed)

*[{{canonicalurl:Solo}}_&#91;3&#93; Solo [3&#93;]: <code><nowiki>{{#invoke:Bad title suggestion|main|[|Solo &#91;3&#93;}}</nowiki></code>
{{#invoke:Bad title suggestion|main|[|Solo &#91;3&#93;}}

* [https://en.wikipedia.org/wiki/M%3ETrain M>Train]: <code><nowiki>{{#invoke:Bad title suggestion|main|>|M&#62;Train}}</nowiki></code>

{{#invoke:Bad title suggestion|main|>|M&#62;Train}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>