forked from qt-creator/qt-creator
Doc: Describe help filtering from Qt 5.15
Fixes: QTCREATORBUG-24239 Change-Id: Ib91b6ea8df7d3724956d6cad932a0b6d6f9bf1bc Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
This commit is contained in:
Binary file not shown.
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 14 KiB |
Binary file not shown.
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 61 KiB |
@@ -261,28 +261,32 @@
|
|||||||
contents of the \uicontrol Index and \uicontrol Contents
|
contents of the \uicontrol Index and \uicontrol Contents
|
||||||
view in the sidebar change accordingly.
|
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,
|
You can define your own filters to display documentation for a set of
|
||||||
or you can define your own filters. To construct filters, you can use the
|
Qt modules and versions.
|
||||||
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.
|
|
||||||
|
|
||||||
To add filters:
|
To add filters:
|
||||||
|
|
||||||
\list 1
|
\list 1
|
||||||
|
|
||||||
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Help >
|
\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.
|
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.
|
\li Click \uicontrol OK.
|
||||||
|
|
||||||
@@ -291,9 +295,11 @@
|
|||||||
|
|
||||||
\endlist
|
\endlist
|
||||||
|
|
||||||
To modify filters, select a filter in \uicontrol Filters, select the attributes,
|
To modify the selected filter, add and remove Qt modules and versions, and
|
||||||
and then click \uicontrol Apply.
|
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
|
||||||
|
.
|
||||||
*/
|
*/
|
||||||
|
Reference in New Issue
Block a user