The basic syntax looks like this: {{videosite>videoid?parameter1¶meter2|title}}
videosite is one of the identifiers listed in Supported Services chapter
videoid is the identifier of the video at the respective site
parameters are optional. You start these with a ? and separate more of them by a &. Look in Parameters 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. For some services you may need to paste a special URL. See the table below.
When embedding a video you should add a size parameter.
You can either give it in the form:
widthxheight like 500×300
small, medium or large
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. There are also hints in the table below.
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}}
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 | |
| twitchtv | Twitch.tv | chapter_id, initial_time | |
| archiveorg | Archive.org | ||
| soundcloud | SoundCloud | ||
| niconico | NicoNico | ||
| break | Break | ||
| bitchute | BitChute | ||
| coub | Coub | ||
| odysee | Odysee LBRY | paste the embed or download URL | |
| youku | Youku | unclear if working | |
| bilibili | bili bili | ||
| msoffice | unclear if working | ||
| msstream | unclear if working |
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
When enabling the gdpr option, videos will not be embedded right away. Instead the user needs to click on the embed first. This will embed the video.
Enabling the debug option enables the syntax macro ~~vshare-debug~~. Using that macro in a page, will embed a video from each of the configured video sites. This makes it easy to check that all services still work as expected. It is probably only useful for developers.
New services can easily be added by editing the sites.ini file in the plugin's main directory. Each service expects the following settings:
| url | The URL that will be loaded into an iframe, should contain at least @VIDEO@ placeholder which will be replaced by the video ID. |
| vid | A public sample video ID used for testing |
| web | The full URL to the website for the video identified by vid above |
| emb | An optional special URL to use for extracting the vid, sometimes needed when the VideoID is only available in special URLs |
| rex | A regular expression that can extract the vid from the web or ''emb' url. It has to contain a single capturing group. It's used in the toolbar mechanism |
| nfo | An option hint on how to find the right URL to paste, currently not used anywhere |
Pull requests providing this data are welcome.