= collective.embedly =

[[PageOutline]]

[[Image(collective.embedly.jpg, nolink)]]	

== Links ==

 * [http://quintagroup.com/services/plone-development/products/collective.embedly collective.embedly on Quintagroup.com]
 * [http://plone.org/products/collective.embedly collective.embedly on plone.org]
 * [http://pypi.python.org/pypi/collective.embedly collective.embedly om PyPi]
 * [https://github.com/collective/collective.embedly Repository]
 * [https://travis-ci.org/collective/collective.embedly Build status] [[Image(https://travis-ci.org/collective/collective.embedly.png?branch=master)]]

This package provides TinyMCE visual editor support for [http://api.embed.ly/docs embed.ly] service: videos, images and other rich media files can be inserted to Plone from different services through one API. The approach here is to use the Transform machinery to replace the URL with embed code by calling the embed.ly API.

There are [http://api.embed.ly 204 services] so far that support embedly service, such as:
 * video sharing sites: Youtube, Blip.tv, Vimeo, TED.com
 * audio streaming services: SoundCloud, last.fm
 * image/photo sticks: Flickr, Picasa
 * other: !GoogleMaps,  Facebook

This product was developed by  http://quintagroup.com for Plone collective, sponsored by Headnet company  http://headnet.dk/. 

== Usage ==

To embed media from the embedly-supported external resource to Plone, first you will need to register in the embedly service. Upon completing sign up, you'll be provided with the API key. Copy and insert it into '''API Key''' field of Embedly settings (add '''/@@embedly-controlpanel''' to the site address). 

[[Image(embed.png, nolink)]]

Now you can embed content from more than 200 sharing sources.
Follow these steps to insert videos, photos, music into Plone:

 1. Go to the object's edit form, select text (it will be replaced with the embedded media) and click "Insert/Edit Embedly link" on the TinyMCE toolbar

 [[Image(style.png, nolink)]]	

 2. In the popup  window type in the URL of the object. You may click "Preview" to make sure the link is correct. Then click "Insert"

 [[Image(linked.png, nolink)]]	

 3. Save this page.

 [[Image(page.png, nolink)]]

 4. You may customize video parameters (e.g. maxheight, maxwidth, autoplay) using '''Advanced''' settings tab.

 [[Image(embedly-advanced.png, nolink)]] 


----

You can set parameters by going to the Plone control panel / Embedly settings:

* cache usage and timeout
* service URL verification
* API key


You can update the regular expression for supported services by calling

{{{
  http://yourhost/plonesite/@@update_embedly_services
}}}


The default is to not pass along an API key, your requests to embedly will be anonymous and based solely on IP address.

== Notes ==

 * collective.embedly does not fix errors in provided URLs
 * you can check if your URL will be transformed calling embed.ly manualy, for example:
   * video URL http://www.youtube.com/watch?v=L1NPLlhFTVk
   * you should call http://api.embed.ly/v1/api/oembed setting 'url' parameter with your value
   * http://api.embed.ly/v1/api/oembed?url=http://www.youtube.com/watch?v=L1NPLlhFTVk
   * http://api.embed.ly/v1/api/oembed?url=http://www.youtube.com/watch?v=L1NPLlhFTVk&fromat=xml format result as xml



== Examples of usage ==

Please see the following pages to learn how to:

 * [wiki:collective.embedly/youtube How to embed videos from YouTube to Plone]
 * [wiki:collective.embedly/blip-tv How to embed videos from blip.tv to Plone]
 * [wiki:collective.embedly/vimeo How to embed videos from vimeo to Plone]
 * [wiki:collective.embedly/ted How to embed videos from TED.com to Plone]
 * [wiki:collective.embedly/flickr How to embed images from Flickr to Plone]
 * [wiki:collective.embedly/google-maps How to embed map from GoogleMaps to Plone]
 * [wiki:collective.embedly/soundcloud How to embed audio from SoundCloud to Plone]
 * [wiki:collective.embedly/facebook How to embed content from Facebook to Plone]
 * [wiki:collective.embedly/scribd How to embed pdf files from Scribd to Plone]