Plugin Directory

Changes between Version 49 and Version 50 of dge-slideshow

07/24/07 10:41:52 (11 years ago)

Page moved notice


  • dge-slideshow

    v49 v50  
    77This plugin takes a collection of images (e.g. Flickr or Zooomr image feed) and turns it into a javascript-based slideshow within a Wordpress post or page. 
    9 This page will soon shrink a great deal. I've put all the information into the readme in the download zip. It will move [http://wordpress.org/extend/plugins/dge-inlinerss/ here], which is updated directly from the readme. 
     9== Moved == 
    11 == Detail == 
    13 The plugin takes the source (e.g. RSS feed), passes it through XSLT via a modified version of the inlineRSS plugin, and then uses javascript and css in the client to do the actual slideshow. 
    15 == Status == 
    17 Under development, but working nicely on Firefox 1.5, 2.0, IE 6 (Win) and IE 7. Please feel free to submit bugs and suggest features by posting questions etc on the [http://dave.stufftoread.net/slideshow/ home page]. 
    19 == Requirements == 
    21  * Javascript. 
    22  * [http://dev.wp-plugins.org/wiki/dge-inlinerss DGE_InlineRSS] plugin version 0.93 or greater. 
    23  * Only tested with Wordpress 2.0 and 2.1. I don't know if it'll work with earlier versions. 
    24  * PHP 5. 
    26 == Examples == 
    28 The latest trunk is up and (probably) running [http://dave.stufftoread.net/testwp/ here], currently on 0.4. 
    30 A potentially more stable version with various applications of the slideshow is [http://dave.stufftoread.net/slideshow/ here], currently on 0.4. 
    32 == Installation == 
    34  1. Follow the instructions to install and activate the latest [http://dev.wp-plugins.org/wiki/dge-inlinerss DGE_InlineRSS] plugin from the trunk. 
    35  2. Download the plugin: [http://downloads.wordpress.org/plugin/dge-slideshow.0.4.zip latest stable] or [http://downloads.wordpress.org/plugin/dge-slideshow.zip latest nightly]. 
    36  3. Activate the plugin from your wordpress admin menu. 
    37  4. Make sure inlinerss' cache directory is set up properly. This plugin uses the same settings. 
    38  5. Add 'wp-content/plugins' (without the quotes) to the inlinerss 'XSLT path' setting. Nothing will work otherwise. 
    40 == Usage == 
    42 You can invoke a slideshow by either placing a specially formatted string into any page or post, or from your theme templates with a call to DGE_!SlideShow. For both methods, the arguments are the same, but the call is different. 
    44 Both methods of invokation require a unique id, and a url to fetch. You can also pass in a number of options. 
    46 The id must be unique for each slideshow, and must be a valid javascript variable name, with the exception that it may start with a number. So it must not contain spaces or dashes, for example. 
    48 === Filter method === 
    50 When you activate the plugin, it installs a content filter into wordpress. This filter looks for strings beginning with '!slideshow!', followed by the 2 required parameters, and a list of options. Each of these parts of the filtered string must be separated by an exclamation mark. Options must be separated by a semi-colon. If you want to include more than one slideshow in succession, make sure they are defined on a new line for each call. 
    52 Here's the syntax: 
    53 {{{ 
    54   !slideshow!<id>!<url>[!<option1=val>;<option2=val>...]! 
    55 }}} 
    57 Here's a few examples: 
    58 {{{ 
    59   !slideshow!ss1!http://beta.zooomr.com/bluenote/feeds:rss/recent/! 
    60   !slideshow!ss2!http://beta.zooomr.com/bluenote/feeds:rss/recent/!limit=5! 
    61   !slideshow!ss3!http://beta.zooomr.com/bluenote/feeds:rss/recent/!limit=5;reverse! 
    62 }}} 
    64 === From php (your theme templates) === 
    66 The DGE_!SlideShow function takes three parameters. The first is the unique id for your slideshow, followed by the url of the desired feed, followed by an array of optional arguments. The function returns a string with the necessary javascript and html to set up the slideshow, so just e{{{}}}cho it. 
    68 For example: 
    69 {{{ 
    70   // From version 0.3 and above 
    71   e\cho DGE_SlideShow('ss1', 'http://beta.zooomr.com/bluenote/feeds:rss/recent/', array('limit'=>5,'reverse'=>1)); 
    72 }}} 
    74 === Options === 
    76  limit:: 
    77    Limits the number of images extracted from the feed. Default is 0, implying no limit, or everything in the feed. 
    78  preset:: 
    79    Applies the options defined in the named preset, before overriding them with any other options passed. 
    80  reverse:: 
    81    This method doesn't need any value. Just by being present, it tells the plugin to reverse the order of the images in the feed. 
    82  timeout:: 
    83    Specify the time in minutes before the cached html is refreshed. Set the default in the options pane. It is 1 hour by default. 
    84  xslt:: 
    85    Specify a new xsl translation file. 
    86  html:: 
    87    Assume input url is HTML, rather than XML. (As of v0.392) 
    89 === Presets === 
    91 On the slideshow options page, you can set up presets to save you typing the same options in for different slideshow calls. Just give the preset a name in the left-hand field, and fill in the right-hand field with the desired options in the same format as the filter call. That is, separate each option with a semi-colon. 
    93 For example, the name of your preset might be 'preset1', and you want to always reverse the feed, and have a timeout of only 1 minute. Fill in the left-hand field with 'preset1', and the right hand field with 'reverse;timeout=1', omitting the quotes, of course. 
    95 Another example would be to add a shortcut for Zooomr favourites. Put 'zooomrfaves' as the name, and 'xslt=dge-inlinerss/zooomrfaves.xsl' in the value field, again omitting the quotes. You could then invoke a slideshow of a Zooomr set with: 
    96 {{{ 
    97   !slideshow!zfaves!http://beta.zooomr.com/photos/DaveE/faves!preset=zooomrfaves! 
    98 }}} 
    100 == Features == 
    102 [http://dev.wp-plugins.org/log/dge-slideshow/ Full changelog] 
    104 === changes in 0.4 === 
    106  * Bug fixes, mostly for IE. 
    107  * Added a menu bar for navigation etc. 
    108  * Choose number of thumbnails via parameters. 
    109  * Zooomr mark III compatibility fixes. 
    110  * Full-screen mode. 
    111  * Updated options page for specifying defaults. 
    112  * Simplified XSL, and reorganised XSL files. 
    113  * Structural changes under the hood to separate behaviour from content. 
    114  * Easier to write new data sources, with introduction of data handlers. 
    116 === changes in 0.3 === 
    118  * General clean-up and some bug fixes. 
    119  * New 'xslt' parameter to use custom XSL transformations. 
    120  * Cleaned up, modularised XSL files. 
    121  * New XSL files for Zooomr SmartSets, Zooomr favourites, and Flickr photosets. 
    123 === changes in 0.2 === 
    125  * Optionally reverse the order of images in the feed. 
    126  * Security enhancements. 
    127  * Indicates which images are still loading in the background (modifiable with CSS) 
    128  * Admin panel for setting defaults and defining presets. 
    129  * Presets allow quick changing of settings across several slideshows. 
    130  * New options to influence image size, and skip default css rules. 
    132 === 0.1 === 
    134  * Flickr or Zoomr feeds 
    135  * Displays thumbnails of images in the feed. 
    136  * Background loading of images for visible thumbnails. 
    137  * Caches xsl translation of feed, with configurable refresh period. 
    138  * Customisable look&feel via CSS. 
    140 == Plans == 
    142 === For v0.5 and above === 
    144 In no particular order: 
    145  * set up inlinerss settings like XSLT path automatically 
    146  * warn if cache directory isn't set up properly. 
    147  * auto filters to select a preset when source matches particular regex. 
    148  * abstraction of the back end so we don't rely on DGE_InlineRSS calls. 
    149  * show image title somewhere 
    150  * auto generation of slideshow id 
    151  * Next/previous 5 or some sort of paging 
    152  * Optionally use flickr or zooomr api for speed 
    153  * Event handler to allow changing slides with left and right arrow keys. 
    154  * Optionally display position in sequence and/or total images. 
    155  * Fading transitions 
    156  * Pull multiple feeds into one slideshow 
     11This page has moved [http://wordpress.org/extend/plugins/dge-slideshow/ here]. I've put all the information into the readme in the download zip. The previous link is updated directly from the readme.