1====== oEmbed Plugin ======
2
3---- plugin ----
4description: Easily embed media from OEmbed providers.
5author     : Dwayne Bent, nik gaffney
6email      : nik@fo.am
7type       : syntax
8lastupdate : 2019-09-01
9compatible : Greebo
10depends    :
11conflicts  :
12similar    :
13tags       : media, images, video, music, embed
14
15downloadurl: https://github.com/zzkt/dokuwiki-oembed/zipball/master
16sourcerepo : https://github.com/zzkt/dokuwiki-oembed/
17bugtracker : https://github.com/zzkt/dokuwiki-oembed/issues
18donationurl: https://www.sarcoma.org.au/donations
19
20----
21
22The oEmbed plugin allows you to easily embed media from any provider that supports the [[https://oembed.com/|oEmbed]] format.
23
24===== Install =====
25
26Search for and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to :Plugins on how to install plugins manually.
27
28===== Syntax =====
29
30The simplest way to embed media is with its url. e.g. ''%%{{>http://example.com/}}%%''
31
32Some providers can be given extra options in the form ''%%{{>url?options}}%%'' such as ''%%maxwidth%%'' or ''%%maxheight%%''
33
34An oembed provider will specify a URL scheme and API endpoint pairs. If you know the endpoint you can also use the ''%%!direct%%'' keyword to send paramaters to the API endpoint
35
36===== Examples =====
37
38Embed a single image from Flickr
39
40''%%{{>http://www.flickr.com/photos/foam/41018347952}}~%%''
41
42embed an image with a maximum width of 800px
43
44''%%{{>http://www.flickr.com/photos/foam/41018347952?maxwidth=800}}~%%''
45
46embed a gallery
47
48''%%{{>http://www.flickr.com/photos/flickr/galleries/72157667259442778/}}~%%''
49
50use the API endpoint directly
51
52''%%{{>http://www.flickr.com/services/oembed/ !direct ?url=http://www.flickr.com/photos/sdasmarchives/5018415361/}}%%''
53
54===== Further =====
55
56A list of oembed providers can be found on the [[https://oembed.com/|oEmbed website]] and [[https://noembed.com/|Noembed]] can provide a consitent inferface for supported and unsupoprted site.
57
58===== Known issues =====
59
60The current plugin (as of 2019) has been updated from an old unmaintained version but doesn't use the new plugin skeleton and may not be fully compatible with current/future versions of dokuwiki.
61
62  * can't resolve https urls for some providers
63
64