diff --git a/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc b/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc index 315f19da930..449eba8a259 100644 --- a/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc +++ b/doc/qtcreator/src/editors/creator-coding-edit-mode.qdoc @@ -32,7 +32,11 @@ /*! \previouspage creator-editor-functions.html \page creator-coding-navigating.html + \if defined(qtdesignstudio) + \nextpage creator-sidebars.html + \else \nextpage creator-highlighting.html + \endif \title Working in Edit Mode @@ -296,4 +300,14 @@ 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) + \section1 Related Topics + + \list + \li \l{Working with Sidebars} + \li \l{Browsing Project Contents} + \li \l{Viewing Output} + \endlist + \endif */ diff --git a/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc b/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc index 3bb5f5832e5..459cc1f15cd 100644 --- a/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc +++ b/doc/qtcreator/src/editors/creator-editors-writing-code.qdoc @@ -86,7 +86,7 @@ \if defined(qtcreator) \li \l{Pasting and Fetching Code Snippets} - You can cooperate with other developers by pasting and fetching + You can cooperate with others by pasting and fetching snippets of code from a server. For example, you might ask colleagues to review a change that you plan to submit to a version control system. diff --git a/doc/qtcreator/src/howto/creator-sidebars.qdoc b/doc/qtcreator/src/howto/creator-sidebars.qdoc index 9ef27ef1478..8c8162035e4 100644 --- a/doc/qtcreator/src/howto/creator-sidebars.qdoc +++ b/doc/qtcreator/src/howto/creator-sidebars.qdoc @@ -25,8 +25,13 @@ /*! \page creator-sidebars.html - \previouspage creator-views.html - \nextpage creator-project-managing-workspaces.html + \if defined(qtdesignstudio) + \previouspage creator-coding-navigating.html + \else + \previouspage creator-modes.html + \endif + \nextpage creator-views.html + \title Working with Sidebars diff --git a/doc/qtcreator/src/howto/creator-ui.qdoc b/doc/qtcreator/src/howto/creator-ui.qdoc index 2f5dc4f274e..ff5d0baf72e 100644 --- a/doc/qtcreator/src/howto/creator-ui.qdoc +++ b/doc/qtcreator/src/howto/creator-ui.qdoc @@ -32,7 +32,7 @@ /*! \page creator-quick-tour.html \if defined(qtdesignstudio) - \previouspage qtbridge-ps-using.html + \previouspage exporting-from-maya.html \else \previouspage creator-overview.html \endif @@ -43,15 +43,20 @@ When you start \QC, it opens to the \uicontrol Welcome mode, where you can: \list + \if defined(qtcreator) + \li Open recent sessions + \endif - \li Open recent sessions and projects + \li Open recent projects \li Create and open projects \li Open tutorials and example projects + \if defined(qtcreator) \li Browse Qt extensions in the \l{https://marketplace.qt.io/} {Qt Marketplace} + \endif \li Read news from the online community and Qt blogs @@ -65,47 +70,50 @@ \image studio-welcome-mode.png \endif + \if defined(qtcreator) You can use the \l{Selecting Modes}{mode selector} (1) to change to another \QC mode. - \if defined(qtcreator) You can use the kit selector (2) to select the \l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or building (5) the application. Output from these actions is displayed in the output panes (7). - \else - You can use the kit selector (2) to select the \l{glossary-buildandrun-kit} - {kit} for running (3) or debugging (4) the application. Output from these - actions is displayed in the \l{Viewing Output}{output panes} (5). - \endif You can use the \l{Searching with the Locator}{locator} (6) to browse through projects, files, classes, functions, documentation, and file systems. - \if defined(qtcreator) For a quick tour of the user interface that takes you to the locations of these controls, select \uicontrol Help > \uicontrol {UI Tour}. - \endif - The following sections describe some \QC controls in more detail: \list \li \l{Selecting Modes}{Mode selector} - \li \l{Browsing Project Contents}{Views} \li \l{Working with Sidebars}{Sidebars} + \li \l{Browsing Project Contents}{Views} \li \l{Managing Workspaces}{Workspaces} \li \l{Viewing Output}{Output panes} \endlist + \else + You can use the \l{Selecting Modes}{mode selector} to switch to the + \l{Editing QML Files in Design Mode}{Design mode} (1), where you will do + most of your work and the \l{Using the Help Mode}{Help} (2) mode, where + you can read the product documentation. The other modes are for more + advanced use, and you are likely to need them less often. + + Below the mode selector, you can find shortcuts to some more advanced + functions, such as running the application or finding problems in the + QML code by debugging or profiling it. + \endif + \section1 Navigating with Keyboard - \QC caters not only to developers who are used to using the mouse, - but also to developers who are more comfortable with the keyboard. A wide - range of \l{keyboard-shortcuts}{keyboard} and - \l{Searching with the Locator}{navigation} shortcuts are available to help - speed up the process of developing your application. + \QC caters not only to those users who like to use the mouse, but also + to those who are more comfortable with the keyboard. A wide range of + \l{keyboard-shortcuts}{keyboard} and \l{Searching with the Locator} + {navigation} shortcuts are available to help you work faster. \if defined(qtcreator) \section1 Useful Features @@ -150,10 +158,13 @@ \section2 Exporting SVG Images - If you receive a freely scalable icon in the SVG format from an UI designer, + If you have a freely scalable icon in the SVG format, you can export it to several images of different sizes to create a set of - pixmaps. You can then use QIcon::addPixmap() to add the pixmaps to icons in + pixmaps. + \if defined(qtcreator) + You can then use QIcon::addPixmap() to add the pixmaps to icons in different modes and states. + \endif \section1 Platform Notes @@ -257,12 +268,17 @@ /*! \page creator-modes.html \previouspage creator-quick-tour.html - \nextpage creator-views.html + \if defined(qtdesignstudio) + \nextpage creator-using-qt-quick-designer.html + \else + \nextpage creator-sidebars.html + \endif \title Selecting Modes \image qtcreator-mode-selector.png + \if defined(qtcreator) The mode selector allows you to quickly switch between tasks such as editing project and source files, designing application UIs, configuring how projects are built and executed, and debugging your applications. To change @@ -277,28 +293,28 @@ The following image displays an example application in \uicontrol Edit mode (1) and \uicontrol Design mode (2). - \if defined(qtcreator) \image qtcreator-qt-quick-editors.png "Edit mode and Design mode" - \else - \image studio-editors.png "Edit mode and Design mode" \endif You can use \QC in the following modes: \list - \li \uicontrol {\l{User Interface}{Welcome}} mode for opening projects. + \li \uicontrol {\l{User Interface}{Welcome}} mode for opening projects, + tutorial, and examples. \li \uicontrol{\l{Coding}{Edit}} mode for editing project and source files. \if defined(qtcreator) \li \uicontrol{\l{Designing User Interfaces}{Design}} - \else - \li \uicontrol{\l{Editing QML Files in Design Mode}{Design}} - \endif mode for designing and developing application user interfaces. This mode is available for UI files. + \else + \li \uicontrol{\l{Editing QML Files in Design Mode}{Design}} + mode for designing and developing application user interfaces. + As a designer, you'll do most of your work in this mode. + \endif \if defined(qtcreator) \li \uicontrol{\l{Debugging}{Debug}} @@ -307,7 +323,7 @@ \endif mode for inspecting the state of your application while debugging and for using code analysis tools - to detect memory leaks and profile C++ or QML code. + to detect memory leaks and profile code. \if defined(qtcreator) \li \uicontrol{\l{Specifying Build Settings}{Projects}} mode @@ -318,22 +334,25 @@ \endif This mode is available when a project is open. - \li \uicontrol{\l{Using the Help Mode}{Help}} mode for viewing Qt + \li \uicontrol{\l{Using the Help Mode}{Help}} mode for viewing documentation. \endlist + \if defined(qtcreator) Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} > \uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to \uicontrol {Debug} mode. + \endif */ /*! \page creator-output-panes.html - \previouspage creator-project-managing-workspaces.html \if defined(qtdesignstudio) - \nextpage creator-using-qt-quick-designer.html + \previouspage creator-views.html + \nextpage creator-highlighting.html \else + \previouspage creator-project-managing-workspaces.html \nextpage creator-configuring.html \endif diff --git a/doc/qtcreator/src/howto/creator-views.qdoc b/doc/qtcreator/src/howto/creator-views.qdoc index 1b37513fbdd..0c41d7b4963 100644 --- a/doc/qtcreator/src/howto/creator-views.qdoc +++ b/doc/qtcreator/src/howto/creator-views.qdoc @@ -25,8 +25,12 @@ /*! \page creator-views.html - \previouspage creator-modes.html - \nextpage creator-sidebars.html + \previouspage creator-sidebars.html + \if defined(qtdesignstudio) + \nextpage creator-output-panes.html + \else + \nextpage creator-project-managing-workspaces.html + \endif \title Browsing Project Contents diff --git a/doc/qtcreator/src/howto/creator-workspaces.qdoc b/doc/qtcreator/src/howto/creator-workspaces.qdoc index 7696c481ca0..56177f51071 100644 --- a/doc/qtcreator/src/howto/creator-workspaces.qdoc +++ b/doc/qtcreator/src/howto/creator-workspaces.qdoc @@ -24,9 +24,14 @@ ****************************************************************************/ /*! - \previouspage creator-sidebars.html \page creator-project-managing-workspaces.html + \if defined(qtdesignstudio) + \previouspage creator-using-qt-quick-designer.html + \nextpage {Tutorials} + \else + \previouspage creator-sidebars.html \nextpage creator-output-panes.html + \endif \title Managing Workspaces diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 021b7052f89..33349645de2 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -36,8 +36,8 @@ \li \l{User Interface} \list \li \l{Selecting Modes} - \li \l{Browsing Project Contents} \li \l{Working with Sidebars} + \li \l{Browsing Project Contents} \li \l{Managing Workspaces} \li \l{Viewing Output} \endlist diff --git a/doc/qtcreator/src/qtquick/qtquick-designer.qdoc b/doc/qtcreator/src/qtquick/qtquick-designer.qdoc index ec1388ca331..fe524b7acd7 100644 --- a/doc/qtcreator/src/qtquick/qtquick-designer.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-designer.qdoc @@ -33,7 +33,7 @@ \page creator-using-qt-quick-designer.html \if defined(qtdesignstudio) \previouspage creator-modes.html - \nextpage {Tutorials} + \nextpage creator-project-managing-workspaces.html \else \previouspage quick-projects.html \nextpage quick-uis.html diff --git a/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc b/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc index 3e0d228cb6c..2118cbc1e29 100644 --- a/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc +++ b/doc/qtcreator/src/qtquick/qtquick-profiler.qdoc @@ -134,7 +134,7 @@ To save all the collected data, right-click any QML Profiler view to open the context menu, and then select \uicontrol {Save QML Trace}. To view the saved data, select \uicontrol {Load QML Trace}. You can also deliver the saved data to - other developers for examination or load data saved by them. + others for examination or load data saved by them. \section1 Specifying Flushing Settings diff --git a/doc/qtdesignstudio/images/studio-welcome-mode.png b/doc/qtdesignstudio/images/studio-welcome-mode.png index 2657be12af8..1518b6706cd 100644 Binary files a/doc/qtdesignstudio/images/studio-welcome-mode.png and b/doc/qtdesignstudio/images/studio-welcome-mode.png differ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc index ff5a00f43a0..ac1c6fec842 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -69,6 +69,7 @@ \li \l{Editing QML Files in Design Mode} Describes the parts and basic features of the Design mode. + This is where you'll do most of your work. \li \l {Tutorials} Describes how to use \QDS to create a simple animated UI with some diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 3ce884bf8be..0c20610a1d9 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -49,10 +49,11 @@ \li \l{User Interface} \list \li \l{Selecting Modes} - \li \l{Browsing Project Contents} - \li \l{Viewing Output} \endlist \li \l{Editing QML Files in Design Mode} + \list + \li \l{Managing Workspaces} + \endlist \li \l{Tutorials} \endlist \li \l{Managing Projects} @@ -116,6 +117,7 @@ \endlist \li \l{Advanced Topics} \list + \li \l{Supported Platforms} \li \l{Keyboard Shortcuts} \li \l{Coding} @@ -123,6 +125,11 @@ \li \l{Writing Code} \list \li \l{Working in Edit Mode} + \list + \li \l{Working with Sidebars} + \li \l{Browsing Project Contents} + \li \l{Viewing Output} + \endlist \li \l{Semantic Highlighting} \li \l{Checking Code Syntax} \li \l{Completing Code} diff --git a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc index f5c6d20ab8d..6968e3f55e6 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2019 The Qt Company Ltd. +** Copyright (C) 2020 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Design Studio documentation. @@ -24,7 +24,7 @@ ****************************************************************************/ /*! - \previouspage creator-using-qt-quick-designer.html + \previouspage creator-project-managing-workspaces.html \group gstutorials \nextpage studio-projects-managing.html