User Interface

Revision as of 17:10, 7 March 2014 by Gionatan (talk | contribs)
Jump to navigation Jump to search

HSYCO allows the interaction with the system through a custom user interface. We can identify three entities:

  • Project: a single interface
  • Page: a project can contain pages
  • Object: a page can contain objects

A project is defined by a subdirectory inside www that contains an index.hsm file.

Whenever HSYCO detects any change to the files in www and in its subdirectories, it forces the reload of all the projects on the connected browsers.

For each sub-directory in www in which the file index.hsm exists, you can access the page with the following URL:

https://<name server>/<URLKey>/<subdirectory name>

To create or edit a project there are two methods: visually, through the Project Editor or by manually editing the project's source code, the index.hsm file.


The index.hsm file is based on graphic objects having the following standard format:

(object_name <parameter1>; <parameterN>)
Errors in the index.hsm file are reported in the log file with the message:
Page Parser: Syntax Error, line: nnn

When errors are detected, the page is not served to the Web browser. File parsing stops at the first error, so only the first line with errors is reported in the log file. Each type of graphic object could require one or more parameters, separated by the “;” character. Empty lines or blank spaces are ignored.

Changes to index.hsm cause an automatic page reload on the connected Web browsers.

You can insert comment lines, which are ignored. A comment line starts with the “#” character at the beginning of the line.

Names in index.hsm are case sensitive, small and capital letters are significant; all objects defined in the standard skin have names with lower-case letters.

Some objects support a variant called identified version to allow the !id dynamic modification of the text, visibility, color several other attributes with the uiSet() Java method or the UISET action.

The identified objects should be defined with an id string that is unique in the index.hsm file. The presence of more objects with the same id can cause undesired effects. To identify an object, append a ! character and the id at the end of the object type, for example:

(text!mytextid r1c1; This is my identified text object)