Home > Customization (Skins) > Browser Layout

Documentation for the Definition File for Browser Layouts

The XML definition file for browser layouts contains all the necessary information needed to use a browser layout (skin) are required. 

Please note:
Some basic knowledge is necessary to create a separate browser layout. For obvious reasons we cannot (apart from this documentation) provide free support for creating personalized skins
1. General Structure of the Definition File
The structure of the definition file depends on the specific skin.
The following is an excerpt of the most important elements of the file:

<skindef name="Default Skin" languages-selectable="true">
 
<touchscreen>TX82-Ultra English (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" languages="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>
 
<confightml>skins\default\defaultconfig.html</confightml>
</skindef>

2.
The Elements and Attributes of the Definition File
2.1 skindef-Element
Each layout of a browser layout is divided into a skindef section with several subskindef sections. 

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

name:

Defines the name of the skin. The contents of this attribute are displayed in the SiteKiosk configuration. The attribute name must be unique for each layout.

languages-selectable: 
Boolean value that specifies whether the language selection option on the skin is enabled(true) or disabled (false).

2.2 touchscreen-Element

<touchscreen>TX82-Ultra English(docked)</touchscreen>

Not fully implemented 
2.3 stringtable-Element
Specifies the path to the string table XML file.

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

  In stringtable.xml, you will find all language related settings. More information can be found here.
2.4 languageoption-Element
Defines in the existing layout and configuration selectable languages.

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

id:
The ID defines all available languages.

The language IDs are as follows:

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:
Is set from the operating system language is not supported by SiteKiosk (i.e. Swahili), then the specified default language will be automatically used.
2.5 subskindef-Element
Unterbereich des skindef-Elements, der einige zusammengehörige Elemente gruppiert.

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

name:
Specifies the name of the subskindef.  The name must be unique.

language='id':
There are a couple of solutions for language display:

Solution 1: Create a subskindef with <em>language="0"</em>. In this case, the same dialog is always displayed regardless of the language. The text is only displayed as indicated by the string table in the selected language. The default skin works on this principle.

Solution 2: Create your own language (language=<em>"[language-id]"</em>) subskindef. This gives you the opportunity to show completely different dialogs (See also id dialogue) and browswer skins depending on the selected language. For all other languages ​​solution 1 is a fallback, for instance when a language has completely different display rules, such as Chinese or Hebrew.

2.6 url-Element
Sets various predefined URLs for a skin. This information is optional and can be omitted if the corresponding URLs are not needed in a browser layout.

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

id='emailbutton':
Sets the URL that is called when the email button on the toolbar is clicked.

id='emailnav':
Sets the URL that is called when the user clicks a mailto link (email address) or the email button.

id='mediamail':
Sets the URL to that is called when the WebCam button on the toolbar is pressed. Since SiteKiosk 9.0 this is no longer officially supported.

id='applications':
Sets the URL to that is called when the program button is pressed within the toolbar.

id='naverror':
Sets the URL to that is called when a navigation fails in the SiteKiosk browser.
2.7 dialog-Element
Dialog defines the URL of a variety of skin dialogs, eg the dialog that appears when too many windows are open.

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

id:
Sets a unique internal name for the dialog.

The following IDs are found in the XML file:

id='toomanywindows':
Displayed when more than 5 windows have been opened.

id='sabotage':
Appears when someone repeatedly performs prohibited actions (30 second Tilt Mode).

id='surfarea':
Displayed when a denied URL is called (Surfing Area Rules).

id='dialup':
Displayed when a connection over dial-up happens.

id='actionforbidden':
Displayed when a unauthorized action takes place like a download.

id='email-disabled':
Displayed when the email function is not active and a mailto-Link is called.

id='printerpay':
Displayed when the pay-to-print print job is called.

id='printerinfojobs':
Displayed when the print jobs is called that is allowed.

id='printerinfopages':
Displayed when the print job contains more pages than allowed.

id='payment':
Displayed when the pay-to-surf page is called and there is not enough credit.

id='lowsurftime':
Is displayed after a configured time, shortly before the credit runs out.

id='pullmode':
Displayed when a script with the pullmode funktionen is called.

id='acos-readerror':
Displayed when a smart card is not recognized by the smart card reader. Smart cards are only supported until SiteKiosk 8.91.

id='acos-nomoney':
Displayed when the credit on a smart card runs out. Smart cards are only supported until SiteKiosk 8.91.

id='avt-inpayment':
Displayed when a money card is inserted in to the corresponding reader. Tip: Money card payments are no longer supported.

id='avt-status':
Displayed when a money card reader can not be initialized properly. Tip: Money card payments are no longer supported.

id='coachblocked':
Displayed when a website containing filtered criteria from the content filter is blocked.

id='discardmoney':
Displayed when a user clicks the logout button and the rest of their credit will be discarded.

width:
The width of the dialog.

height:
The height of a dialog.

titlebar:
Boolean value that defines if the title bar is visible or not.

scrollbars:
Boolean value that defines if the scroll bars are visible or not.

border:
Boolean value that defines if the border is visible or not.

sysmenu:
Boolean value that specifies whether a system menu to close, minimize, etc. is visible.

PreventInput:
Boolean value that specifies whether input on the dialog is possible. Similar to sabotage mode when the dialog is displayed with a value of true the entire browser is blocked. No input is possible as long as the dialog is displayed. The dialogue should closed by a script after a certain amount of time.

Closeable:
Boolean value that when set to false, it is not possible to close the dialog.  The system menu will not close the dialog.

CloseOnInput:
Boolean value that specifies whether the dialog is closed when there is input on the dialog for example a mouse click.

TopMostWindow:
Boolean value that specifies whether a dialog is in the always in the foreground, for example when an area outside the window is clicked. The behavior of the Windows Task Manager is similar.

The following default values ​​are automatically set for any dialogue if the values for one or more attributes ​​was not otherwise specified:

Width = 400;
Height = 300;
ScrollBars = false;
Titlebar = false;
Border = true;
Sysmenu = true;
PreventInput = false;
CloseOnInput = false;
Closable = true;
TopMostWindow = false;

2.8 traywindow-Element
This element specifies the URL of the file to display the taskbar.

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

height:
Specifies the height of the taskbar in pixels.
2.9 mainskin-Element:
Refers to parameters within the main window. Has no effect on open additional browser windows.

<mainskin>
...
</mainskin>

The following parameters are available:

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

statusbar:
Boolean value that when used with a skin that has its own status bar, the value should be true. If a skin does not own status bar, you can set the value to false and SiteKiosk displays a standard Windows status bar.

progressbar:
Boolean value that when used will show a progress bar for the payment module when impletmented then the value should be set to true. If a skin does not have a progress bar, you can set the value to false and SiteKiosk will display a standard progress bar.

source:
URL responsible for the display of the main window of the browser layout.
2.10 windowskinless-Element
You can access this in a SiteKiosk configuration file by manually editing it so that windows will be loaded without a skin. In that case a standard window with reduced design elements is displayed. The settings are made here:Tip: This function is no longer officially supported.

<windowskinless>
...
</windowskinless>

The following parameters are available: 

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

busyanim:
Defines the parameters for the busy animation in a new window if it is displayed without a skin.

toolbar:
Defines the parameters for the toolbar items in a new window if it is diplayed without a skin.
2.11 windowskin-Element
Defines the parameters for a new window.

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

minwidth:
Defines the minimum width of a new window. 

minheight:
Defines the minimum height of a new window. 


The following elements are available in the windowskin element:

<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:
URL that is responsible for the display of new browser windows for the browser layout.

border:
Information to calculate the dimensions of the window frame.

addressbar:
Information to calculate the dimensions of the address bar.

statusbar:
The indication of true or false is used to determine whether the information should be used in the calculation.

menubar:
Information to calculate the dimensions of the menu bar. Information is only provided for compatibility reasons. The values ​​should be left at 0.

toolbar:
Information to calculate the dimensions of the tool bar.
2.12 confightml-Element
Specifies the path to the file that is used to display the Customize dialog in the SiteKiosk configuration tool. This information is optional and only necessary if a Customize dialog should be used.

<confightml>skins\default\defaultconfig.html</confightml>

Please note:
Since the most current SiteKiosk 8 versions the html file for the Customize dialog is located in the folder ..\SiteKiosk\ConfigServer\Web\HtmlConfig and then either in the subfolder Skins or Startpages. The path value for the confightml element is relative to the Web folder, so it needs to look like this:


<confightml>HtmlConfig\Skins\Skinname.html</confightml>

You may use a file from one of the downloadable skins as reference.


See also 

Manually Configurable Options
Language Files
SKSKIN File
Keyboard Layout
Start Page Layout
Remapping Keys


Back to top