Difference between revisions of "Project"
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
*'''size''': the project size: width and height. If the orientation mode is enabled, a second set of width and height is required. The first set refers to landscape mode, while the second to portrait mode | *'''size''': the project size: width and height. If the orientation mode is enabled, a second set of width and height is required. The first set refers to landscape mode, while the second to portrait mode | ||
*'''device image''':enables or disables the camera or image pop-ups associated to devices in the interface, as configured in the systemtopo.txt file | *'''device image''':enables or disables the camera or image pop-ups associated to devices in the interface, as configured in the systemtopo.txt file | ||
| Line 19: | Line 11: | ||
*'''uiset''': | *'''uiset''': | ||
| − | == | + | [[Category:User Interface]] |
| + | A project defines a custom user interface, that allows the user to interact with the system. | ||
| + | Each project has one or more pages that contain [[UI Objects]]. | ||
| + | |||
| + | On the index.hsm, the project's parameters are defined as directives (#<directive>) | ||
| + | |||
| + | == Parameters == | ||
| + | === Skin === | ||
Defines the graphical appearance of the project. | Defines the graphical appearance of the project. | ||
| − | === Values === | + | ==== Values ==== |
| − | *'''skin name''': the name of the skin. The standard skin provided with HSYCO is "blue" | + | *'''skin name''': the name of the skin. The standard skin provided with HSYCO is "blue" |
| − | === Syntax === | + | ==== Syntax ==== |
(#skin <skin name>) | (#skin <skin name>) | ||
| − | == | + | === Language === |
Defines the language used for all standard text messages of the Web interface. | Defines the language used for all standard text messages of the Web interface. | ||
| − | === Values === | + | ==== Values ==== |
| − | *'''language id''': the language used for the project (it | en | fr | cn) | + | *'''language id''': the language used for the project (it | en | fr | cn) |
| − | === Syntax === | + | ==== Syntax ==== |
(#language <language id>) | (#language <language id>) | ||
| + | === Header === | ||
| + | Specifies the page header, the text that normally appears in bookmarks and as the title of the browser's window. | ||
| + | |||
| + | ==== Values ==== | ||
| + | *'''title''': the project's title | ||
| + | |||
| + | ==== Syntax ==== | ||
| + | The header must be declared after all the directives and before the pages. | ||
| + | (header <title>) | ||
| + | |||
| + | === Size === | ||
| + | Sets the project size as width and height. If the orientation mode is enabled, a second set of width and height is required. The first set refers to landscape mode, the second to portrait mode. | ||
| + | |||
| + | ==== Values ==== | ||
| + | *'''width''': the project's width in pixels | ||
| + | *'''height''': the project's height in pixels | ||
| + | |||
| + | ==== Syntax ==== | ||
| + | (#size <width>x<height>) | ||
| + | Or to enable orientation mode: | ||
| + | (#size <width (landscape)>x<height (landscape)>x; <width (portrait)>x<height (portrait)>x) | ||
| + | |||
| + | === Device Image === | ||
| + | Enables or disables the camera or image pop-ups associated to devices in the project, as configured in the systemtopo.txt file. | ||
| + | |||
| + | ==== Syntax ==== | ||
| + | If omitted, the default value is "enabled". | ||
| + | (#deviceimage disable) | ||
| + | |||
| + | === Kiosk === | ||
| + | The kiosk mode removes the menu bar and borders, for digital signage or kiosks applications where you want to have a full-screen display of your pages. "lock" also disables the navigation functions. | ||
| + | ==== Values ==== | ||
| + | *'''mode''': disabled, enabled or locked | ||
| + | ==== Syntax ==== | ||
| + | If omitted, the default value is "disabled". | ||
| + | "enabled" mode: | ||
| + | (#kiosk nolock) | ||
| + | "locked" mode: | ||
| + | (#kiosk lock) | ||
The project's parameter are defined through [[meta]] objects. | The project's parameter are defined through [[meta]] objects. | ||
Revision as of 12:48, 8 January 2014
- size: the project size: width and height. If the orientation mode is enabled, a second set of width and height is required. The first set refers to landscape mode, while the second to portrait mode
- device image:enables or disables the camera or image pop-ups associated to devices in the interface, as configured in the systemtopo.txt file
- kiosk:
- scale:
- locked:
- background:
- camera list:
- camera overlay:
- camera grid headers:
- style:
- uiset:
A project defines a custom user interface, that allows the user to interact with the system. Each project has one or more pages that contain UI Objects.
On the index.hsm, the project's parameters are defined as directives (#<directive>)
Contents
Parameters
Skin
Defines the graphical appearance of the project.
Values
- skin name: the name of the skin. The standard skin provided with HSYCO is "blue"
Syntax
(#skin <skin name>)
Language
Defines the language used for all standard text messages of the Web interface.
Values
- language id: the language used for the project (it | en | fr | cn)
Syntax
(#language <language id>)
Header
Specifies the page header, the text that normally appears in bookmarks and as the title of the browser's window.
Values
- title: the project's title
Syntax
The header must be declared after all the directives and before the pages.
(header <title>)
Size
Sets the project size as width and height. If the orientation mode is enabled, a second set of width and height is required. The first set refers to landscape mode, the second to portrait mode.
Values
- width: the project's width in pixels
- height: the project's height in pixels
Syntax
(#size <width>x<height>)
Or to enable orientation mode:
(#size <width (landscape)>x<height (landscape)>x; <width (portrait)>x<height (portrait)>x)
Device Image
Enables or disables the camera or image pop-ups associated to devices in the project, as configured in the systemtopo.txt file.
Syntax
If omitted, the default value is "enabled".
(#deviceimage disable)
Kiosk
The kiosk mode removes the menu bar and borders, for digital signage or kiosks applications where you want to have a full-screen display of your pages. "lock" also disables the navigation functions.
Values
- mode: disabled, enabled or locked
Syntax
If omitted, the default value is "disabled". "enabled" mode:
(#kiosk nolock)
"locked" mode:
(#kiosk lock)
The project's parameter are defined through meta objects. After all the meta and before the declaration of [[Page|pages] and UI Objects, a header object is declared that specifies the project's header.
(#skin <skin>) (#language <language>) (#size <width>x<height>; <width>x<height>) (#scale 2) (#cameralist "london","officeopenspace") (#cameragridlist "123") (#cameraoverlay "123","","","","") (#style body-background-color=) (#uiset autoreload=false)
(header All)
E.g.
(#skin blue) (#language cn) (#size 890x640; 1000x2000) (#scale 2) (#cameralist "london","officeopenspace") (#cameragridlist "123") (#cameraoverlay "123","","","","") (#style body-background-color=) (#uiset autoreload=false)
(header All)
