Edge Documentation

{{DISPLAYTITLE:AppBoard Themes}}
[[Category:AppBoard old]]
[[Image:ThemeEditor.png|thumb|center|500px|Sample View of the AppBoard Theme 
Editor]]


An AppBoard Theme is a collection of settings that manage the overall visual presentation of the application to the end-user in the web browser.  Elements included in a Theme include colors, button styles, shadows, borders, backgrounds, and so on.


Multiple Themes can be configured in an AppBoard system.  One Theme is in place at any given time.  For example, you could create four seasonal Themes, and change the selected Theme once every three months to give the system a fresh look.


== Managing Themes ==

Perform the following to manage Themes:

# Log in to AppBoard Builder as an administrator.
# In the <b>Builder Modes</b> panel, select <b>Settings</b>, then select <b>Themes</b>.  This will launch the Theme Manager panel.


== Base Themes ==
AppBoard ships with 4 base themes:
# Dark
# Light
# Smoked Glass
# Minimalist


The default theme is set to <b>Dark</b>.  To activate a different theme, select another theme from the list of available themes, and click the blue "Check" icon in the bottom toolbar.  The checked Theme indicates the Theme that is currently active.

{{Note|After changing or modifying themes, a browser refresh is required to see the Theme changes take effect.}}


== Creating a New Custom Theme ==
Perform the following steps to create a new Theme:

# Click the green "Plus" icon in the bottom toolbar.  This will launch the "Theme Editor".
# Enter a name for the new Theme to be created.
# The Theme is created with a set of default settings.
# Modify the Theme as desired, and then click "Save Changes" to save the changes to the Theme.
# Apply the theme to the system, if desired, by clicking the blue "Check" icon in the bottom toolbar.

{{Note|If you manually set backgrounds to be dark while using the light theme, then some of the default dark text colors will become unreadable.  The best practice is to switch to the "Dark" template if you want a dark look and feel.  Doing so will ensure default text colors are readable.}}


== Deleting a Theme ==
Perform the following steps to delete a Theme:

# Select the Theme from the list of available Themes.
# Click the red "delete" icon in the bottom toolbar.


{{Note|You can only delete custom themes.  You can not delete the four base themes that ship with AppBoard.  You also can not delete a Theme while it is the currently active Theme.  In such case, activate another Theme first, and then delete the Theme.}}


== Editing a Theme ==
Perform the following steps to edit the settings for a Theme:

# Select the Theme from the list of available Themes.
# Click the yellow "Edit" icon in the bottom toolbar.  This will launch the "Theme Editor".
# Modify the Theme as desired, and then click "Save Changes" to save the changes to the Theme.
# Apply the Theme to the system, if desired, by clicking the blue "Check" icon in the bottom toolbar.


{{Note|You can only edit custom themes.  You can not edit the four base themes that ship with AppBoard.}}


=== Advanced Editing===

It is possible to edit base themes outside of the AppBoard Builder.  The attributes for each base theme are loaded from:
/server/webapps/enportal/WEB-INF/data/pkg/BaseThemes.CSV


Altering the values in BaseThemes.csv will modify the base themes that ship with AppBoard, and requires a server restart to take effect.  However, it is recommended that users go through the Builder for modifying Themes.  Small syntax errors inside of BaseThemes.csv can cause AppBoard to crash.  Always create a backup of BaseThemes.CSV before modifying the attributes in this file.


== Using the Theme Editor ==

An AppBoard theme is a collection of overrides for a default set of attributes.  Rather than build up a Theme from scratch, AppBoard Themes start with default values pre-populated from a template.  AppBoard ships with 4 base themes to provide a range of starting points.  
  

To get started, select a <b>Theme Template </b> using the pull-down selector at the top of Theme Editor.  The base template is all that is required for a Theme.  A new Theme without any overrides is basically just a copy of the Theme Template. 


By selecting a different <b>Theme Template</b>, you will swap out the base values used by the current Theme.  Any overrides configured as part of your new Theme will persist; however, the values used in your overrides may no longer make sense after you have switched from a "Dark" theme to a "Light" theme.


=== Attribute Overrides  ===
Themeable elements are organized into categories, which can be selected using the list on the left side of Theme Editor.  


Each attribute has a default value that it inherits from its template.  To provide an override for that value, check the check box next to the desired attribute.  If you decide you do not like the new values you entered, uncheck the checkbox next to the attribute, and the theme will return to its default value.


{{Note|After changing or modifying themes, in most cases a browser refresh is required to see the Theme changes take effect.}}