Appendix A: The Kiosk File Structure
This appendix is a reference that describes the underlying file hierarchy used in the Public Kiosk and its user interface. The Public Kiosk’s appearance and operations are driven entirely by a local file structure in combination with SOS Automation Control Protocol made from the kiosk to the SOS machine. All media used in the kiosk software is locally resident and set up in advance.
Most of the kiosk files are autogenerated on the SOS machine using the media2kiosk utility found in the bin directory of the SOS software installation. This utility must be run from the command line. There are also some files that must be configured directly on the kiosk.
The files structure described below is relative to the kiosk root directory, which is /shared/sos/kiosk on the SOS machine and C:\shared\sos\kiosk on the kiosk machine.
Directories and Files Required Only on the Kiosk Machine
Permalink to Directories and Files Required Only on the Kiosk MachineThese files are edited on the Kiosk and are not used on the SOS machine.
- config\: UI settings directory
- settings.txt: UI properties
- logo.png: Image in Kiosk title area (upper left corner)
- en_US.txt: Title and label text in English/United States
- xx_YY.txt: Title and label text in “xx” language/“YY” country
- admin\: Admin UI translations directory
- en_US.ts: Admin UI interface elements for US English in text (editable)
- en_US.qm: Admin UI interface elements for US English in binary (used by kiosk software)
- xx_YY.ts: Admin UI interface elements for “xx” language/“YY” country in text (editable)
- xx_YY.qm: Admin UI interface elements for “xx” language/“YY” country in binary (used by kiosk software)
- info\: Info text directory
- en_US.txt: SOS info and kiosk instructions in US English
- xx_YY.txt: SOS info and kiosk instructions in “xx”/“YY” locale
- resource\: Control button image directory
- buttonA.png: Control button image (png)
- buttonB.jpg: Control Button image (jpeg)
Directories and Files Required Only on the SOS Machine
Permalink to Directories and Files Required Only on the SOS MachineThese files are used as input to the media2kiosk utility and are not used directly on the kiosk.
- images/: Images directory
- groups/: Group images directory
- GroupA.jpg: GroupA button image (jpeg)
- GroupB.png: GroupB button image (png)
- groups/: Group images directory
- playlists/: Kiosk playlists directory
- kiosk.sos: A playlist defining the groups in the kiosk
- groups/: Group playlists directory
- overlays.sos: Playlist of the overlays in the Overlays group
- GroupA.sos: Playlist of the datasets in GroupA
- GroupB.sos: Playlist of the datasets in GroupB
- locale/: Media translation playlists directory
- datasets/: Dataset translation playlists directory
- en_US.sos: Dataset names/descriptions playlist in US English
- xx_YY.sos: Dataset names/descriptions playlist in “xx” language/“YY” country
- groups/: Group translation playlists directory
- en_US.sos: Group names playlist in US English
- xx_YY.sos: Group names playlist in “xx” language/“YY” country
- datasets/: Dataset translation playlists directory
Directories and Files Generated on the SOS Machine by the media2kiosk Utility
Permalink to Directories and Files Generated on the SOS Machine by the media2kiosk UtilityThese files must be transferred to the kiosk machine.
- groups/: Derived directory for groups
- groups.txt: Listing of all the groups in the kiosk
- GroupA/: Derived directory for GroupA
- datasets.txt: listing of the datasets in GroupA
- group.png: Image on the group button (can also be a jpeg)
- en_US.txt: Group name in English/United States
- xx_YY.txt: Group name in “xx” language/“YY” country
- GroupB/: Derived directory for GroupB
- datasets.txt
- group.png
- en_US.txt
- xx_YY.txt
- overlays/: Derived directory for overlays
- datasets.txt
- group.png
- en_US.txt
- xx_YY.txt
- datasets/: Derived directory for datasets
- ID_#####/playlist/: Derived directory for dataset with ID “#####”
- thumbnail.jpg: image on the dataset button
- properties.txt: dataset properties used by the kiosk
- sphere.png: dataset image shown in the trackball sphere (can also be a jpeg)
- en_US.txt: dataset name/description in English/United States
- xx_YY.txt: dataset name/description in “xx” language/“YY” country
- ID_#####/playlist_xyz/: Derived directory for dataset variation “xyz” with ID “#####”
- thumbnail.jpg
- properties.txt
- sphere.png
- en_US.txt
- xx_YY.txt
- ID_#####/playlist/: Derived directory for dataset with ID “#####”