Template:Infobox Documentary/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
No edit summary
Tag: sourceedit
No edit summary
 
(8 intermediate revisions by 2 users not shown)
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
|series episode number = 0
|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
|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
|interviewer           = ##{{!}}put the name of any interviewers here
|interviewer         = ##{{!}}put the name of any interviewers here
|interviewee           = put the names of the major interviewees here
|multiple interviewers = if there's more than one interviewer, use this unlinked variable
|uncredited narrator   = put the name of the uncredited narrator here
|interviewee         = put the names of the major interviewees here
|executive producer   = ##{{!}}put the name of the exec here
|uncredited narrator = put the name of the uncredited narrator here
|director             = ##{{!}}put the name of the director here
|executive producer = ##{{!}}put the name of the exec here
|producer             = ##{{!}}put the name of the producer here
|multiple execs      = if there's more than one exec, use this unliked variable instead.
|writer               = ##{{!}}put the name of the writer here
|director           = ##{{!}}put the name of the director here
|broadcast date       = if documentary was originally broadcast, put broadcast date here
|multiple directors  = if there's more than one director, use this unlinked variable instead.
|release date         = if documentary was originally published as a home video/audio, put release date here
|producer           = ##{{!}}put the name of the producer here
|runtime               = put length of documentary here
|multiple producers  = if there's more than one producer, use this unlinked variable instead. 
|prev                 = ##{{!}}if part of a series, put previous entry here
|writer             = ##{{!}}put the name of the writer here
|next                 = ##{{!}}if part of a series, put next entry 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
|release date       = if documentary was originally published as a home video/audio, put release date here
|runtime             = put length of documentary here
|prev               = ##{{!}}if part of a series, put previous 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}}
'''{{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.
'''{{tlx|Infobox Documentary}}''', or '''{{tlx|Infobox 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 ==
== Auto-linking variables ==
Line 54: Line 48:
broadcast date=[[12 May (releases)|]] [[2006 (releases)|]]
broadcast date=[[12 May (releases)|]] [[2006 (releases)|]]
</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".
== 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).
Line 79: Line 53:
{{Infobox Doc
{{Infobox Doc
|image                =
|image                =
|series episode number =
|subject              =
|subject              =
|original to DVD      =
|original to DVD      =
Line 93: Line 68:
|narrator2            =
|narrator2            =
|narrator3            =
|narrator3            =
|narrator4            =
|narrator5            =
|narrator6            =
|narrator7            =
|narrator8            =
|narrator9            =
|narrator10            =
|uncredited narrator  =
|interviewer          =
|interviewer          =
|multiple interviewers =
|interviewer2          =
|interviewer3          =
|interviewer4          =
|interviewer5          =
|interviewer6          =
|interviewer7          =
|interviewer8          =
|interviewer9          =
|interviewer10        =
|interviewee          =
|interviewee          =
|uncredited narrator  =
|interviewee2          =
|interviewee3          =
|interviewee4          =
|interviewee5          =
|interviewee6          =
|interviewee7          =
|interviewee8          =
|interviewee9          =
|interviewee10        =
|director              =
|director              =
|director2            =
|director3            =
|director4            =
|director5            =
|director6            =
|director7            =
|director8            =
|director9            =
|director10            =
|producer              =
|producer              =
|multiple producers    =
|producer2            =
|producer3            =
|producer4            =
|producer5            =
|producer6            =
|producer7            =
|producer8            =
|producer9            =
|producer10            =
|executive producer    =
|executive producer    =
|multiple execs        =
|executive producer2  =
|executive producer3  =
|executive producer4  =
|executive producer5  =
|executive producer6  =
|executive producer7  =
|executive producer8  =
|executive producer9  =
|executive producer10  =
|writer                =
|writer                =
|writer2              =
|writer3              =
|writer4              =
|writer5              =
|writer6              =
|writer7              =
|writer8              =
|writer9              =
|writer10              =
|broadcast date        =
|broadcast date        =
|release date          =
|release date          =
Line 118: Line 151:
</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.  
 
=== 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:
<pre>
|nav                  = 0
</pre>
 
====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 <code>prev = none</code>.  Likewise, the last item in a series should have <code>next = none</code>.


To see this in operation, please click through to ''[[The Making of The Trial of a Time Lord: Part One - Mysterious Planet]]''.
== Video and Audio ==
{{Infobox video and audio variables}}
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 20:28, 20 July 2023

You may be looking for the way to use this template with Confidential episodes.

{{Infobox Documentary}}, or {{Infobox 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)|]]

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                 =
|series episode number = 
|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             =
|narrator4             =
|narrator5             =
|narrator6             =
|narrator7             =
|narrator8             =
|narrator9             =
|narrator10            =
|uncredited narrator   =
|interviewer           =
|interviewer2          =
|interviewer3          =
|interviewer4          =
|interviewer5          =
|interviewer6          =
|interviewer7          =
|interviewer8          =
|interviewer9          =
|interviewer10         =
|interviewee           =
|interviewee2          =
|interviewee3          =
|interviewee4          =
|interviewee5          =
|interviewee6          =
|interviewee7          =
|interviewee8          =
|interviewee9          =
|interviewee10         =
|director              =
|director2             =
|director3             =
|director4             =
|director5             =
|director6             =
|director7             =
|director8             =
|director9             =
|director10            =
|producer              =
|producer2             =
|producer3             =
|producer4             =
|producer5             =
|producer6             =
|producer7             =
|producer8             =
|producer9             =
|producer10            =
|executive producer    =
|executive producer2   =
|executive producer3   =
|executive producer4   =
|executive producer5   =
|executive producer6   =
|executive producer7   =
|executive producer8   =
|executive producer9   =
|executive producer10  =
|writer                =
|writer2               =
|writer3               =
|writer4               =
|writer5               =
|writer6               =
|writer7               =
|writer8               =
|writer9               =
|writer10              =
|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.

Video and Audio

At Tardis, we have a fairly sophisticated system of integrating audio and video content into our infoboxes. Almost every infoboxes has the same set of variables, though the header attached to them may change depending on the infobox. For instance, the headers for {{Infobox Company}} and {{Infobox Person}} are slightly different from the rest, because these infoboxes are about the companies and crewmembers that make DWU stories. Nevertheless, the variable names remain largely the same.

Note that videos must be uploaded to this wiki locally, and that only admin can upload them. If you wish to request an upload, please do so at the video recommendation page.

Due to the fact that ogg audio doesn't play on iOS devices, some OS X browsers, and the Fandom Doctor Who app, audios must be from Soundcloud -- and Soundcloud only.

Though there are a few exceptions, most of the following variables are available for your use in every infobox. 

|trailer            = usually entitled "Official trailer"
|trailer2           = usually, "Another official trailer"
|clip               = "Memorable moment", but can be value of {{{clip name}}}
|clip2              = "Another memorable moment", but can be {{{clip name2}}}
|clip3              = "One more memorable moment", but can be {{{clip name3}}}
|fullvid            = "Full video", but can be {{{fullvid name}}}
|bts                = "Behind the scenes video", but can be {{{bts name}}}
|bts2               = "More behind the scenes stuff", but can be {{{bts2 name}}}
|bts3               = "Another behind the scenes moment", but can be {{{bts3 name}}}
|soundcloudtrailer  = usually, "Official audio trailer"
|soundcloudtrailer2 = usually, "Another official audio trailer"
|musicsuite         = "Music suite"
|sample             = "Music sample"
|soundcloudbts      = "Behind the scenes interview"
|audio commentary   = "Audio commentary"
|fullaud            = "Full audio"
|leitmotif          = "Leitmotif"

You can use the following blanked-out version to copy and paste onto a page, if the above instructions for this specific infobox don't already contain this bit. 

|trailer            = 
|trailer2           = 
|clip               = 
|clip2              = 
|clip3              = 
|fullvid            = 
|bts                = 
|bts2               = 
|bts3               = 
|soundcloudtrailer  = 
|soundcloudtrailer2 = 
|musicsuite         = 
|sample             = 
|soundcloudbts      = 
|audio commentary   = 
|fullaud            = 
|leitmotif          =
Retrieved from "https://tardis.wiki/w/index.php?title=Template:Infobox_Documentary/doc&oldid=3568682"