Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/backdrop-contrib/youtube

Easily embed YouTube videos in your Backdrop CMS website
https://github.com/backdrop-contrib/youtube

backdrop backdropcms cms field youtube

Last synced: 1 day ago
JSON representation

Easily embed YouTube videos in your Backdrop CMS website

Host: GitHub
URL: https://github.com/backdrop-contrib/youtube
Owner: backdrop-contrib
License: gpl-2.0
Created: 2015-06-08T23:10:06.000Z (over 9 years ago)
Default Branch: 1.x-1.x
Last Pushed: 2024-07-27T18:45:08.000Z (7 months ago)
Last Synced: 2024-07-30T17:16:23.455Z (7 months ago)
Topics: backdrop, backdropcms, cms, field, youtube
Language: PHP
Homepage: https://backdropcms.org/project/youtube
Size: 108 KB
Stars: 2
Watchers: 33
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

YouTube Field
========================
The YouTube field module provides a simple field that allows you to add a
YouTube video to a content type, user, or any entity.

Display types include:

* YouTube videos of various sizes and options.
* YouTube thumbnails with image styles.

Requirements
-------------
All dependencies of this module are enabled by default in Backdrop 1.x.

Installation
------------
Install this module using the official Backdrop CMS instructions at
https://backdropcms.org/guide/modules

Usage
-------
To use this module create a new field of type 'YouTube video'. This field will
accept YouTube URLs of the following formats:

* `https://youtube.com/watch?v=[video_id]`
* `https://youtu.be/[video_id]`
* `https://youtube.com/v/[video_id]`
* `https://youtube.com/embed/[video_id]`
* `https://youtube.com/live/[video_id]`
* `https://youtube.com/?v=[video_id]`

All formats listed above can also be provided without `https://`, with `www.`,
or with `http://` rather than `https://`. The last format can be provided with
additional parameters (ignored except for `t`) and `v` does not have to be the first parameter.

All formats can be provided with the additional parameter of `t` which is start
time in seconds. For example `https://youtube.com.live/[video_id]?t=120` or
`https://youtube.com/watch?v=[video_id]&t=120` to start the video 2 minutes in.
The time format can also be in the format of `1h10m30s` or any combination of
hours (`h`), minutes (`m`) and seconds (`s`). For example,
`https://youtu.be/[video_id]?t=1h45s` to start the video at time 01:00:45 from
the beginning.

To enable Colorbox support, enable the YouTube Field Colorbox module included in
this directory and consult its README file.

Configuration
--------------
Global module settings can be found at admin/config/media/youtube.

The video output of a YouTube field can be manipulated in three ways:
* global parameters found on the configuration page mentioned above
* field-specific parameters found in that particular field's display settings
* Views settings for the specific field

The thumbnail of the YouTube image can also be used and can link to either the
content, the video on YouTube, or nothing at all.

To configure the field settings:

1. click 'manage display' on the listing of entity types
2. click the configuration gear to the right of the YouTube field

License
-------

This project is GPL v2 software. See the LICENSE.txt file in this directory for
complete text.

Current Maintainers
-------------------

- Paul Davis (https://github.com/hellomrcat)
- Jen Lampton (https://github.com/jenlampton)
- Daniel Rose (https://github.com/danielrose28)
- [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk)

Credits
-------

This module was originally written for Drupal by Jen Lampton
(https://github.com/jenlampton).