From a3701c5c31f67f02381c09ec2805fe6dd7cbd13f Mon Sep 17 00:00:00 2001 From: Mats Honkamaa Date: Wed, 21 May 2025 13:45:38 +0300 Subject: [PATCH] Doc: Update workspaces docs Task-number: QDS-15330 Change-Id: I85953c6f24ecf765485f10989274168a55e02bfa Reviewed-by: Johanna Vanhatapio --- .../src/user-interface/creator-ui.qdoc | 1 + doc/qtdesignstudio/examples/doc/loginui1.qdoc | 2 +- .../examples/doc/multilanguage.qdoc | 2 +- .../src/qtdesignstudio-toc.qdoc | 2 +- .../src/views/qtquick-designer.qdoc | 2 +- .../src/views/studio-workspaces.qdoc | 77 +++++++++---------- 6 files changed, 43 insertions(+), 43 deletions(-) diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index 16cc6951fe3..c1b966f4dd8 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -123,6 +123,7 @@ \li \l {Set high DPI scaling} \li \l {Switch UI themes} \li \l {View output} + \li \l {Workspaces} \endlist \section1 Viewing images diff --git a/doc/qtdesignstudio/examples/doc/loginui1.qdoc b/doc/qtdesignstudio/examples/doc/loginui1.qdoc index 77bf2ddcf7e..913669f7469 100644 --- a/doc/qtdesignstudio/examples/doc/loginui1.qdoc +++ b/doc/qtdesignstudio/examples/doc/loginui1.qdoc @@ -59,7 +59,7 @@ \note The visibility of views depends on the selection of views on the selected workspace, so your \QDS might look somewhat different from the image above. To open and close views, select \uicontrol View > \uicontrol Views. - For more information about arranging the \QDS workspace, see \l {Managing workspaces}. + For more information about arranging the \QDS workspace, see \l {Workspaces}. Remove the button and the text component from the UI to have a clean workspace. Later in this tutorial, you will add and modify them as you need. diff --git a/doc/qtdesignstudio/examples/doc/multilanguage.qdoc b/doc/qtdesignstudio/examples/doc/multilanguage.qdoc index 70b2ac0ccf7..fa4aa657168 100644 --- a/doc/qtdesignstudio/examples/doc/multilanguage.qdoc +++ b/doc/qtdesignstudio/examples/doc/multilanguage.qdoc @@ -142,7 +142,7 @@ \list 1 \li Go to \uicontrol View > \uicontrol Views and select \uicontrol Translations to open the \uicontrol Translations view. You can - drag it to a \l {Managing workspaces}{workspace} to dock it. + drag it to a \l {Workspaces}{workspace} to dock it. \li In \uicontrol Translations, select \imageselectlanguages. \li Select the languages that you want to support in your project. For this tutorial, select \uicontrol{English - American English} and diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 8b4018fffd8..f44995e194a 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -40,7 +40,7 @@ \li \l{Transitions} \li \l{Translations} \endlist - \li \l{Managing workspaces} + \li \l{Workspaces} \li \l{Manage sessions} \li \l{Keyboard shortcuts} \endlist diff --git a/doc/qtdesignstudio/src/views/qtquick-designer.qdoc b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc index 0acede26506..fb5494a879d 100644 --- a/doc/qtdesignstudio/src/views/qtquick-designer.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc @@ -23,7 +23,7 @@ \image studio-design-mode-states-timeline.png "The States and Timeline views" You can move the views anywhere on the screen and save them as - \e workspaces, as instructed in \l {Managing Workspaces}. + \e workspaces, as instructed in \l {Workspaces}. \section1 Summary of the Design views diff --git a/doc/qtdesignstudio/src/views/studio-workspaces.qdoc b/doc/qtdesignstudio/src/views/studio-workspaces.qdoc index 44ff1c75b55..38650046d57 100644 --- a/doc/qtdesignstudio/src/views/studio-workspaces.qdoc +++ b/doc/qtdesignstudio/src/views/studio-workspaces.qdoc @@ -1,35 +1,37 @@ -// Copyright (C) 2020 The Qt Company Ltd. +// Copyright (C) 2025 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \page creator-project-managing-workspaces.html \previouspage studio-model-editor.html \nextpage creator-project-managing-sessions.html + \sa {Design Views} - \title Managing workspaces + \title Workspaces - In the \uicontrol Design mode, you can arrange a set of \QDS - views as a \e workspace on the screen. + \QDS provides a flexible UI, allowing you to arrange \l {Design Views}{views} freely and save + your setups as \e workspaces. You can also use one of the predefined workspaces. - To detach views: + To change the current workspace, go to \uicontrol View > \uicontrol Workspaces or select a + workspace from the dropdown menu in the top toolbar. - \list + \section1 Moving views in a workspace + + To move a view to a different location in the workspace: + + \list 1 \li Toggle \imagelockon to \imagelockoff at the top toolbar. - \li Double-click the title bar of the view. - \li Start dragging the view to another position. + \li Drag the view from the title bar to its new position. You can either dock + the view in a dock area or detach the view from a dock area. \endlist - You can move detached views or groups of views anywhere on the screen. + \note You can also move view groups. - To attach views, drag them over the dock area markers until the dock area - where you want to attach the view is highlighted, and then drop them into - the dock area. + \image {qtcreator-workspace-attaching-views.webp} {Moving a view to a dock area.} - \image qtcreator-workspace-attaching-views.webp "Attaching views" - - To close groups of views, select the \uicontrol {Close Group} button. + To close a group of views, right-click the group top bar and select \uicontrol {Close Group}. To open closed views, select \uicontrol View > \uicontrol Views. @@ -38,39 +40,36 @@ to \imagelockon at the top toolbar. - \section1 Saving workspaces + \section1 Managing workspaces - The changes you make to a workspace are saved when you exit \QDS. - Select \uicontrol View > \uicontrol Workspaces > - \uicontrol Manage > \uicontrol {Restore last workspace on startup} + To manage your workspaces, open \uicontrol {Workspace Manager} from \uicontrol View > + \uicontrol Workspaces > \uicontrol Manage. + + \image {qtcreator-workspace-manager.png} {The Workspace Manager dialog.} + + In \uicontrol {Workspace Manager}, you can, for example, create, rename, clone, delete, reset, + import, and export workspaces. + + \section2 Restoring a workspace on startup + + The changes you make to a workspace are saved when you close \QDS. + In \uicontrol {Workspace Manager}, select \uicontrol {Restore last workspace on startup} to restore the current workspace the next time you start \QDS. - \image qtcreator-workspace-manager.png "Workspace Manager" + \section2 Creating a custom workspace - To save a workspace under a new name, select \uicontrol Clone. - - To revert the changes you made to a preset workspace, select - \uicontrol Reset. - - To switch between workspaces, select \uicontrol {Switch To}. - - To save a workspace after you've moved views around or opened and - closed them: + To save a workspace as a custom workspace after making changes in the workspace: \list 1 + \li Go to \uicontrol View > \uicontrol Workspaces \uicontrol Manage to open + \uicontrol {Workspace Manager}. \li Select \uicontrol New. - \image qtcreator-workspace-new.png "New Workspace Name dialog" - \li In the \uicontrol {Enter the name of the workspace} field, - enter a name for the workspace. + \image {qtcreator-workspace-new.png} {The New Workspace Name dialog.} + \li Enter a name for the workspace. \li Select \uicontrol Create to create a new empty workspace or - \uicontrol {Create and Open} to create a workspace and to + \uicontrol {Create and Open} to create a workspace and switch to it. \endlist - To delete the selected workspace, select \uicontrol Delete in - \uicontrol {Workspace Manager}. - - To export workspace settings into \e {.wrk} files select \uicontrol Export. - To import them to another computer, select \uicontrol Import, and then - locate the workspace settings file. */ +