"Download":https://github.com/NicolasGraph/oui_vimeo/releases the compiled plugin file or the source to compile a customized file.

August 15, 2018 · View on GitHub

h1. oui_vimeo

  • "Introduction":#introduction
  • "Plugin management":#plugin-management
  • "Tags and parameters":#tags-and-parameters
  • "Examples":#examples
  • "Credits":#credits

h2. Introduction

"oui_vimeo":https://github.com/NicolasGraph/oui_vimeo is a "oui_player":https://github.com/NicolasGraph/oui_player v2+ extension to easily embed "Vimeo":https://vimeo.go.com/ provided videos in "Textpattern":https://textpattern.com/ powered websites.

The above platform serves cookies with its player, according to the EU legislation, you should warn your users about these cookies before they are added. This can be done by using "oui_cookie":https://github.com/NicolasGraph/oui_cookie.

h3. Plugin requirements

oui_vimeo's minimum requirements:

h2. Plugin management

h3. Installation

h4. From the admin interface

"Download":https://github.com/NicolasGraph/oui_vimeo/releases the compiled plugin file or the source to compile a customized file.

Paste the content of the compiled plugin file under the "Admin > Plugins":?event=plugin tab and click the Upload button.

Confirm the plugin install by clicking the Install button on the plugin preview page.

Enable the plugin and click the Options link (or visit the Preferences tab) to set the provider preferences.

h4. Via Composer (not available yet)

After "installing Composer":https://getcomposer.org/doc/00-intro.md…

Target your project directory:

@$ cd /path/to/your/textpattern/installation/dir@

If it's not already done, lock your version of Txp:

@$ composer require textpattern/lock:4.6.2@, where @4.6.2@ is the Txp version in use.

Install oui_vimeo:

@$ composer require nicolasgraph/oui_vimeo@

h3. Update

h4. From the admin interface

Follow the installation instruction above.

h4. Via Composer (not available yet)

bc. $ composer update nicolasgraph/oui_vimeo

h3. Uninstall

h4. From the admin interface

Check the box on the left of the plugin row under the "Admin > Plugins":?event=plugin.

open the select list at the bottom of the plugins table and choose Delete.

confirm the plugin deletion.

h4. Via Composer (not available yet)

bc. $ composer remove nicolasgraph/oui_vimeo

h2. Tags and parameters

h3. oui_vimeo vs oui_player

While the @<txp:oui_player />@ tag is able to embed any video from any extension-related provider, the @<txp:oui_vimeo />@ tag is a shortcut to embed Vimeo videos only. It is strictly equivalent to @<txp:oui_player provider="vimeo" />@.

Check the "oui_player":https://github.com/NicolasGraph/oui_player documentation for more informations.

h4. Recognised values for the @play@ attribute

  • ID;
  • http(s)://vimeo.com/[ID];
  • http(s)://player.vimeo.com/video/[ID].

When using the @oui_player@ tag (vs @oui_vimeo@), the right provider needs to be set if the @play@ value or its field related one is an ID. It is optional, but can fasten the rendering, if the value is an URL.

h4. Player customization

h5. Preferences vs attributes

While some player customization elements, related to the media to play, should be used through attributes, these used as global settings should preferrably be set through the plugin preferences to avoid a massive use of tag attributes.

Of course, it is still possible to override a preference value via an attribute when needed.

h5. Size

  • @width@ := Integer; initially set to @640@. The width of the player in pixels. =:
  • @height@ := Integer; initially set to @360@. The height of the player in pixels. =:
  • @ratio@ := Integer[@:@]integer; initially not set. The ratio used to calculate the missing value for the width or the height. =:
  • @responsive@ := @true@ or @false@; initially set to @false@. Adapts the final player size from the provided width and/or height and/or ratio values to fit the container width. Wraps the player and adds some styles. =:

h5. Parameters (a→z)

From Txp 4.7, paramaters accepting @0@ and @1@ as valid values can be enable through boolean/valueless attributes.

  • @api@ := @0@ or @1@; initially set to @0@. Enables or disables "the javascript player api":https://github.com/vimeo/player.js. =:
  • @autopause@ := @0@ or @1@; initially set to @1@. Enables or disables pausing this video when another video is played. =:
  • @autoplay@ := @0@ or @1@; initially set to @0@. Play the video automatically on load. Note that this won’t work on some devices. =:
  • @byline@ := @0@ or @1@; initially set to @1@. Show the user’s byline on the video. =:
  • @color@ := Hexadecimal color value; initially set to @#00adef@; Specify the color of the video controls. =:
  • @loop@ := @0@ or @1@; initially set to @0@. Play the video again when it reaches the end. =:
  • @portrait@ := @0@ or @1@; initially set to @1@. Show the user’s portrait on the video. =:
  • @title@ := @0@ or @1@; initially set to @1@. Show the title on the video. =:

p(alert-block information). %(ui-icon ui-icon-info).% More informations on "this Vimeo webpage":https://developer.vimeo.com/player/embedding.

h3. oui_if_vimeo vs oui_if_player

p. While the @txp:oui_if_player…</txp:oui_if_player>@ tag is able to check an URL against any URL from any extension-related provider, the @txp:oui_if_vimeo…</txp:oui_if_vimeo>@ tag is a shortcut to check an URL against Vimeo related URL schemes only. It is strictly equivalent to @<txp:oui_if_player provider="vimeo">…</txp:oui_if_player>@.

Check the "oui_player":https://github.com/NicolasGraph/oui_player documentation for more informations.

h2. Examples

h3. Embed a player using the preference values

bc(language-markup). <txp:oui_player />

"oui_player":https://github.com/NicolasGraph/oui_player preference related field value: @https://vimeo.com/59777392@.

h3. Embed a player by defining its provider and a media ID through attributes

bc(language-markup). <txp:oui_player provider="vimeo" play="59777392" />

…or:

bc(language-markup). <txp:oui_vimeo play="59777392" />

h3. Conditionally embed a player using attributes

bc(language-markup).. <txp:oui_if_player provider="vimeo" play="https://player.vimeo.com/video/59777392"> <txp:oui_player /> </txp:oui_if_player>

p. …or:

bc(language-markup).. <txp:oui_if_vimeo play="https://player.vimeo.com/video/59777392"> <txp:oui_vimeo /> </txp:oui_if_vimeo>

h2. Credits

h3. Author

"Nicolas Morand":https://twitter.com/NicolasGraph Thank you to the Textpattern community and the core team.

h3. License

This plugin is distributed under "GPL v2.0":https://www.gnu.org/licenses/gpl-2.0.txt.

oui_vimeo version 1.0.0-BETA3, Copyright (C) 2018 Nicolas Morand This Textpattern plugin comes with ABSOLUTELY "NO WARRANTY":https://www.gnu.org/licenses/gpl-2.0.html#section11. This is free software, and you are welcome to redistribute it "under certain conditions":https://www.gnu.org/licenses/gpl-2.0.html#SEC3.

h3. Changelog

  • oui_vimeo v1.0.0-BETA3 (2018-08-15) ** Changed: initial player size.
  • oui_player v1.3.0 (2017-05-24)