Introduction to HyperWorks

Setting up Help on Linux or Windows

Setting up Help on Linux or Windows

Previous topic Next topic No expanding text in this topic  

Setting up Help on Linux or Windows

Previous topic Next topic JavaScript is required for expanding text JavaScript is required for the print function  

The HyperWorks help system is a browser-based HTML help system. It can be installed with applications or installed alone on a server. Help can be installed via different ways:

Installed on a local machine along with the HyperWorks software.
Pre-installed on a shared network location
Using Altair Website help.

In order for HyperWorks help to work properly, you must set up a valid browser on the machine from where the application is launched. For Windows and Mac OS X, HyperWorks uses the default browser that is set. For Linux, the valid browser is set during the installation time using the path to the browser, for example “/usr/bin/firefox/”.  You can verify the browser setting which is stored in the hwhelp.cfg file.  The hwhelp.cfg file is located in the <installation directory>/altair/ directory path

If Help is pre-installed on a shared network location, the information will be stored in the hwhelp.cfg file as well.  A typical hwhelp.cfg file should contain the following information:

HW_MSG_HELP "<install_Dir>/altair/help"

HW_MSG_BROWSER "/usr/bin/firefox"  

If HW_MSG_HELP is not set in the hwhelp.cfg file, the HyperWorks application will default and try to connect to the Altair Website help automatically. UNC paths are supported for Windows networked paths.

 

Note:The help server on Linux platforms does not support tilde (~) completion of paths.  Please make sure that you use the full path for the items HW_MSG_HELP and HW_MSG_BROWSER if you set them as environment variables or in hwhelp.cfg. (for example, use /path/to/help_user/my_help instead of ~help_user/my_help.