1# -*- mode: org;  coding: utf-8; -*-
2
3* oEmbed Plugin
4
5#+BEGIN_SRC dokuwiki
6---- plugin ----
7description: Easily embed media from OEmbed providers.
8author     : Dwayne Bent, nik gaffney
9email      : nik@fo.am
10type       : syntax
11lastupdate : 2019-09-01
12compatible : Greebo
13depends    :
14conflicts  :
15similar    :
16tags       : media, images, video, music, embed
17
18downloadurl: https://github.com/zzkt/dokuwiki-oembed/zipball/master
19sourcerepo : https://github.com/zzkt/dokuwiki-oembed/
20bugtracker : https://github.com/zzkt/dokuwiki-oembed/issues
21donationurl: https://www.sarcoma.org.au/donations
22
23----
24#+END_SRC
25
26The oEmbed plugin allows you to easily embed media from any provider that supports the [[https://oembed.com/][oEmbed]] format.
27
28** Install
29
30Search for and install the plugin using the [[plugin:extension][Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
31
32** Syntax
33
34The simplest way to embed media is with its url. e.g. ~{{>http://example.com/}}~
35
36Some providers can be given extra options in the form ~{{>url?options}}~ such as ~maxwidth~ or ~maxheight~
37
38
39
40An 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
41
42** Examples
43
44Embed a single image from Flickr
45
46~{{>http://www.flickr.com/photos/foam/41018347952}}~~
47
48embed an image with a maximum width of 800px
49
50~{{>http://www.flickr.com/photos/foam/41018347952?maxwidth=800}}~~
51
52embed a gallery
53
54~{{>http://www.flickr.com/photos/flickr/galleries/72157667259442778/}}~~
55
56use the API endpoint directly
57
58~{{>http://www.flickr.com/services/oembed/ !direct ?url=http://www.flickr.com/photos/sdasmarchives/5018415361/}}~
59
60** Further
61
62A 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.
63
64** Known issues
65
66The 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.
67
68  - can't resolve https urls for some providers
69
70