How to install a Visual Theme
A Visual Theme is distributed as a single .zip file like for example vt_chrome.zip.
- Download the zip file from the Gallery
- Unzip it in the OFBiz themes folder
- Issue the "ant run-install" command in your OFBiz home folder
From this moment your added Visual Theme is installed and available in the OFBiz framework.
How to create a Visual Theme
An OFBiz Visual Theme consists of a simple OFBiz component installed, usually, in the themes folder. In the component, all the resources needed by the Visual Theme are defined.
The simplest way to create a Visual Theme is starting from one of the already available themes in the OFBiz themes folder.
Let's say you want to create a new theme called mytheme and have selected bluelight as a starting template.
- Create a new /themes/mytheme folder and copy there all files from the /themes/bluelight folder.vt_multiflex.zip
- Rename the folder /themes/mytheme/webapp/bluelight to /themes/mytheme/webapp/mytheme
- Delete all files from the /themes/mytheme/includes folder and add your own header and/of footer files if needed
- Delete all files from the /themes/mytheme/webapp/mytheme folder and add your own css files and images
Please consider that all images references in your css file must be linked using the "/mytheme" path.
For example if you have a background.jpg image, you should use the following address: url(/mytheme/background.jpg)
- Edit the file /themes/mytheme/data/ThemeData.xml as follows:
- change the visualThemeId from "BLUELIGHT" to "MYTHEME"
- if your theme is intended to be used for the Ecommerce application set the visualThemeTypeId="ECOMMERCE"
- if your theme is intended to be used for the backoffice applications set the visualThemeTypeId="BACKOFFICE"
- Change all VisualThemeResource lines to include references to you theme files
- Edit the file /themes/mytheme/webapp/mytheme/WEB-INF/web.xml as follows:
- change the <display-name> and <description> with a description of your theme
- change the <display-name> and <description> with a description of your theme
- Edit the file /themes/mytheme/ofbiz-component.xml as follows:
- change all "bluelight" occurrences with "mytheme"
Your theme is now ready to be installed.
If you want to upload your theme to the Visual Theme Gallery, simply create a mytheme.zip file from the /themes/mytheme folder and upload to the gallery.
Enjoy !