forked from qt-creator/qt-creator
Doc: Move details of managing plugins into How-to topics
...from Configuring Qt Creator Create "Enable and disable plugins" and "Install plugins" topics. Task-number: QTCREATORBUG-29361 Change-Id: I51fdfad1cd7d210a72cf08ef3e82f08ae8c6ecac Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
BIN
doc/qtcreator/images/qtcreator-installed-plugins.webp
Normal file
BIN
doc/qtcreator/images/qtcreator-installed-plugins.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.0 KiB |
@@ -0,0 +1,35 @@
|
||||
// Copyright (C) 2023 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page creator-how-to-enable-plugins.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Enable and disable plugins
|
||||
|
||||
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
|
||||
after you restart \QC. By default, all the plugins that the plugin depends
|
||||
on are also enabled.
|
||||
|
||||
You can also disable plugins that you do not use, to streamline \QC.
|
||||
By default, all the plugins that depend on the plugin are also disabled.
|
||||
|
||||
To enable and disable plugins:
|
||||
|
||||
\list 1
|
||||
\li Select \uicontrol Help > \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
|
||||
it to disable a plugin.
|
||||
\li Select \uicontrol OK.
|
||||
\li Select \uicontrol {Restart Now} to restart \QC and have the changes
|
||||
take effect.
|
||||
\endlist
|
||||
|
||||
\sa {Install plugins}{How-to: Install plugins}
|
||||
*/
|
||||
@@ -0,0 +1,43 @@
|
||||
// Copyright (C) 2023 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
|
||||
|
||||
/*!
|
||||
\page creator-how-to-install-plugins.html
|
||||
\previouspage creator-how-tos.html
|
||||
\nextpage creator-known-issues.html
|
||||
\ingroup creator-how-to-use
|
||||
|
||||
\title Install plugins
|
||||
|
||||
\l{https://marketplace.qt.io/}{Qt Marketplace} has links to \QC plugins that
|
||||
you can download and install either for free or for a price set by their
|
||||
publisher. Browse the available plugins in the \uicontrol Marketplace tab
|
||||
in the \uicontrol Welcome mode.
|
||||
|
||||
You can also install plugins from other sources, such as
|
||||
\l{https://github.com/}{GitHub}.
|
||||
|
||||
\note You can install only plugins that your \QC version supports.
|
||||
|
||||
To install plugins:
|
||||
|
||||
\list 1
|
||||
\li Select \uicontrol Help > \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
|
||||
\li In the \uicontrol {Install Location} dialog, select
|
||||
\uicontrol {User plugins} to make the plugin available for the
|
||||
current user in all compatible \QC instances or
|
||||
\uicontrol {\QC installation} to make the plugin available for
|
||||
all users of a particular \QC instance.
|
||||
\image qtcreator-install-plugin-location.png
|
||||
\li In the \uicontrol Summary dialog, select \uicontrol Finish to
|
||||
install the plugin.
|
||||
\image qtcreator-install-plugin-summary.png
|
||||
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
|
||||
\endlist
|
||||
|
||||
\sa {Enable and disable plugins}{How-to: Enable and disable plugins}
|
||||
*/
|
||||
@@ -64,7 +64,9 @@
|
||||
\section1 Use \QC
|
||||
|
||||
\list
|
||||
\li \l {Enable and disable plugins}
|
||||
\li \l {Find settings files}
|
||||
\li \l {Install plugins}
|
||||
\li \l {Run \QC from the command line}
|
||||
\endlist
|
||||
*/
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
in different build and run \l{glossary-buildandrun-kit}{kits}.
|
||||
|
||||
\note Meson build plugin is disabled by default, see
|
||||
\l{Enabling and Disabling Plugins}.
|
||||
\l{Enable and disable plugins}{How-to: Enable and disable plugins}.
|
||||
|
||||
\section1 Adding Meson Tools
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
// **********************************************************************
|
||||
@@ -142,55 +142,16 @@
|
||||
\section1 Managing Plugins
|
||||
|
||||
\QC comes with a set of plugins, some of which are disabled by default.
|
||||
You can enable disabled plugins if you need them and disable plugins you
|
||||
don't need.
|
||||
You can \l{Enable and disable plugins}{enable} disabled plugins if you
|
||||
need them and disable plugins you don't need.
|
||||
|
||||
You can download and install additional plugins from
|
||||
You can \l{Install plugins}{download and install} more plugins from
|
||||
\l{https://marketplace.qt.io/}{Qt Marketplace} or some
|
||||
other source, such as \l{https://github.com/}{GitHub}.
|
||||
|
||||
\section2 Enabling and Disabling Plugins
|
||||
|
||||
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
|
||||
after you restart \QC. By default, all the plugins that the plugin depends
|
||||
on are also enabled.
|
||||
|
||||
You can also disable plugins that you do not use, to streamline \QC.
|
||||
By default, all the plugins that depend on the plugin are also disabled.
|
||||
|
||||
To enable and disable plugins, select \uicontrol Help >
|
||||
\uicontrol {About Plugins}.
|
||||
|
||||
\image qtcreator-installed-plugins.png "Installed Plugins dialog"
|
||||
|
||||
\section2 Installing Plugins
|
||||
|
||||
Qt Marketplace has links to \QC plugins that you can download and
|
||||
install either for free or for a price set by their publisher. You can
|
||||
browse the available plugins in the \uicontrol Marketplace tab in the
|
||||
Welcome mode.
|
||||
|
||||
\note You can install only plugins that your \QC version supports.
|
||||
|
||||
To install plugins:
|
||||
|
||||
\list 1
|
||||
\li Select \uicontrol Help > \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
|
||||
\li In the \uicontrol {Install Location} dialog, select
|
||||
\uicontrol {User plugins} to make the plugin available for the
|
||||
current user in all compatible \QC instances or
|
||||
\uicontrol {\QC installation} to make the plugin available for
|
||||
all users of a particular \QC instance.
|
||||
\image qtcreator-install-plugin-location.png
|
||||
\li In the \uicontrol Summary dialog, select \uicontrol Finish to
|
||||
install the plugin.
|
||||
\image qtcreator-install-plugin-summary.png
|
||||
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
|
||||
\endlist
|
||||
To install plugins, select \uicontrol Help > \uicontrol {About Plugins} >
|
||||
\uicontrol {Install Plugins}.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user