summaryrefslogtreecommitdiffstats
path: root/examples/helpdemo/doc/index.html
blob: 7b68152823958d2e7ef4525834cff734f049ea00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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 Qt Assistant as help system
	for your own application. You can control Qt 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 Qt 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 Qt 3.1. Once such a profile has been
	specified Qt 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 Qt Assistant customized for
	HelpDemo</i>. 
	</p>

	<p>	
	Qt Assistant can also display arbitrary pages with the
	<i>Display</i> button or using the context help (F1), but Qt
	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>