Template:Infobox Documentary/doc: Difference between revisions
(adding new vars) |
(expanding explanation) |
||
Line 1: | Line 1: | ||
{{Infobox Doc | {{Infobox Doc | ||
|image=Image.jpg, automatically sized to 250px | |image = Image.jpg, automatically sized to 250px | ||
|subject = a brief summary of the subject of the documentary; you must give this variable a value | |subject = a brief summary of the subject of the documentary; you must give this variable a value | ||
|name = name of documentary; you must give this variable a value | |name = name of documentary; you must give this variable a value | ||
Line 13: | Line 13: | ||
|home audio = if a documentary has been made available on home audio, put the name of the CD here | |home audio = if a documentary has been made available on home audio, put the name of the CD here | ||
|narrator = put the name of the credited narrator here | |narrator = put the name of the credited narrator here | ||
|multiple narrators = if there's more than one narrator, use this unlinked variable | |||
|interviewer = put the name of any interviewers here | |interviewer = put the name of any interviewers here | ||
|multiple interviewers = if there's more than one interviewer, use this unlinked variable | |||
|interviewee = put the names of the major interviewees here | |interviewee = put the names of the major interviewees here | ||
|uncredited narrator = put the name of the uncredited narrator here | |uncredited narrator = put the name of the uncredited narrator here | ||
Line 38: | Line 40: | ||
narrator=[[Alex Price]] | narrator=[[Alex Price]] | ||
</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. | |||
==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: | |||
<pre> | <pre> | ||
broadcast date=[[12th May]] [[2006]] | broadcast date=[[12th May]] [[2006]] | ||
</pre> | </pre> | ||
===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: | |||
<pre>interviewee = [[David Tennant]], [[Catherine Tate]], [[Russell T Davies]]</pre> | |||
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 | |||
!width=50%|Singular <br>''the template <br>links for you'' | |||
!width=50%|Plural<br>''you supply <br>the <nowiki>[[brackets]]</nowiki> | |||
|-align=center | |||
|narrator||multiple narrators | |||
|-align=center | |||
|producer||multiple producers | |||
|-align=center | |||
|executive producer||multiple execs | |||
|-align=center | |||
|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". | 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". | ||
Line 50: | Line 72: | ||
<pre> | <pre> | ||
{{Infobox Doc | {{Infobox Doc | ||
|image | |image = | ||
|subject | |subject = | ||
|name | |name = | ||
|series | |series = | ||
|original to DVD | |original to DVD = | ||
|original to VHS | |original to VHS = | ||
|original to CD | |original to CD = | ||
|original to web | |original to web = | ||
|channel | |channel = | ||
|broadcast with | |broadcast with = | ||
|home video | |home video = | ||
|home audio | |home audio = | ||
|narrator | |narrator = | ||
|interviewer | |multiple narrators = | ||
|interviewee | |interviewer = | ||
|uncredited narrator = | |multiple interviewers = | ||
|director | |interviewee = | ||
|producer | |uncredited narrator = | ||
|multiple producers | |director = | ||
|executive producer | |producer = | ||
|multiple execs | |multiple producers = | ||
|broadcast date | |executive producer = | ||
|release date | |multiple execs = | ||
|runtime | |broadcast date = | ||
|previous | |release date = | ||
|next | |runtime = | ||
|previous = | |||
|next = | |||
}} | }} | ||
</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 15:00, 13 May 2011
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.