Template:Infobox Documentary/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
(expanding explanation)
m (Robot: Cosmetic changes)
Line 31: Line 31:
}}'''{{PAGENAME}}''' is a template that can be used for any documentary, whether audio or video, broadcast or DVD special feature.  Because it is a multi-media template, no single page will use all the variables the template enables. Please use the template to include information primarily about the '''original public form of the documentary'''.  However, if a documentary once available elsewhere has since been repurposed for a home audio or video release, the infobox does allow you to list details about the secondary (and in most cases, more well-known) home for the documentary.
}}'''{{PAGENAME}}''' is a template that can be used for any documentary, whether audio or video, broadcast or DVD special feature.  Because it is a multi-media template, no single page will use all the variables the template enables. Please use the template to include information primarily about the '''original public form of the documentary'''.  However, if a documentary once available elsewhere has since been repurposed for a home audio or video release, the infobox does allow you to list details about the secondary (and in most cases, more well-known) home for the documentary.


==Auto-linking variables==
== Auto-linking variables ==
Note that many of this template's variables are fully self-linking.  Thus, to indicate that [[Alex Price]] was the narrator of an episode, you would enter simply:
Note that many of this template's variables are fully self-linking.  Thus, to indicate that [[Alex Price]] was the narrator of an episode, you would enter simply:
<pre>
<pre>
Line 41: Line 41:
</pre>
</pre>
If you look in the sample infobox to your right, all the variables whose values are in red are auto-linking variables.  All the ones in black require you to manually type in the <nowiki>[[brackets]]</nowiki> yourself.
If you look in the sample infobox to your right, all the variables whose values are in red are auto-linking variables.  All the ones in black require you to manually type in the <nowiki>[[brackets]]</nowiki> yourself.
==Non-linking variables==
== Non-linking variables ==
There are, however, some cases where you must still put the brackets in yourself.
There are, however, some cases where you must still put the brackets in yourself.
===Dates===
=== Dates ===
Broadcast and release date variables do not auto-link.  These dates must be entered as:
Broadcast and release date variables do not auto-link.  These dates must be entered as:
<pre>
<pre>
broadcast date=[[12th May]] [[2006]]
broadcast date=[[12th May]] [[2006]]
</pre>
</pre>
===Variables which can have multiple responses===
=== Variables which can have multiple responses ===
In cases where more than one individual is expected by a variable, the variable is not auto-linking.  The most obvious example of this is the interviewee variable.  Almost every documentary has more than one interviewee, so this variable doesn't link.  It would be entered thus:
In cases where more than one individual is expected by a variable, the variable is not auto-linking.  The most obvious example of this is the interviewee variable.  Almost every documentary has more than one interviewee, so this variable doesn't link.  It would be entered thus:
<pre>interviewee = [[David Tennant]], [[Catherine Tate]], [[Russell T Davies]]</pre>
<pre>interviewee = [[David Tennant]], [[Catherine Tate]], [[Russell T Davies]]</pre>
Line 54: Line 54:
There are a whole class of variables which ordinarily expect only one person, but which can, in special cases, take more than one.  For example, there's normally only one narrator on a project.  However, for those cases where there's more than one, you'd use the non-linking variable, "multiple narrators".  Here's a simple list.
There are a whole class of variables which ordinarily expect only one person, but which can, in special cases, take more than one.  For example, there's normally only one narrator on a project.  However, for those cases where there's more than one, you'd use the non-linking variable, "multiple narrators".  Here's a simple list.
{|align=center
{|align=center
!width=50%|Singular <br>''the template <br>links for you''
!width=50%|Singular <br />''the template <br />links for you''
!width=50%|Plural<br>''you supply <br>the <nowiki>[[brackets]]</nowiki>
!width=50%|Plural<br />''you supply <br />the <nowiki>[[brackets]]</nowiki>
|-align=center
|-align=center
|narrator||multiple narrators
|narrator||multiple narrators
Line 68: Line 68:
Also, the narrator, interviewer and interviewee variables are non-linking to allow for the entry of more than one person.  Likewise, the subject variable is free-form, as is the variable "original to web".
Also, the narrator, interviewer and interviewee variables are non-linking to allow for the entry of more than one person.  Likewise, the subject variable is free-form, as is the variable "original to web".


==Usage==
== Usage ==
Copy and paste '''all''' of the text below onto whichever article page it is needed for (even if some fields are not needed, copy '''all''' of the text).
Copy and paste '''all''' of the text below onto whichever article page it is needed for (even if some fields are not needed, copy '''all''' of the text).
<pre>
<pre>
Line 103: Line 103:
</pre>
</pre>


The sample output at right gives a description of what each of the fields are for. Due to the auto-linking nature of the template, some of the text may be slightly obscured by stray coding elements.
The sample output at right gives a description of what each of the fields are for. Due to the auto-linking nature of the template, some of the text may be slightly obscured by stray coding elements.

Revision as of 21:51, 30 January 2012

Infobox Documentary/doc is a template that can be used for any documentary, whether audio or video, broadcast or DVD special feature. Because it is a multi-media template, no single page will use all the variables the template enables. Please use the template to include information primarily about the original public form of the documentary. However, if a documentary once available elsewhere has since been repurposed for a home audio or video release, the infobox does allow you to list details about the secondary (and in most cases, more well-known) home for the documentary.

Auto-linking variables

Note that many of this template's variables are fully self-linking. Thus, to indicate that Alex Price was the narrator of an episode, you would enter simply:

narrator=Alex Price

not

narrator=[[Alex Price]]

If you look in the sample infobox to your right, all the variables whose values are in red are auto-linking variables. All the ones in black require you to manually type in the [[brackets]] yourself.

Non-linking variables

There are, however, some cases where you must still put the brackets in yourself.

Dates

Broadcast and release date variables do not auto-link. These dates must be entered as:

broadcast date=[[12th May]] [[2006]]

Variables which can have multiple responses

In cases where more than one individual is expected by a variable, the variable is not auto-linking. The most obvious example of this is the interviewee variable. Almost every documentary has more than one interviewee, so this variable doesn't link. It would be entered thus:

interviewee = [[David Tennant]], [[Catherine Tate]], [[Russell T Davies]]

There are a whole class of variables which ordinarily expect only one person, but which can, in special cases, take more than one. For example, there's normally only one narrator on a project. However, for those cases where there's more than one, you'd use the non-linking variable, "multiple narrators". Here's a simple list.

Singular
the template
links for you
Plural
you supply
the [[brackets]]
narrator multiple narrators
producer multiple producers
executive producer multiple execs
interviewer multiple interviewers

Also, the narrator, interviewer and interviewee variables are non-linking to allow for the entry of more than one person. Likewise, the subject variable is free-form, as is the variable "original to web".

Usage

Copy and paste all of the text below onto whichever article page it is needed for (even if some fields are not needed, copy all of the text).

{{Infobox Doc
|image                 =
|subject               =
|name                  =
|series                =
|original to DVD       =
|original to VHS       =
|original to CD        =
|original to web       =
|channel               =
|broadcast with        =
|home video            =
|home audio            =
|narrator              =
|multiple narrators    =
|interviewer           =
|multiple interviewers =
|interviewee           =
|uncredited narrator   =
|director              =
|producer              =
|multiple producers    =
|executive producer    =
|multiple execs        =
|broadcast date        =
|release date          =
|runtime               =
|previous              =
|next                  =
}}

The sample output at right gives a description of what each of the fields are for. Due to the auto-linking nature of the template, some of the text may be slightly obscured by stray coding elements.