Kiosk Project logo

ModuleDocumentation

KioskWiki | RecentChanges | Preferences

Below is a listing of the base chromes and various overlays

You probably want to use kiosk3.xul as the basis for a new chrome. So here is what I would do:

There are 3 main kiosk.xul files that you can use for your new chrome:

kiosk template xul files

Includes the blank tool-bar, nav-bar, nav-buttons, progress-meter and flip-to label. Starts in full screen unless a sizeOverlay is added in the rdf stanza. This is the main kiosk.xul most of the sample chromes are made from.

blank-kiosk.xul

This base kiosk.xul contains no tool-bar, nav-bar, nav-buttons, progress-meter or flip-to items. Just a plain box that will display web content and follows links. Starts full screen. Is best used without an rdf stanza so that no Overlays are applied, although you can use this as the basis of a new chrome.

vanilla-kiosk.xul

Contains no flip-to label. Has all the other blank UI items included in kiosk-template.xul. Starts full screen unless a sizeOverlay is added in the rdf stanza.


Here is a listing of available overlays that may be combined to create a chrome for the kiosk browser:

800x600-sizeOverlay.xul

Sets the initial size of the kiosk window to 800 wide by 600 tall. Kiosk defaults to full screen if no sizeOverlay.xul is specified. This overlay is depreciated in favor of the sizeOverlay.xul

sizeOverlay.xul

Sets the initial size of the kiosk browser. It gets its size information from the /kiosk/locale/en-US/kiosk.dtd file.

throbberOverlay.xul

The throbber gives visual feedback to the user and operates at the same time as the progress meter. The default values for this throbber element are defined in the /kiosk/locale/en-US/kioskDefault.properties file.

eye-throbberOverlay.xul

The eye-throbber has two eyeballs that look around when a uri load is taking place. Gives visual feedback to the user and operates at the same time as the progress meter.

neon-throbberOverlay.xul

The neon-throbber displays a flashing neon LOADING during a uri load and a neon VIEWING when no uri load is occuring.

tux-throbberOverlay.xul

The tux-throbberOverlay displays tux the penquin doing flips during a uri load and displays tux sitting reading the news paper when no load is occuring.

intl-throbberOverlay.xul

The intl-throbberOverlay displays a standard mozilla throbber element. This Overlay is located in the /intl-skin directory. It uses it's own implmnt-specific.js, intl-kiosk.css and its own images directory. When used as the last item in an rdf stanza it's intl-kiosk.css will take over and the toolbar buttons will be international symbols(mozilla modern theme) representing their functions. Remember that with css the last matching rule wins.

headerOverlay.xul

A header banner that gets placed above the toolbar. The header banner is defined in the /kiosk/skin/default/kiosk.css file.

list-uri-feildOverlay.xul

Experimental UI element. Included in the toolbar. Element is a dropdown list

home-btnOverlay.xul

Includes the Home button. Resets the kiosk browser to base.uri specified in the kiosk/locale/en-US/kiosk.dtd file. Element has no keybinding.

forward-back-btnsOverlay.xul

Includes the Forward and Back buttons. Included in the toolbar. Keybindings included.

nav-btnsOverlay.xul

Includes the Flip, Forward and Back buttons. Included in the toolbar. Keybindings included. The Flip button flips between the last page you surfed to and the page you are viewing.

extra-btnsOverlay.xul

Includes the Print and Quit buttons. These buttons have no keybindings. Applies to the toolbar at the top of the kiosk window. When laying out the rdf stanza the toolbar items get added from the left.

flip-btnOverlay.xul

Adds the flip page button to the toolbar. Flip button keybinding F4 or alt+up arrow. The flip button flips between two pages, the page you are viewing and the last page you surfed to. If you use the back button to go back 3 pages and then click the flip page button you will go back to the page you were at before you started going back.

print-btnOverlay.xul

Adds a print button to the toolbar. No keybindings. Items are added to the tool bar from the left.

quit-btnOverlay.xul

Adds a quit button to the toolbar. No keybindings. Items are added to the tool bar from the left.

reset-kioskOverlay.xul

Resets the kiosk to the default base.uri after 5 minutes of no mouse clicks. Also dumps the session history. The base.uri is defined in the kiosk.dtd and the reset time is defined in the /kiosk/locale/en-US/kioskDefault.properties file

uri-menuOverlay.xul

Addes a menu of predefined uri's to the toolbar. The labels(base.siteN.txt) and uri(base.siteN.uri) definitions are in the kiosk.dtd

urlbarOverlay.xul

Adds a Url bar with Go button to the top of the browser window. Url bar has a Go button and keybindings, pressing Enter or F1 loads the listed uri into the the browser window. Look here [KioskBrowser/UrlBar] for a discussion of the uri bar filtering capability

list-urlbarOverlay.xul

Adds a Url bar with Go button to the top of the browser window. Url bar has a Go button and keybindings, pressing Enter or F1 loads the listed uri into the the browser window. Includes a dropdown list that holds all(well, the last 25) uri entered during the current session. Look here [KioskBrowser/UrlBar] for a discussion of the uri bar filtering capability

bookmark-Overlay.xul

Adds a dropdown listbox to the toolbar that, when double-clicked, adds the current uri to the list. The bookmark list is reset whenever the browser is reset.

base-uri-listOverlay.xul

Adds a dropdown list to the toolbar containing a list of predefined uri's. The default uri's are defined in the /kiosk/locale/en-US/uri-list.properties file.

VKeyboardOverlay.xul

Adds a virtual keyboard to the bottom of the kiosk browser window below the progress meter. Starts as a collapsed grippy. Is meant for simple text input from touchscreens or pointer only environments. More information on the virtual keyboard can be found at KioskBrowser/VirtualKeyboard
KioskWiki | RecentChanges | Preferences
This page is read-only | View other revisions
Last edited March 19, 2010 10:03 am (diff)
Search: