Template:Counterparts/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
(Added Template documentation category)
 
(3 intermediate revisions by 2 users not shown)
Line 13: Line 13:


In theory, the template supports infinitely many counterparts, although there is a practical limit after which performance would begin to noticeably suffer.
In theory, the template supports infinitely many counterparts, although there is a practical limit after which performance would begin to noticeably suffer.
In cases where a dedicated template is not merited, but "the" is needed, you may simply add <code>|t=y</code> to the template.


== Example ==
== Example ==
{{counterparts |name=Twelfth Doctor
{{counterparts |name=Twelfth Doctor |t=y
|2=Twelfth Doctor (Shadow World)
|2=Twelfth Doctor (Shadow World)
|3=Twelfth Doctor (The Curse of Fatal Death) |d3=''The Curse of Fatal Death''
|3=Twelfth Doctor (The Curse of Fatal Death) |d3=''The Curse of Fatal Death''
|4=Twelfth Doctor (Four Doctors) |d4=''Four Doctors''}}
|4=Twelfth Doctor (Four Doctors) |d4=''Four Doctors''}}


The following code produces the box on the right:
The following code produces the box demonstrated here:


<pre>{{counterparts |name=Twelfth Doctor
<pre>{{counterparts |name=Twelfth Doctor |t=y
|2=Twelfth Doctor (Shadow World)
|2=Twelfth Doctor (Shadow World)
|3=Twelfth Doctor (The Curse of Fatal Death) |d3=''The Curse of Fatal Death''
|3=Twelfth Doctor (The Curse of Fatal Death) |d3=''The Curse of Fatal Death''
|4=Twelfth Doctor (Four Doctors) |d4=''Four Doctors''}}</pre>
|4=Twelfth Doctor (Four Doctors) |d4=''Four Doctors''}}</pre>


Obviously, since it's missing "the", this is an instance where creating a dedicated template would serve the situation better: in this case, {{tlx|Twelfth Doctor counterparts}}.
For commonly used counterpart boxes such as this one, creating a separate template may be desirable: in this case, {{tlx|Twelfth Doctor counterparts}}.
 
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 01:23, 18 December 2024

{{Counterparts}} is a template used to construct "alternate counterparts of..." boxes that go below infoboxes. It's syntax is simple:

{{counterparts |name=page name of primary counterpart
|dname=display name of primary counterpart
|1=first counterpart |d1=display name of second counterpart
|2=second counterpart |d2=display name of second counterpart}}

By default, the name of the primary counterpart used in the box's header is the page name of the page the template is being used on. If that is not desirable, it can optionally be specified using the name variable. This produces a link to the specified page with the display text set to the name specified but without the dab term. If a different display name should be used, that can be specified with the optional dname variable.

Counterparts are specified with numbered variables like 1 and 2. Technically, the actual "1=" bit can be omitted. However, that quickly becomes confusing when combining it with the display name variables. By default, the counterpart's dab term is used as display text. If there is no dab term, the full page name is used. If neither of these are desirable, a display name can be manually set using an optional "d" variable. For instance, if you want to specify the display name for the third counterpart, you would use the d3 variable.

It is more often than not desirable to use the same page as in the name variable for the first counterpart, along with the display text "The Doctor's universe". If this is needed, the first counterpart's variables can be left out entirely. If the same page name as in the name variable should be used as the first counterpart but with different display text, d1 can be specified as normal. For an example of this in use, see below.

In theory, the template supports infinitely many counterparts, although there is a practical limit after which performance would begin to noticeably suffer.

In cases where a dedicated template is not merited, but "the" is needed, you may simply add |t=y to the template.

Example[[edit source]]

The following code produces the box demonstrated here:

{{counterparts |name=Twelfth Doctor |t=y
|2=Twelfth Doctor (Shadow World)
|3=Twelfth Doctor (The Curse of Fatal Death) |d3=''The Curse of Fatal Death''
|4=Twelfth Doctor (Four Doctors) |d4=''Four Doctors''}}

For commonly used counterpart boxes such as this one, creating a separate template may be desirable: in this case, {{Twelfth Doctor counterparts}}.