Doc: Update info about using Help
Change-Id: I23085fbaa9af3ecc20e45a2bbaafd6ce602abc4a Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 64 KiB |
Before Width: | Height: | Size: 6.9 KiB After Width: | Height: | Size: 7.8 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 62 KiB |
BIN
doc/images/qtcreator-help-options.png
Normal file
After Width: | Height: | Size: 15 KiB |
Before Width: | Height: | Size: 64 KiB After Width: | Height: | Size: 36 KiB |
@@ -1,6 +1,6 @@
|
|||||||
/****************************************************************************
|
/****************************************************************************
|
||||||
**
|
**
|
||||||
** Copyright (C) 2018 The Qt Company Ltd.
|
** Copyright (C) 2019 The Qt Company Ltd.
|
||||||
** Contact: https://www.qt.io/licensing/
|
** Contact: https://www.qt.io/licensing/
|
||||||
**
|
**
|
||||||
** This file is part of the Qt Creator documentation.
|
** 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
|
\contentspage index.html
|
||||||
\page creator-help.html
|
\page creator-help.html
|
||||||
@@ -62,7 +56,6 @@
|
|||||||
|
|
||||||
\li To select and configure how the documentation is displayed in the
|
\li To select and configure how the documentation is displayed in the
|
||||||
\uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help.
|
\uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help.
|
||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
The following image displays the context sensitive help in the \uicontrol Edit
|
The following image displays the context sensitive help in the \uicontrol Edit
|
||||||
@@ -70,6 +63,19 @@
|
|||||||
|
|
||||||
\image qtcreator-context-sensitive-help.png
|
\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
|
\section1 Viewing Function Tooltips
|
||||||
|
|
||||||
To hide function tooltips by default, select \uicontrol {Tools > Options >
|
To hide function tooltips by default, select \uicontrol {Tools > Options >
|
||||||
@@ -127,17 +133,19 @@
|
|||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
To import and export bookmarks, select \uicontrol {Tools > Options > Help >
|
To import and export bookmarks, select \uicontrol Tools > \uicontrol Options
|
||||||
General Settings > Import} or \uicontrol Export.
|
> \uicontrol Help > \uicontrol General > \uicontrol {Import Bookmarks} or
|
||||||
|
\uicontrol {Export Bookmarks}.
|
||||||
|
|
||||||
\section2 Full-text Search
|
\section2 Full-text Search
|
||||||
|
|
||||||
In the \uicontrol Search pane, you can use full-text search for finding a
|
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}
|
particular word in all the installed documents. Enter the term you are
|
||||||
field, enter the term you are looking for, and select the \uicontrol Search
|
looking for, and select the \uicontrol Search button. All documents that
|
||||||
button. All documents that contain the specified term are listed. The list
|
contain the specified term are listed. The list is sorted by document
|
||||||
is sorted by the number of search hits that the documents contain. Select a
|
version (if you have installed several Qt versions, for example) and
|
||||||
document in the list to open it.
|
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"
|
\image qtcreator-help-search.png "Search pane"
|
||||||
|
|
||||||
@@ -159,12 +167,6 @@
|
|||||||
|
|
||||||
\endlist
|
\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
|
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,
|
time when you open the \uicontrol Search pane. If you add or remove documents,
|
||||||
\QC recreates the index.
|
\QC recreates the index.
|
||||||
|