Difference between revisions of "Template:Filmjr/doc"
Line 26: | Line 26: | ||
==== An Example for A/V Geeks ==== | ==== An Example for A/V Geeks ==== | ||
Using this film - https://archive.org/details/public_service_announcements - as an example | |||
<pre class="jjrPre"><nowiki>{{Filmjr | <pre class="jjrPre"><nowiki>{{Filmjr | ||
|title=Theatrical Public Service Announcements | |title=Theatrical Public Service Announcements | ||
Line 37: | Line 40: | ||
|lang=English | |lang=English | ||
|pbrs= | |pbrs= | ||
|len=00: | |len=00:10:57 | ||
|link=https://archive.org/details/public_service_announcements | |link=https://archive.org/details/public_service_announcements | ||
|bw=|ani= | |bw=1|ani=0 | ||
|ewid=|oclc= | |ewid=|oclc= | ||
|dopt=1}} | |dopt=1}} |
Revision as of 14:25, 28 February 2022
Usage
Unpopulated Examples
Ex 1
cut and past this example
{{Filmjr |title= |embid= |embsv= |heldby= |synop=0 |forma= |year= |up=|next=|prev=|step=1 |lang=English |pbrs= |len=00:00:00 |link= |bw= |ani= |ewid=|oembedid=|mdpi=|oclc= |dopt=2|athumb=}}
Ex 2
{{Filmjr|title=|oclc=|form=|year=|up=|next=|prev=|step=}}
Ex 3
For just a minimal embed video
{{Filmjr |title= |embid= |embsv= }}
Populated Example with Param Values
An Example for A/V Geeks
Using this film - https://archive.org/details/public_service_announcements - as an example
{{Filmjr |title=Theatrical Public Service Announcements |embid=public_service_announcements |embsv=archiveorg |heldby=AVG |synop=Films shown before the feature pleading for various charitable causes |forma=16mm |year=0 |up=|next=|prev=|step=1 |lang=English |pbrs= |len=00:10:57 |link=https://archive.org/details/public_service_announcements |bw=1|ani=0 |ewid=|oclc= |dopt=1}}
Notes
Synopsis Param
This is the bit for the synopsis parameter, often referred to as desc or "Description
{{#if:{{{synop|}}}| {{DescUnpack|{{{synop}}}}}|{{#if:{{{desc|}}}| {{DescUnpack|{{{desc}}}}}|{{DescAttemptSynopSection}}}}}}
- If synop is found, do that {{DescUnpack|{{{synop}}}}}
- Else check if desc or simply missing |{{#if:{{{desc|}}}|
- if set or missing (neither value nor key; the parameter is entirely absent), do desc {{DescUnpack|{{{desc}}}}}
Possible outcomes
- Neither synop nor desc keys are present: ZD cat
- Synop key is present
- Synop key is present and value is blank
- Synop key is present and value is "0"
- Synop key is present and value exists: display synop
- Desc key is present
- Desc key is present and value is blank
- Desc key is present and value is "0": synopsis prompt and ZD cat
- Desc key is present and value exists
- Both keys are present
- sb db: ZD cat
- sb d0: synopsis prompt and ZD cat
- sb de: ignore blank synop and display desc
- s0 db: synopsis prompt and ZD cat
- s0 d0: synopsis prompt and ZD cat
- s0 de: synopsis prompt and ZD cat undesirable: should display desc
- se db: ignore blank desc and display synop
- se d0: ignore desc and display synop
- se de: ignore desc and display synop
HTML and CSS
Tpl output is wrapped in div.tplContainer. Then there is an initial p followed by div.tplFlex. After tplContainer an empty div div.tplEnd is placed on page.
the two ending divs before div.tplEnd end div.tplFlex and div.tplContainer respectively. </div><!-- /tplFlex --></div><!-- /tplContainer -->
- div.tplContainer
- p
- div.tplFlex
- small.jrdebug
- div.tplEnd
microdata
<div itemscope itemtype="https://schema.org/Movie">
- RDFa
- <div vocab="https://schema.org/" typeof="Movie">
Template markup
This is temporary: {{#ifeq: {{NAMESPACENUMBER}} | 162 | | [[Category:Film Bad NS]]}}
Templates
Unpackers
- "Does this film contain animation?" Unpacker: Template:AnimationUnpack
- Length Unpacker (film duration): Template:LenUnpack
- Synopsis Unpacker: Template:DescUnpack (param "synop or "desc")
- Synopsis is blank (synop prompt and zd cat): Template:DescZ
- Display Option Unpacker: Template:DoptUnpack
- Publisher Unpacker: Template:PubUnpack
- Release Date Unpacker: Template:DateUnpack
- Template:DispTitleUnpack
- Template:EmbedIdUnpack
- Template:OCLCUnpack
- Template:HeldbyUnpack
- Template:FormaUnpack
Templates to Maintain
When you update the fields, you need to update
- Template:Filmjr/Tclu - main Filmjr feeder
- Template:Filmjr/TcluIn - IUL Filmjr feeder ("In" stands for Indiana)
as appropriate
Related
- Template:Filmjr/Tclude2 - helper, doesn't actually need to be maintained, but this is what actually "prints" the params in Template:Filmjr/Tclu (text in Example 1 is provided by Tclude2)
Other Relevant Tpls
- Template:Filmjr/keys
- Template:Filmjr/Tclude2
- Template:Ifdef
- Template:Ifwp
Template:Filmjr/Tclude<- don't use
Template Params
This is the main template to display Moving Image items. This template is used to describe a short film. It passes a lot of it's data to additional templates typically called something like "FooUnpack"
Parameter | Description | Type | Status | |
---|---|---|---|---|
title | title name | The title of the short film. If this short film's name was to be placed upon a marque or a printed program, how should it be rendered? Supply that here. This title will also be used to provide a display name for the page itself, and a title for embedded video if one is supplied.
| Page name | suggested |
Year Released | year | Year released - uses the DateUnpack template. Currently only supports four numerical digits (ie 1945 works, '45 will not)
| Date | suggested |
form | forma | Format the film was primarily released upon (ie. 16mm) | Unknown | optional |
embid | embid | The video embed id (or code). This looks different for different services. In particular, for the IUL service (embsv=Insimple), embid is an 8 (ish?) alphanumeric code often found in the URL of the given item. The 8 character code IUL lists in their share widget is an oembed id. Archive.org calls this "Identifier." | Unknown | optional |
embsv | embsv | One of archiveorg, youtube, Insimple, Indiana, or vimeo. This field is probably case sensitive. Use Insimple for Indiana University Library. This code indicates the service hosting the video, and is used in conjunction with embid to generate the embedVideo code.
| Unknown | optional |
Synopsis | synop desc | A short description of the film - two or three sentences or less
| String | suggested |
In Collection | heldby | Is this film part of a collection or held by a library? Use '''IUL''' for the Indiana University Libraries Moving Image Archive, '''AVG''' for A/V Geeks, and '''PA''' or "Prel" for Prelinger Archives. Passed to template '''HeldbyCountCommas''' with param name "h". If unknown, leave blank
| String | required |
OCLC | oclc worldcat | The OCLC identifier, as used in the WorldCat database. It is optional. If given, it will link to it's WorldCat entity. This value is then from here fed into template [[Template:OCLCUnpack]]
| Number | optional |
lang | lang | Language the film primarily uses. English is provided as the default value.
| String | optional |
Publishers | pbrs | no description | String | optional |
EFW Workflow | step | An admin label used to track workflow. Step 1 indicates an import than has never been manually edited.
| Number | suggested |
next | next | If this film is episodic, the next episode is indicated here. Note no brackets | Page name | optional |
prev | prev | If this film is episodic, the preceding episode is given here. Note no brackets | Unknown | optional |
up | up series | Parent page. Optional. If this film is episodic, the series overview is indicated here. Note no brackets. The alias "series" is not functional yet. TODO
| Page name | optional |
link | link | A link to more information about the film. Optional.
| URL | optional |
produ | produ | Name of producer | String | deprecated |
Animation | ani | Animation? 1: yes 0:no
| Boolean | suggested |
black and white? | bw | 1 is yes, 0 is no | Boolean | optional |
IUL ID | mdpi | iul id (INDIANA UNIVERSITY Libraries id) - rarely useful - not currently output by template | Number | optional |
Duration (length) | len | duration of the film in colon notation; the value should be in 00:00:00 format
| String | suggested |
oembedid | oembedid | The video oembed id. For the IUL service (embsv=Insimple), embid is an 8 (ish?) alphanumeric code often found in the share widget. Potentially useful for both IUL and YouTube. | Unknown | optional |
dopt: Display Option | dopt | Options to change how the template works. 1 shows video embed, 2 does not. See Template:DoptUnpack
| Number | suggested |