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

Doc: Restructure the QDS Manual Getting Started chapter

Browse Source 
- Add the Use Cases topic
- Move text from other topics as necessary
- Fix the navigation links to match the new structure

Fixes: QDS-4468
Change-Id: Ic67dbe073c5be2420795c1f5049217319ab0a202
Reviewed-by: Jarko Vihriala <jarko.vihriala@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2021-06-02 17:10:38 +02:00
parent 71db2d9c4f
commit 6a9a58941e
18 changed files with 141 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreator/src/howto/creator-keyboard-shortcuts.qdoc
View File

@@ -32,8 +32,8 @@
/*!
\page creator-keyboard-shortcuts.html
\if defined(qtdesignstudio)
\previouspage studio-platforms.html
\nextpage creator-coding.html
\previouspage creator-project-managing-sessions.html
\nextpage studio-projects.html
\else
\previouspage creator-cli.html
\nextpage creator-editor-external.html

2
doc/qtcreator/src/howto/creator-sessions.qdoc
View File

@@ -33,7 +33,7 @@
\page creator-project-managing-sessions.html
\if defined(qtdesignstudio)
\previouspage creator-project-managing-workspaces.html
\nextpage {Tutorials}
\nextpage creator-keyboard-shortcuts.html
\else
\previouspage creator-sharing-project-settings.html
\nextpage creator-design-mode.html

2
doc/qtcreator/src/qtquick/qtdesignstudio-optimized-3d-scenes.qdoc
View File

@@ -27,7 +27,7 @@
\page studio-optimized-3d-scenes.html
\previouspage studio-qtquick-best-practices.html
\if defined(qtdesignstudio)
\nextpage studio-projects-managing.html
\nextpage studio-platforms.html
\else
\nextpage creator-coding.html
\endif

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

@@ -32,7 +32,7 @@
/*!
\page creator-quick-tour.html
\if defined(qtdesignstudio)
\previouspage studio-installation.html
\previouspage {Your First UI}
\else
\previouspage creator-overview.html
\endif

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

@@ -26,7 +26,11 @@
/*!
\page creator-project-managing-workspaces.html
\previouspage creator-open-documents-view.html
\if defined(qtdesignstudio)
\nextpage creator-project-managing-sessions.html
\else
\nextpage creator-output-panes.html
\endif
\title Managing Workspaces

BIN
doc/qtdesignstudio/images/studio-flow.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.9 KiB

5
doc/qtdesignstudio/src/qtdesignstudio-advanced.qdoc
View File

@@ -47,11 +47,6 @@
You can install and run \QC on several operating systems to design
UIs for multiple desktop, embedded, and mobile device platforms.
\li \l{Keyboard Shortcuts}
\QDS provides various keyboard shortcuts to speed up your
development process. You can change the keyboard shortcuts,
as well as import and export keyboard shortcut mapping schemes.
\li \l{Coding}
You can use the code editor in the \uicontrol {Text Editor} view or

5
doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
View File

@@ -24,10 +24,9 @@
****************************************************************************/
/*!
\previouspage studio-help.html
\previouspage studio-terms.html
\group studioexamples
\nextpage creator-help.html
\nextpage quick-uis.html
\title Examples and Tutorials
In the \uicontrol Welcome mode, you can open examples and tutorials that

50
doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
View File

@@ -30,34 +30,52 @@
\title Getting Started
The following topics contain information that you'll need to get started
with \QDS:
\table
\row
\li \image front-gs.png
\li When you install \QDS, everything you need to start wireframing
and prototyping UIs is installed and set up for you. You can
move directly to learning about how to use the different \QDS
views and menus and how to create a project that will contain
your UI. Then, you can open examples and follow tutorials to
create your first wireframe, prototype, and production-ready
UI.
\endtable
\list
\li \l {Installation}
\QDS is available either as a standalone installation package or
as an option in the Qt online installer.
\li \l {Exporting and Importing}
\li \l {Your First UI}
Describes how to export designs containing 2D and 3D assets into
files that you can import to projects in \QDS, how to import them,
and how to export them from \QDS back to the metadata format.
Follow a set of hands-on tutorials that build on each other to
design your first animated UI using preset and custom components.
\li \l {User Interface}
Describes the parts and basic features of \QDS.
\li \l{Design Views}
\li \l {Creating Projects}
Describes the views and basic features of the Design mode.
This is where you'll do most of your work.
\li \l {Tutorials}
To wireframe or prototype an application, you need a project.
Setting up a new project in \QDS is aided by a wizard that
guides you step-by-step through the project creation process,
creates the necessary files, and specifies settings depending
on the choices you make.
Describes how to use \QDS to create a simple animated UI with some
basic UI components, such as pages, buttons, and fields. Some of
the buttons can be used for moving between the pages.
\li \l {Qt Quick Best Practices}
You can use wizards to create projects for the desktop or embedded
Linux and Android devices. In addition, you can add individual QML
files, components, and JavaScript files to your projects.
\li \l {Use Cases}
Describes how to create UIs that work efficiently on the intended
platforms.
Describes the main use cases of \QDS at a general level.
\li \l{Concepts and Terms}
Describes main \QDS concepts and terms.
\li \l{Examples and Tutorials}
A set of examples available in the \uicontrol Welcome mode
illustrates how to use \QDS features such as the timeline.
If you would rather be shown things than read about them,
you can watch our extensive video tutorials.
\endlist
*/

8
doc/qtdesignstudio/src/qtdesignstudio-help-overview.qdoc
View File

@@ -31,12 +31,6 @@
\title Help
\list
\li \l{Examples and Tutorials}
A set of examples available in the Welcome mode illustrates how
to use \QDS features such as the timeline. If you would rather
be shown things than read about them, you can watch our extensive
video tutorials.
\li \l{Using the Help Mode}
@@ -49,9 +43,7 @@
Contains answers to some frequently asked questions about \QDS.
\li \l{Concepts and Terms}
Describes main \QDS concepts and terms.
\endlist

12
doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
View File

@@ -26,23 +26,25 @@
/*!
\page studio-installation.html
\previouspage studio-getting-started.html
\nextpage creator-quick-tour.html
\nextpage {Your First UI}
\title Installation
You can install \QDS either using a stand-alone installation package or the
Qt online installer. The installers copy all the modules and tools you need
to design UIs and preview them on the desktop to your computer and configure
them for you.
them for you. \QDS is available for Linux, \macOS, and Windows operating
systems. For more information, see \l{Supported Platforms}.
To begin, create a \l{Qt Account}. This account gives you access to a web
portal to manage your licenses and download the standalone \QDS package or
the Qt online installer. Alternatively, you can download an evaluation
package \l{https://www.qt.io/product/ui-design-tools}{here}.
After the installation, you can start exploring \QDS by opening
\l{Examples and Tutorials}{examples}, following \l{Tutorials}{tutorials},
watching videos, and reading this manual.
After the installation, you can start exploring \QDS by following
tutorials to \l{Your First UI}{create your first UI}, opening
\l{Examples and Tutorials}{examples}, watching videos, and reading
this manual.
\section1 Stand-Alone Installation

12
doc/qtdesignstudio/src/qtdesignstudio-projects-overview.qdoc
View File

@@ -36,18 +36,6 @@
\list
\li \l {Creating Projects}
You must add your exported files to a new project that you create
in \QDS. Setting up a new project in \QDS is aided by a wizard that
guides you step-by-step through the project creation process,
creates the necessary files, and specifies settings depending
on the choices you make.
You can use wizards to create projects for the desktop or embedded
Linux and Android devices. In addition, you can add individual QML
files, components, and JavaScript files to your projects.
\li \l{Using Git}
You can add the project files to the Git version control, so that

8
doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc
View File

@@ -24,12 +24,16 @@
****************************************************************************/
/*!
\previouspage studio-projects-managing.html
\page studio-projects.html
\nextpage creator-vcs-git.html
\previouspage creator-keyboard-shortcuts.html
\nextpage studio-use-cases.html
\title Creating Projects
One of the major advantages of \QDS is that it allows a team of designers
and developers to share a project across different development platforms
with a common tool for design, development, profiling, and debugging.
Creating a project enables you to:
\list

4
doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
View File

@@ -25,8 +25,8 @@
/*!
\page studio-terms.html
\previouspage studio-faq.html
\nextpage technical-support.html
\previouspage studio-use-cases.html
\nextpage {Examples and Tutorials}
\title Concepts and Terms

11
doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
View File

@@ -31,7 +31,8 @@
\li \l{Getting Started}
\list
\li \l{Installation}
\li \l{User Interface}{Interface Overview}
\li \l{Your First UI}
\li \l{User Interface}
\list
\li \l{Selecting Modes}
\li \l{Design Views}
@@ -55,18 +56,16 @@
\li \l{Managing Sessions}
\li \l{Keyboard Shortcuts}
\endlist
\li \l{Creating Projects}{Projects}
\li \l{Use Cases} (NEW)
\li \l{Creating Projects}
\li \l{Use Cases}
\li \l{Concepts and Terms}
\li \l{Examples and Tutorials}
\list
\li \l{Tutorials}
\li \l{Qt Quick Best Practices}
\list
\li \l{Creating Optimized 3D Scenes}
\endlist
\endlist
\li \l{Supported Platforms}
\endlist
\li \l{Wireframing} (NEW)
\list
@@ -265,7 +264,7 @@
\list
\li \l{Using the Help Mode}
\li \l{Frequently Asked Questions}
\li \l{How To}
\li \l{Supported Platforms}
\endlist
\li \l{Technical Support}
\li \l{Acknowledgements}

6
doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
View File

@@ -25,10 +25,10 @@
/*!
\group gstutorials
\previouspage creator-project-managing-sessions.html
\nextpage studio-qtquick-best-practices.html
\previouspage studio-installation.html
\nextpage creator-quick-tour.html
\title Tutorials
\title Your First UI
\image loginui4.gif "Log In UI"

67
doc/qtdesignstudio/src/qtdesignstudio-use-cases.qdoc Normal file
View File

@@ -0,0 +1,67 @@
/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Studio 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.
**
****************************************************************************/
/*!
\page studio-use-cases.html
\previouspage studio-projects.html
\nextpage studio-terms.html
\title Use Cases
The following table summarizes the main use cases of \QDS with links to
more information:
\table
\row
\li \inlineimage front-ui.png
\li \inlineimage studio-flow.png
\li \inlineimage studio-3d-scenes.png
\li \inlineimage front-projects.png
\row
\li \b {Creating UI wireframes}
\li \b {Creating UI prototypes}
\li \b {Combining 2D and 3D assets}
\li \b {Cooperating with developers}
\row
\li Create a UI concept by using preset and custom 2D and 3D
components and designing application flows. Create scalable
layouts with all your screens and controls in place.
\li Create an animated UI prototype with functioning UI controls
and logic and validate it on the desktop or mobile or embedded
devices.
\li Create 2D and 3D assets and design UIs in imaging and design
tools. Then bring your designs over to \QDS where you can
combine them into one UI.
\li Use visual editors that generate the code for you and deliver
the code to developers for adding more code and preparing the
application for production. You can use version control to
pass changes back and forth when necessary.
\row
\li \l{Wireframing}
\li \l{Prototyping}
\li \l{Exporting and Importing}
\li \l{Implementing Applications}
\endtable
*/

10
doc/qtdesignstudio/src/qtdesignstudio.qdoc
View File

@@ -48,12 +48,12 @@
\li \b {\l{Getting Started}}
\list
\li \l{Installation}
\li \l{User Interface}{Interface Overview}
\li \l{Creating Projects}{Projects}
\li \l{Use Cases} (NEW)
\li \l{Your First UI}
\li \l{User Interface}
\li \l{Creating Projects}
\li \l{Use Cases}
\li \l{Concepts and Terms}
\li \l{Examples and Tutorials}
\li \l{Supported Platforms}
\endlist
\li \b {\l{Wireframing}} (NEW)
\list
@@ -107,7 +107,7 @@
\list
\li \l{Using the Help Mode}
\li \l{Frequently Asked Questions}
\li \l{How-To}
\li \l{Supported Platforms}
\endlist
\row
\li {4,1} \note To report bugs and suggestions to the