From 792e73a1882720ce089d7b53a67096466bd3bb4a Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 23 Sep 2024 13:50:43 +0200 Subject: [PATCH] Doc: Add links to "Get and Install Qt" ...when discussing Qt Online Installer Fixes: QTCREATORBUG-31622 Change-Id: Ifefcffd8426a33085a840e9ac5ad747a6b9b6b73 Reviewed-by: Eike Ziller --- doc/qtcreator/src/android/androiddev.qdoc | 2 +- doc/qtcreator/src/conan/creator-projects-conan.qdoc | 4 ++-- doc/qtcreator/src/howto/creator-help.qdoc | 3 ++- .../howto/creator-only/creator-how-to-install-plugins.qdoc | 2 +- doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc | 2 +- doc/qtcreator/src/ios/creator-ios-dev.qdoc | 2 +- .../src/overview/creator-only/creator-configuring.qdoc | 2 +- .../src/overview/creator-only/creator-getting-started.qdoc | 2 +- .../src/overview/creator-only/creator-overview.qdoc | 6 +++--- .../creator-only/creator-projects-build-run-tutorial.qdoc | 4 ++-- .../projects/creator-only/creator-projects-compilers.qdoc | 6 +++--- .../projects/creator-only/creator-projects-qt-versions.qdoc | 2 +- .../creator-only/creator-projects-settings-overview.qdoc | 2 +- .../src/qtquick/creator-only/qtquick-creating.qdoc | 4 ++-- doc/qtcreator/src/reference/creator-sdk-tool.qdoc | 3 ++- doc/qtcreator/src/webassembly/creator-webassembly.qdoc | 4 ++-- 16 files changed, 26 insertions(+), 24 deletions(-) diff --git a/doc/qtcreator/src/android/androiddev.qdoc b/doc/qtcreator/src/android/androiddev.qdoc index e2b064d5b50..cc6c7d23b11 100644 --- a/doc/qtcreator/src/android/androiddev.qdoc +++ b/doc/qtcreator/src/android/androiddev.qdoc @@ -43,7 +43,7 @@ automatically download, install, and configure for you. \endlist - \sa {Android}{How To: Develop for Android} + \sa {Android}{How To: Develop for Android}, {Get and Install Qt} */ /*! diff --git a/doc/qtcreator/src/conan/creator-projects-conan.qdoc b/doc/qtcreator/src/conan/creator-projects-conan.qdoc index 67cdd9141ae..4ebd14aa9fb 100644 --- a/doc/qtcreator/src/conan/creator-projects-conan.qdoc +++ b/doc/qtcreator/src/conan/creator-projects-conan.qdoc @@ -31,8 +31,8 @@ sources. Because the client has a local cache for package storage, you can work offline, as long as no new packages are needed from remote servers. - To use Conan, install it by using \QOI or the tools that - your operating system has. For example, on Windows, you can use the + To use Conan, install it by using \l{Get and Install Qt}{\QOI} or the tools + that your operating system has. For example, on Windows, you can use the \c {choco install conan} or \c {pip install conan} command. \note Enable the Conan plugin to use it. diff --git a/doc/qtcreator/src/howto/creator-help.qdoc b/doc/qtcreator/src/howto/creator-help.qdoc index 530937337cc..06f669472f0 100644 --- a/doc/qtcreator/src/howto/creator-help.qdoc +++ b/doc/qtcreator/src/howto/creator-help.qdoc @@ -153,7 +153,8 @@ \endlist \if defined(qtcreator) - \sa {Read Documentation}{How To: Read Documentation} + \sa {Read Documentation}{How To: Read Documentation}, {Installation}, + {Get and Install Qt} \endif */ diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-to-install-plugins.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-to-install-plugins.qdoc index a0f0bb9adb8..fe844c7e952 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-how-to-install-plugins.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-how-to-install-plugins.qdoc @@ -38,5 +38,5 @@ \li Select \uicontrol {Restart Now} to restart \QC and load the plugin. \endlist - \sa {Enable and disable plugins} + \sa {Enable and disable plugins}, {Installation}, {Get and Install Qt} */ diff --git a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc index a67a8fb7657..63a428febe1 100644 --- a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc +++ b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc @@ -121,7 +121,7 @@ \b {The Qt API Reference Documentation is missing and context help does not find topics. What can I do?} - Install a Qt version and Qt documentation with \QOI. + Install a Qt version and Qt documentation with \l{Get and Install Qt}{\QOI}. To view the installed documentation (.qch files) and to add documentation, go to \preferences > \uicontrol Help > diff --git a/doc/qtcreator/src/ios/creator-ios-dev.qdoc b/doc/qtcreator/src/ios/creator-ios-dev.qdoc index b6c8d53cde9..e465b035617 100644 --- a/doc/qtcreator/src/ios/creator-ios-dev.qdoc +++ b/doc/qtcreator/src/ios/creator-ios-dev.qdoc @@ -17,7 +17,7 @@ configured iOS devices. You only need Qt libraries that are built for iOS. You can install Qt for iOS - with \QOI. + with \l{Get and Install Qt}{\QOI}. \section1 iOS 17 Devices diff --git a/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc b/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc index fa7b1ddc554..085be899eb3 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc @@ -178,5 +178,5 @@ For more information, see \l{Download highlight definitions}. - \sa {Installation}, {Reset \QC settings}, {Preferences} + \sa {Installation}, {Reset \QC settings}, {Preferences}, {Get and Install Qt} */ diff --git a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc index b1f4bc8dc61..b9548b24e60 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-getting-started.qdoc @@ -57,5 +57,5 @@ and APIs to develop Qt applications, go to \l {Qt Documentation}. \endtable - \sa {Installation} + \sa {Installation}, {Get and Install Qt} */ diff --git a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc index 9ab035a23e1..19717732963 100644 --- a/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc +++ b/doc/qtcreator/src/overview/creator-only/creator-overview.qdoc @@ -210,9 +210,9 @@ \li \l {Remote Linux} \endlist - Install the toolchain for building applications for the targeted - embedded platform on the computer, and then use \QOI to install Qt - libraries that are built for the platform. Add a kit with the toolchain and + Install the toolchain for building applications for the targeted embedded + platform on the computer, and then use \l{Get and Install Qt}{\QOI} to install + Qt libraries that are built for the platform. Add a kit with the toolchain and the Qt version for the device's architecture. When possible, \QOI creates suitable kits for you. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc index 206e028e348..a0ca1155568 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-build-run-tutorial.qdoc @@ -19,8 +19,8 @@ \brief How to build and run a Qt example. - To test that your \QOI installation is successful, open an existing - example application project. + To test that your \l{Get and Install Qt}{\QOI} installation is successful, + open an existing example application project. To run an example application on an Android or iOS device, you must set up the development environment for Android or iOS. For more information, see diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc index e068ec86d4f..991b8fbff84 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-compilers.qdoc @@ -22,9 +22,9 @@ necessary tools for building an application for and running it on a particular platform. - \QC automatically detects the compilers that your system or \QOI - registers and lists them in \preferences > \uicontrol Kits > - \uicontrol Compilers. + \QC automatically detects the compilers that your system or + \l{Get and Install Qt}{\QOI} registers and lists them in + \preferences > \uicontrol Kits > \uicontrol Compilers. \image qtcreator-toolchains.png diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc index 48958f8846e..a535c12b304 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-qt-versions.qdoc @@ -31,7 +31,7 @@ \section1 Register installed Qt versions - You can link to a Qt that \QOI installed to + You can link to a Qt that \l{Get and Install Qt}{\QOI} installed to automatically detect the installed Qt versions. However, you cannot link to a Qt that the system installed with some other package manager, such as your Linux distribution, brew on \macos, or Chocolatey on diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc index 942c42bddcf..bfe9f8a6832 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc @@ -105,7 +105,7 @@ \sa {Activate kits for a project}, {Configure projects for building}, {Configure projects for running}, {Open projects}, - {Activate custom output parsers} + {Activate custom output parsers}, {Get and Install Qt} */ /*! diff --git a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc index d0c4e64970e..f8d87dda1b1 100644 --- a/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc +++ b/doc/qtcreator/src/qtquick/creator-only/qtquick-creating.qdoc @@ -57,8 +57,8 @@ \note If you have not installed the Qt Virtual Keyboard module when you installed Qt, an error message will appear when you try to open - \e Main.qml for editing. You can use \l {Installing Qt} - {\QOI} to install Qt Virtual Keyboard. + \e Main.qml for editing. You can use \l{Get and Install Qt}{\QOI} + to install Qt Virtual Keyboard. \li Select \uicontrol Next to open the \uicontrol {Kit Selection} dialog. diff --git a/doc/qtcreator/src/reference/creator-sdk-tool.qdoc b/doc/qtcreator/src/reference/creator-sdk-tool.qdoc index 27f22f1bbce..547cc1b304d 100644 --- a/doc/qtcreator/src/reference/creator-sdk-tool.qdoc +++ b/doc/qtcreator/src/reference/creator-sdk-tool.qdoc @@ -12,7 +12,8 @@ \brief Configure CMake and set up compilers, debuggers, devices, Qt versions, and kits from the command line. - \QOI uses the SDK Tool (\c sdktool) to configure CMake and set \l {Kits}{Kit} + \l{Get and Install Qt}{\QOI} uses the SDK Tool (\c sdktool) to configure + CMake and set \l {Kits}{Kit} preferences, such as compilers, debuggers, devices, and Qt versions. You can use it from the command line to set Qt and \QC preferences automatically for all users of a computer, for example. For a single user, it is usually easier diff --git a/doc/qtcreator/src/webassembly/creator-webassembly.qdoc b/doc/qtcreator/src/webassembly/creator-webassembly.qdoc index ab757d7add0..37526abe87d 100644 --- a/doc/qtcreator/src/webassembly/creator-webassembly.qdoc +++ b/doc/qtcreator/src/webassembly/creator-webassembly.qdoc @@ -20,8 +20,8 @@ \note Enable the WebAssembly plugin to use it. To build applications for the web and run them in a web browser, install - Qt for WebAssembly with \QOI. It automatically adds a build and run kit - to \QC. + Qt for WebAssembly with \l{Get and Install Qt}{\QOI}. It automatically adds + a build and run kit to \QC. \section1 Set up WebAssembly development environment