Documentation Home

YouTube

The youtube tag displays a YouTube video player with a specified video.

Attributes

alt (string): The text to use in the alt tag used by screen readers. If not provided an alt tag is automatically generated from the IIIF manifest label property or inferred from the filename.

autoplay (boolean): Automatically play video when the viewer is loaded.

caption (string): Defines the text to use for a caption that is displayed below the video player.

end (string): Time position to stop playing, in hh:mm:ss format.

muted (boolean): Mute video when initially played.

nocaption (boolean): This property inhibits the display of the caption at the bottom of the image.

poster (url): Image displayed in viewer before video plays.

start (string): Time position to begin playing, in hh:mm:ss format.

vid (string): The YouTube ID of the image to stream

Positioning attributes

left (boolean): Align the component with the left side of the window. The components width is 50% of the window and any section text following the component tag will wrap around the component.

right (boolean): Align the component with the .right side of the window. The components width is 50% of the window and any section text following the component tag will wrap around the component.

center (boolean): The component is centered in the window.

large (boolean): The component is sized to 75% of the window.

medium (boolean): The component is sized to 50% of the window.

small (boolean): The component is sized to 33% of the window.

Notes:

  • Boolean attributes are specified using the property name only, for instance - marker.
  • Non-boolean attributes are specified using property=value syntax (i.e., caption=Example). If the value includes spaces the value must be quoted (i.e., caption="An Example Map").

Examples

Basic examples

Simple YouTube player

`youtube vid=dQw4w9WgXcQ`

youtube vid=dQw4w9WgXcQ

Positioning examples

Large and center

#####

Markdown
`youtube vid=dQw4w9WgXcQ .large .center`

youtube vid=dQw4w9WgXcQ .large .center

`youtube vid=dQw4w9WgXcQ .right`

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

youtube vid=dQw4w9WgXcQ .right

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.