You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+8-4
Original file line number
Diff line number
Diff line change
@@ -43,18 +43,22 @@ Steps performed to build the available packages:
43
43
44
44
- Wait some time (it was about 1 min in my case) and check the **qch-proj.xml** file in the site root. It has the **Qt Help project** data needed to generate the **.qch** file. It should contain **<keywords>** section which will go the the **Index** panel of the **Qt Assistant** tool with relative links to the pages for each keyword. And **<files>** section with all the files (HTML pages and resources) that will be packed to the help file.
45
45
46
-
- Generate he**.qch** file with Qt running the command:
46
+
- Generate the**.qch** file with Qt running the command:
- To check the final file open **Qt Assistant** from the **[QT_HOME]\bin\assistant.exe**
52
+
## Load **QCH** in **Qt Assistant**
53
+
54
+
- First open **Qt Assistant** from the **[QT_HOME]\bin\assistant.exe**
53
55
54
56
- Navigate to the **Edit -> Preferences** menu, **Documentation** tab and **Add** the file to the list.
55
57
56
-
- After that you should see the **Standard C++ Library reference** entry in the **Content** panel. Click there and navigate the reference. The **Index** panel can be used to search for the most important keywords and the tool also allows to **Search** the content of all the pages.
58
+
- After that you should see the **Standard C++ Library reference** entry in the **Content** panel (or **cplusplus.com** menu in the case of full site). Click there and navigate the reference. The **Index** panel can be used to search for the most important keywords and the tool also allows to **Search** the content of all the pages.
57
59
58
60
## Notes
59
61
60
-
I didn't add **Table of contents** to the **.qch** file because the site itself has already its navigation panel.
62
+
I didn't add full **Table of contents** to the **.qch** file because the site itself has already its navigation panel.
63
+
64
+
If you want to regenerate **Qt help** files you may use prebuilt project files: **qch-proj-cpp-ref.xml** and **qch-proj-cpp-full.xml** inside the **_site** packages in the releases. Run the `qhelpgenerator` command mentioned above to get the **.qch** help file.
0 commit comments