DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:vshare

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:vshare [2016-03-09 09:16] – [Usage/Syntax] 79.248.2.207plugin:vshare [2024-03-25 17:49] (current) Aleksandr
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: Easily embed videos from various Video Sharing sites like YouTube or Vimeo.+description: Easily embed videos from various Video Sharing sites like YouTube or Vimeo 
 author     : Andreas Gohr author     : Andreas Gohr
 email      : andi@splitbrain.org email      : andi@splitbrain.org
 type       : syntax type       : syntax
-lastupdate : 2016-01-24 +lastupdate : 2024-03-24 
-compatible : RincewindAnguaAdora BelleWeatherwax, Binky, Ponder Stibbons, Hrun, Detritus+compatible : !Hogfather!IgorJack JackrumKaos
 depends    :  depends    : 
-conflicts  : dailymotion, google_video, youtubev2 +conflicts  : dailymotion 
-similar    : dailymotion, google_videoyoutubev2, niconico, slideshare +similar    : dailymotion, slideshareoEmbed 
-tags       : media, video, embed, flash, youtube+tags       : media, video, embed, youtube, gdpr
  
 downloadurl: https://github.com/splitbrain/dokuwiki-plugin-vshare/zipball/master downloadurl: https://github.com/splitbrain/dokuwiki-plugin-vshare/zipball/master
Line 19: Line 19:
 ---- ----
  
-This plugin allows you to embed flash 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.+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 ===== ===== Download and Install =====
  
-Please use the the download link at the top for manual installation or use in the plugin manager.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Usage/Syntax ===== ===== Usage/Syntax =====
Line 34: Line 34:
   * 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   * 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+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.
  
 === Parameters === === Parameters ===
  
-  * The ''//size//'' parameter is the best supported parameter. You can either give it in the form: +When embedding a video you should add a size parameter.
-    * ''//width//x//height//'' like ''500x300'' +
-    * or use the keywords ''small'', ''medium'' or ''large'' +
-  * Some other additional parameters are supported (depending on video service) as well: +
-    * 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)+
  
 +You can either give it in the form:
  
-===== Supported Services =====+  * ''//width//x//height//'' like ''500x300'' 
 +  * 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. There are also hints in the table below. 
 + 
 +==== 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 Copy paste the video url in the toolbar pop-up prompt to generate the syntax
-^ Identifier  ^ Website  ^ Supported parameters ^ +^ Identifier   ^ Website                                        ^ Comments                         ^ Supported parameters       
-5min        | [[http://www.5min.com/|5min]]                |  | +youtube      | [[https://www.youtube.com/|YouTube]]                                            | start, end, rel, autoplay  | 
-bambuser    | [[http://bambuser.com|Bambuser]]             | autoplay | +vimeo        | [[https://www.vimeo.com/|Vimeo]]               |                                  | autoplay                   
-bliptv      | [[http://blip.tv/|Blip.TV]]                   +slideshare   | [[https://www.slideshare.com|Slideshare]]      paste the Wordpress shortcode    | startSlide                 
-break       | [[http://www.break.com|Break]]               |  | +dailymotion  | [[https://www.dailymotion.com/|Daily Motion]]  |                                  | start                      
-clipfish    | [[http://www.clipfish.de/|Clipfish]]          +twitchtv     | [[https://www.twitch.tv|Twitch.tv]]                                             | chapter_id, initial_time   
-dailymotion | [[http://www.dailymotion.com/|Daily Motion]] | start +archiveorg   | [[https://archive.org/|Archive.org]]                                                                       
-gtrailers   | [[http://www.gametrailers.com|GameTrailers]] |  +soundcloud   | [[https://soundcloud.com|SoundCloud]]                                                                      
-metacafe    | [[http://www.metacafe.com/|MetaCafe]]        ap +niconico     | [[https://www.nicovideo.jp|NicoNico]]                                                                      
-msoffice    | [[http://office.microsoft.com/en-us/support/training-FX101782702.aspx|Microsoft Office Training]] | | +break        | [[https://www.break.com|Break]]                                                                            
-myspacetv   | [[http://vids.myspace.com/|MySpaceTV]]        +bitchute     | [[https://www.bitchute.com|BitChute]]                                                                      
-rcmovie     | [[http://www.rcmovie.de|RCMovie]]             +coub         | [[https://coub.com|Coub]]                                                                                  
-scivee      | [[http://scivee.tv|Scivee.tv]]               |  | +odysee       | [[https://odysee.com/|Odysee LBRY]]            paste the embed or download URL  |                            
-twitchtv    | [[http://www.twitch.tv|Twitch.tv]]           chapter_id, initial_time  +youku        | [[https://youku.com|Youku]]                    unclear if working                                          
-slideshare  | [[http://www.slideshare.com|Slideshare]]     startSlide  +bilibili     | [[https://www.bilibili.com|bili bili]]                                                                     
-ustream     | [[http://ustream.tv|Ustream.TV]]              +msoffice     |                                                unclear if working                                          
-veoh        | [[http://www.veoh.com/|Veoh]]                +msstream                                                    | unclear if working                                          | 
-| viddler     [[http://www.viddler.com|Viddler]]           offsetTime + 
-vimeo       [[http://www.vimeo.com/|Vimeo]]              autoplay +For other video sharing sites not supported by vshare, particularly those using [[https://joinpeertube.org|PeerTube]], you could use the [[plugin:oembed|oEmbed plugin]] to embed videos and other medias 
-youtube     [[http://www.youtube.com/|YouTube]]          startend, rel, autoplay |+ 
 +===== Configuration ===== 
 + 
 +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. 
 + 
 +The ''extrahard'' option will set a whole bunch of extra attributes on the iframe, instructing the browser to access the video in it's own sandboxed context. This will send less personal data to the video site but will also disable features logged in users might usually expect. Eg. ad-less videos for premium subscribers, the use of watch-later lists, etc. 
 + 
 +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. 
 + 
 +===== Adding new services ===== 
 + 
 +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' urlIt has to contain a single capturing groupIt's used in the toolbar mechanism | 
 +nfo | An option hint on how to find the right URL to pastecurrently not used anywhere | 
 + 
 +Pull requests providing this data are welcome.
  
-Additional sites can be added to the ''sites.conf'' file in the plugin directory. Video ID recognition patterns for the toolbar button are configured in ''sites.js'' 
  
-==== Changes ====+===== Changes =====
  
 {{rss>https://github.com/splitbrain/dokuwiki-plugin-vshare/commits/master.atom date}} {{rss>https://github.com/splitbrain/dokuwiki-plugin-vshare/commits/master.atom date}}
  
-Please report bugs and request features at the [[https://github.com/splitbrain/dokuwiki-plugin-vshare/issues|issue tracker]]+Please report bugs and request features at the [[https://github.com/splitbrain/dokuwiki-plugin-vshare/issues|issue tracker]].
plugin/vshare.1457511387.txt.gz · Last modified: 2016-03-09 09:16 by 79.248.2.207

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