Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 DescriptionLocation
Index fileStringTemplate index file

JAR or

Include Page
_

HomeFolder

ConfigLocation
_

HomeFolder

ConfigLocation

Web resourcesJavaScript, CSS, images, etc.

JAR or

Include Page
_

HomeFolder

ConfigLocation
_

HomeFolder

ConfigLocation

Configuration

Properties in the

Include Page
_PropertiesFileJava
_PropertiesFileJava
file

Include Page
_

HomeFolder

ConfigLocation
_

HomeFolder

...

ConfigLocation


Getting started

The base of a theme is the index file from which the main page is built. Blueriq uses a template engine called StringTemplate to make server properties available in the client.

...

Installing your custom theme is easily done by putting all files in the 

Include Page
_HomeFolderConfigLocation
_HomeFolderConfigLocation
 folder. For example when a theme is created named "custom_dashboard" which consists of an index file, a JavaScript file and a CSS stylesheet, installation would be as follows:

...

  1. Create a UI/mvc folder in 
    Include Page
    _HomeFolderConfigLocation
    _HomeFolderConfigLocation
     and put the custom index file (for example custom_dashboard.stg) here.
  2. Create a webresources/mvc folder in 
    Include Page
    _HomeFolderConfigLocation
    _HomeFolderConfigLocation
     and put the JavaScript and CSS files here (optionally in /js and /css sub folders).
  3. Add a configuration section for your custom theme to
    Include Page
    _PropertiesFileJava
    _PropertiesFileJava
     in 
    Include Page
    _HomeFolderConfigLocation
    _HomeFolderConfigLocation
     root, as described in the Configuration section below.

...

The mvc.themes or name property specifies the name for the theme which will be displayed in the Runtime theme selector. The other two properties specify which StringTemplate index file should be used and which StringTemplate function should be called to render the index page (see "Creating the index file" above). The path to the index file is relative to either the JAR/DLL or the 

Include Page
_
HomeFolder
ConfigLocation
_
HomeFolder
ConfigLocation
/Configuration folder. When a file name is specified which is located in
Include Page
_
HomeFolder
ConfigLocation
_
HomeFolder
ConfigLocation
/Configuration and that is already loaded from a JAR, the file from 
Include Page
_
HomeFolder
ConfigLocation
_
HomeFolder
ConfigLocation
/Configuration will be used and the file from the JAR/DLL will be overridden. More information about overriding existing themes can be found on Extending themes.