TIP OEmbedPlugin is not installed on Foswiki.org.


Easy embedding of third party content

oEmbed is a format for allowing an embedded representation of a URL on third party sites. The simple API allows a website to display embedded content (such as photos or videos) when a user posts a link to that resource, without having to parse the resource directly.

All you need to do to embed material from one of the supported providers is to add a link to it. The plugin will contact the provider and use the appropriate code to add it to the page, e.g. add an iframe for videos and the like.

Supported providers

  1. AmChart Live Editor
  2. Edocr
  3. AudioSnaps
  4. Quiz.biz
  5. FunnyOrDie
  6. Clyp
  7. 23HQ
  8. Alpha App
  9. Amazon (embed.ly)
  10. Animoto
  11. Aol
  12. Blib.tv
  13. Cacoo
  14. Chirbit
  15. CircuitLab
  16. ClikThrough
  17. Clipfish (embed.ly)
  18. CollegeHumor
  19. Coub
  20. CrowdRanking
  21. DailyMile
  22. DailyMotion
  23. DeviantArt
  24. Dipity
  25. Dotsub
  26. Flickr
  27. Foursquare (embed.ly)
  28. FunnyOrDie
  29. Geograph Britain and Ireland
  30. Geograph Channel Islands
  31. Geograph Germany
  32. Github
  33. GMEP
  34. Google Maps (embed.ly)
  35. HuffDuffer
  36. Hulu
  37. IFTTT
  38. IMDB (embed.ly)
  39. Instagram
  40. Jest
  41. JustinTV
  42. Kickstarter
  43. Kinomap
  44. Meetup
  45. MixCloud
  46. MobyPicture
  47. Nfb
  48. OfficialFM
  49. PollEverywhere
  50. PollyDaddy
  51. Portfolium
  52. Quiz.biz
  53. Rdio
  54. Revision3
  55. Roomshare
  56. SapoVideos
  57. Screencast (embed.ly)
  58. Screenr
  59. Scribd
  60. Shoudio
  61. Sketchfab
  62. SlideShare
  63. SoundCloud
  64. SpeakerDeck
  65. Ted
  66. Twitpic (embed.ly)
  67. Twitter
  68. Ustream
  69. Viddler
  70. Viddler
  71. VideoJug
  72. Vimeo
  73. Vimeon
  74. Vine
  75. Washington Post (embed.ly)
  76. WordPress
  77. WordPress TV
  78. YFrog
  79. Youtube

A lot of providers are available via http://embed.ly. However, you'll have to register to get an api-key. Some of the listed providers have already been added to this plugin, yet not all.


Syntax: %EMBED{"url" [width="..." height="..."]}% (or %OEMBED{...}%)

  • url: an external link to the resource to be embedded
  • width, height: optional maximum values for the image/video/... being embedded (note: not all providers properly implement these parameters)
  • format: a format string to implement a custom renderer
  • template: the name of a template defined in oembed.tmpl; known templates shipped with OEmbedPlugin are "article" (todo add more)
  • <custom_key>: any custom key="value" pair may be defined and made use of in the format (or template) using $custom_key to expand it; these have higher precendence than the default values submitted by the oembed provider; for example use a custom thumbnail_width="100" parameter to override the default width.

The keys in the json submitted from the oembed provider can be used in a format string (or a template definition). Some well-known keys are:

  • $author_name
  • $author_url
  • $descriptio
  • $html
  • $provider_name
  • $provider_url
  • $thumbnail_height
  • $thumbnail_url
  • $thumbnail_width
  • $title
  • $type
  • $url
  • $web_page

In addition all standard format tokens can be used ($percnt, $dollar, $nop, etc).

See the oembed.tmpl file on how to use them.


Washington Post


%EMBED{"http://www.washingtonpost.com/investigations/us-intelligence-mining-data-from-nine-us-internet-companies-in-broad-secret-program/2013/06/06/3a0c0da8-cebf-11e2-8845-d970ccb04497_story.html" template="article" thumbnail_width="100" }%


%EMBED{"http://www.youtube.com/watch?v=O8e8Ttfz-pY" width="600"}%

%EMBED{"http://www.youtube.com/watch?v=O8e8Ttfz-pY" width="600"}%


%EMBED{"http://soundcloud.com/safia-music/listen-to-soul-listen-to-blues" width="600"}%

%EMBED{"http://soundcloud.com/safia-music/listen-to-soul-listen-to-blues" width="600"}%


%EMBED{"http://www.flickr.com/photos/onement/1239189689/" height="400"}%
%EMBED{"http://www.flickr.com/photos/onement/1239189689/" height="400"}%

More examples

%EMBED{"http://www.scribd.com/doc/17896323/Indian-Automobile-industryPEST" width="600"}%
  format="<a href='$url'><img src='$url' width='$width' /></a> %BR% by <a href='$author_url'>$author_name</a>"
%EMBED{"http://www.23hq.com/brinjal/photo/13305970" width="500"}%

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.


Author(s): Michael Daum
Copyright: © 2013-2015 Michael Daum http://michaeldaumconsulting.com
License: GPL (Gnu General Public License)
Release: 27 Feb 2015
Version: 5.11
Change History:  
23 Feb 2015 added a few more provider
16 Dec 2014 have an image preview for vimeo and youtube and only embed the real video when clicking on it; added Vine
25 Sep 2014 added caching
24 Sep 2014 added a custom renderer for youtube videos
29 Aug 2014 removed my opera, qirk and urtak; use https whereever possible
01 Nov 2013 added more providers
30 Aug 2013 added more providers
24 Jun 2013 added format, template and custom params; added a few more providers
Home page: Foswiki:Extensions/OEmbedPlugin
Support: Foswiki:Support/OEmbedPlugin
Topic revision: r11 - 27 Feb 2015, MichaelDaum - This page was cached on 28 Oct 2016 - 10:23.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License