Developer's Setup Information

This information is only required by tutorial developers

Letting other people run your recorded instructions

Save your first recorded instructions as getting started.xml. This will replace the existing file and become the default tutorial that generally starts first (the last played file is started first under certain conditions).

If you want to run a tutorial on top of a website then create a desktop shortcut to, or just start the, viewer.exe file.

If you want to run a tutorial on top of a program then start the program and create a desktop shortcut to, or just start the, tutor.exe file.

Please note! In its default setting the viewer.exe program is configured to always download the latest tutorial from the internet. This may overwrite any changes you have made to the getting stared.xml file so either select the DO NOT download new files menu option or with the full distribution license we will tell you how automaticlly turn this off or to configure ST so that it downloads your own tutorials.

Ways in which the tutor will work with other applications

There are a range of ways this program will work with other applications:-

1. As a stand along application that does not interact with the program it is teaching on.

2. Synchronising initial program parameters at startup.

3. Constantly exchanging information with the program it's teaching on.

4. Opening a website or sequence of pictures and guiding people around them.

5. Reading pre-installed XML files or automatically downloading the latest training information and content.

Anyone interested in know more about the developer editions please contact us.

Where to store your training modules

XML training modules

The software tutor's lesson information is stored by default in a directory called tutor that sits below the program itself. This can be changed from within the program or in the INI file shown below.

Because the training information itself may be language sensitive we use a sub directory tutor/text0 where 0 is the language key and could be changed to 1 say for German etc.

We also use tutor/text0/point0 or info0 where 0 is the program frame or section number. Both default to 0 if nothing is set.

You should always include a file called getting started.xml as this is always called for first. This can be changed in the INI file and the last looked at will be called up first.

If you replace the title with the name of an http:// address for an XML file the Software Tutor will download and play this instead. If you replace the title with a website address the Software Tutor will open that page automatically.

The random tip information is stored as an rtf text file in the text0 directory. The software tutor simply displays a sequence of paragraph numbers. Changing or adding to the paragraphs will update the program. If this is removed then no tip option will be displayed in the tutor options section.

The information text files are stored as an rtf text file in the text0\info0 directories. Simply changing or adding to the paragraphs will update the program. If this is removed then no information text option will be displayed in the tutor options section.

Changing the background pictures or visual layout

The software tutor's set-up information is stored in the default tutor directory as a setup.xml file. This can be changed from within the developer edition's editing program. You can change the appearance etc by changing the pictures and setup information. Storing different pictures and setup information in different directories will automatically change the programs appearance.

Playing sound files

The Software Tutor will play .mp3 or .wma sound files if you add the file name and path to the sound element of XML module.

When each new XML training module is loaded ST searches the sound elements for http address to sound files. It then automatically downloads these to a directory with the same name as the XML training module unless they have previously been downloaded to create a file of the same name.

How the software tutor interacts with other programs

Default communication is via an INI file called webdata.ini that is located in the root directory of the tutor program but there are also a number of other options available. An INI file is a simple text file that can be opened using Notepad and requires a simple file/group/item string or item value structure.

Please note that the free trial version does not use this format to communicate with

The standard elements within our INI file are shown below. These will be rechecked every second:-

[sound]

sound_on_off=0 1 is off e.g. it is on at start up but only plays if files are present

[Tipsetup]

tipstatus=0 0 for pointer, 1 tips ,2 info, 4 is don't show at start

tipdirectory=C:\Program Files \yourprog\tutor The directory the training modules are, not the tutor program itself

tiplesson=getting started.xml The starting module name. This will be the last one used

update= 0 Automatically downloads and 1 does not download.

[livetutor]

isactive=0 Tutor closes when this equals 0. This is set to 1 by the tutor when it opens therefore set this to 0 by main program before it is shut down and it will close the tutor.

frame=0 Program frame number used to define the info or point directory values. Leave as 0 if not used

Language=0 Defines text0 or text1 directory etc and used for loading different language files. Leave as 0 if not used

posnx=0 X position of subject program on screen

posny=0 Y position of subject program on screen

movenow=0 Make this 1 to step forward 1 and -1 to step back one at any step. This is a simple but not always accurate way to move the tutor with your program.

stepnumber=1 Key frame step. The tutor only moves to this when it is changed. Use every step as a keyframe if it is critical that the tutor and program don't get out of sequence. Value 999 will close the tutor

minimise=0 0 is open 1 is minimize. Set these values in the main program and the tutor will follow