Structure of Help
This topic describes some of the basic elements of Innovyze help systems. The structure of the system is effectively defined by the Table of Contents (also called Contents), although you are not constrained by this structure when navigating through information.
You can jump about the help file using the various navigation methods on the Navigation Pane, or by following hyperlinks in the help topics themselves.
Each help topic contains a list of hyperlinks at the end of the topic. These are in the Related Topics section and are links to other related topics that may be located anywhere in the help system.
Structure Description
Help is divided into a number of top level sections. Each section is represented by a top level book or folder. Most sections are then further sub-divided into the various functional areas.
Some of the main top level sections mentioned below may not apply to your individual Help System.
Main top level sections may be:
- Welcome - provides a general overview of the application, with information on installing the product and details of new features at each release.
- Using this Help - the section this topic belongs to. It is a comprehensive reference describing how to use an HTML Help system, and the Innovyze help system in particular.
- Tour of the Workspace - dedicated to the InfoWorks WS Pro user interface, this section contains topics describing in detail the application workspace (windows, views, panes, toolbars) and explaining what each interface element is used for, so you can rapidly find your way around InfoWorks WS Pro.
- Data Management - is composed of help topics relating to data management in InfoWorks WS Pro and provides a number of best practices for setting up local and remote roots, backing up your data and transferring data between databases.
- Database Items - contains information about the items that can be found inside the InfoWorks WS Pro Master Database.There is one or more topics for each database item type, detailing how to create and manage each type.
- Useful Internet Sites - a list of links to potentially useful Internet sites. You can open these sites within the HTML Help Viewer, or copy the address into your normal web browser.
- References - all the references used within the help topics are also listed here.
There may be some additional individual topics that reside at the top level of the help system. These provide general information and contact details for Innovyze. These can be:
- Feedback - more complex applications have an e-mail address for sending feedback about any aspect of the software or help system
- Contacting Innovyze - contact details for the Support Team
- Innovyze web site - another place where you can access the web site
- Glossary - this contains glossary definitions.
