From ac252c2d49c6afb2a0f9faac4ffbf2f58e736ce9 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 6 Feb 2023 13:46:44 +0100 Subject: [PATCH] Doc: Make the locator more visible in the other parts of the docs Change-Id: Icdefa64f5874f14c6a9c6a24e4d73837c12b457f Reviewed-by: Eike Ziller --- doc/qtcreator/src/editors/creator-locator.qdoc | 3 +++ .../creator-file-system-view.qdoc | 5 +++++ .../user-interface/creator-projects-view.qdoc | 4 ++++ .../src/user-interface/creator-ui.qdoc | 17 ++++++++++------- .../src/user-interface/creator-views.qdoc | 4 ++++ 5 files changed, 26 insertions(+), 7 deletions(-) diff --git a/doc/qtcreator/src/editors/creator-locator.qdoc b/doc/qtcreator/src/editors/creator-locator.qdoc index 21630640e71..cefef039c4f 100644 --- a/doc/qtcreator/src/editors/creator-locator.qdoc +++ b/doc/qtcreator/src/editors/creator-locator.qdoc @@ -8,6 +8,9 @@ \title Searching with the Locator + The locator is the fastest way to find a particular project, file, class, or + function, or almost anything else in your project. + By default, you can find the locator in the bottom left of the \QC window. To open it as a centered popup, click \inlineimage icons/magnifier.png (\uicontrol Options) in it and select \uicontrol {Open as Centered Popup}. diff --git a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc index 416e32e02fc..e47328e744d 100644 --- a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc @@ -11,6 +11,11 @@ If you cannot see a file in the \l Projects view, switch to the \uicontrol {File System} view, which shows all the files in the file system. + \note Usually, \l{Searching with the Locator}{searching with the locator} + is the fastest way to find a particular project, file, class, or function, + or almost anything else in your project. Use the \e {file system (f)} filter + to open files from anywhere in the file system. + \if defined(qtdesignstudio) The following image displays the \uicontrol {File System} view in the \uicontrol Design mode: diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc index 4e2577cf7ca..85bdb4f1a51 100644 --- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc @@ -18,6 +18,10 @@ the build system structure of the project and lists all files that are part of the project. + \note Usually, \l{Searching with the Locator}{searching with the locator} + is the fastest way to find a particular project, file, class, or function, + or almost anything else in your project. + \if defined(qtdesignstudio) The following image displays the \uicontrol Projects view in the \uicontrol Design mode: diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index 8fb74a5a4ba..1e233283fdc 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -50,17 +50,20 @@ \endif \if defined(qtcreator) - Use the \l{Selecting Modes}{mode selector} (1) to change to another \QC mode. + Do you want to perform a particular task, such as designing the UI, + writing code, or debugging the application? Select the appropriate mode in + the \l{Selecting Modes}{mode selector} (1). - Use the kit selector (2) to select the \l{glossary-buildandrun-kit}{kit} for - running (3), debugging (4), or building (5) the application. The task bar (7) + Are you ready to build the application for particular hardware or (5) + run (3) or debug (4) it on a device? Use the kit selector (2) to select + the appropriate \l{glossary-buildandrun-kit}{kit}. The task bar (7) displays output from these actions. - Use the \l{Searching with the Locator}{locator} (6) to browse through - projects, files, classes, functions, documentation, and file systems. + Are you looking for a particular project, file, class, or function? + Start typing its name in the \l{Searching with the Locator}{locator} (6). - For a quick tour of the user interface that takes you to the locations of - these controls, select \uicontrol Help > \uicontrol {UI Tour}. + To see where the above controls are in the user interface, select + \uicontrol Help > \uicontrol {UI Tour}. The following sections describe some \QC controls in more detail: diff --git a/doc/qtcreator/src/user-interface/creator-views.qdoc b/doc/qtcreator/src/user-interface/creator-views.qdoc index 789c622f725..12faa3bb0d7 100644 --- a/doc/qtcreator/src/user-interface/creator-views.qdoc +++ b/doc/qtcreator/src/user-interface/creator-views.qdoc @@ -22,6 +22,10 @@ {mode} you are working in. Only views that are relevant to a mode are available in it. + \note Usually, \l{Searching with the Locator}{searching with the locator} + is the fastest way to find a particular project, file, class, or function, + or almost anything else in your project. + Manage projects and files in the following views: \list