release/plugins/oembed/README.md

   1 CKEditor-oEmbed-Plugin
   2 ======================
   3
   4 oEmbed Plugin for CKEditor
   5
   6 This Plugin allows to insert embedded content (such as photos, videos, audio, and other rich media) via the OEmbed API. You only have to provide the url to the site (It works also when the url is shortened) you want to embed and the plugin does the rest.
   7
   8 This Plugin uses the jquery-oembed-all Plugin  located at https://github.com/starfishmod/jquery-oembed-all.
   9
  10 ####Demo
  11
  12 http://w8tcha.github.com/CKEditor-oEmbed-Plugin/
  13
  14 ####Currently Supported Sites...
  15
  16 ###Video
  17 * Youtube - oembed - YQL
  18 * Blip - oEmbed
  19 * Hulu - oEmbed
  20 * Vimeo - oEmbed
  21 * National film board of Canada - oEmbed
  22 * Qik - oEmbed
  23 * Dotsub - oEmbed
  24 * Clikthrough - oEmbed
  25 * Kino Map - oEmbed
  26 * Funny Or Die - Embedded
  27 * College Humour - Embedded
  28 * Metacafe - Embedded
  29 * embedr - Embedded
  30 * 5min - oEmbed is XML only - using YQL to translate it
  31 * ustream.tv - oEmbed is not JSONP enabled - using YQL to translate it
  32 * viddler - OGP
  33 * twitvid - Embedded
  34 * bambuser - Embedded
  35 * xtranormal - Embedded
  36 * Gametrailers - Embedded
  37 * Vzarr - Embedded
  38 * VHX - oembed
  39 * bambuser - oembed
  40 * dailymotion.com - oembed
  41 * animoto - oembed
  42 * justin.tv - YQL JSON
  43 * livestream - OGP
  44 * scivee - embedded
  45 * veoh - embedded
  46 * minoto-video - oembed using YQL
  47 * TrailerAddict - OGP
  48 * vodpod - oembed YQL - broken as the oembed has absolute positioning which breaks the display
  49 * fora.tv -OGP YQL
  50 * TED - OGP YQL
  51 * Aniboom - embedded
  52 * Comedy Central - OGP
  53 * snotr - embedded
  54 * zapiks - OGP
  55 * youku - embedded
  56 * wistia - Oembed
  57
  58 ###Audio
  59 * Soundcloud - oEmbed
  60 * HuffDuffer - oEmbed
  61 * BandCamp - YQL and Embedded
  62 * podomatic - OGP
  63 * rdio.com - oEmbed
  64 * hark.com - OGP
  65 * chirb.it - YQL and oembed
  66 * official.fm - YQL and oembed
  67 * mixcloud - YQL and oembed
  68 * shoudio - oembed
  69 * audioboo.fm - OGP
  70 * Spotify - OGP YQL
  71
  72 ###Photo
  73 * flickr - oEmbed
  74 * photobucket - oEmbed
  75 * instagram - oEmbed
  76 * yfrog - oEmbed
  77 * 23HQ - oEmbed
  78 * Smugmug - oEmbed
  79 * twitpic - OGP YQL
  80 * 500px.com - OGP
  81 * visual.ly - YQL Lookup
  82 * img.ly - Thumbnail view
  83 * imgur.com - Thumbnail view
  84 * twitgoo.com - Thumbnail view
  85 * gravatar - Thumbnail view when using mailto
  86 * pintrest - YQL - Embedded view of a sort.
  87 * circuitlab - image view
  88 * skitch - YQL oembed
  89 * graphic.ly  - OGP
  90 * dribble - jsonp lookup
  91 * Lockerz - YQL lookup
  92 * AsciiArtFarts - YQL Lookup
  93 * lego cusoo - OGP over YQL
  94 * plannary - OGP over YQL
  95 * propic - OGP
  96 * avairy.com - OGP
  97 * lomography - ogp
  98 * weheartit - ogp
  99 * glogster - ogp
 100 * chart.ly - embedded
 101 * twitrpix - OGP
 102 * chictopia - OGP
 103
 104 ###Rich
 105 * Meetup - oEmbed
 106 * gigapans - Embedded
 107 * Slideshare - oEmbed
 108 * ebay - Embedded
 109 * scribd - Embedded
 110 * screenr - Embedded
 111 * tumblr- JSONP lookup
 112 * imdb - JSONP lookup via imdbapi.com
 113 * wikipedia- JSONP lookup
 114 * github- JSONP lookup (CSS)
 115 * eventful - OGP
 116 * myspace - OGP
 117 * live Journal - JSONP Lookup (CSS)
 118 * wordpress - oEmbed (wordpress.com, wp.me, blogs.cnn.com, techcrunch.com). I can add other wordpress sites as well.
 119 * circuitbee -Embedded
 120 * stack overflow - JSONP Lookup (CSS)
 121 * Facebook - JSONP Lookup (CSS)
 122 * Pastebin - Embedded
 123 * Pastie - YQL lookup
 124 * kickstarter - Embedded
 125 * issuu - OGP
 126 * reelapp.com - Embedded
 127 * Etsy - OGP over YQL
 128 * Amazon - Embedded - Requires Affiliate code
 129 * linkedin - Embedded IFRAME - found a link that works :)
 130 * Lanyrd - YQL (CSS)
 131 * twitter - Oembed - status only - but that is ok I think
 132 * github gist - oembed
 133 * speakerdeck - yql oembed
 134 * dipity - yql oembed
 135 * dailymile - oembed
 136 * deviantart - oembed
 137 * Roomshare Japan - oembed
 138 * mobypictures - oembed
 139 * prezi - embedded
 140 * popplet - embedded
 141 * authorstream - OGP
 142 * googlecalendar - Iframe
 143 * cacoo - oembed
 144 * pearltrees - embedded
 145 * urtak - oembed - is broken in iframe return atm -seems to be an embed.ly issue??
 146 * jotform - embedded
 147 * Urban Dictionary - YQL lookup
 148 * Ars Technica - YQL Lookup
 149 * Eventbrite - OGP YQL
 150 * last.fm OGP YQL
 151 * Rotten Tomatoes - OGP YQL
 152 * iFixit - OGP
 153 * qwiki - OGP
 154 * brighttalk - Meta info
 155 * tinychat - OGP
 156 * tourwrist - embedded
 157 * bnter - OGP
 158 * bigthink - OGP
 159 * wirewax - OGP
 160 * whosay - OGP
 161 * timetoast - embedded
 162 * tripline - OGP
 163 * jsfiddle - embedded
 164
 165
 166 ####License
 167
 168 Licensed under the terms of the MIT License.
 169
 170 ####Dependencies
 171 This Plugin requires the following plugins to work: Widget, Dialog.
 172
 173 ####Installation
 174
 175  1. Before you can use the plugin you also need to download & install the widget plugin, if you have it not installed. http://ckeditor.com/addon/widget
 176  2. Extract the contents of the file into the "plugins" folder of CKEditor.
 177  3. In the CKEditor configuration file (config.js) add the following code:
 178
 179 ````js
 180 config.extraPlugins = 'oembed,widget';
 181 ````
 182
 183 2a. Additionally you can also set the default values vor the Max. Width/Height Values
 184
 185 ````js
 186 config.oembed_maxWidth = '560';
 187 config.oembed_maxHeight = '315';
 188 ````
 189
 190 and also you can define an css class for the embeded content wrapper (div), by default there is no Class defined
 191
 192 ````js
 193 config.oembed_WrapperClass = 'embededContent';
 194 ````
 195
 196
 197 3. and also include the plugin in the toolbar
 198
 199 ````js
 200 toolbar :[ ... ['oembed']...]
 201 ````