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

Doc: Update topics about reading documentation

Browse Source 
- Describe the Open Online Documentation option
- Edit the style
- Use How To: Read Documentation as \sa for all topics in the group

Task-number: QTCREATORBUG-30604
Change-Id: I7219ef9a38e993fc1387dd0ece9c8dfe762387d1
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2024-06-20 12:09:50 +02:00
parent 3babe8c73c
commit b4ece2e056
2 changed files with 84 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
View File

@@ -120,11 +120,14 @@
tooltips tooltips
\li Selecting any of the above elements and pressing \key F1 to show \li Selecting any of the above elements and pressing \key F1 to show
its documentation its documentation
\li Switching to the Help mode \li Switching to the \uicontrol Help mode
\endlist \endlist
\sa {Build with CMake}{How To: Build with CMake}, {CMake}, To view the documentation online, open it in the \uicontrol Help mode and
{Read Documentation}{How To: Read Documentation} select \inlineimage icons/online.png (\uicontrol {Open Online Documentation}).
\sa {Build with CMake}{How To: Build with CMake},
{Read Documentation}{How To: Read Documentation}, {CMake}
*/ */
/*! /*!

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

@@ -23,23 +23,23 @@
\li To view context sensitive help on a Qt class or function as a \li To view context sensitive help on a Qt class or function as a
tooltip, move the mouse cursor over the class or function. If help tooltip, move the mouse cursor over the class or function. If help
is not available, the tooltip displays type information for the is not available, the tooltip shows type information for the
symbol. symbol.
\li To display tooltips for function signatures regardless of the \li To show tooltips for function signatures regardless of the
cursor position in the function call, press \key {Ctrl+Shift+D}. cursor position in the function call, press \key {Ctrl+Shift+D}.
\li To display the full help on a Qt class or function, press \key F1 or \li To show the full help on a Qt class or function, press \key F1 or
select \uicontrol {Context Help} in the context menu. select \uicontrol {Context Help} in the context menu.
The documentation is displayed in a The documentation is shown in a
view next to the code editor, or, if there is not enough vertical view next to the code editor, or, if there is not enough vertical
space, in the fullscreen \uicontrol Help mode. space, in the fullscreen \uicontrol Help mode.
\li To select and configure how the documentation is displayed in the \li To change how the documentation is shown in the
\uicontrol Help mode, select \preferences > \uicontrol Help. \uicontrol Help mode, go to \preferences > \uicontrol Help.
\endlist \endlist
The following image displays the context sensitive help in the \uicontrol Edit The following image shows the context sensitive help in the \uicontrol Edit
mode. mode.
\image qtcreator-context-sensitive-help.png {Context-sensitive help in Edit mode} \image qtcreator-context-sensitive-help.png {Context-sensitive help in Edit mode}
@@ -52,43 +52,43 @@
\image qtcreator-preferences-help-general.webp {General tab in Help preferences} \image qtcreator-preferences-help-general.webp {General tab in Help preferences}
You can set the default zoom level in the \uicontrol Zoom field. When Set the default zoom level in \uicontrol Zoom. When viewing help pages, use
viewing help pages, you can use the mouse scroll wheel to zoom them. To the mouse scroll wheel to zoom them. To turn off this feature, clear
disable this feature, deselect the \uicontrol {Enable scroll wheel zooming} \uicontrol {Enable scroll wheel zooming}.
check box.
To disable antialiasing, deselect the \uicontrol Antialiasing check box. To turn off antialiasing, clear \uicontrol Antialias.
\section1 Return to the editor \section1 Return to the editor
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. \uicontrol {Return to editor on closing the last page}.
\section1 Select help viewer backend \section1 Select help viewer backend
The help viewer backend determines the style sheet that is used to display The help viewer backend determines the style sheet that is used to show
the help files. The default help viewer backend that is based on litehtml the help files. The default help viewer backend that is based on litehtml
is recommended for viewing Qt documentation. You can choose another help is recommended for viewing Qt documentation. You can choose another help
viewer backend in the \uicontrol {Viewer backend} field. To take the new viewer backend in the \uicontrol {Viewer backend}. To take the new
backend to use, reload the help page. backend to use, reload the help page.
\section1 View function tooltips \section1 View function tooltips
To hide function tooltips by default, select \preferences > To hide function tooltips by default:
\uicontrol {Text Editor} > \uicontrol Behavior >
\uicontrol {Show help tooltips using the mouse} > \list 1
\uicontrol {On Shift+Mouseover}. You can still view the tooltips by pressing \li Go to \preferences > \uicontrol {Text Editor} > \uicontrol Behavior.
and holding down the \key Shift key. \image qtcreator-preferences-texteditor-behavior.webp {Text Editor Behavior preferences}
\li In \uicontrol {Show help tooltips using the mouse}, select
\uicontrol {On Shift+Mouseover}.
\endlist
You can still view the tooltips by pressing and holding down the \key Shift
key.
To use a keyboard shortcut for viewing help tooltips, select To use a keyboard shortcut for viewing help tooltips, select
\uicontrol {Show help tooltips using keyboard shortcut (Alt)}. \uicontrol {Show help tooltips using keyboard shortcut (Alt)}.
\sa {Find information in Qt documentation}, {Filter documentation}, \sa {Read Documentation}{How To: Read Documentation}
{Search from documentation}
\sa {Add external documentation}, {Detach the help window},
{Filter documentation}, {Find information in Qt documentation},
{Select the help start page}
*/ */
/*! /*!
@@ -103,15 +103,18 @@
\title Find information in Qt documentation \title Find information in Qt documentation
\QC, \QSDK and other Qt deliverables have documentation \QC installer, \QOI, and other Qt deliverables install documentation as .qch
as .qch files. All the documentation is accessible in the \uicontrol Help mode. files. View the documentation in the \uicontrol Help mode. To view the
currently open document online, select \inlineimage icons/online.png
(\uicontrol {Open Online Documentation}).
By default, \QC registers only the latest available version of the By default, \QC registers only the latest available version of the
documentation for each installed Qt module. To register all installed documentation for each installed Qt module. To register all installed
documentation, select \preferences > \uicontrol Kits > documentation, go to \preferences > \uicontrol Kits >
\uicontrol {Qt Versions} > \uicontrol {Register documentation}. \uicontrol {Qt Versions} and select an option in
\uicontrol {Register documentation}.
\image qtcreator-qt-versions.png {Register documentation field in Qt Versions tab in Kit Preferences} \image qtcreator-qt-versions.png {Register documentation in Qt Versions preferences}
\section1 Help mode sidebar views \section1 Help mode sidebar views
@@ -137,7 +140,7 @@
\endlist \endlist
\sa {Add bookmarks to help pages}, {Search from documentation} \sa {Read Documentation}{How To: Read Documentation}
*/ */
/*! /*!
@@ -152,8 +155,8 @@
\title Add bookmarks to help pages \title Add bookmarks to help pages
You can add bookmarks to useful help pages to easily find them later Add bookmarks to useful help pages to easily find them later
in the \uicontrol Bookmarks view. You can either use the page title as the in the \uicontrol Bookmarks view. Either use the page title as the
bookmark or change it to any text. You can organize the bookmarks in bookmark or change it to any text. You can organize the bookmarks in
folders in the view. folders in the view.
@@ -163,21 +166,21 @@
\list 1 \list 1
\li Click the \inlineimage icons/bookmark.png \li Select \inlineimage icons/bookmark.png (\uicontrol {Add Bookmark})
(\uicontrol {Add Bookmark}) button on the toolbar. on the toolbar.
\li In the \uicontrol {Add Bookmark} dialog, click \uicontrol OK to save the \li In the \uicontrol {Add Bookmark} dialog, select \uicontrol OK to save the
page title as a bookmark in the selected folder. page title as a bookmark in the selected folder.
\endlist \endlist
\section1 Import and export bookmarks \section1 Import and export bookmarks
To import and export bookmarks, select \preferences > To import and export bookmarks, go to \preferences > \uicontrol Help >
\uicontrol Help > \uicontrol General > \uicontrol {Import Bookmarks} or \uicontrol General and select \uicontrol {Import Bookmarks} or
\uicontrol {Export Bookmarks}. \uicontrol {Export Bookmarks}.
\sa {Find information in Qt documentation} \sa {Read Documentation}{How To: Read Documentation}
*/ */
/*! /*!
@@ -192,10 +195,10 @@
\title Search from documentation \title Search from documentation
In the \uicontrol Help mode \uicontrol Search pane, you can use full-text In the \uicontrol Help mode \uicontrol Search pane, use full-text
search for finding a search for finding a
particular word in all the installed documents. Enter the term you are particular word in all the installed documents. Enter the term you are
looking for, and select the \uicontrol Search button. All documents that looking for, and select \uicontrol Search. All documents that
have the specified term are listed. The list is sorted by document have the specified term are listed. The list is sorted by document
version (if you have installed several Qt versions, for example) and version (if you have installed several Qt versions, for example) and
the number of search hits that the documents have. Select a document in the number of search hits that the documents have. Select a document in
@@ -225,16 +228,15 @@
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.
If you cannot find words that you know are there, indexing might not have If you cannot find words that you know are there, the index might not be
been completed for some reason. To regenerate the index, click complete. To recreate it, select \inlineimage icons/reload_gray.png
\inlineimage icons/reload_gray.png
(\uicontrol {Regenerate Index}). (\uicontrol {Regenerate Index}).
Punctuation is not included in indexed terms. To find terms that have Punctuation is not included in indexed terms. To find terms that have
punctuation, such as domain names, use the asterisk as a wild card. For punctuation, such as domain names, use the asterisk as a wild card. For
example, to find \c {Pastebin.Com}, enter the search term \c {Pastebin*}. example, to find \c {Pastebin.Com}, enter the search term \c {Pastebin*}.
\sa {Find information in Qt documentation} \sa {Read Documentation}{How To: Read Documentation}
*/ */
/*! /*!
@@ -249,7 +251,7 @@
\title Add external documentation \title Add external documentation
You can display external documentation in the \uicontrol Help mode. You can view external documentation in the \uicontrol Help mode.
To add documentation or replace the documentation that ships with \QC and Qt: To add documentation or replace the documentation that ships with \QC and Qt:
\list 1 \list 1
@@ -259,14 +261,14 @@
For information on how to prepare your documentation and create a For information on how to prepare your documentation and create a
.qch file, see \l{The Qt Help Framework}. .qch file, see \l{The Qt Help Framework}.
\li To add the .qch file to \QC, select \preferences > \li To add the .qch file to \QC, go to \preferences >
\uicontrol Help > \uicontrol Documentation > \uicontrol Add. \uicontrol Help > \uicontrol Documentation > \uicontrol Add.
\image qtcreator-preferences-help-documentation.webp {Documentation tab in Help Preferences} \image qtcreator-preferences-help-documentation.webp {Documentation tab in Help Preferences}
\endlist \endlist
\sa {Get help} \sa {Read Documentation}{How To: Read Documentation}
*/ */
/*! /*!
@@ -281,26 +283,24 @@
\title Detach the help window \title Detach the help window
By default, context-sensitive help is opened in a window next to the By default, context-sensitive help opens in a window next to the
code editor when you press \key F1. If there is not enough vertical code editor when you press \key F1. If there is not enough vertical
space, the help opens in the full-screen help mode. space, the help opens in the full-screen help mode.
\image qtcreator-context-sensitive-help.png {Context-sensitive help in Edit mode} \image qtcreator-context-sensitive-help.png {Context-sensitive help in Edit mode}
To specify that the help always opens in full-screen mode or To specify that the help always opens in full-screen mode or in an external
is detached to an external window, select \preferences > \uicontrol Help > window, go to \preferences > \uicontrol Help > \uicontrol General.
\uicontrol General.
\image qtcreator-preferences-help-general.webp {General tab in Help preferences} \image qtcreator-preferences-help-general.webp {General tab in Help preferences}
Set preferences for displaying context-sensitive help Set preferences for viewing context-sensitive help
in the \uicontrol {On context help} field. To detach the help window, select in \uicontrol {On context help}. To detach the help window, select
\uicontrol {Always Show in External Window}. \uicontrol {Always Show in External Window}.
To change this setting in a help view, select the \inlineimage icons/linkicon.png To change this setting in a help view, select \inlineimage icons/linkicon.png.
toolbar button.
\sa {Get help} \sa {Read Documentation}{How To: Read Documentation}
*/ */
/*! /*!
@@ -315,27 +315,27 @@
\title Select the help start page \title Select the help start page
You can select the page to display when you open the \uicontrol Help mode in the To set the page to show when you open the \uicontrol Help mode, go to
\preferences > \uicontrol Help > \uicontrol General > \preferences > \uicontrol Help > \uicontrol General and select
\uicontrol {On help start} field. \uicontrol {On help start}.
\image qtcreator-preferences-help-general.webp {General tab in Help preferences} \image qtcreator-preferences-help-general.webp {General tab in Help preferences}
\list \list
\li To display the page and help views that were open when you exited the mode, \li To show the page and help views that were open when you exited the mode,
select the \uicontrol {Show My Tabs from Last Session} option. However, Web pages select the \uicontrol {Show My Tabs from Last Session} option. However, Web pages
are not opened because loading them would slow down opening the \uicontrol Help are not opened because loading them would slow down opening the \uicontrol Help
mode. mode.
\li To display a particular page, select \uicontrol {Show My Home Page}, and specify \li To show a particular page, select \uicontrol {Show My Home Page}, and specify
the page in the \uicontrol {Home Page} field. the page in \uicontrol {Home Page}.
\li To display a blank page, select the \uicontrol {Show a Blank Page} option. You can \li To show a blank page, select the \uicontrol {Show a Blank Page} option.
also select the \uicontrol {Use Blank Page} button to set a blank page as your Select \uicontrol {Use Blank Page} to set a blank page as your
home page. home page.
\endlist \endlist
\sa {Get help} \sa {Read Documentation}{How To: Read Documentation}
*/ */
/*! /*!
@@ -350,40 +350,40 @@
\title Filter documentation \title Filter documentation
You can filter the documents displayed in the \uicontrol Help mode to find Filter the documents in the \uicontrol Help mode to find
relevant information faster. Select a filter from a list of filters. The relevant information faster. Select a filter from a list of filters. The
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 {Filters field on the Help mode toolbar} \image qtcreator-help-filters.png {Filters on the Help mode toolbar}
\section1 Add filters \section1 Add filters
You can define your own filters to display documentation for a set of Define your own filters to show documentation for a set of
Qt modules and versions. Qt modules and versions.
To add filters: To add filters:
\list 1 \list 1
\li Select \preferences > \uicontrol Help > \uicontrol Filters. \li Go to \preferences > \uicontrol Help > \uicontrol Filters.
\image qtcreator-help-filter-attributes.png {Filters tab in Help preferences} \image qtcreator-help-filter-attributes.png {Filters tab in Help preferences}
\li Select \inlineimage icons/plus.png \li Select \inlineimage icons/plus.png
to add a new filter in the \uicontrol {Add Filter} dialog. to add a new filter in the \uicontrol {Add Filter} dialog.
\li In the \uicontrol {Filter name} field, enter a name for the filter, \li In \uicontrol {Filter name}, enter a name for the filter,
and then select \uicontrol {OK} to return to the \uicontrol Filters and then select \uicontrol {OK} to return to the \uicontrol Filters
tab. tab.
\li In the \uicontrol Components field, select the Qt modules to include \li In \uicontrol Components, select the Qt modules to include
in the filter. in the filter.
\li In the \uicontrol Versions field, select the Qt versions to include \li In \uicontrol Versions, select the Qt versions to include
in the filter. in the filter.
\li Click \uicontrol OK. \li Select \uicontrol OK.
\li In the \uicontrol Help mode, select the filter in the list of \li In the \uicontrol Help mode, select the filter in the list of
filters to see the filtered documentation in the sidebar. filters to see the filtered documentation in the sidebar.
@@ -392,15 +392,14 @@
\section1 Change filters \section1 Change filters
To modify the selected filter, add and remove Qt modules and versions, and To modify the selected filter, add and remove Qt modules and versions and
then select \uicontrol Apply. then select \uicontrol Apply.
To rename the selected filter, select \uicontrol Rename. To rename the selected filter, select \uicontrol Rename.
\section1 Remove filters \section1 Remove filters
To remove the selected filter select \inlineimage icons/minus.png To remove the selected filter, select \inlineimage icons/minus.png.
.
\sa {Get help} \sa {Read Documentation}{How To: Read Documentation}
*/ */