diff options
Diffstat (limited to 'examples/helpdemo/doc/index.html')
| -rw-r--r-- | examples/helpdemo/doc/index.html | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/examples/helpdemo/doc/index.html b/examples/helpdemo/doc/index.html new file mode 100644 index 000000000..9f1fb212c --- /dev/null +++ b/examples/helpdemo/doc/index.html @@ -0,0 +1,41 @@ +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Help example</title> + </head> + <body style="font-size:12pt;font-family:helvetica"> + <p><h2>Help example</h2></p> + + <p> + This example demonstrates how to use TQt Assistant as help system + for your own application. You can control TQt Assistant either directly + using e.g. the open button or indirectly by pressing F1. + </p> + + <p> + This example provides a context sensitive help, i.e. pressing F1 will + show the help for the item under the mouse cursor. + </p> + + <p> + In order to run TQt Assistant as a custom help tool for this + application properly you have to specify a profile. A profile + is a file format similar to the documentation content files + that assistant used up to TQt 3.1. Once such a profile has been + specified TQt Assistant can be run with the option <code>-profile</code> + and then the filename of the profile. The HelpDemo example does + this for you if you press the <i>Run TQt Assistant customized for + HelpDemo</i>. + </p> + + <p> + TQt Assistant can also display arbitrary pages with the + <i>Display</i> button or using the context help (F1), but TQt + Assistant won't be customized for this example application. + </p> + + <ul> + <li><a href="manual.html">How to use this example</a></li> + </ul> + </body> +</html> |