Template:Filmjr/doc
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
Example Markup
{{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=3}}
Notes
Using this film - https://archive.org/details/public_service_announcements - as an example
- title
- The title of the short film. Do not use colons, brackets, or other types of parenthesis. Dashes are permitted.
- embid and embsv
- If using archive.org as the embed host, this can be autogenerated from the url (link, href) - the values are the string at the end of the url after the last slash, and the string "archiveorg" ("archive.org" without period)
- synop
- the "synop" key now takes precedence over the "desc" key
- 1-3 sentences, preferably without line breaks
- This is the summary, synopsis, abstract, description, intro text. The lead should identify the topic and summarize the body of the article with appropriate weight. See w:Wikipedia:Manual of Style/Lead section
- forma
- Format, 16mm for example
- year
- if unknown or unsupplied, use 0, otherwise a four digit year number without letters, month, day, prefix, or suffix
- up, next, prev, step
- the first three refer to series, where the "up" key is the Series page itself. "Next" and "prev" reference the next and prior installment of the series.
- "Step" is not related to other keys for the purposes of this wiki.
- "Step" should be 1 in the case of imports. It should not be blank.
- While not implemented yet, "step" is the basic workflow category
- lang
- Language
- pbrs
- Publishers, we intend to use this key in an open-ended, not dogmatic, "catch-all" manner - the values can be multiple and can refer to any organizational body associated with the work, regardless of specific role or right
- len
- Length, in HH:MM:SS format, or 0 for blank
- link
- URL optional, but only one may be used. It is desirable to populate this, so for the example above "https://archive.org/details/public_service_announcements" should be the value
- bw and ani
- both are Boolean, though I'm making progress allowing them to accept things like "yes," "y," and "true" for 1, and "no" or "f" for 0
- "bw" is key for "is black and white." If color, bw=1. If not, bw=0. (Note, is black and white actually binary like this?)
- "ani" is key for "contains animation." If any animation is present, even if minor, use 1. If the film contains no animation, ani=0.
- A parameter for silent (silent/contains audio) should be added but does not currently exist.
- ewid and oclc
- these are ids, they are optional aren't particularly important
- "ewid" is our internal id, which has yet to be established in a consistent manner (this key is aspirational)
- "oclc" refers to worldcat id. Nice to have when possible. In 2022, a link to search worldcat will be displayed if this key is present but the value is "0" or null (not supplied)
- dopt=3
- Display Option
- this is WIP, use 3 for imports, use 2 for new manual submissions for volunteers (2 is default I think)
- While this changes how films look, by design this key assists with modifications to those pages. So if the display is wrong, we fix the display, not the display option.
Notes
Synopsis Param
This is the summary, synopsis, abstract, description, intro text. The lead should identify the topic and summarize the body of the article with appropriate weight. See w:Wikipedia:Manual of Style/Lead section
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: synopsis prompt and ZD cat
- 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
Template markup
This is temporary: {{#ifeq: {{NAMESPACENUMBER}} | 162 | | [[Category:Film Bad NS]]}}
Templates
Merger with Infobox Film
took out
{{DateUnpack|y={{{year}}}|opt=b}}
which means we lost categories, TODO: make it so opt c is just for cats
Unpackers
- "Does this film contain animation?" Unpacker: Template:AnimationUnpack note it doesn't do much
- 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
- if embsv is archiveorg than do Archive Gif Unpacker: Template:GifUnpack
- Format Unpacker: Template:FormaUnpack
- Template:DispTitleUnpack
- Template:EmbedIdUnpack
- Template:OCLCUnpack
- Template:HeldbyUnpack
- Template:DebugDisplay
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. Do not use colons, brackets, or other types of parenthesis. Dashes are permitted. 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.
| Date | suggested |
| Format | 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. Summary, synopsis, abstract, the wiki lead sentence
| 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 |
| Language | lang | Language the film primarily uses. English is provided as the default value.
| 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 |
| 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 |
| soundmix | soundmix | no description | Unknown | optional |
| athumb | athumb | no description | 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 |
| Publishers | pbrs | no description | String | optional |
| produ | produ | Name of producer | String | optional |
| dist | dist | distributor | String | optional |
| animator | animator | no description | Unknown | optional |
| starring | starring | no description | Unknown | optional |