Template:Vimeo video/doc

From Saintapedia
< Template:Vimeo video
Revision as of 20:42, 16 September 2024 by Tom (talk | contribs) (Text replacement - "Powerpedia" to "Saintapedia")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The Vimeo video templates allows editors to easily add videos to Saintapedia using templates' Template Data form.

Popular options

  • id - The URL of the Vimeo video

Other options

  • service
    • The video service to call
    • Set by default to Vimeo for this template
  • dimensions="[WIDTH|WIDTHxHEIGHT|xHEIGHT]" Required: no, Default: 640
    • Dimensions in pixels to size the embed container. The standard format is width x height where either can be omitted, but the x must proceed height to indicate it as the height.
    • Examples: 480, 480x320, x320. If the height is not provided it will be calculated automatically from the width and service default ratio.
    • Some services such as Gfycat do not have standard heights and should be specified for each embed.
    • $wgEmbedVideoDefaultWidth can be set in LocalSettings.php to override the default width.
  • alignment="[left|center|right|inline]" Required: no, Default: none
    • Align the placement of the video either to the left, centered, or to the right. Inline will allow multiple videos to display side by side without forced line breaks.
  • description="[wiki text]" Required: no, Default: none
    • Display a description under the embed container.
  • container="[frame]" Required: no, Default: none
    • Specifies the container type to use for the embed.
  • frame: Wrap the video player in a Mediawiki thumbnail box.
  • urlargs="modestbranding=1&version=3" Required: no, Default: none
    • Allows extra URL arguments to be appended to the generated embed URL. This is useful for obscure options only supported on one service.
  • autoresize="false" Required: no, Default: true
    • Automatically resize videos when their size will cause them to break outside of their container element.
  • valignment="[top|middle|bottom|baseline]" Required: no, Default: none
    • Align the vertical placement of the video either to the top, middle, bottom, or baseline of the parent element. Using this parameter forces the alignment parameter to be inline.

Full template

{{#evt:
|service=vimeo
|id={{{id}}}
|dimensions={{{dimensions}}}
|alignment={{{alignment}}}
|description={{{description}}}
|container={{{container}}}
|urlargs={{{urlargs}}}
|autoresize={{{autoresize}}}
|valignment={{{valignment}}}
}}

Usage

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Vimeo video in articles based on its TemplateData.

TemplateData for Vimeo video

No description.

Template parameters

ParameterDescriptionTypeStatus
descriptiondescription

no description

Unknownoptional
urlurl

no description

Unknownoptional