Doc: Make the instructions for enabling plugins more consistent

- Add the following for documented plugins that are
  disabled by default: \note Enable the <name> plugin to use it
- Add \sa {Enable and disable plugins} for the above plugins and
  describe there how to find the About Plugins dialog on macOS
- For the one occurrence in the QDS Manual, add instructions for
  finding the About Plugins dialog on macOS ("Enable and disable plugins"
  is not included in the QDS Manual
- Mostly remove other kinds of references to enabling plugins

Task-number: QTCREATORBUG-29734
Change-Id: I7b12bd651c1c99e0c6b3ca6f94d3831ebe038438
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-10-26 13:22:49 +02:00
parent b77b12c97b
commit 022847c852
27 changed files with 108 additions and 190 deletions

View File

@@ -25,6 +25,8 @@
The experimental Axivion plugin integrates the Axivion dashboard server into
\QC.
\note Enable the Axivion plugin to use it.
To use the plugin, you must set up a project in the Axivion dashboard
server and link to it from \QC. You can then see style violations in the
\uicontrol Edit mode and descriptions and issue counts in the
@@ -44,16 +46,6 @@
To view the issue counts, select \inlineimage icons/home.png
(\uicontrol {Show Dashboard}).
\section1 Enabling the Axivion Plugin
To enable the Axivion plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Code Analyzer} > \uicontrol Axivion to enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\section1 Connecting to Axivion Dashboard Servers
To connect to Axivion:
@@ -106,4 +98,6 @@
To clear the view, select \inlineimage icons/clean_pane_small.png
(\uicontrol Clear).
\sa {Enable and disable plugins}
*/

View File

@@ -42,15 +42,7 @@
To use the plugin, you must download and install Coco.
\section1 Enabling the Coco Plugin
To enable the Coco plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol Coco to enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\note Enable the Coco plugin to use it.
\section1 Configuring Coco
@@ -93,5 +85,5 @@
\li Implicit Manual Coverage Validation
\endlist
For more information, see \l{Specifying Text Editor Settings}.
\sa {Enable and disable plugins}, {Specifying Text Editor Settings}
*/

View File

@@ -15,20 +15,12 @@
The experimental Cppcheck Diagnostics plugin integrates diagnostics
that are generated by the Cppcheck tool into the C++ editor.
\note Enable the Cppcheck plugin to use it.
Cppcheck is automatically run on open files. To select the files to
check in the currently active project, select \uicontrol Analyze >
\uicontrol Cppcheck.
\section1 Enabling the Cppcheck Plugin
To enable the Cppcheck plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Code Analyzer} > \uicontrol Cppcheck to enable the
plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\section1 Running Cppcheck on Selected Files
@@ -74,4 +66,6 @@
To specify the settings above for the automatically run checks,
select \preferences > \uicontrol Analyzer
> \uicontrol Cppcheck.
\sa {Enable and disable plugins}
*/

View File

@@ -54,18 +54,7 @@
ST-Link and J-Link debug server providers can be used together with
the \l {uVision IDE}.
\section1 Enabling the Bare Metal Device Plugin
To enable the Bare Metal Device plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Device Support} > \uicontrol {Bare Metal}.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\note Enable the Bare Metal plugin to use it.
\section1 Specifying Settings for Debug Server Providers
@@ -273,4 +262,6 @@
You can build applications for and run them on bare metal devices
in the same way as for and on the desktop. For more information, see
\l{Building for Multiple Platforms} and \l{Running on Multiple Platforms}.
\sa {Enable and disable plugins}
*/

View File

@@ -35,9 +35,7 @@
your operating system has. For example, on Windows, you can use the
\c {choco install conan} or \c {pip install conan} command.
To enable the experimental Conan plugin, select \uicontrol Help >
\uicontrol {About Plugins} > \uicontrol Utilities > \uicontrol Conan.
Then select \uicontrol {Restart Now} to restart \QC and load the plugin.
\note Enable the Conan plugin to use it.
For each project, you must write a
\l{https://docs.conan.io/en/latest/reference/conanfile.html}{conanfile.py}
@@ -49,4 +47,6 @@
Alternatively, you can automatically set up the Conan package manager for
use with CMake. For more information, see \l{Using CMake with Conan}.
\sa {Enable and disable plugins}
*/

View File

@@ -107,7 +107,7 @@
You can use \QC to create applications that embed state machines. A
project wizard creates \l{https://www.w3.org/TR/scxml/}
{State Chart XML (SCXML)} files with boilerplate code that you can
edit using an experimental SCXML editor. You can use the classes in
edit using an SCXML editor. You can use the classes in
the Qt SCXML module to embed state machines created from the files
in Qt applications.

View File

@@ -32,6 +32,12 @@
specified in the Beautifier preferences. You can use a predefined style or
define your own style.
\note Enable the Beautifier plugin to use it. Since \QC 10.0.0, the
ClangFormat plugin is enabled by default. Select \preferences >
\uicontrol {C++} > \uicontrol {Formatting mode} > \uicontrol Disable
to turn off ClangFormat if you enable Beautifier because combining
them can lead to unexpected results.
To use the Beautifier plugin:
\list 1
@@ -48,17 +54,6 @@
You might have to build the tools from sources for some platforms.
\li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} >
\uicontrol Beautifier to enable the plugin.
\note Since \QC 10.0.0, the ClangFormat plugin is enabled by
default. Select \preferences >
\uicontrol {C++} > \uicontrol {Formatting mode} > \uicontrol Disable
to turn off ClangFormat if you enable Beautifier because combining
them can lead to unexpected results.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \preferences >
\uicontrol Beautifier to specify settings for beautifying files.
@@ -168,4 +163,6 @@
select it when no text is selected, the whole file is formatted by default.
To disable this behavior, deselect the
\uicontrol {Format entire file if no text was selected} check box.
\sa {Enable and disable plugins}
*/

View File

@@ -25,6 +25,8 @@
the files in a compilation database with access to all the editing features
of the Clang code model.
\note Enable the Compilation Database Project Manager plugin to use it.
To switch between header and source files, select \uicontrol Tools >
\uicontrol C++ > \uicontrol {Switch Header/Source}.
@@ -32,9 +34,7 @@
database projects in the \uicontrol Projects mode. For more information,
see \l{Adding Custom Build Steps} and \l {Specifying Run Settings}.
To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Build Systems} > \uicontrol {Compilation Database Project Manager}.
Then select \uicontrol {Restart Now} to restart \QC and load the plugin.
\sa {Enable and disable plugins}
//! [using compilation databases]
*/

View File

@@ -31,17 +31,6 @@
{Copilot.vim/Readme.md}.
\endlist
\section1 Enabling the Copilot Plugin
To enable the Copilot plugin:
\list 1
\li Select \uicontrol Help (or \uicontrol {\QC} on \macos) >
\uicontrol {About Plugins} > \uicontrol Utilities >
\uicontrol Copilot to enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\section1 Setting Copilot Preferences
To set preferences for using Copilot:
@@ -117,4 +106,6 @@
select \uicontrol Projects > \uicontrol {Project Settings} >
\uicontrol Copilot, and then select or deselect the
\uicontrol {Enable Copilot} check box.
\sa {Enable and disable plugins}
*/

View File

@@ -22,12 +22,11 @@
\e event, but also on earlier events. With state charts, you
can easily share this information.
\QC has a project wizard for adding \l{https://www.w3.org/TR/scxml/}
{State Chart XML (SCXML)} files with boilerplate code to projects and an
experimental SCXML editor for editing the state charts. You can use the
SCXML editor to add \e states and \e transitions to the files. You can then
use the classes in the Qt SCXML module to embed the state machines created
from the files in Qt applications.
With the \QC project wizard you can add \l{https://www.w3.org/TR/scxml/}
{State Chart XML (SCXML)} files with boilerplate code to projects. Edit
the state charts with the SCXML editor to add \e states and \e transitions
to the files. Then, use the classes in the Qt SCXML module to embed the
state machines created from the files in Qt applications.
\image qtcreator-scxml-editor.png SXCML Editor
@@ -83,11 +82,6 @@
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Modeling > \uicontrol ScxmlEditor.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \uicontrol File > \uicontrol {New File} >
\uicontrol {Files and Classes} > \uicontrol Modeling >
\uicontrol {State Chart} > \uicontrol Choose to create an empty

View File

@@ -219,7 +219,9 @@
\section1 Enabling Silver Searcher
You can use Silver Searcher as a search engine in \QC if you install
Silver Searcher on the development PC and enable the experimental plugin.
Silver Searcher on the development PC.
\note Enable the SilverSearcher plugin to use it.
To use Silver Searcher:
@@ -232,12 +234,6 @@
You might have to build Silver Searcher from sources for some
platforms.
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Utilities} > \uicontrol {SilverSearcher} to enable the
plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li When searching, select \uicontrol {Silver Searcher} in the
\uicontrol {Search engine} field.
@@ -248,5 +244,7 @@
and add the entry \c{PATH=/path/to/bin:${PATH}}.
\endlist
\sa {Enable and disable plugins}
\endif
*/

View File

@@ -453,7 +453,11 @@
You can specify shortcuts for executing actions in a way that is familiar to
\l{https://www.gnu.org/software/emacs/manual/html_node/emacs/index.html}
{Emacs} editor users. The actions are not bound to any key combinations by
default. The following actions are available:
default.
\note Enable the EmacsKeys plugin to use the shortcuts.
The following actions are available:
\list
\li Copy
@@ -790,7 +794,11 @@
\endif
\sa {Assign keyboard shortcuts}, {Find keyboard shortcuts},
{Import and export keyboard shortcuts}
{Import and export keyboard shortcuts}
\if defined(qtcreator)
\sa {Enable and disable plugins}
\endif
*/
/*!

View File

@@ -9,6 +9,18 @@
\title Enable and disable plugins
\QC uses standard names and locations on Linux, \macos, and Windows for
standard features, such as \e about dialogs.
\table
\header
\li Linux and Windows
\li \macos
\row
\li \uicontrol Help > \uicontrol {About Plugins}
\li \uicontrol {\QC} > \uicontrol {About Plugins}
\endtable
New \QC plugins are often introduced as \e {experimental plugins} to let you
try them out before they are fully supported. Experimental plugins are
disabled by default and you must enable them for them to become visible
@@ -24,7 +36,7 @@
To enable and disable plugins:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins}.
\li Go to \uicontrol {About Plugins}.
\li Start typing in the \uicontrol Filter field to find a plugin.
\image qtcreator-installed-plugins.webp {Installed Plugins dialog}
\li Select the \uicontrol Load check box to enable a plugin, or deselect
@@ -34,5 +46,5 @@
take effect.
\endlist
\sa {Install plugins}{How To: Install plugins}
\sa {Install plugins}
*/

View File

@@ -22,8 +22,7 @@
To install plugins:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Install Plugins}.
\li Go to \uicontrol {About Plugins} > \uicontrol {Install Plugins}.
\li In the \uicontrol Source dialog, enter the path to the archive
or library that has the plugin.
\image qtcreator-install-plugin-source.png
@@ -39,5 +38,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}
*/

View File

@@ -42,15 +42,7 @@
To use the plugin, you must download and install Squish, create a connection
to the Squish Server, and specify AUTs to run.
\section1 Enabling the Squish Plugin
To enable the Squish plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol Squish to enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\note Enable the Squish plugin to use it.
\section1 Specifying a Squish Server
@@ -328,4 +320,6 @@
output, \uicontrol {Runner/Server Log} tab.
\image qtcreator-squish-output-runner-server-log.png "Runner and Server Log output"
\sa {Enable and disable plugins}
*/

View File

@@ -18,15 +18,7 @@
You can use \QC to create and edit vcpkg.json files to specify packages to
build as part of your project when using CMake as the build system.
\section1 Enabling the vcpkg Plugin
To enable the vcpkg plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol Vcpkg to enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\note Enable the Vcpkg plugin to use it.
\section1 Setting vcpkg Preferences
@@ -86,4 +78,6 @@
To set the path to the directory where you installed vcpkg, select
\inlineimage icons/settings.png
(\uicontrol Configure) on the editor toolbar.
\sa {Enable and disable plugins}
*/

View File

@@ -34,7 +34,9 @@
{Enable Usage Statistics} in the splash screen that appears when you first
launch \QDS. If the splash screen does not appear, you can enable the
telemetry plugin by selecting \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol UsageStatistic.
\uicontrol Utilities > \uicontrol UsageStatistic on Linux and Windows (or
\uicontrol {\QDS} > \uicontrol {About Plugins} > \uicontrol Utilities >
\uicontrol UsageStatistic on \macos).
\image studio-usage-statistics.png "Enabling Usage Statistics"
\endif

View File

@@ -23,8 +23,7 @@
\c PATH. You can add paths to other Meson or Ninja executables and use them
in different build and run \l{glossary-buildandrun-kit}{kits}.
\note Meson build plugin is disabled by default, see
\l{Enable and disable plugins}{How To: Enable and disable plugins}.
\note Enable the Meson plugin to use it.
\section1 Adding Meson Tools
@@ -86,5 +85,6 @@
\li Adding files to Meson projects from \QC.
\endlist
\sa {Open projects}, {Meson Build Configuration}, {Specifying Run Settings}
\sa {Enable and disable plugins}, {Open projects},
{Meson Build Configuration}, {Specifying Run Settings}
*/

View File

@@ -12,11 +12,9 @@
\brief \QC can open projects that use the Autotools build system. You can
build and run the projects directly from \QC.
The AutotoolsProjectManager is a plugin for autotools support. It is
disabled by default. To enable the plugin, select \uicontrol Help >
\uicontrol {About Plugins} > \uicontrol {Build Systems} >
\uicontrol AutotoolsProjectManager. Then select \uicontrol {Restart Now}
to restart \QC and load the plugin.
The AutotoolsProjectManager is a plugin for autotools support.
\note Enable the Autotools plugin to use it.
To work with your Autotools project in \QC:
@@ -47,4 +45,6 @@
\image qtcreator-autotools-buildsettings.png
\endlist
\sa {Enable and disable plugins}
*/

View File

@@ -17,10 +17,7 @@
\l{https://nim-lang.org/}{Nim} and uses the Nim compiler to generate
executables that are supported on Windows, Linux, and \macos.
To use \QC for Nim development, you need to enable the experimental
Nim plugin. Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Other Languages} > \uicontrol Nim. Then select
\uicontrol {Restart Now} to restart \QC and load the plugin.
\note Enable the Nim plugin to use Nimble and Nim.
In addition, you have to download and install Nim and set up a Nim kit
in \QC.
@@ -62,4 +59,6 @@
\image qtcreator-project-nimble.png
\li Select \uicontrol Next to create the project.
\endlist
\sa {Enable and disable plugins}
*/

View File

@@ -21,13 +21,5 @@
For more information about using \QMLD, see \l{Qt Design Studio Manual}.
\section1 Enabling the \QMLD Plugin
To enable the \QMLD plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Qt Quick} > \uicontrol {QmlDesigner}.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\sa {Enable and disable plugins}
*/

View File

@@ -9,6 +9,8 @@
\title To-Do Entries
\note Enable the Todo plugin to use it.
\brief Lists the BUG, FIXME, NOTE, TODO, and WARNING keywords from the
current file, from all project files, or from a subproject.
@@ -21,17 +23,6 @@
analysis tools in \l Issues. For more information, see
\l{Show task list files in Issues}.
\section1 Enabling the To-Do Plugin
The Todo plugin is disabled by default. To enable it:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Utilities > \uicontrol Todo.
\li Select \uicontrol OK.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\section1 To-Do Preferences
To add keywords, select \preferences >

View File

@@ -15,16 +15,13 @@
GitLab servers and use \l{Git} to manage your local and remote
repositories.
To enable the experimental GitLab plugin, select \uicontrol Help >
\uicontrol {About Plugins} > \uicontrol {Version Control} >
\uicontrol GitLab. Then select \uicontrol {Restart Now} to
restart \QC and load the plugin.
To use GitLab, you must create a connection to the GitLab server and clone
the projects you want to work on. You can also link previously cloned
projects to GitLab in the project settings. This enables you to receive
event notifications in the \l {View output}{Version Control} pane.
\note Enable the GitLab plugin to use it.
\section1 Connecting to GitLab Servers
To connect to a GitLab server, you need to specify the server host name and
@@ -125,6 +122,6 @@
To stop the reception of event notifications, select
\uicontrol {Unlink from GitLab}.
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}, {Git}
\sa {Enable and disable plugins}, {Set up version control systems},
{Use common VCS functions}, {Version Control Systems}, {Git}
*/

View File

@@ -20,15 +20,7 @@
Perforce is a fast software configuration management system developed by
Perforce Software.
\section1 Enabling the Perforce Plugin
To enable the Perforce plugin:
\list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Perforce.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\note Enable the Perforce plugin to use it.
\section1 Configuring Perforce
@@ -69,6 +61,6 @@
To view information about change lists and the files in them, select
\uicontrol Tools > \uicontrol Perforce > \uicontrol Describe.
\sa {Set up version control systems}, {Use common VCS functions},
{Version Control Systems}
\sa {Enable and disable plugins}, {Set up version control systems},
{Use common VCS functions}, {Version Control Systems}
*/

View File

@@ -35,21 +35,15 @@
\row
\li \l{ClearCase}
\li \l{http://www-01.ibm.com/software/awdtools/clearcase/}
\li Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol ClearCase.
Then select \uicontrol {Restart Now} to restart \QC
and load the plugin.
\li Enable the plugin to use it.
\row
\li \l{CVS}
\li \l{http://www.nongnu.org/cvs/}
\li
\li Enable the plugin to use it.
\row
\li \l{Fossil}
\li \l{https://fossil-scm.org/index.html/doc/trunk/www/index.wiki}
\li Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Fossil.
\li Enable the plugin to use it.
\row
\li \l{Git}
\li \l{http://git-scm.com/}
@@ -59,7 +53,7 @@
\row
\li \l{GitLab}
\li \l{http://gitlab.com/}
\li Experimental
\li Enable the plugin to use it.
\row
\li \l{Mercurial}
\li \l{http://mercurial.selenic.com/}
@@ -69,16 +63,14 @@
\li \l{http://www.perforce.com}
\li Server version 2006.1 and later
Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Perforce.
Enable the plugin to use it.
\row
\li \l{Subversion}
\li \l{http://subversion.apache.org/}
\li Subversion version 1.7.0 and later
\endtable
\sa {Create VCS repositories for new projects},
\sa {Create VCS repositories for new projects}, {Enable and disable plugins},
{Set up version control systems}, {Use common VCS functions}
*/

View File

@@ -21,6 +21,8 @@
You can change the web browser in the project's \l{Specifying Run Settings}
{run settings}.
\note Enable the WebAssembly plugin to use it.
To build applications for the web and run them in a web browser, you need to
install Qt for WebAssembly and the tool chain for compiling to WebAssembly.
@@ -56,16 +58,6 @@
{Install Emscripten}.
\endlist
\section2 Enabling the WebAssembly Plugin
To enable the plugin:
\list 1
\li In \QC, select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Device Support} > \uicontrol {WebAssembly}.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\endlist
\section2 Specifying WebAssembly Settings
To configure \QC for building Qt apps for the web:
@@ -119,4 +111,6 @@
You can now build Qt applications in WebAssembly format and run them in
a web browser as described in \l {Building for Multiple Platforms} and
\l{Running on Multiple Platforms}.
\sa {Enable and disable plugins}
*/

View File

@@ -47,7 +47,8 @@
located in \c {<Qt_version>\<compiler>\bin} in the Qt installation
directory. It fetches plugins from the \c {\plugins\designer} subdirectory
of \c bin. To check which plugins were loaded successfully and which failed,
choose \uicontrol Help > \uicontrol {About Plugins}.
choose \uicontrol Help > \uicontrol {About Plugins} on Linux and Windows
(or \uicontrol {\QC} > \uicontrol {About Plugins} on \macos).
\section1 Matching Build Keys