summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2019-06-04 17:09:30 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2019-06-17 08:02:03 +0000
commit4ffa0e9ef9448e1dd309cdc8d75d673433b5a87c (patch)
treefef879592c6806233e0be4a29660f332a2f2d0b0
parent12b6242f43c531f6cb0a08fea575a9b7d0cb080e (diff)
downloadqt-creator-4ffa0e9ef9448e1dd309cdc8d75d673433b5a87c.tar.gz
Doc: Update info about using Help
Change-Id: I23085fbaa9af3ecc20e45a2bbaafd6ce602abc4a Reviewed-by: Eike Ziller <eike.ziller@qt.io>
-rw-r--r--doc/images/qtcreator-context-sensitive-help.pngbin57447 -> 65139 bytes
-rw-r--r--doc/images/qtcreator-help-add-bookmark-dlg.pngbin7064 -> 7964 bytes
-rw-r--r--doc/images/qtcreator-help-filter-attributes.pngbin23049 -> 15403 bytes
-rw-r--r--doc/images/qtcreator-help-filters.pngbin48998 -> 63108 bytes
-rw-r--r--doc/images/qtcreator-help-options.pngbin0 -> 14951 bytes
-rw-r--r--doc/images/qtcreator-help-search.pngbin65662 -> 36520 bytes
-rw-r--r--doc/src/howto/creator-help.qdoc44
7 files changed, 23 insertions, 21 deletions
diff --git a/doc/images/qtcreator-context-sensitive-help.png b/doc/images/qtcreator-context-sensitive-help.png
index d26b14469d..fb5720bb4a 100644
--- a/doc/images/qtcreator-context-sensitive-help.png
+++ b/doc/images/qtcreator-context-sensitive-help.png
Binary files differ
diff --git a/doc/images/qtcreator-help-add-bookmark-dlg.png b/doc/images/qtcreator-help-add-bookmark-dlg.png
index 998060a81f..bec770fe98 100644
--- a/doc/images/qtcreator-help-add-bookmark-dlg.png
+++ b/doc/images/qtcreator-help-add-bookmark-dlg.png
Binary files differ
diff --git a/doc/images/qtcreator-help-filter-attributes.png b/doc/images/qtcreator-help-filter-attributes.png
index 2ca849a600..9c290d9dd0 100644
--- a/doc/images/qtcreator-help-filter-attributes.png
+++ b/doc/images/qtcreator-help-filter-attributes.png
Binary files differ
diff --git a/doc/images/qtcreator-help-filters.png b/doc/images/qtcreator-help-filters.png
index 38fd932e9a..2763f736c8 100644
--- a/doc/images/qtcreator-help-filters.png
+++ b/doc/images/qtcreator-help-filters.png
Binary files differ
diff --git a/doc/images/qtcreator-help-options.png b/doc/images/qtcreator-help-options.png
new file mode 100644
index 0000000000..63c34700b5
--- /dev/null
+++ b/doc/images/qtcreator-help-options.png
Binary files differ
diff --git a/doc/images/qtcreator-help-search.png b/doc/images/qtcreator-help-search.png
index 14ece95700..ca29bd6593 100644
--- a/doc/images/qtcreator-help-search.png
+++ b/doc/images/qtcreator-help-search.png
Binary files differ
diff --git a/doc/src/howto/creator-help.qdoc b/doc/src/howto/creator-help.qdoc
index 51bf69b810..7d8e7908bc 100644
--- a/doc/src/howto/creator-help.qdoc
+++ b/doc/src/howto/creator-help.qdoc
@@ -1,6 +1,6 @@
/****************************************************************************
**
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -23,12 +23,6 @@
**
****************************************************************************/
-// **********************************************************************
-// NOTE: the sections are not ordered by their logical order to avoid
-// reshuffling the file each time the index order changes (i.e., often).
-// Run the fixnavi.pl script to adjust the links to the index order.
-// **********************************************************************
-
/*!
\contentspage index.html
\page creator-help.html
@@ -62,7 +56,6 @@
\li To select and configure how the documentation is displayed in the
\uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help.
-
\endlist
The following image displays the context sensitive help in the \uicontrol Edit
@@ -70,6 +63,19 @@
\image qtcreator-context-sensitive-help.png
+ If the help HTML file does not use a style sheet, you can change the font
+ family, style, and size in \uicontrol Tools > \uicontrol Options >
+ \uicontrol Help > \uicontrol General.
+
+ \image qtcreator-help-options.png
+
+ By default, you can use the mouse scroll wheel to zoom help pages. To
+ disable this feature, deselect the \uicontrol {Enable scroll wheel zooming}
+ check box.
+
+ To switch to the editor context when you close the last help page, select
+ the \uicontrol {Return to editor on closing the last page} check box.
+
\section1 Viewing Function Tooltips
To hide function tooltips by default, select \uicontrol {Tools > Options >
@@ -127,17 +133,19 @@
\endlist
- To import and export bookmarks, select \uicontrol {Tools > Options > Help >
- General Settings > Import} or \uicontrol Export.
+ To import and export bookmarks, select \uicontrol Tools > \uicontrol Options
+ > \uicontrol Help > \uicontrol General > \uicontrol {Import Bookmarks} or
+ \uicontrol {Export Bookmarks}.
\section2 Full-text Search
In the \uicontrol Search pane, you can use full-text search for finding a
- particular word in all the installed documents. In the \uicontrol {Search for}
- field, enter the term you are looking for, and select the \uicontrol Search
- button. All documents that contain the specified term are listed. The list
- is sorted by the number of search hits that the documents contain. Select a
- document in the list to open it.
+ particular word in all the installed documents. Enter the term you are
+ looking for, and select the \uicontrol Search button. All documents that
+ contain the specified term are listed. The list is sorted by document
+ version (if you have installed several Qt versions, for example) and
+ the number of search hits that the documents contain. Select a document in
+ the list to open it.
\image qtcreator-help-search.png "Search pane"
@@ -159,12 +167,6 @@
\endlist
- For more flexibility, use the \uicontrol {Advanced search}. Specify words to
- exclude from the search hits, or search for an exact phrase or for similar
- words. For example, searching for \c{QStin}, \c{QSting}, or \c{QStrin} lists
- all the documents with titles that are similar, such as \c{QString}.
- Combine options to improve the search results.
-
Full-text search is based on indexing all the installed documents the first
time when you open the \uicontrol Search pane. If you add or remove documents,
\QC recreates the index.