feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Combine "Working with Sidebars" and "Show and hide sidebars"

Browse Source 
- 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 <mats.honkamaa@qt.io>
This commit is contained in:
Leena Miettinen
2023-07-03 14:44:17 +02:00
parent 1956b0f698
commit a23b933308
10 changed files with 70 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/qtcreator/src/user-interface/creator-file-system-view.qdoc
View File

@@ -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
*/

34
doc/qtcreator/src/user-interface/creator-only/creator-how-to-show-and-hide-sidebars.qdoc Normal file
View File

@@ -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
*/

31
doc/qtcreator/src/user-interface/creator-projects-view.qdoc
View File

@@ -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
*/

4
doc/qtcreator/src/user-interface/creator-ui.qdoc
View File

@@ -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

15
doc/qtcreator/src/user-interface/creator-views.qdoc
View File

@@ -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}