diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2019-10-25 14:51:50 +0200 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2019-10-29 10:24:04 +0000 |
commit | 636ee3e91d39c4d64ab1b90c6038b352941b7718 (patch) | |
tree | 5b9d5e028a2ef847cabb8678bdb24db564d756cf /doc | |
parent | 74d458c0da24d6f99e8b0df58541ba92ad20973c (diff) | |
download | qt-creator-636ee3e91d39c4d64ab1b90c6038b352941b7718.tar.gz |
Doc: rename Tips and Tricks to How-tos
This is based on Qbs' how-tos documentation:
https://doc.qt.io/qbs/howtos.html
I find this format easier to follow, both because of the phrasing of
each section and the fact that it doesn't rely on the table of contents
to list the contents, which is squished into a tiny word-wrapped
section on the left of the page in the online documentation.
Change-Id: I46a0751a55e7f34458392c56e12c2e301adde234
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/debugger/creator-debugger-common.qdocinc | 2 | ||||
-rw-r--r-- | doc/src/howto/creator-only/creator-how-tos.qdoc (renamed from doc/src/howto/creator-only/creator-tips.qdoc) | 57 | ||||
-rw-r--r-- | doc/src/howto/creator-only/qtcreator-faq.qdoc | 4 | ||||
-rw-r--r-- | doc/src/howto/creator-ui.qdoc | 2 | ||||
-rw-r--r-- | doc/src/overview/creator-only/creator-help-overview.qdoc | 2 | ||||
-rw-r--r-- | doc/src/overview/creator-only/creator-issues.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qtcreator-toc.qdoc | 2 | ||||
-rw-r--r-- | doc/src/qtcreator.qdoc | 2 |
8 files changed, 47 insertions, 26 deletions
diff --git a/doc/src/debugger/creator-debugger-common.qdocinc b/doc/src/debugger/creator-debugger-common.qdocinc index 5437b0d2a5..e5366aa968 100644 --- a/doc/src/debugger/creator-debugger-common.qdocinc +++ b/doc/src/debugger/creator-debugger-common.qdocinc @@ -398,7 +398,7 @@ entry. You can enable tooltips in the main editor displaying this information. - For more information, see \l{Showing Tooltips in Debug Mode}. + For more information, see \l{See the value of variables in tooltips while debugging}. //! [debugger-qt-basic-objects] */ diff --git a/doc/src/howto/creator-only/creator-tips.qdoc b/doc/src/howto/creator-only/creator-how-tos.qdoc index 5e481b42f2..6b43d9ffb6 100644 --- a/doc/src/howto/creator-only/creator-tips.qdoc +++ b/doc/src/howto/creator-only/creator-how-tos.qdoc @@ -32,12 +32,33 @@ /*! \contentspage index.html \previouspage creator-faq.html - \page creator-tips.html + \page creator-how-tos.html \nextpage creator-known-issues.html - \title Tips and Tricks + \title How-tos - \section1 Switching Between Modes + How do I: + + \list + \li \l {Switch between modes} + \li \l {Move between open files} + \li \l {Switch to Edit mode} + \li \l {Find a specific setting} + \li \l {Open output panes} + \li \l {Find keyboard shortcuts} + \li \l {Run \QC from the command line} + \li \l {Show and hide sidebars} + \li \l {Move to symbols} + \li \l {Inspect signal-slot connections while debugging} + \li \l {Display low-level data in the debugger} + \li \l {See the value of variables in tooltips while debugging} + \li \l {Quickly locate files using the keyboard} + \li \l {Add a license header template for C++ code} + \li \l {Paste text from my clipboard history} + \li \l {Sort lines alphabetically} + \endlist + + \section1 Switch between modes \QC uses different modes for different purposes. You can quickly switch between these modes with the following keyboard shortcuts: @@ -55,7 +76,7 @@ For more information about \QC modes, see \l {Selecting Modes}. - \section1 Moving Between Open Files + \section1 Move between open files To quickly move between currently open files, press \key Ctrl+Tab. @@ -66,7 +87,7 @@ to jump to a symbol in the same file, you can jump back to your original location in that file by pressing \key {Alt+Left}. - \section1 Moving To the Edit Mode + \section1 Switch to Edit mode To move to the \uicontrol Edit mode and currently active file, press \key Esc. @@ -81,12 +102,12 @@ \endlist - \section1 Using the Filter in Options Dialog + \section1 Find a specific setting To find specific settings you require in \uicontrol{Tools} > \uicontrol{Options} use the filter located at the top left of the \uicontrol Options dialog box. - \section1 Opening Output Panes + \section1 Open output panes The output panes provide a list of errors and warnings encountered during a build, detailed output from the compiler, status of a program when it is @@ -112,7 +133,7 @@ For more information about output panes, see \l{Viewing Output}. - \section1 Using Keyboard Shortcuts + \section1 Find keyboard shortcuts \QC provides \l{Keyboard Shortcuts}{many useful keyboard shortcuts}. You can see the keyboard shortcut for a menu command in the menu @@ -121,7 +142,7 @@ To customize, import or export keyboard shortcuts, select \uicontrol Tools > \uicontrol Options > \uicontrol Environment > \uicontrol Keyboard. - \section1 Running \QC From Command Line + \section1 Run \QC from the command line You can launch \QC from command line using the name of an existing session or \c .pro file by giving the name as the command @@ -132,7 +153,7 @@ For more information, see \l{Using Command Line Options}. - \section1 Showing and Hiding Sidebars + \section1 Show and hide sidebars You can toggle the left and right sidebar in some \QC modes. @@ -147,7 +168,7 @@ For more information on using the sidebars, see \l {Browsing Project Contents}. - \section1 Moving To Symbols + \section1 Move to symbols To move straight to a symbol used in a project, select the symbol in the \uicontrol Editor toolbar drop-down menu. For more information on the editor @@ -163,7 +184,7 @@ cursor on the symbol and press \key {F2}. For more information, see \l{Moving to Symbol Definition or Declaration}. - \section1 Displaying Signals and Slots + \section1 Inspect signal-slot connections while debugging If an instance of a class is derived from QObject, and you would like to find all other objects connected to one of your object's slots using @@ -177,7 +198,7 @@ For more information about the \uicontrol{Locals} view, see \l{Local Variables and Function Parameters}. - \section1 Displaying Low Level Data + \section1 Display low-level data in the debugger If special debugging of Qt objects fails due to data corruption within the debugged objects, you can switch off the debugging helpers. When debugging @@ -193,7 +214,7 @@ \endlist - \section1 Showing Tooltips in Debug Mode + \section1 See the value of variables in tooltips while debugging To inspect the value of variables from the editor, you can turn on tooltips. Tooltips are hidden by default for performance reasons. @@ -218,7 +239,7 @@ select \uicontrol {Close Editor Tooltips} in the context menu in the \uicontrol {Locals} view. - \section1 Locating Files + \section1 Quickly locate files using the keyboard The \uicontrol Locator provides one of the easiest ways in \QC to browse through projects, files, classes, functions, documentation and file systems. @@ -230,7 +251,7 @@ For more information, see \l{Creating Locator Filters}. - \section1 Adding a License Header Template for C++ Code + \section1 Add a license header template for C++ code A file containing a license header for C++ can be specified under \uicontrol{Tools > Options > C++ > License Template}. It may contain special @@ -250,13 +271,13 @@ \endlist - \section1 Pasting from Clipboard History + \section1 Paste text from my clipboard history \QC stores copied text in clipboard history. To retrieve clips from the history, press \key {Ctrl+Shift+V} until the clip appears. The number of clips in the history is fixed to 10. - \section1 Sorting Lines Alphabetically + \section1 Sort lines alphabetically To sort selected lines alphabetically, select \uicontrol Edit > \uicontrol Advanced > \uicontrol {Sort Selected Lines} or press diff --git a/doc/src/howto/creator-only/qtcreator-faq.qdoc b/doc/src/howto/creator-only/qtcreator-faq.qdoc index 712d81aeda..87bd22d00d 100644 --- a/doc/src/howto/creator-only/qtcreator-faq.qdoc +++ b/doc/src/howto/creator-only/qtcreator-faq.qdoc @@ -27,13 +27,13 @@ \contentspage index.html \previouspage creator-help.html \page creator-faq.html - \nextpage creator-tips.html + \nextpage creator-how-tos.html \title FAQ This section contains answers to some frequently asked questions about \QC. You might also find answers to your questions in the - \l{Known Issues} and \l{Tips and Tricks} sections, or the Troubleshooting + \l{Known Issues} and \l{How-tos} sections, or the Troubleshooting sections for a special area, such as \l{Troubleshooting Debugger}{debugging}. diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index adc38a0cf3..ac8fe77bca 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -107,7 +107,7 @@ \section1 Useful Features For a list of useful \QC features described in other parts of the - documentation, see \l{Tips and Tricks}. + documentation, see \l{How-tos}. \endif \section1 Changing Languages diff --git a/doc/src/overview/creator-only/creator-help-overview.qdoc b/doc/src/overview/creator-only/creator-help-overview.qdoc index dd8c47dc25..fd16ed3e9f 100644 --- a/doc/src/overview/creator-only/creator-help-overview.qdoc +++ b/doc/src/overview/creator-only/creator-help-overview.qdoc @@ -53,7 +53,7 @@ Contains answers to some frequently asked questions about \QC. - \li \l{Tips and Tricks} + \li \l{How-tos} Lists useful \QC features. diff --git a/doc/src/overview/creator-only/creator-issues.qdoc b/doc/src/overview/creator-only/creator-issues.qdoc index 16c5263aee..bbbd71002f 100644 --- a/doc/src/overview/creator-only/creator-issues.qdoc +++ b/doc/src/overview/creator-only/creator-issues.qdoc @@ -31,7 +31,7 @@ /*! \contentspage index.html - \previouspage creator-tips.html + \previouspage creator-how-tos.html \page creator-known-issues.html \nextpage creator-glossary.html diff --git a/doc/src/qtcreator-toc.qdoc b/doc/src/qtcreator-toc.qdoc index f0bd3f9e02..fb796ae8bf 100644 --- a/doc/src/qtcreator-toc.qdoc +++ b/doc/src/qtcreator-toc.qdoc @@ -231,7 +231,7 @@ \list \li \l{Using the Help Mode} \li \l{FAQ} - \li \l{Tips and Tricks} + \li \l{How-tos} \li \l{Known Issues} \li \l{Glossary} \li \l{Technical Support} diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc index 5401ecc442..58db763d76 100644 --- a/doc/src/qtcreator.qdoc +++ b/doc/src/qtcreator.qdoc @@ -123,7 +123,7 @@ \list \li \l{Using the Help Mode} \li \l{FAQ} - \li \l{Tips and Tricks} + \li \l{How-tos} \li \l{Known Issues} \li \l{Glossary} \endlist |