This is an old revision of the document!
Table of Contents
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
Similar to dailymotion, oembed, slideshare, vimeo, youtube
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¶meter2|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
like500×300
- or use the keywords
small
,medium
orlarge
- you can also use the keywords
full
orhalf
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
- Version upped (2024-03-24 23:50)
- move noreferrer policy to hardend mode (2024-03-24 19:35)
- Version upped (2024-02-28 23:50)
- lazy load iframes (2024-02-28 17:33)
- automatic style fixes (2024-02-28 16:03)
- added extra hardening option (2024-02-28 15:58)
- Merge pull request #131 from dokuwiki-translate/lang_update_648_16853… (2023-05-31 08:15)
- translation update (2023-05-29 20:25)
Please report bugs and request features at the issue tracker