The Web Theme is optimized to allow extensive modifications without affecting the system files.
This will allow all future service packs and major versions to be installed with minimal impact to any modifications that have been made.
Customization can be on two levels:
The UI of DriveWorks Live can be used to customize the following:
Additionally the image and description used for your projects can be changed by following the instructions in the topic Project Image, Name and Description.
Before undertaking any modifications to the files DriveWorks Live uses it is important to understand the following:
All files that enable DriveWorks Live are stored in the location:
%ProgramData%\DriveWorks\11\Live\Themes
The Themes folder contains the following sub folders:
All files required for the Application Theme are stored here.
All files required for the Web Theme are stored here. The Web Theme is highly customizable.
The table below identifies the Core and Custom files that are located in the \Web folder:
Item | Type | Notes |
---|---|---|
DriveWorks.config | Custom | This file contains the following information:
|
Global.asax | System | This file should not be changed. |
Theme.drivetheme | System | This file should not be changed. |
Web.config | Custom |
|
\bin | System | The files in this folder should not be changed. |
\content | Contains the custom folder. | |
Web.config | System | This file should not be changed. |
\system | System | The files in this folder should not be changed directly.
To customize anything in the system folder, e.g. a skin or module, copy it across to the custom folder. Files in the custom folder override files in the system folder. |
error.cshtml | System | This file should not be changed. |
navigation.xml | System | This file should not be changed. |
pages.xml | System | This file should not be changed. This file is copied to the \custom folder when a Live session is started. |
\components | System | The files in this folder should not be changed. |
\handlers | System | The files in this folder should not be changed. |
\modules | System | The files in this folder should not be changed directly.
To customize anything in the system folder, e.g. a skin or module, copy it across to the custom folder. Files in the custom folder override files in the system folder. |
\skins | System | The files in this folder should not be changed directly.
To customize anything in the system folder, e.g. a skin or module, copy it across to the custom folder. Files in the custom folder override files in the system folder. |
\settings main.js | System | The file in this folder should not be changed directly. To customize this file copy it across to the custom\settings folder. Files in the custom folder override files in the system folder. this file contains the setting that controls:
|
\custom | This folder should be used to contain any custom modules or skins that you create, or copy from the originals in the system folder. | |
pages.xml | System | This file should not be changed. It will be replaced with the file of the same name from the \system folder when a Live session is started. |
\uploads | System | This folder is used to contain any uploads from the image upload module. |
\modules | Custom | This folder should be used to contain any custom modules that you create, or copy from the originals in the system folder. |
\skins | Custom | This folder should be used to contain any custom skins that you create, or copy from the originals in the system folder. |
\settings | Custom | This folder should be used to contain the customized main.js file, copied from the \system folder. |
\setup | System | The files in this folder should not be changed. |
Display Order
When running DriveWorks Live the files in the Custom folder will be read first.
If the required file is not found DriveWorks Live will read the file from the System folder.
Customizing a Skin is done by:
To identify a skin to base your customization on:
To copy a skin, for customizing, follow the steps below:
This will be one of the folders from:
It is the files in this folder that should be modified to create the new skin.
Once the Skin has been copied to the \custom\skins folder the files in the skin folder can be customized.
The files associated to a skin that are typically customized include:
File | Description |
---|---|
bg.png | Background image. (Not all skins require this file) |
skinImage.png | A thumbnail view of the skin for display on the \setup skins page. |
Header and Banner image files | The images to use for any required header and banners. (Not all skins require these files) |
skin.css skin.colors.css skin.fonts.css | The cascading style sheet files to set layout, colors and fonts used for the skin. |
skinProperties.xml | Built in view style for the skin (Metro or Main) |
Modules give each of the web pages a function. The method to apply a module can be generalized as:
A module can be viewed in 3 modes:
Customizing a module is done by:
This is simply a case of running through the specification process using PWE and noting the URL and position of the module you require.
Once the module is found enter edit mode on the page and the name will be displayed in the module.
To copy a module, for customizing, follow the steps below:
This will be one of the folders from:
It is the files in this folder that should be modified to create the new skin.
Once the Module has been copied to the \custom\modules folder the files in the modules folder can be customized.
The files associated to a module that are typically customized include:
File Name | Description |
---|---|
toolbox.png | The icon used to display the module when the page is in Edit mode. |
module.xml | Stores the settings of the module. (Not all modules require this file) |
controller.cshtml | Decides what to render. Receives the settings from the module.xml file (if required). |
\views (folder) | The files in this folder decide what is displayed to the user. |
Before upgrading please take a backup of your existing DriveWorks Live theme folder.
Any modifications made to existing files can then be replicated in the new Theme structure.
The table below lists the key files that held various settings that may have been customized. The new names of the files where these settings are now held are listed adjacent to them.
File Name Prior to DriveWorks 11 | File Name From DriveWorks 11 Onwards | Notes |
---|---|---|
web.config | driveworks.config | Copy any modifications from web.config to driveworks.config for: Group Connection String (If running Live through IIS) Preview Service Location (If using 3D Preview control) |
KeepAlive.js | main.js | Copy any modifications made to the Timeout setting in the KeepAlive.js file to the ping.js file. |
TextBox.js NumericTextBox.js MeasurementTextBox.js | main.js | Copy any modifications made to the update interval settings in the ControlType.js files to the main.js file. |
*.aspx | *.cshtml | Copy any modifications made in .aspx files to the appropriate .cshtml files. |
Use the table below to determine where customizations made to existing skins are to be located for DriveWorks 11 skins.
File | Description |
---|---|
bg.png | Background image. (Not all skins require this file) |
skinImage.png | A thumbnail view of the skin for display on the \setup skins page. |
Header and Banner image files | The images to use for any required header and banners. (Not all skins require these files) |
skin.css skin.colors.css skin.fonts.css | The cascading style sheet files to set layout, colors and fonts used for the skin. |
skinProperties.xml | Built in view style for the skin (Metro or Main) |
Use the table below to determine where customizations made to existing modules are to be located for DriveWorks 11 modules.
File Name | Description |
---|---|
toolbox.png | The icon used to display the module when the page is in Edit mode. |
module.xml | Stores the settings of the module. (Not all modules require this file) |
controller.cshtml | Decides what to render. Receives the settings from the module.xml file (if required). |
\views (folder) | The files in this folder decide what is displayed to the user. |
See Also