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

Doc: Turn some "Advanced Use" topics into how-to topics

Browse Source 
Task-number: QTCREATORBUG-29361
Change-Id: Ie675e4d72ad524e0a7a4ba4adca8a477ff579d55
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-08-31 15:16:08 +02:00
parent 9a81e1270a
commit 66fabd0c0d
22 changed files with 349 additions and 271 deletions
Download Patch File Download Diff File Expand all files Collapse all files

161
doc/qtcreator/src/howto/creator-external-tools.qdoc
View File

@@ -1,4 +1,4 @@
// 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
// **********************************************************************
@@ -13,11 +13,12 @@
\previouspage quick-converting-ui-projects.html
\nextpage studio-on-mcus.html
\else
\previouspage creator-keyboard-shortcuts.html
\nextpage creator-task-lists.html
\previouspage creator-how-tos.html
\endif
\title Using External Tools
\ingroup creator-how-to-use
\title Use external tools
You can use external tools directly from \QC. Qt Linguist, QML preview
tools, and the default text editor for your system are preconfigured
@@ -27,59 +28,7 @@
To run the tools, select \uicontrol Tools > \uicontrol External, or use the
\c x filter in the locator.
\section1 Using Qt Linguist
When you \l{Creating Projects}{create a new project}, you can automatically
generate a translation source file (TS) for one language. You can add other
languages later by editing the project file.
You can use the Qt Linguist release manager tools, lupdate and lrelease,
directly from \QC. The lupdate tool is used to synchronize source
code and translations. The lrelease tool is used to create run-time
translation files for use by the released application.
\note Running the tools from \QC is supported only when using qmake as the
build system. For more information about using the tools with CMake, see
\l{https://doc.qt.io/qt-6/cmake-command-reference.html#qt6-linguisttools}
{Qt6::LinguistTools}.
To synchronize TS files from a translator with the
application code, select \uicontrol Tools > \uicontrol External >
\uicontrol Linguist > \uicontrol {Update Translations (lupdate)}.
To generate from the TS files Qt message (QM) files that can be used by an
application, select \uicontrol Tools > \uicontrol External >
\uicontrol Linguist > \uicontrol {Release Translations (lrelease)}.
By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \uicontrol Tools >
\uicontrol External > \uicontrol Configure.
To open TS files in Qt Linguist, right-click a TS file in the
\uicontrol Projects or \uicontrol {File System} view and select
\uicontrol {Open With} > \uicontrol {Qt Linguist} in the context menu.
For more information about Qt Linguist, see \l{Qt Linguist Manual}.
\section1 Running QML Files
You can test the current QML document while you are developing an application.
To run the currently active QML file, select \uicontrol Tools >
\uicontrol External > \uicontrol {Qt Quick} > \uicontrol {QML Runtime}.
\section1 Using External Text Editors
You can open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and \macos.
To open the file you are currently viewing in an external editor, select
\uicontrol Tools > \uicontrol External > \uicontrol Text >
\uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on
your system.
\QC looks for the editor path in the PATH environment variable
of your operating system.
\section1 Configuring External Tools
\section1 Configure external tools
You can change the configuration of preconfigured tools and configure
additional tools in \QC \uicontrol Preferences.
@@ -171,4 +120,102 @@
in Windows. To share a configuration with other users, copy an XML
configuration file to the folder.
\sa {Run QML files}, {Use external text editors}, {Use Qt Linguist}
*/
/*!
\page creator-how-to-use-qtlinguist.html
\if defined(qtdesignstudio)
\previouspage creator-editor-external.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-use
\title Use Qt Linguist
When you \l{Creating Projects}{create a new project}, you can automatically
generate a translation source file (TS) for one language. You can add other
languages later by editing the project file.
To open TS files in Qt Linguist, right-click a TS file in the
\uicontrol Projects or \uicontrol {File System} view and select
\uicontrol {Open With} > \uicontrol {Qt Linguist} in the context menu.
For more information about Qt Linguist, see \l{Qt Linguist Manual}.
\section1 Use lupdate and lrelease
You can use the Qt Linguist release manager tools, lupdate and lrelease,
directly from \QC. The lupdate tool synchronizes source
code and translations. The lrelease tool creates run-time
translation files for use by the released application.
\note Running the tools from \QC is supported only when using qmake as the
build system. For more information about using the tools with CMake, see
\l{https://doc.qt.io/qt-6/cmake-command-reference.html#qt6-linguisttools}
{Qt6::LinguistTools}.
By default, the project .pro file is passed to the tools as an argument. To
specify other command line arguments for the tools, select \uicontrol Tools >
\uicontrol External > \uicontrol Configure.
\section2 Synchronize TS files
To synchronize TS files from a translator with the
application code, select \uicontrol Tools > \uicontrol External >
\uicontrol Linguist > \uicontrol {Update Translations (lupdate)}.
\section2 Generate QM files
To generate from the TS files Qt message (QM) files that can be used by an
application, select \uicontrol Tools > \uicontrol External >
\uicontrol Linguist > \uicontrol {Release Translations (lrelease)}.
\sa {Use external tools}
*/
/*!
\page creator-how-to-run-qml-files.html
\if defined(qtdesignstudio)
\previouspage creator-editor-external.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-design
\title Run QML files
You can test the current QML document while you are developing an application.
To run the currently active QML file, select \uicontrol Tools >
\uicontrol External > \uicontrol {Qt Quick} > \uicontrol {QML Runtime}.
\sa {Use external tools}
*/
/*!
\page creator-how-to-use-external-text-editors.html
\if defined(qtdesignstudio)
\previouspage creator-editor-external.html
\else
\previouspage creator-how-tos.html
\endif
\ingroup creator-how-to-use
\title Use external text editors
You can open files for editing in the default text editor for your system:
Notepad on Windows and vi on Linux and \macos.
To open the file you are currently viewing in an external editor, select
\uicontrol Tools > \uicontrol External > \uicontrol Text >
\uicontrol {Edit with Notepad} or \uicontrol {Edit with vi}, depending on
your system.
\QC looks for the editor path in the PATH environment variable
of your operating system.
\sa {Use external tools}
*/

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

@@ -7,11 +7,12 @@
\previouspage studio-help.html
\nextpage studio-faq.html
\else
\previouspage creator-help-overview.html
\nextpage creator-faq.html
\previouspage creator-how-tos.html
\endif
\title Using the Help Mode
\ingroup creator-how-to-use
\title Get help
\QC comes fully integrated with Qt documentation and examples using the Qt
Help plugin.
@@ -172,11 +173,18 @@
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*}.
*/
\section1 Adding External Documentation
/*!
\page creator-how-to-add-external-documentation.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-use
\title Adding External Documentation
You can display external documentation in the \uicontrol Help mode.
To augment 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
@@ -190,6 +198,8 @@
\endlist
\sa
\section1 Detaching the Help Window
By default, context-sensitive help is opened in a window next to the

5
doc/qtcreator/src/howto/creator-only/creator-cli.qdoc
View File

@@ -17,8 +17,9 @@
\brief Options for starting \QC from the command line.
To specify command line options, enter the following command in the \QC
installation or build directory:
To specify command line options, enter the following command in the
directory that contains the \QC executable or specify the path to
\QC as a part of the command:
\badcode
qtcreator [option] [filename[:line_number[:column_number]]]

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

@@ -27,6 +27,7 @@
\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}
@@ -54,6 +55,7 @@
\list
\li \l {Export SVG images}
\li \l {Run QML files}
\li \l {View images}
\endlist
@@ -78,10 +80,16 @@
\section1 Use \QC
\list
\li \l {Collect usage statistics}
\li \l {Enable and disable plugins}
\li \l {Find settings files}
\li \l {Inspect internal logs}
\li \l {Install plugins}
\li \l {Manage data collection}
\li \l {Run \QC from the command line}
\li \l {Use external text editors}
\li \l {Use external tools}
\li \l {Use Qt Linguist}
\endlist
*/
@@ -149,14 +157,55 @@
\title Run \QC from the command line
You can launch \QC from the command line using the name of an
existing \l{Managing Sessions}{session} or project file by entering
the name as the command argument.
You can start \QC and specify some options from the command line. For
example, you can open a file to any line and column.
For example, running \c {qtcreator somesession}, launches \QC and
loads the session called \e somesession.
To use command line options, enter the following command in the
directory that contains the \QC executable or specify the path to
\QC as a part of the command:
For more information, see \l{Using Command Line Options}.
\badcode
qtcreator [option] [filename[:line_number[:column_number]]]
\endcode
\note You can use either a colon (:) or a plus sign (+) as a separator
between the filename and line number and the line number and the column
number. You can also use a space between the separator and the line number.
\section1 Examples of CLI commands
On Windows:
\list
\li \c {C:\qtcreator\bin>qtcreator -help}
\li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp:100:2}
\li \c {C:\qtcreator\bin>qtcreator C:\TextFinder\textfinder.cpp +100+2}
\endlist
On \macos:
\list
\li \c {Qt\ Creator.app/Contents/MacOS/Qt\ Creator -help}
\endlist
\section1 Open a project from a directory
To open a project that is located in a particular directory, you can
pass on the directory name as a command line argument. \QC looks for
a \l{Managing Sessions}{session} that matches the directory name and
loads it. Or it looks for a project file in the directory and opens it.
For example, on Windows:
\c {C:\qtcreator\bin>qtcreator.exe C:\Examples\alarms}
\sa {Command Line Options}
*/
/*!

11
doc/qtcreator/src/howto/creator-only/creator-logging-viewer.qdoc
View File

@@ -1,12 +1,13 @@
// Copyright (C) 2022 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-logging-viewer.html
\previouspage creator-task-lists.html
\nextpage creator-telemetry.html
\previouspage creator-how-tos.html
\title Inspecting Internal Logs
\ingroup creator-how-to-use
\title Inspect internal logs
You can inspect internal log messages of \QC at runtime without having to
restart it or configure the logging rules. Log messages are helpful when
@@ -25,7 +26,7 @@
\note Messages are not cached, so the viewer displays only messages that
are recorded after you enabled a category.
\section1 Viewing Logs
\section1 View logs
To enable logging categories, select them in \uicontrol Category.
\uicontrol Type specifies the minimum level of messages to display from

15
doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2020 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -8,11 +8,12 @@
// **********************************************************************
/*!
\previouspage creator-editor-external.html
\page creator-task-lists.html
\nextpage creator-logging-viewer.html
\previouspage creator-how-tos.html
\title Showing Task List Files in Issues
\ingroup creator-how-to-ui
\title Show task list files in issues
You can use code scanning and analysis tools to examine source code. These
tools report issues for you to fix. \QC enables you to load lists of
@@ -25,7 +26,7 @@
lines of code and matches them against regular expressions to generate a
task list, see \c{scripts\mytasks.pl} in the \QC repository.
\section1 Managing Task List Entries
\section1 Manage task list entries
To open task list files in \uicontrol Issues, choose \uicontrol File >
\uicontrol Open. Right-click a task list entry to open a context menu that
@@ -36,7 +37,7 @@
To keep the current entries in a task list, but stop checking for
changes, select \uicontrol {Stop Monitoring}.
\section1 Task List File Format
\section1 Task list file format
The filename extension must be .tasks for \QC to recognize a file as a
task list file.
@@ -79,4 +80,6 @@
If the file path is given as a relative path, it is based on the parent
directory of the task list file.
\sa {Issues}, {View output}
*/

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

@@ -2,13 +2,15 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-help.html
\page creator-faq.html
\nextpage creator-how-tos.html
\previouspage creator-reference.html
\ingroup creator-reference
\title FAQ
This section has answers to some frequently asked questions about \QC.
\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
sections for a special area, such as

34
doc/qtcreator/src/howto/creator-telemetry.qdoc
View File

@@ -1,16 +1,18 @@
// 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-telemetry.html
\if defined(qtdesignstudio)
\previouspage creator-quick-ui-forms.html
\else
\previouspage creator-logging-viewer.html
\endif
\nextpage collecting-usage-statistics.html
\else
\previouspage creator-how-tos.html
\endif
\title Managing Data Collection
\ingroup creator-how-to-use
\title Manage data collection
\if defined (qtcreator)
When you install \QC as a part of Qt installation, you are asked whether
@@ -24,8 +26,8 @@
mode for data collection to begin.
See \l {Collecting Usage Statistics} for more information about the data
transmitted by the telemetry plugin and \l {Specifying Telemetry Settings}
See \l {Collect usage statistics} for more information about the data
transmitted by the telemetry plugin and \l {Specify telemetry settings}
{specifying telemetry settings}.
\else
To enable the use of the telemetry plugin, you need to select \uicontrol
@@ -40,13 +42,13 @@
See below for more information about the collected data:
\list
\li \l {Collecting Usage Statistics}
\li \l {Collect usage statistics}
\li \l {Collecting User Feedback}
\li \l {Reporting Crashes}
\endlist
\endif
\section1 Principles of Data Collection
\section1 Principles of data collection
No personal data, such as names, IP addresses, MAC addresses, or project
and path names are collected. However, QUuid objects are used to identify
@@ -56,18 +58,22 @@
For more information about Qt privacy policy, select
\l{https://www.qt.io/terms-conditions/#privacy}
{Legal Notice and Privacy Policy}.
\sa {Collect usage statistics}
*/
/*!
\page collecting-usage-statistics.html
\previouspage creator-telemetry.html
\if defined(qtdesignstudio)
\previouspage creator-telemetry.html
\nextpage studio-user-feedback.html
\else
\nextpage creator-help-overview.html
\previouspage creator-how-tos.html
\endif
\title Collecting Usage Statistics
\ingroup creator-how-to-use
\title Collect usage statistics
The telemetry plugin uses the
\l{https://api.kde.org/frameworks/kuserfeedback/html/index.html}
@@ -79,7 +85,7 @@
connection. The storage is located in the same Heroku backend as the
Qt installer backend. Physically, data is stored in the Amazon cloud.
\section1 Specifying Telemetry Settings
\section1 Specify telemetry settings
To determine what data is transmitted to the backend storage:
@@ -93,4 +99,6 @@
exactly what data is collected. Deselect check boxes for data
that you do not want to transmit to the backend storage.
\endlist
\sa {Manage data collection}
*/

8
doc/qtcreator/src/overview/creator-acknowledgements.qdoc
View File

@@ -9,10 +9,18 @@
/*!
\page creator-acknowledgements.html
\if defined(qtdesignstudio)
\previouspage technical-support.html
\else
\previouspage creator-reference.html
\endif
\ingroup creator-reference
\title Acknowledgements
\brief Third-party components in \QC.
\section1 Credits
We would like to thank our contributors, who are listed in the \QC change

9
doc/qtcreator/src/overview/creator-only/creator-glossary.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -8,12 +8,15 @@
// **********************************************************************
/*!
\previouspage creator-known-issues.html
\page creator-glossary.html
\nextpage technical-support.html
\previouspage creator-reference.html
\ingroup creator-reference
\title Glossary
\brief \QC terms and concepts.
\table
\header
\li Term

67
doc/qtcreator/src/overview/creator-only/creator-help-overview.qdoc
View File

@@ -1,67 +0,0 @@
// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\page creator-help-overview.html
\previouspage collecting-usage-statistics.html
\nextpage creator-help.html
\title Getting Help
\image front-help.png
\list
\li \l{Using the Help Mode}
\QC comes fully integrated with Qt documentation and examples using
the Qt Help plugin. You can add external documentation to the
\uicontrol Help mode and filter the documents displayed to find relevant
information faster. In addition, you can add bookmarks to help
pages.
\li \l{FAQ}
Has answers to some frequently asked questions about \QC.
\li \l{How-to}
Lists useful \QC features.
\li \l{Reference}
Lists the sidebar views and the output views.
\li \l{Known Issues}
Lists known issues in \QC version \qtcversion. The development team
is aware of them, and therefore, you do not need to report them as
bugs.
\li \l{Glossary}
Lists special terms used in \QC.
\endlist
\section1 Related Topics
\list
\li \l{Technical Support}
Lists Qt support sites and other useful sites.
\li \l{Acknowledgements}
Lists the third-party components in \QC.
\endlist
*/

2
doc/qtcreator/src/overview/creator-only/creator-reference.qdoc
View File

@@ -26,6 +26,4 @@
\section1 Output Views
\annotatedlist creator-reference-output-views
\sa {User Interface}, {Show and hide sidebars}, {View output}
*/

13
doc/qtcreator/src/overview/creator-tech-support.qdoc
View File

@@ -1,4 +1,4 @@
// 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
// **********************************************************************
@@ -11,13 +11,18 @@
\page technical-support.html
\if defined(qtdesignstudio)
\previouspage studio-platforms.html
\else
\previouspage creator-glossary.html
\endif
\nextpage creator-acknowledgements.html
\else
\previouspage creator-reference.html
\endif
\ingroup creator-reference
\title Technical Support
\brief Qt support sites and other useful sites.
The following table lists Qt support sites and other useful links.

171
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -197,84 +197,86 @@
\li \l{Running Autotests}
\li \l{Using Squish}
\endlist
\li \l{Getting Help}
\li \l{How-to}
\list
\li \l{Using the Help Mode}
\li \l{FAQ}
\li \l{How-to}
\li Use the UI
\list
\li 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 {Switch between modes}
\li \l {Switch UI themes}
\li \l {View output}
\endlist
\li Edit Code
\list
\li \l {Add code snippets to the auto-complete menu}
\li \l {Enclose selected code in curly braces, parentheses, or double quotes}
\li \l {Jump to a function in QML code}
\li \l {Locate files using the keyboard}
\li \l {Move between open files}
\li \l {Move to symbols}
\li \l {Paste text from clipboard history}
\li \l {Perform calculations}
\li \l {Search and replace across files using a regular expression}
\li \l {Select the enclosing block in C++}
\li \l {Sort lines alphabetically}
\li \l {Switch to Edit mode}
\li \l {Write down notes}
\endlist
\li Design UIs
\list
\li \l {Export SVG images}
\li \l {View images}
\endlist
\li Manage Projects
\list
\li \l {Add a license header template for C++ code}
\li \l {Add libraries to projects}
\li \l {Add subprojects to projects}
\li \l {Add wizards}
\li \l {Create C++ classes}
\li \l {Create files}
\li \l {Create OpenGL fragment and vertex shaders}
\li \l {Create resource files}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Select the build system}
\li \l {Specify project contents}
\li \l {Use project wizards}
\endlist
\li Use \QC
\list
\li \l {Collect usage statistics}
\li \l {Enable and disable plugins}
\li \l {Find settings files}
\li \l {Inspect internal logs}
\li \l {Install plugins}
\li \l {Manage data collection}
\li \l {Run \QC from the command line}
\li \l {Use external text editors}
\li \l {Use external tools}
\li \l {Use Qt Linguist}
\endlist
\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
\li Edit Code
\list
\li \l {Add code snippets to the auto-complete menu}
\li \l {Enclose selected code in curly braces, parentheses, or double quotes}
\li \l {Get help}
\li \l {Jump to a function in QML code}
\li \l {Locate files using the keyboard}
\li \l {Move between open files}
\li \l {Move to symbols}
\li \l {Paste text from clipboard history}
\li \l {Perform calculations}
\li \l {Search and replace across files using a regular expression}
\li \l {Select the enclosing block in C++}
\li \l {Sort lines alphabetically}
\li \l {Switch to Edit mode}
\li \l {Write down notes}
\endlist
\li Design UIs
\list
\li \l {Export SVG images}
\li \l {Run QML files}
\li \l {View images}
\endlist
\li Manage Projects
\list
\li \l {Add a license header template for C++ code}
\li \l {Add libraries to projects}
\li \l {Add subprojects to projects}
\li \l {Add wizards}
\li \l {Create C++ classes}
\li \l {Create files}
\li \l {Create OpenGL fragment and vertex shaders}
\li \l {Create resource files}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Select the build system}
\li \l {Specify project contents}
\li \l {Use project wizards}
\endlist
\li Use \QC
\list
\li \l {Collect usage statistics}
\li \l {Enable and disable plugins}
\li \l {Find settings files}
\li \l {Inspect internal logs}
\li \l {Install plugins}
\li \l {Manage data collection}
\li \l {Run \QC from the command line}
\li \l {Use external text editors}
\li \l {Use external tools}
\li \l {Use Qt Linguist}
\endlist
\li \l{Known Issues}
\li \l{Glossary}
\li \l{Technical Support}
\li \l{Acknowledgements}
\endlist
\li \l{Reference}
\list
\li \l {Acknowledgements}
\li \l {Command Line Options}
\li \l {Custom Wizards}
\li \l {FAQ}
\li \l {Glossary}
\li \l {Keyboard Shortcuts}
\li \l {Known Issues}
\li \l {Technical Support}
\li \l {Build Systems}
\list
\li \l{Managing Packages with vcpkg}
@@ -287,15 +289,14 @@
\li \l{Setting Up a Generic Project}
\li \l{Setting Up an Autotools Project}
\endlist
\li \l {Command Line Options}
\li \l {Custom Wizards}
\li \l {Keyboard Shortcuts}
\li \l {Supported Platforms}
\li Output Views
\list
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\li \l {Application Output}
\li \l {Compile Output}
\li \l {Issues}
\li \l {Search Results}
\li \l {To-Do Entries}
\endlist
\li Sidebar Views
\list
\li \l {Call Hierarchy}
@@ -307,13 +308,11 @@
\li \l {Projects}
\li \l {Type Hierarchy}
\endlist
\li Output Views
\li \l {Supported Platforms}
\list
\li \l {Application Output}
\li \l {Compile Output}
\li \l {Issues}
\li \l {Search Results}
\li \l {To-Do Entries}
\li \l {Desktop Platforms}
\li \l {Embedded Platforms}
\li \l {Mobile Platforms}
\endlist
\endlist
\endlist

2
doc/qtcreator/src/user-interface/creator-only/creator-reference-to-do-entries-view.qdoc
View File

@@ -19,7 +19,7 @@
You can also open task list files generated by code scanning and
analysis tools in \l Issues. For more information, see
\l{Showing Task List Files in Issues}.
\l{Show task list files in Issues}.
\section1 Enabling the To-Do Plugin

11
doc/qtcreator/src/user-interface/creator-reference-output-views.qdoc
View File

@@ -60,6 +60,11 @@
the issues from the previous build rounds, deselect \uicontrol Edit >
\uicontrol Preferences > \uicontrol {Build & Run} > \uicontrol General >
\uicontrol {Clear issues list on new build}.
\sa {View output}
\if defined(qtcreator)
\sa {Show task list files in Issues}
\endif
*/
/*!
@@ -90,6 +95,8 @@
For more information about the different search options, see
\l {Finding and Replacing}.
\sa {View output}
*/
/*!
@@ -137,6 +144,8 @@
You can select whether to open \uicontrol{Application Output} on output when
running or debugging applications, to clear old output on a new run,
to word-wrap output, and to limit output to the specified number of lines.
\sa {View output}
*/
/*!
@@ -215,4 +224,6 @@
the new output to the old output.
\li Select \uicontrol OK to start parsing.
\endlist
\sa {View output}
*/

2
doc/qtcreator/src/widgets/qtdesigner-app-tutorial.qdoc
View File

@@ -67,7 +67,7 @@
\image qtcreator-new-qt-gui-application-translationfile.png {Translation File dialog}
\li In the \uicontrol Language field, you can select a language that you
plan to \l {Using Qt Linguist}{translate} the application to. This
plan to \l {Use Qt Linguist}{translate} the application to. This
sets up localization support for the application. You can add other
languages later by editing the project file.

6
doc/qtcreatordev/src/qtcreator-dev.qdoc
View File

@@ -156,7 +156,7 @@
\list
\li \l{https://doc.qt.io/qtcreator/creator-editor-external.html}
{Using External Tools}
{Use external tools}
\li \l{External Tool Specification Files}
\endlist
@@ -180,7 +180,7 @@
configure the tool in \QC, you can add an options page for it.
\list
\li \l{https://doc.qt.io/qtcreator/creator-editor-external.html}{Using External Tools}
\li \l{https://doc.qt.io/qtcreator/creator-editor-external.html}{Use external tools}
\li \l{External Tool Specification Files}
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
@@ -206,7 +206,7 @@
\list
\li \l{https://doc.qt.io/qtcreator/creator-task-lists.html}
{Showing Task List Files in Issues}
{Show task list files in Issues}
\li \l{Creating Plugins}
\li \l{Qt Creator Coding Rules}
\omit

2
doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc
View File

@@ -23,7 +23,7 @@
Some of the wizard templates create projects that contain UI files.
You should always edit UI files in the \l {2D}
and \l Properties view, to avoid breaking the code.
\li \l{Managing Data Collection}
\li \l{Manage Data Collection}
You can enable \QDS to report crashes automatically. If you enable
the telemetry plugin, you can turn on the pseudonymous user

2
doc/qtdesignstudio/src/qtdesignstudio-developer-topics.qdoc
View File

@@ -29,7 +29,7 @@
application development in Qt Creator, you have to convert
them to Qt Quick Application projects that contain .pro,
.cpp, and .qrc files.
\li \l{Using External Tools}
\li \l{Use external tools}
You can use external tools directly from \QDS. Qt Linguist,
QML utilities, the default text editor for your system, and the

6
doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
View File

@@ -238,9 +238,9 @@
\li Extending Component Functionality
\endomit
\li \l{UI Files}
\li \l{Managing Data Collection}
\li \l{Manage Data Collection}
\list
\li \l {Collecting Usage Statistics}
\li \l {Collect Usage Statistics}
\li \l {Collecting User Feedback}
\li \l {Reporting Crashes}
\endlist
@@ -251,7 +251,7 @@
\li \l{Using Git}
\li \l{Converting Qt 5 Projects into Qt 6 Projects}
\li \l{Converting UI Projects to Applications}
\li \l{Using External Tools}
\li \l{Use external tools}
\li \l{\QDS on MCUs}
\list
\li \l {\QDS Version Compatibility with \QMCU SDKs}

4
doc/qtdesignstudio/src/qtdesignstudio.qdoc
View File

@@ -72,7 +72,7 @@
\li \b {\l{Advanced Designer Topics}}
\list
\li \l{UI Files}
\li \l {Managing Data Collection}
\li \l {Manage Data Collection}
\li \l{Packaging Applications}
\endlist
\li \b {\l{Developer Topics}}
@@ -80,7 +80,7 @@
\li \l{Using Git}
\li \l{Converting Qt 5 Projects into Qt 6 Projects}
\li \l{Converting UI Projects to Applications}
\li \l{Using External Tools}
\li \l{Use external tools}
\li \l{\QDS on MCUs}
\endlist
\li \b {\l Help}