SiteKiosk Documentation
One Step Back

Documentation Concerning XML Definition File (Start Page Layout)



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

Please note:
You will need some knowledge about how you can alter start page 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 to XML definition file: SK-Installation folder/skins/Startpages/(StartpageName)/(StartpageName).xml

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

<startpagedef name="Desktop Startpage">
<confightml>skins\public\Startpages\Desktop\Config.html</confightml>
<common>
	<newwindow-startpage>
	http://www.sitekiosk.de/</newwindow-startpage>
	<allow-session-override>false</allow-session-override>
	<fullscreen>true</fullscreen>
	<fullscreen-hide-taskbar>false</fullscreen-hide-taskbar>
	<fullscreen-hide-statusbar>false</fullscreen-hide-statusbar>
	<startpage>$(SiteKioskPath)\skins\public\
	Startpages\Desktop\Start.html</startpage>
</common>
</startpagedef>

 

Documentation Concerning Elements and Attributes

    startpagedef:
    Every layout contains a startpagedef section.

    <startpagedef name="Desktop Startpage">
    	...
    </startpagedef>

    "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.

    confightml:
    <confightml>skins\public\Startpages\Desktop\Config.html</confightml>
    

    This element contains the path and file name of an HTML page containing user interface and scripts for configuring this skin. If this page is defined here, it can be accessed by the Configuration Wizard ("Customize" button of the start page).

    common:
    <common>
    	<newwindow-startpage>
    	http://www.sitekiosk.de/</newwindow-startpage>
    	<allow-session-override>false</allow-session-override>
    	<fullscreen>true</fullscreen>
    	<fullscreen-hide-taskbar>false</fullscreen-hide-taskbar>
    	<fullscreen-hide-statusbar>false</fullscreen-hide-statusbar>
    	<startpage>$(SiteKioskPath)\skins\public\
    	Startpages\Desktop\Start.html</startpage>
    </common>
    

    The "common" element defines a section containing definition parameters that specify the skin's behavior.

    newwindow-startpage:
    This element contains the start page for every new window opened (not the main window).

    allow-session-override:
    If this option is set to "true", other modules like payment devices are able to overwrite the value for the start page of new windows specified above. Otherwise, the value defined in "newwindow-startpage" will always apply.

    fullscreen:
    This option should be set to "true" since all start page skins are implemented to be displayed full screen.

    fullscreen-hide-taskbar:
    If this option is set to "true", the task bar will be hidden if "fullscreen" is set to true. Otherwise, it will be displayed.

    fullscreen-hide-statusbar:
    If this option is set to "true", the status bar will be hidden if "fullscreen" is set to true. Otherwise, it will be displayed.

    startpage:
    This option defines the path and file name of an HTML page that represents the main window of this start page skin. It should be located in a path in which SiteKiosk Object Model scripting is enabled by the Configuration Wizard.

 


Back to topBack to top

© 1997-2010 PROVISIO - Aventura, USA & Muenster, Germany - SiteKiosk DevTeam