aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2021-11-30 15:27:06 +0200
committerMats Honkamaa <mats.honkamaa@qt.io>2021-12-01 13:15:28 +0000
commit06e1182574b4bb1c3adedcf0c7e9d532391f5f8a (patch)
tree23bc6aec1a49e296d0b3e85b919025ed2f7ab9c4
parent8fd937f29f394b16e99dbb3f3421489b5b5d3dde (diff)
Doc: Split the Examples and Tutorials Section into two pages
Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
-rw-r--r--doc/qtcreator/src/user-interface/creator-ui.qdoc2
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui1.qdoc1
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui2.qdoc1
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui3.qdoc1
-rw-r--r--doc/qtdesignstudio/examples/doc/loginui4.qdoc3
-rw-r--r--doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc46
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc8
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc6
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc2
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc4
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc24
-rw-r--r--doc/qtdesignstudio/src/qtdesignstudio.qdoc4
14 files changed, 48 insertions, 58 deletions
diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc
index 2af504a69d..2d154021cf 100644
--- a/doc/qtcreator/src/user-interface/creator-ui.qdoc
+++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc
@@ -32,7 +32,7 @@
/*!
\page creator-quick-tour.html
\if defined(qtdesignstudio)
- \previouspage {Your First UI}
+ \previouspage {Tutorials}
\else
\previouspage creator-overview.html
\endif
diff --git a/doc/qtdesignstudio/examples/doc/loginui1.qdoc b/doc/qtdesignstudio/examples/doc/loginui1.qdoc
index 0165817ad6..31e1ebb549 100644
--- a/doc/qtdesignstudio/examples/doc/loginui1.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui1.qdoc
@@ -25,7 +25,6 @@
/*!
\example loginui1
- \ingroup studioexamples
\ingroup gstutorials
\nextpage {Log In UI - Positioning}
diff --git a/doc/qtdesignstudio/examples/doc/loginui2.qdoc b/doc/qtdesignstudio/examples/doc/loginui2.qdoc
index 0a74a67f85..6ff8b2f542 100644
--- a/doc/qtdesignstudio/examples/doc/loginui2.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui2.qdoc
@@ -25,7 +25,6 @@
/*!
\example loginui2
- \ingroup studioexamples
\ingroup gstutorials
\previouspage {Log In UI - Components}
\nextpage {Log In UI - States}
diff --git a/doc/qtdesignstudio/examples/doc/loginui3.qdoc b/doc/qtdesignstudio/examples/doc/loginui3.qdoc
index a7a919319c..d04690b224 100644
--- a/doc/qtdesignstudio/examples/doc/loginui3.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui3.qdoc
@@ -25,7 +25,6 @@
/*!
\example loginui3
- \ingroup studioexamples
\ingroup gstutorials
\title Log In UI - States
diff --git a/doc/qtdesignstudio/examples/doc/loginui4.qdoc b/doc/qtdesignstudio/examples/doc/loginui4.qdoc
index b88c122558..5c8bdca033 100644
--- a/doc/qtdesignstudio/examples/doc/loginui4.qdoc
+++ b/doc/qtdesignstudio/examples/doc/loginui4.qdoc
@@ -25,7 +25,6 @@
/*!
\example loginui4
- \ingroup studioexamples
\ingroup gstutorials
\title Log In UI - Timeline
@@ -324,5 +323,5 @@
\section1 Next Steps
- For more examples about using timelines, see \l{Examples and Tutorials}.
+ For more examples about using timelines, see \l{Examples}.
*/
diff --git a/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc
index 3cb66337fc..4b626c46e0 100644
--- a/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc
+++ b/doc/qtdesignstudio/src/overviews/qtquick-uis.qdoc
@@ -26,7 +26,7 @@
/*!
\page quick-uis.html
\if defined(qtdesignstudio)
- \previouspage {Examples and Tutorials}
+ \previouspage {Examples}
\nextpage studio-app-flows.html
\else
\previouspage qtquick-text-editor.html
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
index d2b7a7e9dd..f80f66dc38 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc
@@ -27,43 +27,29 @@
\previouspage studio-terms.html
\group studioexamples
\nextpage quick-uis.html
- \title Examples and Tutorials
+ \title Examples
- In the \uicontrol Welcome mode, you can open examples and tutorials that
- illustrate how to use \QDS. Some examples are delivered together with
- \QDS and have been documented, while you can download and install others
- for previewing them on the desktop.
-
- \section1 Video Tutorials
-
- The \uicontrol Tutorials tab contains links to video tutorials that provide
- more information about \QDS. To watch a tutorial on YouTube, select it in
- the tab.
-
- \include qtbridge-tutorial-links.qdocinc qtsketchbridge tutorials
-
- \section1 Examples for Downloading
-
- The \uicontrol Examples tab lists complex example applications for
- downloading that demonstrate what you can accomplish with \QDS.
+ \QDS comes with a set of example projects. To see these, select \uicontrol
+ Examples on the \uicontrol Welcome page when you run \QDS.
\image studio-examples-download.png "Examples for download in Welcome mode"
- To download the examples and open them in \QDS:
+ To run an example project:
+ \list 1
+ \li Select the example.
+ \li Select the \inlineimage live_preview.png
+ (\uicontrol {Show Live Preview}) button to preview the example.
+ \endlist
+ Some of the example projects require that you download them before you can run them, to do this:
\list 1
- \li Select an example.
- \li Select \uicontrol {Start Download} to download the example source
- files.
- \li Select the folder where the source files will be installed.
- \li Select \uicontrol Continue to install the files.
- \li Select \uicontrol Open to open the example in \QDS.
- \li Select the \inlineimage live_preview.png
- (\uicontrol {Show Live Preview}) button to preview the example.
+ \li Select an example.
+ \li Select \uicontrol {Start Download}.
+ \li Select the folder where the source files will be installed.
+ \li Select \uicontrol Continue to install the files.
+ \li Select \uicontrol Open to open the example in \QDS.
\endlist
- \section1 Documented Examples
+ \section1 Example Documentation
- The \uicontrol Examples tab lists documented examples of using \QDS. To
- open an example in \QDS, select it in the tab.
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc
index 0e802ebcc7..97981f16bc 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-faq.qdoc
@@ -34,7 +34,7 @@
grouped by categories. You might also find answers to your questions in the
product documentation by searching or browsing the index in the
\l{Using the Help Mode}{Help mode}. Many questions are also answered by the
- \l{Examples and Tutorials}{examples and video tutorials}.
+ \l{Examples}{examples} and \l{Tutorials}{video tutorials}.
\list
\li \l {FAQ - \QB}{\QB}
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
index 58dbd20203..6ad323da3e 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-getting-started.qdoc
@@ -47,10 +47,10 @@
\QDS is available either as a standalone installation package or
as an option in the Qt online installer.
- \li \l {Your First UI}
+ \li \l {Tutorials}
- Follow a set of hands-on tutorials that build on each other to
- design your first animated UI using preset and custom components.
+ Follow a set of hands-on tutorials that illustrate how to use the
+ features of \QDS.
\li \l {User Interface}
Describes the parts and basic features of \QDS.
@@ -71,7 +71,7 @@
\li \l{Concepts and Terms}
Describes main \QDS concepts and terms.
- \li \l{Examples and Tutorials}
+ \li \l{Examples}
A set of examples available in the \uicontrol Welcome mode
illustrates how to use \QDS features such as the timeline.
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
index 701b84d30c..a896a1ded6 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-installation.qdoc
@@ -26,7 +26,7 @@
/*!
\page studio-installation.html
\previouspage studio-getting-started.html
- \nextpage {Your First UI}
+ \nextpage {Tutorials}
\title Installation
@@ -42,8 +42,8 @@
package \l{https://www.qt.io/product/ui-design-tools}{here}.
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
+ \l{Tutorials}{tutorials}, opening
+ \l{Examples}{examples}, watching videos, and reading
this manual.
\section1 Stand-Alone Installation
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
index a1b163bc21..c05618ee0c 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc
@@ -26,7 +26,7 @@
/*!
\page studio-terms.html
\previouspage studio-use-cases.html
- \nextpage {Examples and Tutorials}
+ \nextpage {Examples}
\title Concepts and Terms
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
index 52ba391531..cd6982b100 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
@@ -31,7 +31,7 @@
\li \l{Getting Started}
\list
\li \l{Installation}
- \li \l{Your First UI}
+ \li \l{Tutorials}
\li \l{User Interface}
\list
\li \l{Selecting Modes}
@@ -59,7 +59,7 @@
\li \l{Creating Projects}
\li \l{Use Cases}
\li \l{Concepts and Terms}
- \li \l{Examples and Tutorials}
+ \li \l{Examples}
\endlist
\li \l{Wireframing}
\list
diff --git a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
index 331e84185a..0ff5137f58 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio-tutorials.qdoc
@@ -28,14 +28,22 @@
\previouspage studio-installation.html
\nextpage creator-quick-tour.html
- \title Your First UI
+ \title Tutorials
\image loginui4.gif "Log In UI"
- You can follow a set of hands-on tutorials that build on each other to
+ \section1 Video Tutorials
+
+ When you run \QDS, the \uicontrol Tutorials tab in \uicontrol Welcome mode contains links
+ to video tutorials. To watch a tutorial on YouTube,
+ select it.
+
+ \section1 Written Tutorials
+
+ You can follow a set of hands-on tutorials that
illustrate how to use the features of \QDS. Even if you plan to export your
- designs from a design tool, it is useful to first create a small UI from
- scratch to learn to use \QDS. In particular, \e {Log In UI - Components}
+ designs from a design tool, it is useful to go through tutorials to learn to
+ use \QDS. In particular, \l {Log In UI - Components}
describes the terms and concepts that you will run into when exporting
designs with \QB.
@@ -43,8 +51,8 @@
yourself with the parts of \QDS in general, and the \uicontrol Design
mode in particular: \l{User Interface} and \l{Design Views}.
- In addition to these entry-level tutorials, \QDS comes with examples
- and video tutorials that you can open from the \uicontrol Examples and
- \uicontrol Tutorials tabs in the \uicontrol Welcome mode. For more
- information, see \l {Examples and Tutorials}.
+ In addition to these tutorials, \QDS comes with examples that you can open
+ from the \uicontrol Examples and tabs in the \uicontrol Welcome mode. For more
+ information, see \l {Examples}.
+
*/
diff --git a/doc/qtdesignstudio/src/qtdesignstudio.qdoc b/doc/qtdesignstudio/src/qtdesignstudio.qdoc
index e97a0cbf6a..a64c5e95be 100644
--- a/doc/qtdesignstudio/src/qtdesignstudio.qdoc
+++ b/doc/qtdesignstudio/src/qtdesignstudio.qdoc
@@ -48,12 +48,12 @@
\li \b {\l{Getting Started}}
\list
\li \l{Installation}
- \li \l{Your First UI}
+ \li \l{Tutorials}
\li \l{User Interface}
\li \l{Creating Projects}
\li \l{Use Cases}
\li \l{Concepts and Terms}
- \li \l{Examples and Tutorials}
+ \li \l{Examples}
\endlist
\li \b {\l{Wireframing}}
\list