aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-06-23 16:32:38 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-06-24 10:21:27 +0000
commit351cb8a028e767c6e3bbdc817572a4831bf556f5 (patch)
treebc6dd3785a439c6715c84c220f3dae4a02793739 /doc/qtcreator
parent27d4f4b6631f2310a47c3681107680b22fccb0b0 (diff)
Doc: Describe help filtering from Qt 5.15
Fixes: QTCREATORBUG-24239 Change-Id: Ib91b6ea8df7d3724956d6cad932a0b6d6f9bf1bc Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Diffstat (limited to 'doc/qtcreator')
-rw-r--r--doc/qtcreator/images/qtcreator-help-filter-attributes.pngbin15403 -> 14441 bytes
-rw-r--r--doc/qtcreator/images/qtcreator-help-filters.pngbin63108 -> 62391 bytes
-rw-r--r--doc/qtcreator/src/howto/creator-help.qdoc34
3 files changed, 20 insertions, 14 deletions
diff --git a/doc/qtcreator/images/qtcreator-help-filter-attributes.png b/doc/qtcreator/images/qtcreator-help-filter-attributes.png
index 9c290d9dd0..4720c94540 100644
--- a/doc/qtcreator/images/qtcreator-help-filter-attributes.png
+++ b/doc/qtcreator/images/qtcreator-help-filter-attributes.png
Binary files differ
diff --git a/doc/qtcreator/images/qtcreator-help-filters.png b/doc/qtcreator/images/qtcreator-help-filters.png
index 2763f736c8..73af52f158 100644
--- a/doc/qtcreator/images/qtcreator-help-filters.png
+++ b/doc/qtcreator/images/qtcreator-help-filters.png
Binary files differ
diff --git a/doc/qtcreator/src/howto/creator-help.qdoc b/doc/qtcreator/src/howto/creator-help.qdoc
index 90e007ceeb..1ed5404866 100644
--- a/doc/qtcreator/src/howto/creator-help.qdoc
+++ b/doc/qtcreator/src/howto/creator-help.qdoc
@@ -261,28 +261,32 @@
contents of the \uicontrol Index and \uicontrol Contents
view in the sidebar change accordingly.
- \image qtcreator-help-filters.png "Help filters"
+ \image qtcreator-help-filters.png "Filters field on the Help mode toolbar"
- You can modify the filters to include external documentation, for example,
- or you can define your own filters. To construct filters, you can use the
- filter attributes that are specified in the documentation. Each document
- contains at least one filter attribute. If several documents contain the
- same filter attribute, such as \c tools, you can use that attribute to
- include all those documents.
+ You can define your own filters to display documentation for a set of
+ Qt modules and versions.
To add filters:
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Help >
- \uicontrol Filters > \uicontrol Add.
+ \uicontrol Filters.
- \li Enter a name for the filter and press \uicontrol {OK}.
+ \image qtcreator-help-filter-attributes.png "Filters tab in Help options"
- \li In \uicontrol Attributes, select the documents that you want to include
+ \li Select \inlineimage plus.png
+ to add a new filter in the \uicontrol {Add Filter} dialog.
+
+ \li In the \uicontrol {Filter name} field, enter a name for the filter,
+ and then select \uicontrol {OK} to return to the \uicontrol Filters
+ tab.
+
+ \li In the \uicontrol Components field, select the Qt modules to include
in the filter.
- \image qtcreator-help-filter-attributes.png "Help filter attributes"
+ \li In the \uicontrol Versions field, select the Qt versions to include
+ in the filter.
\li Click \uicontrol OK.
@@ -291,9 +295,11 @@
\endlist
- To modify filters, select a filter in \uicontrol Filters, select the attributes,
- and then click \uicontrol Apply.
+ To modify the selected filter, add and remove Qt modules and versions, and
+ then select \uicontrol Apply.
- To remove filters, select them in \uicontrol Filters, and click \uicontrol Remove.
+ To rename the selected filter, select \uicontrol Rename.
+ To remove the selected filter select \inlineimage minus.png
+ .
*/