Changeset 1185


Ignore:
Timestamp:
07/28/10 09:11:48 (3 years ago)
Author:
jeroen
Message:

added examples and tutorials to sharing plugin

Location:
plugins/sharing/v5/doc
Files:
14 added
1 deleted
3 edited
1 copied
1 moved

Legend:

Unmodified
Added
Removed

  • plugins/sharing/v5/doc/guides/conf.py

    r1178 r1185  
    7777# (source start file, target name, title, author, documentclass [howto/manual]). 
    7878latex_documents = [ 
    79   ('index','Sharing.tex','JW Player Sharing Plugin','www.longtailvideo.com','howto',False) 
     79  ('index','Sharing.tex','JW Player Sharing Plugin','www.longtailvideo.com','manual',False) 
    8080] 
    8181 

  • plugins/sharing/v5/doc/guides/index.rst

    r1178 r1185  
    1 Guide 
    2 ===== 
     1Sharing Guides 
     2============= 
    33 
    44.. toctree:: 
    55   :maxdepth: 2 
    6     
    7    sharing 
    86 
     7   reference 
     8   facebook 
     9   embedcodes 
    910 
    10  
    11 .. :: 
    12  
    13    Additional docs to write: 
    14     
    15    * Setting up Facebook tutorial 
    16    * Using short player codes tutorial 
    17    * Skinning the plugin tutorial 
    18     
    19    * Basic example 
    20    * Custom skin example 
    21    * Playlist example 

  • plugins/sharing/v5/doc/guides/reference.rst

    r1178 r1185  
    1 Introduction 
    2 ============ 
     1Sharing Plugin Reference 
     2======================== 
    33 
    44The Sharing plugin for the JW Player for Flash contains two options for viral sharing of a video: 
    … …  
    66* The plugin can display a screen to share an *embed code* of the video, similar to Youtube or Vimeo. 
    77* The plugin can display a screen to share a *share link* of the video, e.g. the URL of a page this video is included in.  
    8  
    98 
    109The link sharing screen also provides a couple of shortcuts for easy sharing using popular services: 
    … …  
    1716.. note:: 
    1817 
    19    With Facebook, only the basic link is shared by default. However, it is possible to share the full video player to Facebook with some tinkering to your page HTML. 
     18   With Facebook, only the basic link is shared by default. However, it is possible to share the full video player to Facebook by `setting some meta tags <http://wiki.developers.facebook.com/index.php/Facebook_Share/Specifying_Meta_Tags>`_ in the <head> of your page. 
    2019 
    2120 
    … …  
    2322 
    2423Configuration Options 
    25 ===================== 
     24--------------------- 
    2625 
    2726The plugin is loaded with the **plugins=sharing-2** option in the JW Player. This ensures you load version 2 of the plugin, which includes the skinning and playlist support. In addition to the plugin assignor, two dedicated flashvars are supported: 
    … …  
    3130   URL to display in the **share** screen of the plugin. If no *link* is set, the **share** screen is not shown. Example: 
    3231    
    33    code-block:: html 
     32   .. code-block:: html 
    3433    
    35    http://www.mywebsite.com/videos/12345/ 
     34      http://www.mywebsite.com/videos/12345/ 
    3635 
    3736.. describe:: sharing.code ( undefined ) 
    … …  
    4948 
    5049Example 
    51 ------- 
     50^^^^^^^ 
    5251 
    5352Here is a basic embed code example of a player using the sharing plugin. This example uses the SWFObject 2.0 embedding script: 
    … …  
    7271 
    7372Using Playlists 
    74 =============== 
     73--------------- 
    7574 
    7675In addition to setting them in the embed code, the two sharing options can also be set per playlist entry. The global configuration options should still be set: 
    … …  
    9796 
    9897Example 
    99 ------- 
     98^^^^^^^ 
    10099 
    101100Here is a basic example; an RSS playlist with one entry that has both a *sharing.link* and *sharing.code* defined. 
    … …  
    132131 
    133132Skinning 
    134 ======== 
     133-------- 
    135134 
    136135This plugin can be skinned using the `PNG Skinning Model <http://www.longtailvideo.com/support/jw-player/jw-player-for-flash-v5/14/skinning-the-jw-player-5>`_ of the JW Player. Three aspects of the plugin can be skinned: 
    … …  
    140139* The background of the **share** and **embed** screens. 
    141140 
    142 The skinning functionality is basic and purely visual. It is not possible to rearrange the position of the various elements in the share and embed screens, or to add/remove elements. 
     141The skinning functionality is basic and purely visual. It is not possible to rearrange the position of the various elements in the share and embed screens, or to add/remove elements. Here's two examples of what is possible with the skinning of this plugin: 
    143142 
    144 The sharing screens must both be 300x140 pixels, since the plugin simply maps the coordinates of a mouse click to the action that should be executed. 
     143.. image:: ../assets/exampleskins.png 
     144        :alt: Skinning examples. 
     145 
     146The sharing screens must both be 300x140 pixels, since the plugin simply maps the coordinates of a mouse click to the action that should be executed. Here is an overview of the mappings: 
     147 
     148.. image:: ../assets/skinning.png 
     149        :alt: Sharing plugin screens. 
     150 
    145151 
    146152XML Block 
    147 --------- 
     153^^^^^^^^^ 
    148154 
    149155Here is the full XML code block as supported by the sharing plugin: 
    … …  
    166172 
    167173Example Skins 
    168 ------------- 
     174^^^^^^^^^^^^^ 
    169175 
    170176Here's a few skins that include a custom look for the *sharing* plugin (all using the dock, not the controlbar). Feel free to download these and/or tweak their looks: 
    … …  
    178184 
    179185 
    180 Changes 
    181 ======= 
     186Changelog 
     187--------- 
    182188 
    183189Version 2.0 
    184 ----------- 
     190^^^^^^^^^^^ 
    185191 
    186 * Switched from the 4.x to the 5.x plugin API. As of this version, the plugin cannot be loaded in the JW Player v4. 
     192* Switched from the 4.x to the 5.x plugin API. As of now, the plugin cannot be loaded in the JW Player v4. 
    187193* Added support for a *sharing.code* and *sharing.link* property per PlaylistItem. 
    188194* Added support for PNG skinning. As of this version, the buttons and the screens can be skinned. 
Note: See TracChangeset for help on using the changeset viewer.