Template:Wrongname/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
No edit summary
Tags: Mobile edit Mobile web edit
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This template should be placed at the top of articles whose names cannot be represented on this wikia due to limitations of the MediaWiki software.  A prime example is the article on [[2 entertain]].  The proper spelling of the name involves a pipe ([[2 entertain|2{{!}}entertain]], which is not an allowed character in MediaWiki page names.
'''{{PAGENAME}}''' should be placed at the top of articles whose names cannot be represented on this wikia due to limitations of the MediaWiki software.  A prime example is the article on [[Project Lazarus (audio story)|Project Lazarus]].  The proper spelling of the name involves a colon after "Project" — '''[[Project Lazarus (audio story)|Project: Lazarus]]''' — but "Project:" is always converted to "Tardis:" on this wiki.  If you tried to link to "Project: Lazarus", the system would therefore try to link to a page called "Lazarus" in the Tardis: [[namespace]].  Thus we have to title the article ''without'' the colon.
==Usage==
== Usage ==
To use, simply place the following at the '''top''' of the page:
To use, simply place the following at the '''top''' of the page:
<pre>
<pre>
{{wrongname
{{wrongname|workaround=}}
|workaround=
 
}}
in certain circumstances, an additional variable may be needed:
 
{{wrongname|workaround=|title=}}
</pre>
The variable, '''''workaround''''', allows the user to enter a way to represent the name properly. 
 
To remove the instructions for {{tlx|cs}}, include <code>cs=n</code>.
 
=== Most cases ===
In most cases, characters not permitted in page titles can nevertheless be typed directly into '''''workaround'''''.  So, to represent "Man #2" — a fairly widespread usage in the end credits of [[Doctor Who Universe|DWU]] credits — one would title the page [[Man 2 (episode name)]], and then add this template to the top of it, like this:
<pre>
{{wrongname|workaround=Man #2 (episode name)}}
</pre>
</pre>
The variable, '''''workaround''''' allows the user to enter a way to represent the name properly.  This generally involves using a tiny template to allow for the proper inclusion of a special character.  In the case of [[2 entertain]], the pipe is rendered using [[:Template:!]], thus making the value of '''''workaround''''': <nowiki>2{{!}}entertain</nowiki>
===Future development===
Though at present this template is really only necessary on this wiki for the one page, it's possible that there may be other cases where it will be necessary to use this template, and to create new templates like [[:template:!]] to allow for the proper rendering of a name.


The following symbols cannot be used in a page title, and would thus require this template, should they be used in the proper spelling/punctuation of a topic's name:
All the following characters can be used in the same fashion as the pound/hash mark seen above:
*<nowiki>#</nowiki> - workaround [[:Template:pound]] (also redirected through [[:Template:hash]], for Br. Eng. speakers)
* <nowiki>#</nowiki>  
*< - workaround [[:Template:bracketed]]
* < 
*> - workaround [[:Template:bracketed]]
* > 
*[ - workaround [[:Template:bracketed]]
* [
*] - workaround [[:Template:bracketed]]
* ]
*| - workaround [[:Template:!]]
* { 
*{ - workaround [[:Template:bracketed]]
* }
*} - workaround [[:Template:bracketed]]
=== Use with pipes ({{!}}) ===
Pipes are special symbols that usually do not print.  They also have special meaning with respect to page titles.  Therefore, they require a slightly more elaborate use of this template.  So far, the only real example of a pipe in a topic's title on this wiki is [[2 entertain]]. Thus we shall look at it as a model of how to handle the pipe case.  
 
The only way to get the pipe to render is to use [[:Template:!]].  However, because 2|entertain requires this additional ''template'', it also requires an additional ''variable'' to be used with [[:template:wrongname]].  Thus, the full markup '''for use on a page that requires a pipe character''' follows this pattern:
::::'''<nowiki>
{{</nowiki>wrongname<br />|workaround=2<nowiki><nowiki>{{!}}</nowiki></nowiki>entertain<br />|title=2<nowiki>{{!}}</nowiki>entertain}}
 
In this instance, '''''workaround''''' requires '''nowiki''' codes in order to actually show the <nowiki>{{!}}</nowiki> markup, while '''''title''''' '''does not''' include '''nowiki''' codes, in order to show the title properly rendered with wiki code.


==Sample output==
== Sample output ==
{{wrongname}}
{{wrongname|workaround=Project: Lazarus}}Note in the sample output at right that the template ''defaults'' to using '''''workaround''''' in two places. If '''''title''''' is defined, then it will replace the first instance of '''''workaround'''''.
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>
== Template classification ==
This template is '''intentionally''' misclassified as "non-article" for technical reasons.

Latest revision as of 09:18, 2 August 2024

Wrongname/doc should be placed at the top of articles whose names cannot be represented on this wikia due to limitations of the MediaWiki software. A prime example is the article on Project Lazarus. The proper spelling of the name involves a colon after "Project" — Project: Lazarus — but "Project:" is always converted to "Tardis:" on this wiki. If you tried to link to "Project: Lazarus", the system would therefore try to link to a page called "Lazarus" in the Tardis: namespace. Thus we have to title the article without the colon.

Usage

To use, simply place the following at the top of the page:

{{wrongname|workaround=}}

in certain circumstances, an additional variable may be needed:

{{wrongname|workaround=|title=}}

The variable, workaround, allows the user to enter a way to represent the name properly.

To remove the instructions for {{cs}}, include cs=n.

Most cases

In most cases, characters not permitted in page titles can nevertheless be typed directly into workaround. So, to represent "Man #2" — a fairly widespread usage in the end credits of DWU credits — one would title the page Man 2 (episode name), and then add this template to the top of it, like this:

{{wrongname|workaround=Man #2 (episode name)}}

All the following characters can be used in the same fashion as the pound/hash mark seen above:

  • #
  • <
  • >
  • [
  • ]
  • {
  • }

Use with pipes (|)

Pipes are special symbols that usually do not print. They also have special meaning with respect to page titles. Therefore, they require a slightly more elaborate use of this template. So far, the only real example of a pipe in a topic's title on this wiki is 2 entertain. Thus we shall look at it as a model of how to handle the pipe case.

The only way to get the pipe to render is to use Template:!. However, because 2|entertain requires this additional template, it also requires an additional variable to be used with template:wrongname. Thus, the full markup for use on a page that requires a pipe character follows this pattern:

{{wrongname
|workaround=2<nowiki>{{!}}</nowiki>entertain
|title=2{{!}}entertain}}

In this instance, workaround requires nowiki codes in order to actually show the {{!}} markup, while title does not include nowiki codes, in order to show the title properly rendered with wiki code.

Sample output

Software limitations prevent us from representing the proper styling of this title, Project: Lazarus. See here for more details. Editors wishing to link to the article using the proper spelling can type [[Wrongname/doc|Project: Lazarus]], or {{cs|Wrongname/doc|Project: Lazarus}} if making use of {{cite source}}.

Note in the sample output at right that the template defaults to using workaround in two places. If title is defined, then it will replace the first instance of workaround.

Template classification

This template is intentionally misclassified as "non-article" for technical reasons.