From a23b9333080dec3ed9b9b8c1548a97a81b0ffaa6 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 3 Jul 2023 14:44:17 +0200 Subject: [PATCH] Doc: Combine "Working with Sidebars" and "Show and hide sidebars" - Sidebars are hidden in QDS and the views can be added to workspaces, so hide references to sidebars on the QDS side. Task-number: QTCREATORBUG-29361 Change-Id: Ic468f6f818bddb391bd9514d273ecf8b6b412187 Reviewed-by: Mats Honkamaa --- .../src/editors/creator-coding-edit-mode.qdoc | 15 ++++---- .../howto/creator-only/creator-how-tos.qdoc | 22 ------------ .../howto/creator-only/creator-squish.qdoc | 2 +- doc/qtcreator/src/qtcreator-toc.qdoc | 1 - .../creator-file-system-view.qdoc | 23 ++++--------- ...creator-how-to-show-and-hide-sidebars.qdoc | 34 +++++++++++++++++++ .../user-interface/creator-projects-view.qdoc | 31 ++++++----------- .../src/user-interface/creator-ui.qdoc | 4 +-- .../src/user-interface/creator-views.qdoc | 15 ++++---- .../src/qtdesignstudio-toc.qdoc | 1 - 10 files changed, 70 insertions(+), 78 deletions(-) create mode 100644 doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-sidebars.qdoc diff --git a/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc b/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc index fb7cc429f43..c5042fd7553 100644 --- a/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc +++ b/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc @@ -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 // ********************************************************************** @@ -11,7 +11,7 @@ \previouspage creator-editor-functions.html \page creator-coding-navigating.html \if defined(qtdesignstudio) - \nextpage creator-sidebars.html + \nextpage creator-views.html \else \nextpage creator-highlighting.html \endif @@ -246,7 +246,12 @@ \endlist To view the note, move the mouse pointer over the bookmark or open the - \uicontrol Bookmarks view in the \l{Working with Sidebars}{sidebar}. + \uicontrol Bookmarks view + \if defined(qtcreator) + in the \l{Show and hide sidebars}{sidebar}. + \else + in the \l{Managing Workspaces}{workspace}. + \endif \section2 Navigating Bookmarks @@ -358,13 +363,11 @@ \QC underlines semantic errors in olive in the C++ code editor. To check the correct paths for includes that are not resolved or that are resolved to the wrong file, select \uicontrol {Project Parts} > \uicontrol {Header Paths}. - \endif - \if defined(qtdesignstudio) + \else \section1 Related Topics \list - \li \l{Working with Sidebars} \li \l{Browsing Project Contents} \li \l{Viewing Output} \endlist diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc index c90ba786bc5..ae2b15c2509 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc @@ -193,28 +193,6 @@ For more information, see \l{Using Command Line Options}. */ -/*! - \page creator-how-to-show-and-hide-sidebars.html - \previouspage creator-how-tos.html - \nextpage creator-known-issues.html - \ingroup creator-how-to-ui - - \title Show and hide sidebars - - You can toggle the left and right sidebar in some \QC modes. - - To toggle the left sidebar, click \inlineimage icons/leftsidebaricon.png - (\uicontrol {Hide Left Sidebar/Show Left Sidebar}) or press \key Alt+0 - (\key Cmd+0 on \macos). - - To toggle the right sidebar, click \inlineimage icons/rightsidebaricon.png - (\uicontrol {Hide Right Sidebar/Show Right Sidebar}) or press - \key Alt+Shift+0 (\key Cmd+Shift+0 on \macos). - - For more information on using the sidebars, see - \l {Browsing Project Contents}. -*/ - /*! \page creator-how-to-move-to-symbols.html \previouspage creator-how-tos.html diff --git a/doc/qtcreator/src/howto/creator-only/creator-squish.qdoc b/doc/qtcreator/src/howto/creator-only/creator-squish.qdoc index 27918da3e48..874b4b389e4 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-squish.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-squish.qdoc @@ -130,7 +130,7 @@ \section1 Managing Test Suites and Cases You can manage Squish test suites and cases in the \uicontrol Squish - \l {Working with Sidebars}{view}. + \l {Show and hide sidebars}{view}. \image qtcreator-squish-view.png "Squish sidebar view" diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 3c9e696fdb2..eb8ced88e3b 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -19,7 +19,6 @@ \li \l{IDE Overview} \li \l{User Interface} \list - \li \l{Working with Sidebars} \li \l{Browsing Project Contents} \list \li \l{Projects} 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 da554a3ab08..b7eddea19a0 100644 --- a/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-file-system-view.qdoc @@ -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,8 +8,7 @@ \title File System - 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. + The \uicontrol {File System} view 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, @@ -17,12 +16,9 @@ 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: - - \image qtcreator-filesystem-view-design.png "File System view in the Design mode" + \image qtcreator-filesystem-view-design.png {File System view} \else - \image qtcreator-filesystem-view.webp "File System view in the sidebar" + \image qtcreator-filesystem-view.webp {File System view in the sidebar} \endif To move to the root directory of the file system, select \uicontrol Computer @@ -87,19 +83,11 @@ \li Collapse all open folders. \endlist + \if defined(qtcreator) \section1 File System View Toolbar - \if defined(qtdesignstudio) - In the \uicontrol Edit and \uicontrol Debug mode, the - \uicontrol {File System} view is displayed in the \l{Working with Sidebars} - {sidebar}. It has a toolbar with additional options. - - \image qtcreator-filesystem-view.webp "File System view in the sidebar" - \else The toolbar in the \uicontrol {File System} view has additional options. - \endif - To manage view contents, select \inlineimage icons/filtericon.png (\uicontrol Options): @@ -116,4 +104,5 @@ To stop the synchronization with the file currently open in the editor, deselect \inlineimage icons/linkicon.png (\uicontrol {Synchronize with Editor}). + \endif */ diff --git a/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-sidebars.qdoc b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-sidebars.qdoc new file mode 100644 index 00000000000..d1a07de2cef --- /dev/null +++ b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-sidebars.qdoc @@ -0,0 +1,34 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page creator-how-to-show-and-hide-sidebars.html + \previouspage creator-how-tos.html + \nextpage creator-known-issues.html + \ingroup creator-how-to-ui + + \title Show and hide sidebars + + In some \l{Switch between modes}{modes}, you can use a left and right + sidebar to organize different views into project contents. Only views + that are relevant to the mode you are working in are available in it. + + Select views in the sidebar menu (1): + + \image qtcreator-sidebar.png + + You can change the view of the sidebars in the following ways: + + \list + \li To toggle the left sidebar, click \inlineimage icons/leftsidebaricon.png + (\uicontrol {Hide Left Sidebar/Show Left Sidebar}) or press + \key Alt+0 (\key Cmd+0 on \macos). + \li To toggle the right sidebar, click \inlineimage icons/rightsidebaricon.png + (\uicontrol {Hide Right Sidebar/Show Right Sidebar}) or press + \key Alt+Shift+0 (\key Cmd+Shift+0 on \macos). + \li To split a sidebar, click \inlineimage icons/splitbutton_horizontal.png + (\uicontrol {Split}). Select new content to view in the split view. + \li To close a sidebar view, click \inlineimage icons/splitbutton_closetop.png + (\uicontrol {Close}). + \endlist +*/ diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc index 431227e4fc5..ef356c81cf4 100644 --- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc @@ -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 /*! @@ -13,6 +13,7 @@ \title Projects The \uicontrol Projects view displays projects in a project tree. + The project tree has a list of all projects open in the current \l{Managing Sessions}{session}. For each project, the tree visualizes the build system structure of the project and lists all files that @@ -23,12 +24,9 @@ or almost anything else in your project. \if defined(qtdesignstudio) - The following image displays the \uicontrol Projects view in the - \uicontrol Design mode: - - \image qtcreator-projects-view-design.png "Projects view in the Design mode" + \image qtcreator-projects-view-design.png {Projects view} \else - \image qtcreator-projects-view-edit.png "Projects view in the sidebar" + \image qtcreator-projects-view-edit.png {Projects view in the sidebar} \endif You can use the project tree in the following ways: @@ -54,6 +52,9 @@ configuration files. \endlist + \note 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. + \section1 Projects View Context Menu The \uicontrol Projects view has context menus for managing projects, @@ -61,8 +62,10 @@ projects and subprojects: \list + \if defined(qtcreator) \li Set a project as the active project. - \li Execute the \uicontrol Build menu commands. + \endif + \li Execute \uicontrol Build menu commands. \li Create new files. For more information, see \if defined(qtdesignstudio) \l{Adding Files to Projects}. @@ -109,18 +112,10 @@ the \l {File System} view. To view a project in it, select \uicontrol {Show in File System View}. + \if defined(qtcreator) \section1 Projects View Toolbar - \if defined(qtdesignstudio) - In the \uicontrol Edit and \uicontrol Debug mode, the - \l{Working with Sidebars}{sidebar} has the \uicontrol Projects - view. It has a toolbar with additional options. - - \image qtcreator-projects-view-edit.png "Projects view in the sidebar" - \else The toolbar in the \uicontrol Projects view has additional options. - \endif - To filter view contents, select \inlineimage icons/filtericon.png (\uicontrol {Filter Tree}): @@ -143,7 +138,6 @@ currently opened in the editor, deselect \inlineimage icons/linkicon.png (\uicontrol {Synchronize with Editor}). - \if defined(qtcreator) Some build systems support adding and removing files to a project in \QC (currently qmake and Qbs). The faithful display of the project structure enables you to specify exactly where to place a new file in the build system. @@ -155,8 +149,5 @@ from the version control system in brackets after the project name. \QC currently implements this for Git (the view displays the branch name or a tag) and ClearCase (the view displays the branch name). - \else - If the project is under Git version control, you can see the currently - checked out branch or tag in brackets after the project name. \endif */ diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index 5afdb8986d0..29fe61bb26b 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -14,7 +14,7 @@ \nextpage creator-using-qt-quick-designer.html \else \previouspage creator-overview.html - \nextpage creator-sidebars.html + \nextpage creator-views.html \endif \title User Interface @@ -82,7 +82,7 @@ For information about new features and bug fixes in each \QC release, select \uicontrol Help > \uicontrol {Change Log}. - \sa {Working with Sidebars}, {Browsing Project Contents} + \sa {Show and hide sidebars}, {Browsing Project Contents} \sa {Use the UI}{How-to: Use the UI} \else diff --git a/doc/qtcreator/src/user-interface/creator-views.qdoc b/doc/qtcreator/src/user-interface/creator-views.qdoc index 1add46b099f..673e902736d 100644 --- a/doc/qtcreator/src/user-interface/creator-views.qdoc +++ b/doc/qtcreator/src/user-interface/creator-views.qdoc @@ -1,25 +1,24 @@ -// 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-views.html - \previouspage creator-sidebars.html \if defined(qtdesignstudio) + \previouspage creator-coding-navigating.html \nextpage creator-output-panes.html \else + \previouspage creator-quick-tour.html \nextpage creator-projects-view.html \endif \title Browsing Project Contents - You can organize \QC views in \l {Working with Sidebars}{sidebars} or as \if defined(qtdesignstudio) - \l {Managing Workspaces}{workspaces}, depending on the \l{Mode}{mode} you - are working in. + You can organize \QDS views as \l {Managing Workspaces}{workspaces}. \else - workspaces, depending on the \l{Switch between modes} - {mode} you are working in. Only views that are relevant to a mode are - available in it. + You can organize \QC views in \l {Show and hide sidebars}{sidebars} or as + workspaces, depending on the \l{Switch between modes}{mode} you are working + in. Only views that are relevant to a mode are available in it. \endif \note Usually, \l{Searching with the Locator}{searching with the locator} diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index f8f48a27f10..41dffb76f25 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -202,7 +202,6 @@ \list \li \l{Working in Edit Mode} \list - \li \l{Working with Sidebars} \li \l{Browsing Project Contents} \li \l{Viewing Output} \endlist