Add oembed

[perso/Immae/Projets/packagist/piedsjaloux-ckeditor-component.git] / release / plugins / oembed / README.md

CKEditor-oEmbed-Plugin\r
======================\r
\r
oEmbed Plugin for CKEditor\r
\r
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.\r
\r
This Plugin uses the jquery-oembed-all Plugin  located at https://github.com/starfishmod/jquery-oembed-all.\r
\r
####Demo\r
\r
http://w8tcha.github.com/CKEditor-oEmbed-Plugin/\r
\r
####Currently Supported Sites...\r
\r
###Video\r
* Youtube - oembed - YQL\r
* Blip - oEmbed\r
* Hulu - oEmbed\r
* Vimeo - oEmbed\r
* National film board of Canada - oEmbed\r
* Qik - oEmbed\r
* Dotsub - oEmbed\r
* Clikthrough - oEmbed\r
* Kino Map - oEmbed\r
* Funny Or Die - Embedded\r
* College Humour - Embedded\r
* Metacafe - Embedded\r
* embedr - Embedded\r
* 5min - oEmbed is XML only - using YQL to translate it\r
* ustream.tv - oEmbed is not JSONP enabled - using YQL to translate it\r
* viddler - OGP\r
* twitvid - Embedded\r
* bambuser - Embedded\r
* xtranormal - Embedded\r
* Gametrailers - Embedded\r
* Vzarr - Embedded\r
* VHX - oembed\r
* bambuser - oembed\r
* dailymotion.com - oembed\r
* animoto - oembed\r
* justin.tv - YQL JSON\r
* livestream - OGP\r
* scivee - embedded\r
* veoh - embedded\r
* minoto-video - oembed using YQL\r
* TrailerAddict - OGP\r
* vodpod - oembed YQL - broken as the oembed has absolute positioning which breaks the display\r
* fora.tv -OGP YQL\r
* TED - OGP YQL\r
* Aniboom - embedded\r
* Comedy Central - OGP\r
* snotr - embedded\r
* zapiks - OGP\r
* youku - embedded\r
* wistia - Oembed\r
\r
###Audio\r
* Soundcloud - oEmbed\r
* HuffDuffer - oEmbed\r
* BandCamp - YQL and Embedded\r
* podomatic - OGP\r
* rdio.com - oEmbed\r
* hark.com - OGP\r
* chirb.it - YQL and oembed\r
* official.fm - YQL and oembed\r
* mixcloud - YQL and oembed\r
* shoudio - oembed\r
* audioboo.fm - OGP\r
* Spotify - OGP YQL\r
\r
###Photo\r
* flickr - oEmbed\r
* photobucket - oEmbed\r
* instagram - oEmbed\r
* yfrog - oEmbed\r
* 23HQ - oEmbed\r
* Smugmug - oEmbed\r
* twitpic - OGP YQL\r
* 500px.com - OGP\r
* visual.ly - YQL Lookup\r
* img.ly - Thumbnail view\r
* imgur.com - Thumbnail view\r
* twitgoo.com - Thumbnail view\r
* gravatar - Thumbnail view when using mailto\r
* pintrest - YQL - Embedded view of a sort.\r
* circuitlab - image view\r
* skitch - YQL oembed\r
* graphic.ly  - OGP\r
* dribble - jsonp lookup\r
* Lockerz - YQL lookup\r
* AsciiArtFarts - YQL Lookup\r
* lego cusoo - OGP over YQL\r
* plannary - OGP over YQL\r
* propic - OGP\r
* avairy.com - OGP\r
* lomography - ogp\r
* weheartit - ogp\r
* glogster - ogp\r
* chart.ly - embedded\r
* twitrpix - OGP\r
* chictopia - OGP\r
\r
###Rich\r
* Meetup - oEmbed\r
* gigapans - Embedded\r
* Slideshare - oEmbed\r
* ebay - Embedded\r
* scribd - Embedded\r
* screenr - Embedded\r
* tumblr- JSONP lookup\r
* imdb - JSONP lookup via imdbapi.com\r
* wikipedia- JSONP lookup\r
* github- JSONP lookup (CSS)\r
* eventful - OGP\r
* myspace - OGP\r
* live Journal - JSONP Lookup (CSS)\r
* wordpress - oEmbed (wordpress.com, wp.me, blogs.cnn.com, techcrunch.com). I can add other wordpress sites as well.\r
* circuitbee -Embedded\r
* stack overflow - JSONP Lookup (CSS)\r
* Facebook - JSONP Lookup (CSS)\r
* Pastebin - Embedded\r
* Pastie - YQL lookup\r
* kickstarter - Embedded\r
* issuu - OGP\r
* reelapp.com - Embedded\r
* Etsy - OGP over YQL\r
* Amazon - Embedded - Requires Affiliate code\r
* linkedin - Embedded IFRAME - found a link that works :)\r
* Lanyrd - YQL (CSS)\r
* twitter - Oembed - status only - but that is ok I think\r
* github gist - oembed\r
* speakerdeck - yql oembed\r
* dipity - yql oembed\r
* dailymile - oembed\r
* deviantart - oembed\r
* Roomshare Japan - oembed\r
* mobypictures - oembed\r
* prezi - embedded\r
* popplet - embedded\r
* authorstream - OGP\r
* googlecalendar - Iframe\r
* cacoo - oembed\r
* pearltrees - embedded\r
* urtak - oembed - is broken in iframe return atm -seems to be an embed.ly issue??\r
* jotform - embedded\r
* Urban Dictionary - YQL lookup\r
* Ars Technica - YQL Lookup\r
* Eventbrite - OGP YQL\r
* last.fm OGP YQL\r
* Rotten Tomatoes - OGP YQL\r
* iFixit - OGP\r
* qwiki - OGP\r
* brighttalk - Meta info\r
* tinychat - OGP\r
* tourwrist - embedded\r
* bnter - OGP\r
* bigthink - OGP\r
* wirewax - OGP\r
* whosay - OGP\r
* timetoast - embedded\r
* tripline - OGP\r
* jsfiddle - embedded\r
\r
\r
####License\r
\r
Licensed under the terms of the MIT License.\r
\r
####Dependencies\r
This Plugin requires the following plugins to work: Widget, Dialog.\r
\r
####Installation\r
\r
 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\r
 2. Extract the contents of the file into the "plugins" folder of CKEditor.\r
 3. In the CKEditor configuration file (config.js) add the following code:\r
\r
````js\r
config.extraPlugins = 'oembed,widget';\r
````\r
\r
2a. Additionally you can also set the default values vor the Max. Width/Height Values\r
\r
````js\r
config.oembed_maxWidth = '560';\r
config.oembed_maxHeight = '315';\r
````\r
\r
and also you can define an css class for the embeded content wrapper (div), by default there is no Class defined\r
\r
````js\r
config.oembed_WrapperClass = 'embededContent';\r
````\r
\r
\r
3. and also include the plugin in the toolbar\r
\r
````js\r
toolbar :[ ... ['oembed']...]\r
````\r