Template:Infobox Documentary/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
Tag: sourceedit
No edit summary
Tag: sourceedit
Line 1: Line 1:
{{Infobox Doc
{{Infobox Doc
|name                = name of documentary; if you don't put anything, it will default to the pagename (which usually is fine)
|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; if you don't put anything, it will default to the pagename (which usually is fine)
|series              = name of series of which documentary is a part — this might be a series on DVDs (like the "Stripped for Action" series) or might be a broadcast documentary series (like "On Show")
|series              = name of series of which documentary is a part — this might be a series on DVDs (like the "Stripped for Action" series) or might be a broadcast documentary series (like "On Show")
|original to DVD    = if the documentary debuted on DVD, put the name of the DVD here; if a DW story, the name of the DVD is deemed to be the name of the story
|original to DVD    = ##{{!}}if the documentary debuted on DVD, put the name of the DVD here; if a DW story, the name of the DVD is deemed to be the name of the story
|original to VHS    = if the documentary debuted on VHS, put the name of the DVD here; if a DW story, the name of the VHS is deemed to be the name of the story
|original to VHS    = ##{{!}}if the documentary debuted on VHS, put the name of the DVD here; if a DW story, the name of the VHS is deemed to be the name of the story
|original to CD      = if the documentary debuted on an audio CD, put the name of that CD here
|original to CD      = ##{{!}}if the documentary debuted on an audio CD, put the name of that CD here
|original to web    = if the documentary debuted as a webcast, put the name of the website here
|original to web    = ##{{!}}if the documentary debuted as a webcast, put the name of the website here
|channel            = if the documentary debuted on broadcast radio or television, put the channel of first broadcast here
|channel            = ##{{!}}if the documentary debuted on broadcast radio or television, put the channel of first broadcast here
|broadcast with      = if the documentary debuted alongside another broadcast (as in the intermission of a ''Doctor Who at the Proms'' concert) name the "parent" programme here
|broadcast with      = ##{{!}}if the documentary debuted alongside another broadcast (as in the intermission of a ''Doctor Who at the Proms'' concert) name the "parent" programme here
|home video          = if a documentary has been made available on home video, put the name of that video here
|home video          = ##{{!}}if a documentary has been made available on home video, put the name of that video here
|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
|catno              = catalogue number
|catno              = catalogue number
|isbn                = ISBN number
|isbn                = ISBN number
|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
|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
|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
|executive producer  = put the name of the exec here
|executive producer  = ##{{!}}put the name of the exec here
|multiple execs      = if multiple exec producers, use this unlinked variable instead
|multiple execs      = if there's more than one exec, use this unliked variable instead.
|director            = put the name of the director here
|director            = ##{{!}}put the name of the director here
|producer            = put the name of the producer here
|multiple directors  = if there's more than one director, use this unlinked variable instead.
|producer            = ##{{!}}put the name of the producer here
|multiple producers  = if there's more than one producer, use this unlinked variable instead.   
|multiple producers  = if there's more than one producer, use this unlinked variable instead.   
|writer              = put the name of the writer here
|writer              = ##{{!}}put the name of the writer here
|multiple writers    = if there's more than one writer, use this unlinked variable instead.
|broadcast date      = if documentary was originally broadcast, put broadcast date here
|broadcast date      = if documentary was originally broadcast, put broadcast date here
|release date        = if documentary was originally published as a home video/audio, put release date here
|release date        = if documentary was originally published as a home video/audio, put release date here
|channel            = put original channel of broadcast here
|runtime            = put length of documentary here
|runtime            = put length of documentary here
|prev                = if part of a series, put previous entry here
|prev                = ##{{!}}if part of a series, put previous entry here
|next                = if part of a series, put next entry here
|next                = ##{{!}}if part of a series, put next entry here
}}
}}
{{you may|Template:Infobox Con/doc|n1=the way to use this template with ''Confidential'' episodes}}
{{you may|Template:Infobox Con/doc|n1=the way to use this template with ''Confidential'' episodes}}

Revision as of 02:59, 13 November 2016

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=[[12 May (releases)|]] [[2006 (releases)|]]

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               =
|original to DVD       =
|original to VHS       =
|original to CD        =
|original to web       =
|channel               =
|broadcast with        =
|home video            =
|home audio            =
|catno                 =
|isbn                  =
|narrator              =
|narrator2             =
|narrator3             =
|interviewer           =
|multiple interviewers =
|interviewee           =
|uncredited narrator   =
|director              =
|producer              =
|multiple producers    =
|executive producer    =
|multiple execs        =
|writer                =
|broadcast date        =
|release date          =
|runtime               =
|series                =
|prev                  =
|next                  =
|series2               =
|prev2                 =
|next2                 =
|series3               =
|prev3                 =
|next3                 =
}}

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.

Navigation

As with {[tl|Infobox Story}}, this template allows you to set multiple points of navigation. This could allow you to set one navigation point as"Black Orchid DVD documentaries and another as "Stripped for Action" — thus giving the Fifth Doctor's edition of Stripped for Action two points of navigation.

What if there is no navigation?

If the documentary is completely standalone, you'll probably want to turn navigation off entirely, which can be done by adding this line to the infobox:

|nav                   = 0

The next documentary is showing up in the previous column

With pages that are about the first item in a series, chances are that the "next" item is showing up in the "previous" column. To fix this, set prev = none. Likewise, the last item in a series should have next = none.

To see this in operation, please click through to The Making of The Trial of a Time Lord: Part One - Mysterious Planet.