oui_archive

• Introduction
• Plugin management
• Tags and parameters
• Examples
• Credits

Introduction

oui_archive is a oui_player v2+ extension to easily embed Archive provided medias in Textpattern 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.

Plugin requirements

oui_archive’s minimum requirements:

• Textpattern CMS v4.6+;
• oui_player v2+;
• oui_provider v1+.

Plugin management

Installation

From the admin interface

1. Download the compiled plugin file or the source to compile a customized file.
2. Paste the content of the compiled plugin file under the “Admin > Plugins”:?event=plugin tab and click the Upload button.
3. Confirm the plugin install by clicking the Install button on the plugin preview page.
4. Enable the plugin and click the Options link (or visit the Preferences tab) to set the provider preferences.

Via Composer (not available yet)

After installing Composer

1. Target your project directory:
   $ cd /path/to/your/textpattern/installation/dir
2. 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.
3. Install oui_archive:
   $ composer require nicolasgraph/oui_archive

Update

From the admin interface

1. Follow the installation instruction above.

Via Composer (not available yet)

$ composer update nicolasgraph/oui_archive

Uninstall

From the admin interface

1. Check the box on the left of the plugin row under the “Admin > Plugins”:?event=plugin.
2. open the select list at the bottom of the plugins table and choose Delete.
3. confirm the plugin deletion.

Via Composer (not available yet)

$ composer remove nicolasgraph/oui_archive

Tags and parameters

oui_archive vs oui_player

While the <txp:oui_player /> tag is able to embed any media from any extension-related provider, the <txp:oui_archive /> tag is a shortcut to embed Archive medias only. It is strictly equivalent to <txp:oui_player provider="archive" />.

Check the oui_player documentation for more informations.

Recognised values for the play attribute

• ID;
• http(s):(www.)//archive.org/details/ID;
• http(s):(www.)//archive.org/embed/ID.

When using the oui_player tag (vs oui_archive), 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.

Player customization

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.

Size

width

Integer; initially set to 640 (use 500 for a music player).
The width of the player in pixels.

height

Integer, initially set to 480 (use 30 for a music player).
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.

Parameters (a→z)

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

autoplay

0 or 1; initially set to 0.
Specifies whether the initial video will automatically start to play when the player loads.

playlist

0 or 1; initially set to 0.
Specifies whether to display the next titles if the item to play is a playlist.

poster

Image URL; initially not set.
Specifies the URL of an image to display as the starting shot.

oui_if_archive vs oui_if_player

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_archive>…</txp:oui_if_archive> tag is a shortcut to check an URL against Archive related URL schemes only. It is strictly equivalent to <txp:oui_if_player provider="archive">…</txp:oui_if_player>.

Check the oui_player documentation for more informations.

Examples

Embed a player using the preference values

<txp:oui_player />

oui_player preference related field value: https://archive.org/details/CC_1916_07_10_TheVagabond.

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

<txp:oui_player provider="archive" play="CC_1916_07_10_TheVagabond" />

…or:

<txp:oui_archive play="CC_1916_07_10_TheVagabond" />

Conditonally embed a player using attributes

<txp:oui_if_player provider="archive" play="https://archive.org/embed/CC_1916_07_10_TheVagabond">
    <txp:oui_player />
</txp:oui_if_player>

…or:

<txp:oui_if_archive play="https://archive.org/embed/CC_1916_07_10_TheVagabond">
    <txp:oui_archive />
</txp:oui_if_archive>

Credits

Author

Nicolas Morand
Thank you to the Textpattern community and the core team.

License

This plugin is distributed under GPL v2.0.

oui_archive version 1.0.0-BETA3, Copyright © 2018 Nicolas Morand
This Textpattern plugin comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain conditions.

Changelog

• oui_archive v1.0.0-BETA3 (2018-08-15)
• oui_player v1.3.0 (2017-05-24)