Customizing Help
This ability only applies to on-premise users.
On-premise users can customize the online help content to accommodate their specific needs.
The online help is composed of HTML (.htm) files, among other types (.js, .xml). We recommend that you only modify the HTML files, as changing other files could break the help system. It is alright to add your own images.
|
HTML knowledge and experience is strongly recommended. Only on-premise users can customize the help. |
Online Help File Structure
The help topics are located in the following folders:
- Content: Contains the online help HTM files. These can be changed as needed.
- Configure: Contains topics in the Configure Application help section.
- generatedimages: Contains the QR image from the home page.
- Interface: Contains topics in the Heat Interface help section.
- Overview: Contains topics in the Understanding HEAT help section.
- Reference: Contains topics in the Reference help section.
- SelfService: Contains topics in the Self Service help section.
- ServiceDesk: Contains topics in the Service Desk help section.
- Resources:
- GLOBAL_Images, Images: Contain the images used in the online help. You can replace these as needed.
- MasterPages: Do not modify anything in this directory.
PageLayouts: Do not modify anything in this directory.
- Snippets: Do not modify anything in this directory.
Stylesheets: The stylesheet used is called frs_styles.css. You can add your styles to this file.
- TableStyles: Do not modify anything in this directory.
- Videos: Contains videos created for specific procedures. You can replace them with your own videos.
- Data: Contains the search index, the CSH alias files, and other needed files. Do not modify anything in this directory.
- Resources: Contains the scripts used to run the help system. Do not modify anything in this directory.
- Skins: Contains the skin options used in the help system. Do not modify anything in this directory.
Modifying the Online Help
|
Before you begin, MAKE A COPY of the online help files. Failure to do so could cause data loss. |
| 1. | Within an HTML or text editor (such as Dreamweave, CoffeeCup, or Notepad), open the file to change. |
| 2. | Modify the files as needed. Only modify files between the <body></body> tags. |
| 3. | Make a copy of your files and click Save. |
- Each time that you update to a new release of HEAT, the online help files are replaced. Keep a copy of your work in a separate location. After you have updated your system, you can replace the default online help with your saved customized online help files.
- Use a file comparison tool (such as FreeFileSync or ExamDiff) to locate new help topics.