so.addVariable("iniFile", "config_Beautiful_Beach.bin");

and TOURNAMEMIN is the tour's name in lower case letters, so in the same example:

    so.addVariable("swfFile", "resources/beautiful_beach_IbizaVirtualTours_logo_animado.swf");

If the file twviewer.swf isn't stored in the same folder as the web page, at this step all references to twviewer.swf must be preceded with the corresponding relative path.

Important note: The Javascript code that has just been described is compatible only with the swfobject.js script which we deliver with the virtual tour (swfobject v. 1.5). More recent swfobject versions exist out there which can be downloaded from the Internet and using those with our virtual tours is perfectly feasible, but the Javascript code in the virtual tour's web page must then be rewritten for compatibility. For example, the following code is compatible with swfobject v. 2.x:

    <div id="flashcontent">
        To view the virtual tour properly, Flash Player 9.0.28 or later version is needed.
        Please download the latest version of
        <a href="http://www.adobe.com/go/getflashplayer" target="_blank">Flash Player
        </a> and install it on your computer.
    </div>
    <script type="text/javascript">
        var flashvars = {
            base: "",
            iniFile: "config_TOURNAME.bin",
            swfFile: "resources/TOURNAMEMIN_IbizaVirtualTours_logo_animado.swf",
            progressType: "1",
            lwBgColor: "255,255,255,255",
            lwImg: "",
            lwBarBgColor: "255,0,0,0",
            lwBarColor: "255,0,255,0",
            lwBarBounds: "0,0,960,640",
            lwlocation: "0",
            lwShowLoadingPercent: "true",
            lwTextColor: "255,255,255,255",
            href: location.href
        };
        var params = {
            allowNetworking: "all",
            allowScriptAccess: "always",
            allowFullScreen: "true",
            scale: "noscale",
            bgcolor: "#FFFFFF"
        };
        var attributes = {
            id: "VirtualTour",
            name: "VirtualTour"
        };
        swfobject.embedSWF("twviewer.swf", "flashcontent", "960", "640", "9.0.28", null, flashvars, params, attributes);
    </script>

Our tours are usually designed to fit in a box of 960x640 pixels in the web page (hence the values 960 and 640 that appear in the code above). Along with the tour we deliver some sample .HTML files which can be used either to view the tour directly from the client's filesystem or, by looking into the (very easy) source code, to understand how to insert it into any web page.

Customization

Everything that occurs during the virtual tour's playback is regulated by the encrypted file config_TOURNAME.bin, which only the Adobe Flash app twviewer.swf can interpret. It is impossible to edit the config_TOURNAME.bin file directly, the only working way to modify it is to generate it again from the modified source project, and for that it is required that you get in touch with us again, as all rights over the virtual tour sources are reserved by our company. All high-res photographs which are kept in the scene folder are encrypted also, so they can't be modified or even replaced with other ones.

Nevertheless it is still possible to customize a couple of things without much effort:

1) SWFObject parameters:

With the swfobject.js library version 1.5, in the line
        var so = new SWFObject("VIEWER_URL", "sotester", "960", "640", "9.0.28", "#FFFFFF");
or with version 2.x of that library, in the line
        swfobject.embedSWF("VIEWER_URL", "flashcontent", "960", "640", "9.0.28", null, flashvars, params, attributes);
the following parameter may be customized:

• "VIEWER_URL": relative URL of the tour viewer's file (twviewer.swf) with respect to the current web page. Usually its value will be "twviewer.swf", unless you have moved the file to some other folder, in which case the value shall be adapted accordingly and also the base variable (see below) shall be set to the relative path of the virtual tour's folder with respect to the new location of the file twviewer.swf.

2) Variables accepted by the virtual tour viewer twviewer.swf:

These variables are passed to twviewer.swf by means of the so.addVariable("VARIABLE", "VALUE") statements with swfobject 1.5 or as properties of the flashwars object with swfobject 2.x, as can be seen in the examples in part 3 of the "Instructions for the web designer" section.

• base: relative URL of the virtual tour's folder with respect to the URL of twviewer.swf. Combining this variable appropriately with the VIEWER_URL parameter mentioned above, you can have the twviewer.swf file in a folder other than the virtual tour's, and so you could keep a single copy of that file which would be shared among all the virtual tours that you might have in your web site.

All the variables described next apply to the splash screen which is displayed until the files necessary to start viewing the virtual tour get downloaded.

• lwImg: URL of an image file (of type .jpg, .gif, ...) or flash movie (.swf) to be used as background for the splash screen.

• lwBgColor: Splash screen background color(*).

• lwBarBounds: Position and size of the loading progress indicator, expressed as "POS_X,POS_Y,WIDTH,HEIGHT", in pixels. The indicator may be a standard bar (built in the software) or an Adobe Flash movie.

• progressType: Type of the loading progress indicator. Allowed values are:
        "0": The indicator is a standard progress bar.
        "1": The indicator is an Adobe Flash movie, further specified by swfFile.

• swfFile: URL of the loading progress indicator movie. May be left blank when progressType is set to "1" if no indicator at all is desired.

The next four variables only apply when progressType is set to "0":

• lwBarBgColor: Standard progress bar background color(*).

• lwBarColor: Standard progress bar front color(*).

• lwShowLoadingPercent: Determines if, with the standard progress bar, a text showing the currently accomplished load percentage should be displayed or not. The text displayed would be something like "Loading 100%" (or the corresponding percentage). The word Loading is hard-coded in the software and can't be changed. The possible values are:
        "false": No text will be displayed.
        "true": The text will get displayed.

• lwTextColor: With the standard progress bar, the loading percentage text's font color(*)

(*) Colors in these variables are expressed in decimal, comma-separated format, transparency+RGB, with values ranging from 0 to 255. For example, "255,0,0,0" is opaque black, "127,255,255,255" is half-transparent white.

(Information updated on 29/08/2010)