DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:vshare

This is an old revision of the document!


Video Share Plugin

Compatible with DokuWiki

  • 2024-02-06 "Kaos" unknown
  • 2023-04-04 "Jack Jackrum" unknown
  • 2022-07-31 "Igor" unknown
  • 2020-07-29 "Hogfather" yes

plugin Easily embed videos from various Video Sharing sites like YouTube or Vimeo.

Last updated on
2021-06-25
Provides
Syntax
Repository
Source
Conflicts with
dailymotion

This plugin allows you to embed video players from various video sharing sites. New services can be added by just editing a config file. This is not for displaying local video files.

Download and Install

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Usage/Syntax

The basic syntax looks like this: {{videosite>videoid?parameter1&parameter2|title}}

  • Where videosite is one of the identifiers listed in Supported Services chapter
  • and videoid is the identifier of the video at the respective site
  • The parameters are optional. You start these with a ? and separate more of them by a &. Look in Parameters chapter
  • The title is optional as well. Look in Examples chapter
  • The video can be aligned by adding spaces on the left or right inside the curly brackets (like in the image syntax). Look in Examples chapter

A toolbar button pops up a prompt where you can simply paste the full URL to the page of the video you want to embed. The plugin will then try to figure out the video ID by itself

Parameters

When embedding a video you should add a size parameter.

You can either give it in the form:

  • widthxheight like 500×300
  • or use the keywords small, medium or large
  • you can also use the keywords full or half to have the video adjust to the available screen width (either 100% or 50% width)

All additional parameters will be passed on as-is to the video service. Refer to their documentation for what is available. Here are some examples:

  • Start point of video: &start=<seconds> (YouTube, DailyMotion) or &initial_time=<seconds> (TwitchTV)
  • End point of video segment: &end=<seconds> (YouTube)
  • Auto play: &autoplay=1 (Vimeo, YouTube, DailyMotion, Bambuser) or &ap=1(MetaCafe)
  • Do not show related videos when playback ends: &rel=0 (YouTube)
  • Start slide: &startSlide=5 (SlideShare)

Examples

Display a YouTube Video:

{{youtube>L-WM8YxwqEU}}

Show a larger player:

{{youtube>L-WM8YxwqEU?large}}

Right-align the player:

{{ youtube>L-WM8YxwqEU}}

Show a small, centered player:

{{ youtube>L-WM8YxwqEU?small }}

Show a small, centered player with a title (look for right space!):

{{ youtube>L-WM8YxwqEU?small |Some funny video}}

Some other additional parameters are supported (depending on video service) as well:

{{youtube>L-WM8YxwqEU?small&start=30&end=45|A random segment of 15 seconds}}

Supported Services

Copy paste the video url in the toolbar pop-up prompt to generate the syntax

Identifier Website Comments Supported parameters
youtube YouTube start, end, rel, autoplay
vimeo Vimeo autoplay
slideshare Slideshare paste the Wordpress shortcode startSlide
dailymotion Daily Motion start
msoffice unclear if working
msstream unclear if working
archiveorg Archive.org
niconico NicoNico
break Break
bitchute BitChute
coub Coub
odysee Odysee LBRY paste the embed or download URL
twitchtv Twitch.tv chapter_id, initial_time
youku Youku unclear if working
bilibili bili bili

For other video sharing sites not supported by vshare, particularly those using PeerTube, you could use the oEmbed plugin to embed videos and other medias

Changes

Please report bugs and request features at the issue tracker

plugin/vshare.1643920947.txt.gz · Last modified: 2022-02-03 21:42 by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki