Userguide
Starting the Work
To start working simply paste object HTML into your page and setup xml configuration file. You can place configuration file anywhere on your server.
Paste this code into your HTML-page and replace object stage parameter with your values.
(following HTML-code supports MS Internet Explorer and Netscape Navigator)
<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" codebase="http://download.
macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,29,0" width="width" height="height">
<param name="movie" value="swf file path">
<param name="quality" value="high">
<param name="scale" value="noscale">
<param name="bgcolor" value="background color">
<param name="flashVars"
value="configXML=path to configuration file">
<embed src="swf file path" width="width" height="height" flashvars="configXML=path to configuration
file" quality="high" pluginspage="http://www.macromedia.com/go/getflashplayer" type="application/x-shock
wave-flash" scale="noscale" bgcolor="background color"></embed>
</object>
An XML file is used to configure the gallery. By editing the XML file, you can add or remove gallery images as well as edit multiple appearance and behavior settings. The format of the XML file is described below.
Gallery settings are described in the <setup> </setup> tag of the XML file as follows:
<parameter name> parameter value </parameter name>.
For example, the background color is configured using the tag
<backgroundColor>parameter value</backgroundColor>.
You can add an image to the gallery by adding the tag <item></item> to the XML file. In this tag you specify the path to the image by means of the <img>path</img> tag, the path to the thumbnail by means of the <thumb>path</thumb> tag, and image caption by means of the <caption>image caption</caption> tag.
<galery>
<setup>
<!-- Gallery parameters are described in this section -->
<imgPath>images\</imgPath>
<backgroundColor>0x0037FA</backgroundColor>
<thumbAlpha>0.7</thumbAlpha>
<thumbHeight>30</thumbHeight>
</setup>
<item>
<!-- Path to the image, path to the thumbnail, and image caption are described in this section -->
<thumb>img2.jpg</thumb>
<img>img1.jpg</img>
<caption>caption img</caption>
</item>
<item>
<thumb>…</thumb>
<img>…</img>
<caption>…</caption>
</item>
<item>
<thumb>…</thumb>
<img>…</img>
<caption>…</caption>
</item>
</galery>
| Parameter name | Parameter description | Example |
|---|---|---|
| configXML | Full path to the XML settings file and filename. For example, YourFolder/gallery.xml | |
| galleryWidth | Gallery width | |
| galleryHeight | Gallery height | |
| backgroundImgPath | Path to the background of image file | |
| backgroundImgAlpha | Background of image transparency | |
| loadIndicatorColor | Color of the image load indicator | |
| thumbScrollSpeed | Thumbnail scroll speed | |
| loadIndicatorOn | Show/hide image load indicator | |
| slideshowDelay | Image display duration in Slideshow mode (in seconds) |
|
| bgAlpha | Background transparency | |
| bgColor | Background color | |
| bgCorner | Background corners roundness degree | |
| imgScaleMode | Type of image scaling to the size of the visible area | |
| imgAlpha | Image transparency | |
| imgCaptionColor | Color of image captions | |
| imgCaptionFont | Font of image captions | |
| imgCaptionSize | Font size of image captions | |
| imgCaptionAlpha | Caption transparency | |
| imgCaptionPosition | Position of image captions. Possible values: top, bottom. | |
| imgCaptionBgColor | Background color of captions | |
| imgCaptionBgAlpha | Background transparency of captions | |
| imgCaptionShow | Defines when to show an image caption. Possible values: onRollOver, onLoad, never. | |
| imgMaskCorner | Image corners roundness degree | |
| imgShadowOn | Show/hide shadow of image | |
| imgCaptionShadowOn | Show/hide shadow of caption | |
| transitionEffect | Type of image transition effect. Possible values: fade, zoom, squeeze, pixelDissolve, blinds, wipe, iris, photo, fly, rotate. | |
| thumbDistance | Distance between thumbnails | |
| thumbAlpha | Thumbnail transparency | |
| thumbHeight | Thumbnail height | |
| thumbMaskCorner | Degree of thumbnail roundness | |
| thumbOutlineAlpha | Thumbnail transparency degree | |
| thumbOutlineColor | Thumbnail outline color | |
| thumbOutlineColorActive | Active thumbnail outline color | |
| thumbOutlineRoll | Outline color of the thumbnail with the mouse pointer rolled over it | |
| thumbOutlineThick | Thumbnail outline thickness | |
| thumbPosition | Thumbnail position. Possible values: left, right, top, bottom. | |
| thumbRowsCount | Number of rows with thumbnails | |
| thumbToImgSpace | Space between the image and thumbnails | |
| thumbWidth | Thumbnail width | |
| thumbShadowOn | Show/hide shadow of thumbnail | |
| thumbReflectionsOn | Show/hide thumbnail reflections | |
| thumbReflectionsAlpha | Degree of transparency of thumbnail reflections | |
| thumbReflectionsHeight | Height of thumbnail reflections | |
| thumbPreviewOn | Show/hide image preview element | |
| thumbPreviewAlpha | Transparency of the image preview element | |
| thumbPreviewHeight | Height of the image preview element | |
| thumbPreviewMaskCorner | Roundness of the preview mask corners | |
| thumbPreviewWidth | Preview mask width | |
| thumbSoundOnClick | Thumbnail click sound. Specify path to sound file. For example, sounds/click.mp3 | |
| thumbSoundOnRollover | Sound heard when the mouse pointer is rolled over a thumbnail. Specify path to sound file. For example, sounds/over.mp3 | |
| showButtonsOn | Show/hide buttons | |
| buttonsAlignVert | Vertical buttons alignment. Possible values: top, bottom. | |
| buttonsAlignHor | Horizontal buttons alignment. Possible values: left, right. |
Some of the parameters are listed separately because their values do not need to be modified in the majority of cases.
Advanced gallery configuration parameters
| Parameter name | Parameter description | Example |
|---|---|---|
| slideshowLoop | Loop/unloop image display in automatic mode if all images are shown | |
| randomImages | Determines whether images are displayed randomly or sequentially. If the parameter value is "true", images will be displayed randomly. Otherwise, they will be displayed in the sequence of image descriptions in the XML file. | |
| imgScaleAlignHor | Horizontal image alignment. Possible values: center, left, right. | |
| imgScaleAlignVert | Vertical image alignment. Possible values: center, top, bottom. | |
| transitionStartPoint | Starting point of the image transition effect. Used for fly/wipe/iris transition effects (parameter: transitionType). | |
| transitionDirection | Direction of the image transition effect. Horizontal or vertical direction is possible. Used for squeeze/blinds/rotate transition effects | |
| transitionRotateDegrees | Used for "rotate" transition effect. | |
| transitionIrisShape | Used for "iris" transition effect. Possible values: circle, square. | |
| transitionPixelDissolveSize | Used for "pixelDissolve" transition effect. | |
| transitionEasingType | Easing Function for the transition effect. Possible values: back, bounce, elastic, regular, strong. | |
| transitionEasingFunction | Easing Function for the transition effect. Values: in, inOut, out. | |
| transitionTime | Transition effect duration (in seconds) | |
| thumbPreviewDelay | Image preview delay when the mouse pointer is rolled over the thumbnail | |
| thumbPreviewDistance | Distance between the image preview element and the thumbnail | |
| thumbPreviewShowAni… | Image preview animation time |