Template:Screencap/doc
More actions
Overview
Template:Screencap is a unified, self-detecting image tag for BattlestarWiki Media. It replaces the fragmented family of hand-maintained sub-templates (
| The an unknown series, Season "Unknown" from an unknown episode. Please help us identify the episode by updating this tag or discussing it on the [[{{TALKPAGENAME}}|talk page]]. | |
| This capture is copyright by the copyright holder. Use of it here is believed to be fair use. | |
| The timestamp for this image is unknown. Please supply the time index for this capture. | |
| Screen capture (source unknown). Native resolution: unknown. | |
, Template:RDM NTSC DVD screencap,
| The original Battlestar Galactica, Season "Unknown" from an unknown episode. Please help us identify the episode by updating this tag or discussing it on the [[{{TALKPAGENAME}}|talk page]]. | |
| This capture is copyright by Universal Studios. Use of it here is believed to be fair use. | |
| The timestamp for this image is unknown. Please supply the time index for this capture. | |
| Blu-ray screen capture. Native resolution: 1920×1080. | |
, etc.) with a single template backed by Module:Screencap.
The template:
- Auto-detects series, season/episode (from SxxExx or NxNN patterns), and quality tier from the file's pixel dimensions
- Renders a formatted infobox with the correct source badge, episode info, copyright notice, and timestamp
- Applies the correct maintenance and browse categories automatically
- Accepts named override parameters to correct or supplement any auto-detected value
Quick Usage
The simplest case — paste this on a file description page and the template does the rest:
{{Screencap}}
With manual overrides only where needed:
{{Screencap
| episode = 33
| timestamp = 00:14:22
}}
Full explicit form (mirrors the old Master screencap interface):
{{Screencap
| series = rdm
| episode = The Hand of God
| cepisode = The Hand of God (RDM)
| season = 1
| type = bluray
| timestamp = 00:32:11
| scaled = yes
| cropped =
| aspect = yes
| de = Die Hand Gottes
| es =
| fr = La Main de Dieu
| tr =
| zh =
}}
Auto-Detection Logic
Series (from filename prefix)
| Filename prefix | Detected series |
|---|---|
RDM -, TRS -, BSG - S01… |
rdm |
CAP -, Caprica - |
cap |
B&C -, BNC - |
bnc |
TOS - |
tos |
1980 -, G1980 - |
1980 |
Season & Episode (from filename)
| Filename pattern | Extracted info |
|---|---|
RDM - S04E20 - Daybreak.jpg |
Season 4, Episode 20 |
BSG - 1x05 - Act of Contrition.jpg |
Season 1, Episode 5 |
TOS - Saga of a Star World - Apollo.jpg |
Title hint: "Saga of a Star World - Apollo" |
If season/episode numbers cannot be extracted, the template flags the image with a title hint and a maintenance message.
Quality / Source Type (from pixel dimensions)
| Longest pixel dimension | Auto-detected type | Label |
|---|---|---|
| ≥ 3840 px | 4k |
4K UHD |
| ≥ 1920 px | bluray |
Blu-ray / 1080p stream |
| ≥ 1280 px | hdtv |
HDTV 720p broadcast |
| ≥ 853 px | ntscdvd |
NTSC DVD (anamorphic) |
| ≥ 720 px | paldvd |
PAL DVD |
| < 720 px | dvd |
DVD (generic / low res) |
Portrait-orientation images (promo photos) use the longer axis so a 1080×1535 portrait correctly reads as Blu-ray/stream quality.
Parameters
Auto-detected (override only if wrong)
| Parameter | Purpose | Example |
|---|---|---|
series |
Series key. Valid values: rdm, cap, bnc, tos, 1980 |
series=tos
|
type |
Source/quality type. Valid values: 4k, bluray, hdtv, hddvd, itunes, ntscdvd, ntscb, paldvd, palb, promo, dvd, unknown |
type=bluray
|
season |
Season number | season=2
|
Identification (provide if not in filename)
| Parameter | Purpose | Example |
|---|---|---|
episode |
English Wiki article name of episode (used for links and categories) | episode=Exodus, Part II
|
cepisode |
Disambiguation display name if article has "(RDM)" etc. suffix | cepisode=Exodus, Part II (RDM)
|
timestamp |
ISO 8601 time index HH:MM:SS | timestamp=00:42:07
|
Image attributes
| Parameter | Purpose |
|---|---|
scaled=yes |
Image has been scaled down from source dimensions |
cropped=yes |
Image has been cropped |
aspect=yes |
Aspect ratio confirmed correct |
Multilingual episode links
Provide the episode article name on each language wiki. The c-prefixed variants hold disambiguation suffixes where needed.
| Parameter | Wiki |
|---|---|
de / cde |
German wiki (de.battlestarwiki.org) |
es / ces |
Spanish wiki |
fr / cfr |
French wiki (fr.battlestarwiki.ddns.net) |
tr / ctr |
Turkish wiki |
zh / czh |
Chinese wiki |
Auto-Applied Categories
The module automatically applies categories based on detected/overridden values. No manual tags are needed on the file page.
Examples of categories applied for a Blu-ray RDM Season 4 image of "Daybreak":
DVD/broadcast images also receive:
Images where the source cannot be determined receive:
Migration from Old Templates
The old templates are not immediately broken — they can remain as thin wrappers that call
screen capture (source unknown)
The an unknown series, Season "Unknown" from an unknown episode. Please help us identify the episode by updating this tag or discussing it on the [[{{TALKPAGENAME}}|talk page]].
This capture is copyright by the copyright holder. Use of it here is believed to be fair use.
The timestamp for this image is unknown. Please supply the time index for this capture.
Screen capture (source unknown). Native resolution: unknown.
with the appropriate type= and series= pre-filled. For example,
Blu-ray screen capture
The original Battlestar Galactica, Season "Unknown" from an unknown episode. Please help us identify the episode by updating this tag or discussing it on the [[{{TALKPAGENAME}}|talk page]].
This capture is copyright by Universal Studios. Use of it here is believed to be fair use.
The timestamp for this image is unknown. Please supply the time index for this capture.
Blu-ray screen capture. Native resolution: 1920×1080.
can be refactored to:
{{Screencap | series=tos | type=bluray | episode={{{episode|}}} | season={{{season|}}} | timestamp={{{timestamp|}}} | scaled={{{scaled|}}} | cropped={{{cropped|}}} | de={{{de|}}} | es={{{es|}}} | fr={{{fr|}}} | tr={{{tr|}}} | zh={{{zh|}}} }}
This lets existing file pages continue to work unchanged while benefiting from the new auto-detection and unified infobox.
Installation
- Copy Module:Screencap to
Module:Screencapon media.battlestarwiki.org - Copy Template:Screencap wikitext to
Template:Screencap - Copy this documentation to
Template:Screencap/doc - (Optional) Update legacy sub-templates to wrap
screen capture (source unknown)
The an unknown series, Season "Unknown" from an unknown episode. Please help us identify the episode by updating this tag or discussing it on the [[{{TALKPAGENAME}}|talk page]].
This capture is copyright by the copyright holder. Use of it here is believed to be fair use.
The timestamp for this image is unknown. Please supply the time index for this capture.
Screen capture (source unknown). Native resolution: unknown.
as shown above
- Test on a file page with known values; compare infobox output and categories against expected