SiteKiosk Documentation
One Step Back

Documentation Concerning XML Definition File (Browser Layout)



The XML definition file for browser layouts contains all the information you need to create a customized browser layout (skin).

Please note:
You will need some knowledge about how you can alter browser and touch screen layouts. Please understand, therefore, that we cannot provide any support in connection with the creation of your own skins (apart from this detailed documentation)!

 
 

General Structure of the XML Definition File

  • Path when using Default Skin: SK-Installation folder/skins/default/defaultskindef.xml

    The example is based on the .XML file for the Default Skin:

<skindef name="Default Skin" languages-selectable="true">

<touchscreen>TX82-Ultra Deutsch (docked)</touchscreen>
<stringtable>Language\Browserskins\stringtable.xml</stringtable>

<languageoption id="7" name="Deutsch"/>
<languageoption id="9" name="English" enabled-by-default="true"/>
	

<subskindef name="universal" language="0">
<url id='emailbutton'>skins\public\default\menu.html</url>

<dialog id='toomanywindows' width='373' height='225' 
titlebar='true' scrollbars='false' border='true' 
sysmenu='false'>skins\default\systemdialog\toomanywnds.htm</dialog>
 
<traywindow height='28'>skins\default\TrayWindow.html</traywindow>

<mainskin>
	<statusbar>true</statusbar>
	<progressbar>true</progressbar>
	<source>skins\default\MainWnd.htm</source>
</mainskin>

<windowskinless>
	<busyanim framedelay='25' imgwidth='65'>
	skins\default\img\Logos\anilogo.png</busyanim>
	<toolbar transcolor='16711935'>
	skins\default\img\ButtonBar.png</toolbar>
</windowskinless>
		
<windowskin minwidth='390' minheight='260'>
	<source>skins\default\NewWnd.htm</source>
	<border cx='6' cy='0'/>
	<addressbar cx='0' cy='37'/>
	<statusbar cx='0' cy='22'>true</statusbar>
	<menubar cx='0' cy='0'/>
	<toolbar cx='0' cy='75'/>
</windowskin>

	</subskindef>
</skindef>

 

Documentation Concerning Elements and Attributes

    skindef:
    Every layout is subdivided into a skindef section and several subskindef sections.

    <skindef name="Default Skin" languages-selectable="true">
    	<subskindef ...">
    	...
    	</subskindef>
    </skindef>

    "NAME" defines the name of the skin. The content of this attribute will be displayed in SiteKiosk's Configuration Wizard. The attribute "NAME" has to be unambiguous for every layout.

    languages-selectable determines whether the button "languages" is to be activated (true) or deactivated (false) in the Wizard.

    touchscreen:
    <touchscreen>TX82-Ultra German (docked)</touchscreen>
    

    touchscreen:
    Currently not implemented.

    stringtable:
    <stringtable>Language\Browserskins\stringtable.xml</stringtable>
    

    stringtable:
    Specifies the path to the Stringtable.xml file. The Stringtable.xml contains all language-related strings. More information are available here..>

    Example:
    		<!--  Toolbar Buttons  --> 
    		<string id="1">Forward</string> 
    		<string id="2">Back</string> 
    

    languageoption:
    <languageoption id="9" name="English" enabled-by-default="true"/>
    

    id:
    Defines all languages available in the layout that can be selected in the browser. The IDs are simply listed one below the other.

    Here is a list of all the language IDs:
     
    LANG_AFRIKAANS                   54
    LANG_ALBANIAN                    28
    LANG_ARABIC                      1
    LANG_ARMENIAN                    43
    LANG_ASSAMESE                    77
    LANG_BULGARIAN                   2
    LANG_CATALAN                     3
    LANG_CHINESE                     4
    LANG_CROATIAN                    26
    LANG_CZECH                       5
    LANG_DANISH                      6
    LANG_DUTCH                       19
    LANG_ENGLISH                     9
    LANG_ESTONIAN                    37
    LANG_FINNISH                     11
    LANG_FRENCH                      12
    LANG_FRENCH-BELGIUM              2060
    LANG_GERMAN                      7
    LANG_GREEK                       8
    LANG_HEBREW                      13
    LANG_HINDI                       57
    LANG_HUNGARIAN                   14
    LANG_ICELANDIC                   15
    LANG_INDONESIAN                  33
    LANG_ITALIAN                     16
    LANG_JAPANESE                    17
    LANG_KANNADA                     75
    LANG_KOREAN                      18
    LANG_LATVIAN                     38
    LANG_LITHUANIAN                  39
    LANG_MACEDONIAN                  47
    LANG_MALAY                       62
    LANG_MALAYALAM                   76
    LANG_MARATHI                     78
    LANG_NORWEGIAN                   20
    LANG_POLISH                      21
    LANG_PORTUGUESE                  22
    LANG_ROMANIAN                    24
    LANG_RUSSIAN                     25
    LANG_SERBIAN                     26
    LANG_SLOVAK                      27
    LANG_SLOVENIAN                   36
    LANG_SPANISH                     10
    LANG_SWEDISH                     29
    LANG_THAI                        30
    LANG_TURKISH                     31
    
    

    enabled-by-default:
    In case SiteKiosk does not support the language defined as the default language of the operating system (e.g. Swahili), the language you specify here will be used automatically.

    subskindef:
    <subskindef name="universal" language="0">
    ...
    </subskindef>
    

    name:
    Defines the name of the Subskindef. The name has to be unambiguous.

    language="id":
    You can apply different approaches if you want to represent different languages:

    Approach 1: You create a subskindef with language=0. Having done so, the browser will always display the same dialogs (dialog id) no matter what language you are using. Stringtable will then only display the texts in the selected language. Default Skin works like this.

    Approach 2: You create an individual subskindef for the language of your choice (language=(language-id)). This will make it possible for you to have completely different dialogs (dialog id) and browser skins displayed for the selected language. Approach 1 will serve as a fallback solution for all other languages. This approach makes sense especially in connection with languages that are based on an entirely different encoding system, e.g. Chinese or Hebrew.

    url:
    <url id='emailbutton'>skins\public\default\menu.html</url>
    ...
    
    

    id='emailbutton':
    Specifies the URL that will be loaded when the user presses the e-mail button in the toolbar.

    id='emailnav':
    Specifies the URL that will be loaded when the user clicks on a mailto: e-mail address within the browser.

    id='mediamail':
    Specifies the URL that will be loaded when the user presses the web cam button in the toolbar.

    id='applications':
    Specifies the URL that will be loaded when the user presses the Programs button in the toolbar.

    id='naverror':
    Specifies the URL that will be loaded when a navigation within the SiteKiosk browser has failed.

    dialog:
    <dialog id='toomanywindows' width='373' height='225'
    titlebar='true' scrollbars='false' border='true' sysmenu='false'>
    skins\default\systemdialog\toomanywnds.htm</dialog>
    ...
    
    

    Dialog defines the system dialog ID and the URL as well as the display parameters for the dialog.

    Display Parameters:
    titlebar=boolean - Display of the title bar in the dialog box window
    scrollbars=boolean - Display of the scrollbars in the dialog box window
    border=boolean - Display of the borders in the dialog box window
    sysmenu=boolean - Display of the system menu (close, minimize, etc.) in the dialog box window
    PreventInput=boolean - As long as this dialog is displayed and its parameter is set to value=true, the entire browser will be blocked (similar to tilt mode), i.e. the user will be unable to enter anything as long as this dialog is shown.
    Closable=boolean - If value=false, the user will be unable to close this dialog by means of, for example, the Sys menu.
    TopMostWindow=boolean - All of these dialogs are basically topmost. You can, however, also use this flag to set child windows, i.e. windows that have a parent, to topmost.

    The following default values will automatically be set for every dialog:
    Width = 400;
    Height = 300;
    ScrollBars = false;
    Title = false;
    Border = true;
    Sysmenu = true;
    PreventInput = false;
    CloseOnInput = false;
    Closable = true;
    TopMostWindow = false;
    

    You will find the following dialogs in the XML file:

    dialog id='toomanywindows':
    Will pop up as soon as the user tries to open more than the specified maximum count of windows

    dialog id='sabotage':
    Will pop up if the user constantly tries to carry out forbidden actions (30-second tilt mode)

    dialog id='surfarea':
    Will pop up when the user tries to load a forbidden URL (surfing area restricted)

    dialog id='dialup':
    Will pop up when the user is logging on using a dial-up connection.

    dialog id='actionforbidden':
    Will pop up as soon as the user tries to initiate a forbidden action such as a download from the Internet.

    dialog id='email-disabled':
    Just for the disabled e-mail status.

    dialog id='printerpay':
    Will pop up when the user tries to launch a print job with costs.

    dialog id='printerinfojobs':
    Will pop up when the user tries to initiate more print jobs than are permitted.

    dialog id='printerinfopages':
    Will pop up when a print job contains more pages than are permitted.

    dialog id='payment':
    Will pop up when the user tries to open pay site and has no available credit balance

    dialog id='lowsurftime':
    Will pop up, depending on the configured time, shortly before the user's credit amounts to zero (you are running out of surfing time)

    dialog id='pullmode:
    Will pop up when the user initiates a pull mode function. Pull Mode=Charging One-Time Fees

    dialog id='acos-readerror':
    Will pop up when a SmartCard has not been detected properly.

    dialog id='acos-nomoney':
    Will pop up when the credit balance on a SmartCard amounts to zero.

    dialog id='avt-inpayment':
    Will pop up as soon as a money card has been inserted into a money card reader.

    dialog id='avt-status':
    Will pop up when a money card reader could not be initialized properly.

    dialog id='coachblocked':
    Will pop up when a web site is being blocked due to the filtering criteria of the Content Filter.

    dialog id='discardmoney':
    Will pop up when a user presses the Logout button and the remaining credit balance could not be credited.

    traywindow:
    <traywindow height='28'>
    skins\default\TrayWindow.html</traywindow>
    

    traywindow:
    Defines the task bar's height (in pixels) and its URL within the browser layout.

    mainskin:
    <mainskin>
    ..
    </mainskin>
    

    mainskin:
    Refers to parameters within the main window (not to new windows).

    <statusbar>true</statusbar>
    <progressbar>true</progressbar>
    <source>skins\default\MainWnd.htm</source>
    

    statusbar (boolean):
    If your skin includes an individual status bar, you should set this value to true. If your skin does not feature an individual status bar, you can set the value to false. SiteKiosk will then show a standard Windows status bar that will take care of everything.

    progressbar (boolean):
    If the skin you want to use features its own progress bar, the value should be set to true. If the skin does not include an individual progress bar, you can set the value to false. SiteKiosk will then show its own progress bar that will take care of everything.

    source:
    This value contains the path and file of the browser skin's main window.

    windowskinless:
    <windowskinless>
    ..
    </windowskinless>
    

    windowskinless:
    In SiteKiosk's configuration file you can specify that new windows will be opened without a skin (entry "<skin-browserwindows>"). You can make the necessary adjustments here.

    <busyanim framedelay='25' imgwidth='65'>
    skins\default\img\anilogo.png</busyanim>
    <toolbar transcolor='16711935'>
    skins\default\img\ButtonBar.png</toolbar>
    

    busyanim:
    Sets the parameters for the behavior of the busy animation within a new window provided you want it to be displayed without a skin. The image specified between the tags should contain all the animation frames side by side with each frame having a length equal to the value of "imgwidth" in pixels. The element "framedelay" defines the display duration of every frame in milliseconds.

    toolbar:
    Sets the parameters for the behavior of the toolbar within a new window provided you want it to be displayed without a skin. The element "transcolor" defines the color value that has to be treated as a transparent color.

    windowskin:
    <windowskin minwidth='390' minheight='260'>
    

    windowskin:
    Sets the parameters for the display of new windows within SiteKiosk provided they are supposed to be opened with a skin.

    <source>skins\default\NewWnd.htm</source>
    <border cx='6' cy='0'/>
    <addressbar cx='0' cy='37'/>
    <statusbar cx='0' cy='22'>true</statusbar>
    <menubar cx='0' cy='0'/>
    <toolbar cx='0' cy='75'/>
    

    source:
    This value contains the path and file to the skin of a new window.

    border:
    This element provides values for size calculation of a border.

    addressbar:
    This element provides values for size calculation of the addressbar.

    statusbar:
    This element provides values for size calculation of the statusbar. Setting this element to true or false (see example above) defines if these values take part in the calculation.

    menubar:
    This element provides values for size calculation of the menu bar (only for compatibility reasons).

    toolbar:
    This element provides values for size calculation of the toolbar.


Back to topBack to top

© 1997-2011 PROVISIO - Aventura, EEUU - Muenster, Alemania
Sitekiosk.es - Grupo24®, Madrid, España -