Using the Help
This help is designed as a responsive HTML5 system. The display is adjusted automatically depending on the device and/or screen orientation. Therefore, on smaller devices such as smart phones, users will see a condensed look that is more appropriate for those devices compared with larger devices such as tablets, particularly when the screen orientation is landscape.
Screenshots are provided in this Help section to illustrate concepts and layouts. They have been taken from development snapshot builds of the software (the title bar may therefore slightly differ from the one of your released version) and may not always correspond to your particular software product.
This help was launched from the Innovyze help website but help can also be accessed from InfoWorks ICM by:
- Choosing the Help topics option from the Help menu
- Pressing the F1 key at any time to launch the help topic appropriate for that part of the interface
Viewing Help
The help interface consists of:
- Topic Pane - where the help topics are viewed.
- Navigation Pane- which contains a number of tabs that aid you with finding your way round the help file.
- Search facility - under the form of a Search field. Users can search for all instances of a word or phrase that occur in the help system.
- Toolbar - located above the Topic Pane. Contains useful tools allowing the user to navigate within the help, such as an Expand all button, which shows all the hidden images and information in a topic (and subsequently hides them again).
There are two tabs on the Navigation Pane that help you find your way around the help.
- Contents - Table of Contents defining the help system structure. See Using the Table of Contents.
- Index - Allows you to search for information using keywords or phrases. See Using the Index.
You can also find related information by following the hyperlinks embedded in individual help topics.
Some graphics in the help file are selectable. Tapping on various areas of the image will show additional information in a popup window, or another topic. All selectable graphics are clearly marked.
The help is structured in a logical way with step-by-step instructions and background information, usually (but not always) stored in the same section. See Structure of Help.
In many cases, images (and sometimes additional information) are kept hidden so only the important points are visible when you open a topic. The hidden information is displayed when you tap a button. See Hidden Images and Information.
Typographic conventions are used to make the information easier to follow.
General Help Options
This section describes help options that are generally available in most help systems.
You can:
- Find topics you want using the Table of Contents, the Index, and the Full-Text Search facilities.
- Adjust the layout of the help window, change the font size, and hide the Navigation Pane completely.
- Access useful commands from popup menus.
Here are some tips on how to find more information when using the help:
- To link to another topic or access a Web page, click the words coloured in blue.
- Press on the Contents Tab or Topic Pane for popup menu commands.
Searching the help
You can search for all instances of a word or phrase that occur in the help system using the Search field. You can create some complex searches using boolean operators and other tools. See the Searching the Help topic and all the topics in that section for more information.
Innovyze Help systems
The help system includes links back to Innovyze, so you can access the website or make comments and suggestions to the Support Team. There may also be links to other help systems and various useful sources of information around the world wide web.
There is sometimes a long gap between releases of Innovyze products. When this occurs, we intend to make updates to the Help system available between software releases.
Updated help files are regularly available for download from the Innovyze web site. You may optionally request help files by e-mail, but please bear in mind that these help files can be very large.
If you have specific requests for additional information not currently covered in help, do not hesitate to get in touch by contacting the Innovyze Support Team. These will be added to the list of improvements needed for the help system and will appear in a future update.