The context sensitive help is implemented in CrysMAS based on Qt Assistant browser and uses the HTML version of the User Manual.
The help can be triggered in several ways:
from Help menu: two items are opening the help browser - Help Contents menu which opens the starting page of the user manual, and FAQs menu which opens the Frequently asked questions section from the manual.
Additionally, the Release Notes menu opens a window showing the changes made during program development.
from any Dialog window: clicking on
button opens the help for dialog.
pressing F1 key : opens the starting page of the help, if the main window has focus, or opens the help for the dialog, if a dialog has focus.
First time the user triggers the help, the program is looking for browser application - assistant(.exe) program - and initializes it. If the initialization was successful, the browser window opens showing the help page. Otherwise, either the browser or the user manual was not found and you have to set the valid location:
Select File > Preferences.
The Preferences dialog opens.
Select Paths tab.
Check or set the User manual path.
The on-line user manual (*.html files) is installed, by default, in CrysMAS's Doc/Manual subdirectory. If not, specify the actual Manual directory or select it using
button.
Check or set the Help browser.
The help pages are shown by QtAssistant application coming with CrysMAS software. The program is installed, by default, in CrysMAS's directory. If not, select the assistant(.exe) file using
button.
Save changes clicking Apply button.
The help system is activated and you can press F1 key or click on
button.
