miteruzo
/
mr-legend_wiki
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1 Commit
1 Branch
13 MiB
 
 
 
 
 
Tree: c616a96f53
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c616a96f53'
${ noResults }
mr-legend_wiki/lib/plugins/oembed/docs/dokuwiki-oembed.txt

64 lines
2.2 KiB
Raw Blame History 

  1. ====== oEmbed Plugin ======

  2. 

  3. ---- plugin ----

  4. description: Easily embed media from OEmbed providers.

  5. author     : Dwayne Bent, nik gaffney

  6. email      : nik@fo.am

  7. type       : syntax

  8. lastupdate : 2019-09-01

  9. compatible : Greebo

  10. depends    : 

  11. conflicts  : 

  12. similar    : 

  13. tags       : media, images, video, music, embed

  14. 

  15. downloadurl: https://github.com/zzkt/dokuwiki-oembed/zipball/master

  16. sourcerepo : https://github.com/zzkt/dokuwiki-oembed/

  17. bugtracker : https://github.com/zzkt/dokuwiki-oembed/issues

  18. donationurl: https://www.sarcoma.org.au/donations

  19. 

  20. ----

  21. 

  22. The oEmbed plugin allows you to easily embed media from any provider that supports the [[https://oembed.com/|oEmbed]] format.

  23. 

  24. ===== Install =====

  25. 

  26. Search for and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to :Plugins on how to install plugins manually.

  27. 

  28. ===== Syntax =====

  29. 

  30. The simplest way to embed media is with its url. e.g. ''%%{{>http://example.com/}}%%''

  31. 

  32. Some providers can be given extra options in the form ''%%{{>url?options}}%%'' such as ''%%maxwidth%%'' or ''%%maxheight%%''

  33. 

  34. An 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. 

  38. Embed a single image from Flickr

  39. 

  40. ''%%{{>http://www.flickr.com/photos/foam/41018347952}}~%%''

  41. 

  42. embed an image with a maximum width of 800px

  43. 

  44. ''%%{{>http://www.flickr.com/photos/foam/41018347952?maxwidth=800}}~%%''

  45. 

  46. embed a gallery

  47. 

  48. ''%%{{>http://www.flickr.com/photos/flickr/galleries/72157667259442778/}}~%%''

  49. 

  50. use 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. 

  56. A 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. 

  60. The 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