From 49d20960b9b55da04213d433408b4771bdc030e4 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 21 Sep 2020 09:00:58 +0200 Subject: Doc: Show "Managing Sessions" topic in QDS Manual - Moved the topic from the creator-only folder to the howto folder root to have it included in the doc builds. - Added the topic to the toc and fixed the navigation links around it. - Used defines to hide text that does not apply to QDS. Fixes: QDS-2805 Change-Id: I583324a1d0bc60c1b6448a52e48b3f09b1039b7f Reviewed-by: Thomas Hartmann --- .../src/howto/creator-only/creator-sessions.qdoc | 113 ------------------- doc/qtcreator/src/howto/creator-sessions.qdoc | 123 +++++++++++++++++++++ doc/qtcreator/src/howto/creator-workspaces.qdoc | 2 +- doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc | 1 + .../src/qtdesignstudio-tutorials.qdoc | 2 +- 5 files changed, 126 insertions(+), 115 deletions(-) delete mode 100644 doc/qtcreator/src/howto/creator-only/creator-sessions.qdoc create mode 100644 doc/qtcreator/src/howto/creator-sessions.qdoc (limited to 'doc') diff --git a/doc/qtcreator/src/howto/creator-only/creator-sessions.qdoc b/doc/qtcreator/src/howto/creator-only/creator-sessions.qdoc deleted file mode 100644 index e2c3816f86..0000000000 --- a/doc/qtcreator/src/howto/creator-only/creator-sessions.qdoc +++ /dev/null @@ -1,113 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2018 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Creator documentation. -** -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** -****************************************************************************/ - -// ********************************************************************** -// NOTE: the sections are not ordered by their logical order to avoid -// reshuffling the file each time the index order changes (i.e., often). -// Run the fixnavi.pl script to adjust the links to the index order. -// ********************************************************************** - -/*! - \previouspage creator-sharing-project-settings.html - \page creator-project-managing-sessions.html - \nextpage creator-design-mode.html - - \title Managing Sessions - - When you exit \QC, a snapshot of your current workspace is stored as a - \e session. To restore the session automatically when you start \QC, - select \uicontrol File > \uicontrol Sessions > \uicontrol Manage > - \uicontrol {Restore last session on startup}. - - When you open or create any of the following items, they automatically - become a part of the session: - - \list - - \li Projects with their dependencies (including SUBDIRS projects) - - \li Editors - - \li Breakpoints and expressions - - \li Bookmarks - - \endlist - - A session is personal, that is, not meant to be shared. It is not supposed - to reflect the project structure. It contains personal data, such as - bookmarks and breakpoints that are usually not of interest to other - developers working on the same projects. - - For example, if you work on a project and need to switch to another project - for a while, you can clone the current session to save it under a name and - create a new session for the other project. Everything that you open after - switching to the new session becomes a part of it. When you want to return - to working on the first project, switch to the saved session. \QC opens the - projects and files that belong to the session. - - To manage sessions, select \uicontrol File > \uicontrol Sessions > \uicontrol Manage. - - \image qtcreator-session-manager.png - - To save a session under a new name, select \uicontrol Clone. - - To create a new session: - - \list 1 - - \li Select \uicontrol New. - - \li In the \uicontrol {Enter the name of the session} field, enter a - name for the session. - - \li Select \uicontrol Create to create a new empty session or - \uicontrol {Create and Open} to create a session and to switch to - it. - - \endlist - - To switch between sessions, select \uicontrol {Switch To}. - - When you launch \QC, a list of existing sessions is displayed in the - \uicontrol Welcome mode. To open a session, select it or press - \key Ctrl+Alt+, where \e is the number of the session to - open (available for the first nine sessions). - - \image qtcreator-welcome-session.png - - You can also use the \c t locator filter to open a session. For more - information, see \l{Searching with the Locator}. - - To view more information about a session, select the down arrow icon that - appears when you move the mouse cursor over the session name. Select actions - to clone, rename, and delete sessions. - - When you start \QC from the command line, you can give the name of - a session as argument and \QC will start with this session. - - For more information, see \l{Using Command Line Options}. - -*/ diff --git a/doc/qtcreator/src/howto/creator-sessions.qdoc b/doc/qtcreator/src/howto/creator-sessions.qdoc new file mode 100644 index 0000000000..7e74a9a259 --- /dev/null +++ b/doc/qtcreator/src/howto/creator-sessions.qdoc @@ -0,0 +1,123 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +// ********************************************************************** +// NOTE: the sections are not ordered by their logical order to avoid +// reshuffling the file each time the index order changes (i.e., often). +// Run the fixnavi.pl script to adjust the links to the index order. +// ********************************************************************** + +/*! + \page creator-project-managing-sessions.html + \if defined(qtdesignstudio) + \previouspage creator-project-managing-workspaces.html + \nextpage {Tutorials} + \else + \previouspage creator-sharing-project-settings.html + \nextpage creator-design-mode.html + \endif + + \title Managing Sessions + + When you exit \QC, a snapshot of your current workspace is stored as a + \e session. To restore the session automatically when you start \QC, + select \uicontrol File > \uicontrol Sessions > \uicontrol Manage > + \uicontrol {Restore last session on startup}. + + When you open or create any of the following items, they automatically + become a part of the session: + + \list + + \li Projects + \if defined(qtcreator) + with their dependencies (including SUBDIRS projects) + \endif + + \li Editors + + \li Breakpoints and expressions + + \li Bookmarks + + \endlist + + A session is personal, that is, not meant to be shared. It is not supposed + to reflect the project structure. It contains personal data, such as + bookmarks and breakpoints that are usually not of interest to other + developers working on the same projects. + + For example, if you work on a project and need to switch to another project + for a while, you can clone the current session to save it under a name and + create a new session for the other project. Everything that you open after + switching to the new session becomes a part of it. When you want to return + to working on the first project, switch to the saved session. \QC opens the + projects and files that belong to the session. + + To manage sessions, select \uicontrol File > \uicontrol Sessions > \uicontrol Manage. + + \image qtcreator-session-manager.png + + To save a session under a new name, select \uicontrol Clone. + + To create a new session: + + \list 1 + + \li Select \uicontrol New. + + \li In the \uicontrol {Enter the name of the session} field, enter a + name for the session. + + \li Select \uicontrol Create to create a new empty session or + \uicontrol {Create and Open} to create a session and to switch to + it. + + \endlist + + To switch between sessions, select \uicontrol {Switch To}. + + \if defined(qtcreator) + When you launch \QC, a list of existing sessions is displayed in the + \uicontrol Welcome mode. To open a session, select it or press + \key Ctrl+Alt+, where \e is the number of the session to + open (available for the first nine sessions). + + \image qtcreator-welcome-session.png + + You can also use the \c t locator filter to open a session. For more + information, see \l{Searching with the Locator}. + + To view more information about a session, select the down arrow icon that + appears when you move the mouse cursor over the session name. Select actions + to clone, rename, and delete sessions. + + When you start \QC from the command line, you can give the name of + a session as argument and \QC will start with this session. + + For more information, see \l{Using Command Line Options}. + \endif + +*/ diff --git a/doc/qtcreator/src/howto/creator-workspaces.qdoc b/doc/qtcreator/src/howto/creator-workspaces.qdoc index d3e4809089..704a221e6b 100644 --- a/doc/qtcreator/src/howto/creator-workspaces.qdoc +++ b/doc/qtcreator/src/howto/creator-workspaces.qdoc @@ -27,7 +27,7 @@ \page creator-project-managing-workspaces.html \if defined(qtdesignstudio) \previouspage creator-using-qt-quick-designer.html - \nextpage {Tutorials} + \nextpage creator-project-managing-sessions.html \else \previouspage creator-sidebars.html \nextpage creator-output-panes.html diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index a758f444d4..41fc8926cf 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -55,6 +55,7 @@ \li \l{Editing QML Files in Design Mode} \list \li \l{Managing Workspaces} + \li \l{Managing Sessions} \endlist \li \l{Tutorials} \endlist diff --git a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc index 6968e3f55e..9e35d32080 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc @@ -24,8 +24,8 @@ ****************************************************************************/ /*! - \previouspage creator-project-managing-workspaces.html \group gstutorials + \previouspage creator-project-managing-sessions.html \nextpage studio-projects-managing.html \title Tutorials -- cgit v1.2.3