XML Flash Slideshow v4 Help    |    Support Home    |    DWUser.com Home  Download Help PDF (29MB)    |    Search:

Slideshow HTML Parameters

The slideshow configuration object is passed to the slideshow HTML through the XMLFlashSlideshow_v4(...) embed function call.    This object is a javascript object which has a number of name/value pairs.    Here is an example call:

XMLFlashSlideshow_v4({width:'600', height:'400', xml:'v4flashslideshow/slideshow_data0.xml', backgroundColor:'#C5C5C5', backgroundAlpha:'0.5', preloaderTextColor:'#000000'});

All parameters are separated by commas and are in the format parameterName:'value' .

The most important parameter is the xml parameter, which passes the path to the XML configuration file as well as any other external image data sources (with each separated by a comma).    You can learn more about the format used for linking external data sources to specific galleries in the Using External Image Data section of the manual; see Understanding How Dynamic Data Works and Supported Dynamic Data Formats for helpful information.

Also passed are a number of settings which control the appearance of the slideshow before the configuration data is loaded.    These include the width, height, background appearance, and preloader apperance.

Also available are a number of touch-specific parameters that control the appearance of the alternate touchscreen-optimized presentation.  To learn more about these advanced settings, see this topic.

Only a few parameters are usually necessary (such as those shown in the example above); only width, height, and xml are required.    All of available parameters are detailed in the com.dwuser.ss4.core.FlashSlideshowConfigurationParameters class in the API Reference.

In the wizard, most of these settings are specified in the Apperance Settings section, and to a lesser degree the Global Configuration and Playback Settings section.    If you need to set a parameter which doesn't have a dedicated wizard option, you can use the Custom HTML Parameters pod in the Global Configuration and Playback Settings section.

Additional Advanced Information

By default, the slideshow is embedded into the <div> which preceeds it in the slideshow HTML code block.    If you wish to embed a slideshow into some other <div> in your page, you can explicitly pass an id parameter in the initialization object.  This should match the id attribute on the slideshow <div>:

<div id="slideshowHolder"></div>
XMLFlashSlideshow_v4({id:'slideshowHolder', ... });

The slideshow embed script uses the industry-standard SWFObject embed method (the same method used by Dreamweaver to embed SWFs).    The included version is 2.2.    

All of the passed parameters which aren't specifically used for some other purpose (e.g. width and height) are passed to the slideshow SWF as initialization parameters (via flashvars).    The HTML parameter object can also be used to specify SWF embed parameters, such as wmode, quality, etc.    Usually, the only parameter which would need to be modified would be wmode.    To pass one of these embed parameters, you must prepend _param_ to the parameter name; for example, to override the wmode setting you would use _param_wmode as the parameter name.    For more information about the available param settings, see Step 1 in the SWFObject documentation.

Note: The slideshow by default always uses the transparent wmode setting.    This allows any HTML content behind the slideshow to show through.    The only downsides to the transparent wmode are that it can reduce rendering performance and can occasionally have bugs in certain configurations.    Additionally, a wmode of window must be used if you wish to utilize color correction.    To explicitly set the wmode to window or opaque, include a _param_wmode value in the configuration object.    This can be done directly in the wizard by using the Custom HTML Parameters pod in the Global Configuration and Playback Settings section.

By default, the path to the slideshow SWF path is never passed in the slideshow HTML.    Instead, the embed script detects the path to the supporting files folder based on the slideshow.js file's <script> reference and determines the appropriate SWF path.    If for some reason this fails (as evidenced by right-clicking on the slideshow area and seeing 'Movie Not Loaded...'), you can manually specify the correct path through the swf parameter in the Slideshow HTML configuration object.

Note: The showErrorBar parameter (default = true) can be set to false to disable the 'Asset Loading Error' notification bar.