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

Doc: Replace "Getting Help" with "How To"

Browse Source 
Move the topics to either "How To: Read Qt documentation" or
"Reference", depending on their type.

Task-number: QTCREATORBUG-29361
Change-Id: Ifa46192f7a15a71e8d3454010f6b96764776f82b
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
This commit is contained in:
Leena Miettinen
2023-09-05 16:28:35 +02:00
parent 66fabd0c0d
commit 097cb17af4
22 changed files with 281 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,8 +1,8 @@
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-help.html
\page creator-how-to-get-help.html
\if defined(qtdesignstudio)
\previouspage studio-help.html
\nextpage studio-faq.html
@@ -10,7 +10,7 @@
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-use
\ingroup creator-how-to-get-help
\title Get help
@@ -19,7 +19,7 @@
\list
\li To view documentation, switch to \uicontrol Help mode.
\li To view documentation, switch to the \uicontrol Help mode.
\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
@@ -42,29 +42,35 @@
The following image displays the context sensitive help in the \uicontrol Edit
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}
\section1 Change the font
If the help HTML file does not use a style sheet, you can change the font
family, style, and size in \uicontrol Edit > \uicontrol Preferences >
\uicontrol Help > \uicontrol General.
\image qtcreator-help-options.png "General tab in Help preferences"
\image qtcreator-help-options.png {General tab in Help preferences}
You can set the default zoom level in the \uicontrol Zoom field. When
viewing help pages, you can use the mouse scroll wheel to zoom them. To
disable this feature, deselect the \uicontrol {Enable scroll wheel zooming}
check box.
\section1 Return to the editor
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 Select help viewer backend
The help viewer backend determines the style sheet that is used to display
the help files. The default help viewer backend that is based on litehtml
is recommended for viewing Qt documentation. You can choose another help
viewer backend in the \uicontrol {Viewer backend} field. To take the new
backend to use, reload the help page.
\section1 Viewing Function Tooltips
\section1 View function tooltips
To hide function tooltips by default, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Text Editor} > \uicontrol Behavior >
@@ -75,7 +81,25 @@
To use a keyboard shortcut for viewing help tooltips, select
\uicontrol {Show help tooltips using keyboard shortcut (Alt)}.
\section1 Finding Information in Qt Documentation
\sa {Find information in Qt documentation}, {Filter documentation},
{Search from documentation}
\sa {Add external documentation}, {Detach the help window},
{Filter documentation}, {Find information in Qt documentation},
{Select the help start page}
*/
/*!
\page creator-how-to-find-info-in-documentation.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-get-help
\title Find information in Qt documentation
\QC, \QSDK and other Qt deliverables have documentation
as .qch files. All the documentation is accessible in the \uicontrol Help mode.
@@ -86,7 +110,13 @@
\uicontrol Kits > \uicontrol {Qt Versions} >
\uicontrol {Register documentation}.
To find information in the documentation, select:
\image qtcreator-qt-versions.png {Register documentation field in Qt Versions tab in Kit Preferences}
\section1 Help mode sidebar views
\image qtcreator-sidebar-help-mode.webp {Sidebar views in the Help mode}
To find information in the documentation in the \uicontrol Help mode, select:
\list
@@ -106,14 +136,27 @@
\endlist
\section2 Adding Bookmarks to Help Pages
\sa {Add bookmarks to help pages}, {Search from documentation}
*/
/*!
\page creator-how-to-add-bookmarks-to-help-pages.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-get-help
\title Add bookmarks to help pages
You can 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
bookmark or change it to any text. You can organize the bookmarks in
folders in the view.
\image qtcreator-help-add-bookmark-dlg.png "Add Bookmark dialog"
\image qtcreator-help-add-bookmark-dlg.png {Add Bookmark dialog}
To add a bookmark to an open help page:
@@ -127,13 +170,29 @@
\endlist
\section1 Import and export bookmarks
To import and export bookmarks, select \uicontrol Edit > \uicontrol Preferences
> \uicontrol Help > \uicontrol General > \uicontrol {Import Bookmarks} or
\uicontrol {Export Bookmarks}.
\section2 Full-text Search
\sa {Find information in Qt documentation}
*/
In the \uicontrol Search pane, you can use full-text search for finding a
/*!
\page creator-how-to-search-from-docs.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-get-help
\title Search from documentation
In the \uicontrol Help mode \uicontrol Search pane, you can use full-text
search for finding a
particular word in all the installed documents. Enter the term you are
looking for, and select the \uicontrol Search button. All documents that
have the specified term are listed. The list is sorted by document
@@ -141,7 +200,7 @@
the number of search hits that the documents have. Select a document in
the list to open it.
\image qtcreator-help-search.png "Search pane"
\image qtcreator-help-search.png {Help mode Search pane}
The following are examples of common search patterns:
@@ -173,15 +232,21 @@
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
example, to find \c {Pastebin.Com}, enter the search term \c {Pastebin*}.
\sa {Find information in Qt documentation}
*/
/*!
\page creator-how-to-add-external-documentation.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-use
\ingroup creator-how-to-get-help
\title Adding External Documentation
\title Add external documentation
You can display external documentation in the \uicontrol Help mode.
To add documentation or replace the documentation that ships with \QC and Qt:
@@ -196,51 +261,102 @@
\li To add the .qch file to \QC, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol Help > \uicontrol Documentation > \uicontrol Add.
\image qtcreator-preferences-help-documentation.webp {Documentation tab in Help Preferences}
\endlist
\sa
\sa {Get help}
*/
\section1 Detaching the Help Window
/*!
\page creator-how-to-detach-help-window.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-get-help
\title Detach the help window
By default, context-sensitive help is opened in a window next to the
code editor when you press \key F1. If there is not enough vertical
space, the help opens in the full-screen help mode.
You can specify that the help always opens in full-screen mode or
is detached to an external window. Select \uicontrol Edit >
\uicontrol Preferences > \uicontrol Help > \uicontrol General and specify
settings for displaying context-sensitive help
\image qtcreator-context-sensitive-help.png {Context-sensitive help in Edit mode}
To specify that the help always opens in full-screen mode or
is detached to an external window, select \uicontrol Edit >
\uicontrol Preferences > \uicontrol Help > \uicontrol General.
\image qtcreator-help-options.png {General tab in Help preferences}
Set preferences for displaying context-sensitive help
in the \uicontrol {On context help} field. To detach the help window, select
\uicontrol {Always Show in External Window}.
To change this setting in a help view, select the \inlineimage icons/linkicon.png
toolbar button.
\section1 Selecting the Start Page
\sa {Get help}
*/
/*!
\page creator-how-to-set-help-start-page.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-get-help
\title Select the help start page
You can select the page to display when you open the \uicontrol Help mode in the
\uicontrol Edit > \uicontrol Preferences > \uicontrol Help > \uicontrol General
> \uicontrol {On help start} field.
To display 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
are not opened because loading them would slow down opening the \uicontrol Help
mode.
To display a particular page, select \uicontrol {Show My Home Page}, and specify
the page in the \uicontrol {Home Page} field.
\image qtcreator-help-options.png {General tab in Help preferences}
To display a blank page, select the \uicontrol {Show a Blank Page} option. You can
also select the \uicontrol {Use Blank Page} button to set a blank page as your
home page.
\list
\li To display 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
are not opened because loading them would slow down opening the \uicontrol Help
mode.
\section1 Using Documentation Filters
\li To display a particular page, select \uicontrol {Show My Home Page}, and specify
the page in the \uicontrol {Home Page} field.
\li To display a blank page, select the \uicontrol {Show a Blank Page} option. You can
also select the \uicontrol {Use Blank Page} button to set a blank page as your
home page.
\endlist
\sa {Get help}
*/
/*!
\page creator-how-to-filter-documentation.html
\if defined(qtdesignstudio)
\previouspage creator-how-to-get-help.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-get-help
\title Filter documentation
You can filter the documents displayed in the \uicontrol Help mode to find
relevant information faster. Select a filter from a list of filters (1). The
relevant information faster. Select a filter from a list of filters. The
contents of the \uicontrol Index and \uicontrol Contents
view in the sidebar change accordingly.
\image qtcreator-help-filters.png "Filters field on the Help mode toolbar"
\image qtcreator-help-filters.png {Filters field on the Help mode toolbar}
\section1 Add filters
You can define your own filters to display documentation for a set of
Qt modules and versions.
@@ -252,7 +368,7 @@
\li Select \uicontrol Edit > \uicontrol 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
to add a new filter in the \uicontrol {Add Filter} dialog.
@@ -274,11 +390,17 @@
\endlist
\section1 Change filters
To modify the selected filter, add and remove Qt modules and versions, and
then select \uicontrol Apply.
To rename the selected filter, select \uicontrol Rename.
\section1 Remove filters
To remove the selected filter select \inlineimage icons/minus.png
.
\sa {Get help}
*/

2
doc/qtcreator/src/howto/creator-only/creator-how-to-enable-plugins.qdoc
View File

@@ -34,5 +34,5 @@
take effect.
\endlist
\sa {Install plugins}{How-to: Install plugins}
\sa {Install plugins}{How To: Install plugins}
*/

2
doc/qtcreator/src/howto/creator-only/creator-how-to-install-plugins.qdoc
View File

@@ -39,5 +39,5 @@
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\sa {Enable and disable plugins}{How-to: Enable and disable plugins}
\sa {Enable and disable plugins}{How To: Enable and disable plugins}
*/

59
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -12,25 +12,16 @@
\page creator-how-tos.html
\nextpage creator-reference.html
\title How-to
\title How To
The following topics describe how to use \QC to perform a particular task.
\section1 Use the UI
\section1 Design UIs
\list
\li \l {Assign keyboard shortcuts}
\li \l {Find a particular preference}
\li \l {Find keyboard shortcuts}
\li \l {Find menu items on \macos}
\li \l {Import and export keyboard shortcuts}
\li \l {Set high DPI scaling}
\li \l {Set the number of recent files shown}
\li \l {Show and hide sidebars}
\li \l {Show task list files in Issues}
\li \l {Switch between modes}
\li \l {Switch UI themes}
\li \l {View output}
\list
\li \l {Export SVG images}
\li \l {Run QML files}
\li \l {View images}
\endlist
\section1 Edit Code
@@ -51,14 +42,6 @@
\li \l {Write down notes}
\endlist
\section1 Design UIs
\list
\li \l {Export SVG images}
\li \l {Run QML files}
\li \l {View images}
\endlist
\section1 Manage Projects
\list
@@ -77,6 +60,19 @@
\li \l {Use project wizards}
\endlist
\section1 Read Qt Documentation
\list
\li \l {Add bookmarks to help pages}
\li \l {Add external documentation}
\li \l {Detach the help window}
\li \l {Filter documentation}
\li \l {Find information in Qt documentation}
\li \l {Get help}
\li \l {Search from documentation}
\li \l {Select the help start page}
\endlist
\section1 Use \QC
\list
@@ -91,6 +87,23 @@
\li \l {Use external tools}
\li \l {Use Qt Linguist}
\endlist
\section1 Use the UI
\list
\li \l {Assign keyboard shortcuts}
\li \l {Find a particular preference}
\li \l {Find keyboard shortcuts}
\li \l {Find menu items on \macos}
\li \l {Import and export keyboard shortcuts}
\li \l {Set high DPI scaling}
\li \l {Set the number of recent files shown}
\li \l {Show and hide sidebars}
\li \l {Show task list files in Issues}
\li \l {Switch between modes}
\li \l {Switch UI themes}
\li \l {View output}
\endlist
*/
/*!

4
doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
View File

@@ -12,7 +12,7 @@
\brief Answers to some frequently asked questions about \QC.
You might also find answers to your questions in the
\l{Known Issues} and \l{How-to} sections, or the Troubleshooting
\l{Known Issues} and \l{How To} sections, or the Troubleshooting
sections for a special area, such as
\l{Troubleshooting Debugger}{debugging}.
@@ -155,7 +155,7 @@
To view the documentation that is available and to add documentation,
select \uicontrol Edit > \uicontrol Preferences > \uicontrol Help >
\uicontrol Documentation. For more information, see
\l{Adding External Documentation}.
\l{Add external documentation}.
\section1 Debugger Questions