XML file structure

The basic template of the XML file:

<?xml version="1.0" encoding="UTF-8"?>
<rotator>

<settings>

<bannerWidth value="450"/>
<bannerHeight value="300"/>
<bannerCornerRadius value="0"/>
<randomImages value="false"/>
<delayTime value="3"/>
<autoPlay value="true"/>
<pauseOnMouseOver value="false"/>
<repeatMode value="true"/>
<currentImageIndex value="0"/>
<transparentImages value="false"/>


<transitionType value="blinds,windows,fade"/>
<randomTransitions value="true"/>
<blindsEffectStripsNum value="10"/>
<blindsEffectStripsColor value="006600"/>
<blindsEffectStripsAlpha value="40"/>
<windowsEffectSquaresSize value="90"/>
<windowsEffectSquaresColor value="FF6600"/>
<windowsEffectSquaresAlpha value="20"/>
<windowsEffectGridColor value="006600"/>
<windowsEffectGridAlpha value="60"/>
<windowsEffectBlurFilter value="true"/>
<fadeEffectDuration value="0.7"/>


<controlsHPosition value="right"/>
<controlsVPosition value="center"/>
<controlsOrientation value="vertical"/>
<controlsMargin value="10"/>
<showControls value="true"/>
<showNumberButtons value="true"/>
<showControlsScreen value="false"/>
<controlsOrder value="playpause,timer"/>
<controlsAutoHide value="false"/>
<controlsScreenColor value="000000"/>
<controlsScreenAlpha value="30"/>
<controlsScreenPadding value="5"/>
<controlsScreenStretchFull value="false"/>


<buttonSpacing value="2"/>
<buttonBgColor value="000000"/>
<buttonBgAlpha value="50"/>
<buttonTextColor value="FFFFFF"/>
<buttonOverBgColor value="FFFFFF"/>
<buttonOverBgAlpha value="30"/>
<buttonOverTextColor value="000000"/>
<buttonSelectedBgColor value="FFFFFF"/>
<buttonSelectedBgAlpha value="70"/>
<buttonSelectedTextColor value="000000"/>
<buttonRollAnimationDuration value="0.1"/>


<descriptionWidth value="600"/>
<descriptionHPosition value="center"/>
<descriptionVPosition value="bottom"/>
<showDescription value="true"/>
<textFadingDuration value="0.5"/>
<textSize value=""/>
<textColor value=""/>
<embedFonts value="true"/>
<textAlignment value="left"/>
<textLineSpacing value="0"/>
<textLetterSpacing value="0"/>
<textMarginLeft value="10"/>
<textMarginRight value="200"/>
<textMarginTopBottom value="5"/>
<textBgColor value="000000"/>
<textBgAlpha value="30"/>


<preloaderColor value="FFFFFF"/>
<preloaderScale value="80"/>
<showPreloader value="true"/>
</settings>

<images>
<image src="images/image1.jpg" url="" target="" delayTime=""><![CDATA[Description text for this image...]]></image>
</images>

</rotator>

The description of the XML file elements

1. The following table describes the nodes that the <settings> element contains:

Node name	Possible values	Default value	Description
General properties
bannerWidth	0-1920	600	The width of the banner, in pixels.
bannerHeight	0-1200	450	The height of the banner, in pixels.
bannerCornerRadius	≥0	0	The corner radius for the banner area, in pixels.
randomImages	true, false	false	Determines whether to display images in sequential (false) or random (true) order.
delayTime	≥0	5	Amount of delay between images, in seconds.
autoPlay	true, false	false	Specifies whether the banner should start rotating images automatically (true) or not (false).
pauseOnMouseOver	true, false	false	Specifies whether the banner should pause rotating images when the mouse is over it's area (true) or not (false).
repeatMode	true, false	true	Defines the banner behavior when it reaches the last image.
currentImageIndex		0	The index of the image to be displayed first in the sequence when the XML file is loaded. This is a zero-based index, so 0 is the first image.
transparentImages	true, false	false	Determines whether to use specific (true) or ordinary (false) mechanism for transitions. The specific one is needed if transparent images (PNG, GIF or SWF) are used.
Transitions properties
transitionType	fade, blinds, windows	fade,blinds,windows	The type of transition to be applied when rotating images. Multiple values should be separated by commas, without blank space after commas.
randomTransitions	true, false	true	Determines whether to apply transition types (if multiple values are selected) in sequential (false) or random (true) order.
blindsEffectStripsNum	1-40	14	The number of strips to be used for the "Blinds" transition effect.
blindsEffectStripsColor		FFFFFF	The color of strips for the "Blinds" transition effect.
blindsEffectStripsAlpha	0-100	40	The alpha transparency of strips for the "Blinds" transition effect.
windowsEffectSquaresSize		100	The size of squares for the "Windows" transition effect, in pixels. The minimum value is limited by the maximum allowed number of squares in a row or a column (10).
windowsEffectSquaresColor		FFFFFF	The color of squares for the "Windows" transition effect.
windowsEffectSquaresAlpha	0-100	40	The alpha transparency of squares for the "Windows" transition effect.
windowsEffectGridColor		FFFFFF	The color of grid lines for the "Windows" transition effect.
windowsEffectGridAlpha	0-100	40	The alpha transparency of grid lines for the "Windows" transition effect.
windowsEffectBlurFilter	true, false	true	Determines whether to apply the Blur Filter for the "Windows" transition effect.
fadeEffectDuration	0-3	0.8	The length of time that the "Fade" transition effect takes, in seconds.
Controls properties
controlsHPosition	left, center, right	right	The horizontal position of the controls.
controlsVPosition	top, center, bottom	bottom	The vertical position of the controls.
controlsOrientation	horizontal, vertical	horizontal	The geometric orientation of the controls.
controlsMargin	≥0	10	The margins of the controls, relative to the nearest edges of the banner, in pixels.
showControls	true, false	true	Determines if the controls are visible.
showNumberButtons	true, false	true	Determines whether to show the number buttons in the controls (true) or not (false).
showControlsScreen	true, false	true	Determines whether to show the background (screen) of the controls (true) or not (false).
controlsOrder	playpause, previous, next, timer	—	Specifies which navigation buttons to show in the controls, and defines the order in which the buttons are displayed (separated by commas).
controlsAutoHide	true, false	false	Determines whether to show (hide) the controls automatically when the mouse is over (out of) the banner.
controlsScreenColor		FFFFFF	The color of the background (screen) of the controls.
controlsScreenAlpha	0-100	50	The alpha transparency of the background (screen) of the controls.
controlsScreenPadding	0-20	2	The spacing between the edges of the controls screen and the buttons block, in pixels.
controlsScreenStretchFull	true, false	false	Set this property to true if you want to stretch the controls screen to the width (`controlsOrientation`="horizontal") or the height (`controlsOrientation`="vertical") of the banner. The value of `controlsMargin` in this case will be equal to 0.
Buttons properties
buttonSpacing	≥0	2	The spacing between buttons in the controls, in pixels.
buttonBgColor		000000	The background color of a button.
buttonBgAlpha	0-100	50	The background transparency of a button.
buttonTextColor		FFFFFF	The text color of a button's label.
buttonOverBgColor		FFFFFF	The background color of a rolled-over button.
buttonOverBgAlpha	0-100	80	The background transparency of a rolled-over button.
buttonOverTextColor		000000	The color of text when the pointer rolls over a button.
buttonSelectedBgColor		FFFFFF	The background color of a selected button.
buttonSelectedBgAlpha	0-100	80	The background transparency of a selected button.
buttonSelectedTextColor		000000	The text color of the selected button's label.
buttonRollAnimationDuration	0-0.3	0.1	The length of time that the animation takes when the pointer rolls over a button, in seconds.
Description properties
descriptionWidth	≥0	bannerWidth	The width of the description area, in pixels.
descriptionHPosition	left, center, right	center	The horizontal position of the description area.
descriptionVPosition	top, bottom	bottom	The vertical position of the description area.
showDescription	true, false	true	Determines if the description area is visible.
textFadingDuration	0-0.3	0.3	The length of time that the text fading effect takes, in seconds.
textSize	8-96	11	The point size for the font of the description text.
textColor		FFFFFF	The color of the description text.
embedFonts	true, false	true	A Boolean value that indicates whether the font of the description text is an embedded font.
textAlignment	left, center, right, justify	left	The text alignment for the description.
textLineSpacing	-36...72	0	The line spacing for the description text, in points.
textLetterSpacing	-60...60	0	The letter spacing for the description text, in points.
textMarginLeft	≥0	10	The left margin of the description text, relative to the left edge of the description area, in pixels.
textMarginRight	≥0	10	The right margin of the description text, relative to the right edge of the description area, in pixels.
textMarginTopBottom	≥0	10	The top and bottom margins of the description text, relative, respectively, to the top and bottom edge of the description area, in pixels.
textBgColor		000000	The background color of the description area.
textBgAlpha	0-100	30	The background transparency of the description area.
Preloader properties
preloaderColor		FFFFFF	The color of the preloader.
preloaderScale	≥0	100	The scale of the preloader, in percent.
showPreloader	true, false	true	Determines whether to show the preloader (true) or not (false).

2. The <images> element can contain an unlimited number of <image> nodes. Each <image> node represents an image object and should have one required attribute src. You can also add 3 optional attributes in the <image> node: url, target, delayTime.

Node name	Attribute name	Default	Description
image	src	undefined	Specifies the URL of an image.
	url	undefined	(Optional) Specifies the URL of the page to be loaded when clicking on the image.
	target	_self	(Optional) Specifies the window or HTML frame that the page is loaded into ("_self", "_blank", "_parent", "_top" or your custom value).
	delayTime	undefined	(Optional) Specifies amount of delay which is to occur between this particular image and the next one, in seconds.

You can write a description text (optional) inside an <image> node. If you want to use standard HTML for the description text, you can put it inside a CDATA tag (see the basic XML template above).