feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Describe selecting the help viewer backend

Browse Source 
You can switch the help viewer backend if you have issues
with the current one.

Change-Id: I0b0697980259a4d14b6e694faff0afed14040556
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2020-04-14 15:04:26 +02:00
parent 3f513799b4
commit d973823dbb
1 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
doc/qtcreator/src/howto/creator-help.qdoc
View File

@@ -76,6 +76,25 @@
To switch to the editor context when you close the last help page, select 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. the \uicontrol {Return to editor on closing the last page} check box.
\section1 Selecting the Help Viewer Backend
The help viewer backend determines the style sheet that is used to display
the help files. A help viewer backend that is based on the \l {QTextBrowser}
is used by default. However, it has several issues that have been fixed when
using litehtml as the help viewer backend.
On \macos, you can also use a help viewer backend that is based on the
system WebView component.
To switch the help viewer backend:
\list 1
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Help >
\uicontrol General.
\li In the \uicontrol {Viewer backend} field, select a viewer backend.
\li Reload the help page to take the new backend to use.
\endlist
\section1 Viewing Function Tooltips \section1 Viewing Function Tooltips
To hide function tooltips by default, select \uicontrol Tools > To hide function tooltips by default, select \uicontrol Tools >