Commit d4f66be7 authored by Jerome Pasion's avatar Jerome Pasion Committed by The Qt Project
Browse files

Doc: Edited Qt Help page and clarified .qhp file location.


-replaced "html" with "HTML"
-noted that the .qhp files are in the HTML directories

Task-number: QTBUG-29576
Change-Id: I0ba1c9534d730648c25dcdf15fcb1448fa9eb8fc
Reviewed-by: default avatarLeena Miettinen <riitta-leena.miettinen@digia.com>
parent 7598c224
dev 5.10 5.11 5.12 5.12.1 5.12.10 5.12.11 5.12.12 5.12.2 5.12.3 5.12.4 5.12.5 5.12.6 5.12.7 5.12.8 5.12.9 5.13 5.13.0 5.13.1 5.13.2 5.14 5.14.0 5.14.1 5.14.2 5.15 5.15.0 5.15.1 5.15.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.9.8 6.0 6.0.0 6.1 6.1.0 6.1.1 6.1.2 6.1.3 6.2 6.2.0 6.2.1 6.2.2 old/5.0 old/5.1 old/5.2 wip/cmake wip/winrt v5.15.0-alpha1 v5.14.1 v5.14.0 v5.14.0-rc2 v5.14.0-rc1 v5.14.0-beta3 v5.14.0-beta2 v5.14.0-beta1 v5.14.0-alpha1 v5.13.2 v5.13.1 v5.13.0 v5.13.0-rc3 v5.13.0-rc2 v5.13.0-rc1 v5.13.0-beta4 v5.13.0-beta3 v5.13.0-beta2 v5.13.0-beta1 v5.13.0-alpha1 v5.12.7 v5.12.6 v5.12.5 v5.12.4 v5.12.3 v5.12.2 v5.12.1 v5.12.0 v5.12.0-rc2 v5.12.0-rc1 v5.12.0-beta4 v5.12.0-beta3 v5.12.0-beta2 v5.12.0-beta1 v5.12.0-alpha1 v5.11.3 v5.11.2 v5.11.1 v5.11.0 v5.11.0-rc2 v5.11.0-rc1 v5.11.0-beta4 v5.11.0-beta3 v5.11.0-beta2 v5.11.0-beta1 v5.11.0-alpha1 v5.10.1 v5.10.0 v5.10.0-rc3 v5.10.0-rc2 v5.10.0-rc1 v5.10.0-beta4 v5.10.0-beta3 v5.10.0-beta2 v5.10.0-beta1 v5.10.0-alpha1 v5.9.9 v5.9.8 v5.9.7 v5.9.6 v5.9.5 v5.9.4 v5.9.3 v5.9.2 v5.9.1 v5.9.0 v5.9.0-rc2 v5.9.0-rc1 v5.9.0-beta4 v5.9.0-beta3 v5.9.0-beta2 v5.9.0-beta1 v5.9.0-alpha1 v5.8.0 v5.8.0-rc1 v5.8.0-beta1 v5.8.0-alpha1 v5.7.1 v5.7.0 v5.7.0-rc1 v5.7.0-beta1 v5.7.0-alpha1 v5.6.3 v5.6.2 v5.6.1 v5.6.1-1 v5.6.0 v5.6.0-rc1 v5.6.0-beta1 v5.6.0-alpha1 v5.5.1 v5.5.0 v5.5.0-rc1 v5.5.0-beta1 v5.5.0-alpha1 v5.4.2 v5.4.1 v5.4.0 v5.4.0-rc1 v5.4.0-beta1 v5.4.0-alpha1 v5.3.2 v5.3.1 v5.3.0 v5.3.0-rc1 v5.3.0-beta1 v5.3.0-alpha1 v5.2.1 v5.2.0 v5.2.0-rc1 v5.2.0-beta1 v5.2.0-alpha1 v5.1.1 v5.1.0 v5.1.0-rc2 v5.1.0-rc1 v5.1.0-beta1 v5.1.0-alpha1 v5.0.2
No related merge requests found
Showing with 12 additions and 10 deletions
......@@ -64,7 +64,7 @@
help into Qt applications.
The actual help data, meaning the table of contents, index
keywords or html documents, is contained in Qt compressed help
keywords or HTML documents, is contained in Qt compressed help
files. So, one such a help file represents usually one manual
or documentation set. Since most products are more comprehensive
and consist of a number of tools, one manual is rarely enough.
......@@ -85,7 +85,7 @@
generation of the compressed help file.
As already mentioned, the Qt compressed help file contains all
data, so there is no need any longer to ship all single html
data, so there is no need any longer to ship all single HTML
files. Instead, only the compressed help file and optionally the
collection file has to be distributed. The collection file is
optional since any existing collection file, e.g. from an older
......@@ -134,21 +134,23 @@
\section1 Generating Qt Help
Building help files for the Qt help system assumes that the html
documentation files already exist, i.e. the Qt help system does
not offer the possibility to create html files like e.g. Doxygen.
Building help files for the Qt help system assumes that the HTML
documentation files already exist.
Once the html documentents are in place, a \l {Qt Help Project} file
has to be created. After specifying all relevant information in
this file, it needs to be compiled by calling:
Once the HTML documents are in place, a \l {Qt Help Project} file, with
an extension of \c .qhp, has to be created. After specifying all relevant
information in this file, it needs to be compiled by calling:
\snippet doc_src_qthelp.qdoc 2
\snippet doc/src/snippets/code/doc_src_qthelp.qdoc 2
The file 'doc.qch' contains then all html files in compressed
The file 'doc.qch' contains then all HTML files in compressed
form along with the table of contents and index keywords. To
test if the generated file is correct, open Qt Assistant and
install the file via the Settings|Documentation page.
For the standard Qt source build, the .qhp file is generated and placed
in the same directory as the HTML pages.
\target Qt Help Collection Project
\section2 Creating a Qt Help Collection
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment