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>
This commit is contained in:
Mats Honkamaa
2021-11-30 15:27:06 +02:00
parent 8fd937f29f
commit 06e1182574
14 changed files with 49 additions and 59 deletions

View File

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

View File

@@ -25,7 +25,6 @@
/*! /*!
\example loginui1 \example loginui1
\ingroup studioexamples
\ingroup gstutorials \ingroup gstutorials
\nextpage {Log In UI - Positioning} \nextpage {Log In UI - Positioning}

View File

@@ -25,7 +25,6 @@
/*! /*!
\example loginui2 \example loginui2
\ingroup studioexamples
\ingroup gstutorials \ingroup gstutorials
\previouspage {Log In UI - Components} \previouspage {Log In UI - Components}
\nextpage {Log In UI - States} \nextpage {Log In UI - States}

View File

@@ -25,7 +25,6 @@
/*! /*!
\example loginui3 \example loginui3
\ingroup studioexamples
\ingroup gstutorials \ingroup gstutorials
\title Log In UI - States \title Log In UI - States

View File

@@ -25,7 +25,6 @@
/*! /*!
\example loginui4 \example loginui4
\ingroup studioexamples
\ingroup gstutorials \ingroup gstutorials
\title Log In UI - Timeline \title Log In UI - Timeline
@@ -324,5 +323,5 @@
\section1 Next Steps \section1 Next Steps
For more examples about using timelines, see \l{Examples and Tutorials}. For more examples about using timelines, see \l{Examples}.
*/ */

View File

@@ -26,7 +26,7 @@
/*! /*!
\page quick-uis.html \page quick-uis.html
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
\previouspage {Examples and Tutorials} \previouspage {Examples}
\nextpage studio-app-flows.html \nextpage studio-app-flows.html
\else \else
\previouspage qtquick-text-editor.html \previouspage qtquick-text-editor.html

View File

@@ -27,43 +27,29 @@
\previouspage studio-terms.html \previouspage studio-terms.html
\group studioexamples \group studioexamples
\nextpage quick-uis.html \nextpage quick-uis.html
\title Examples and Tutorials \title Examples
In the \uicontrol Welcome mode, you can open examples and tutorials that \QDS comes with a set of example projects. To see these, select \uicontrol
illustrate how to use \QDS. Some examples are delivered together with Examples on the \uicontrol Welcome page when you run \QDS.
\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.
\image studio-examples-download.png "Examples for download in Welcome mode" \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 \list 1
\li Select an example. \li Select the example.
\li Select \uicontrol {Start Download} to download the example source \li Select the \inlineimage live_preview.png
files. (\uicontrol {Show Live Preview}) button to preview the example.
\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.
\endlist \endlist
\section1 Documented Examples 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}.
\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 Example Documentation
The \uicontrol Examples tab lists documented examples of using \QDS. To
open an example in \QDS, select it in the tab.
*/ */

View File

@@ -34,7 +34,7 @@
grouped by categories. You might also find answers to your questions in the grouped by categories. You might also find answers to your questions in the
product documentation by searching or browsing the index 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{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 \list
\li \l {FAQ - \QB}{\QB} \li \l {FAQ - \QB}{\QB}

View File

@@ -47,10 +47,10 @@
\QDS is available either as a standalone installation package or \QDS is available either as a standalone installation package or
as an option in the Qt online installer. 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 Follow a set of hands-on tutorials that illustrate how to use the
design your first animated UI using preset and custom components. features of \QDS.
\li \l {User Interface} \li \l {User Interface}
Describes the parts and basic features of \QDS. Describes the parts and basic features of \QDS.
@@ -71,7 +71,7 @@
\li \l{Concepts and Terms} \li \l{Concepts and Terms}
Describes main \QDS 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 A set of examples available in the \uicontrol Welcome mode
illustrates how to use \QDS features such as the timeline. illustrates how to use \QDS features such as the timeline.

View File

@@ -26,7 +26,7 @@
/*! /*!
\page studio-installation.html \page studio-installation.html
\previouspage studio-getting-started.html \previouspage studio-getting-started.html
\nextpage {Your First UI} \nextpage {Tutorials}
\title Installation \title Installation
@@ -42,8 +42,8 @@
package \l{https://www.qt.io/product/ui-design-tools}{here}. package \l{https://www.qt.io/product/ui-design-tools}{here}.
After the installation, you can start exploring \QDS by following After the installation, you can start exploring \QDS by following
tutorials to \l{Your First UI}{create your first UI}, opening \l{Tutorials}{tutorials}, opening
\l{Examples and Tutorials}{examples}, watching videos, and reading \l{Examples}{examples}, watching videos, and reading
this manual. this manual.
\section1 Stand-Alone Installation \section1 Stand-Alone Installation

View File

@@ -26,7 +26,7 @@
/*! /*!
\page studio-terms.html \page studio-terms.html
\previouspage studio-use-cases.html \previouspage studio-use-cases.html
\nextpage {Examples and Tutorials} \nextpage {Examples}
\title Concepts and Terms \title Concepts and Terms

View File

@@ -31,7 +31,7 @@
\li \l{Getting Started} \li \l{Getting Started}
\list \list
\li \l{Installation} \li \l{Installation}
\li \l{Your First UI} \li \l{Tutorials}
\li \l{User Interface} \li \l{User Interface}
\list \list
\li \l{Selecting Modes} \li \l{Selecting Modes}
@@ -59,7 +59,7 @@
\li \l{Creating Projects} \li \l{Creating Projects}
\li \l{Use Cases} \li \l{Use Cases}
\li \l{Concepts and Terms} \li \l{Concepts and Terms}
\li \l{Examples and Tutorials} \li \l{Examples}
\endlist \endlist
\li \l{Wireframing} \li \l{Wireframing}
\list \list

View File

@@ -28,14 +28,22 @@
\previouspage studio-installation.html \previouspage studio-installation.html
\nextpage creator-quick-tour.html \nextpage creator-quick-tour.html
\title Your First UI \title Tutorials
\image loginui4.gif "Log In UI" \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 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 designs from a design tool, it is useful to go through tutorials to learn to
scratch to learn to use \QDS. In particular, \e {Log In UI - Components} use \QDS. In particular, \l {Log In UI - Components}
describes the terms and concepts that you will run into when exporting describes the terms and concepts that you will run into when exporting
designs with \QB. designs with \QB.
@@ -43,8 +51,8 @@
yourself with the parts of \QDS in general, and the \uicontrol Design yourself with the parts of \QDS in general, and the \uicontrol Design
mode in particular: \l{User Interface} and \l{Design Views}. mode in particular: \l{User Interface} and \l{Design Views}.
In addition to these entry-level tutorials, \QDS comes with examples In addition to these tutorials, \QDS comes with examples that you can open
and video tutorials that you can open from the \uicontrol Examples and from the \uicontrol Examples and tabs in the \uicontrol Welcome mode. For more
\uicontrol Tutorials tabs in the \uicontrol Welcome mode. For more information, see \l {Examples}.
information, see \l {Examples and Tutorials}.
*/ */

View File

@@ -48,12 +48,12 @@
\li \b {\l{Getting Started}} \li \b {\l{Getting Started}}
\list \list
\li \l{Installation} \li \l{Installation}
\li \l{Your First UI} \li \l{Tutorials}
\li \l{User Interface} \li \l{User Interface}
\li \l{Creating Projects} \li \l{Creating Projects}
\li \l{Use Cases} \li \l{Use Cases}
\li \l{Concepts and Terms} \li \l{Concepts and Terms}
\li \l{Examples and Tutorials} \li \l{Examples}
\endlist \endlist
\li \b {\l{Wireframing}} \li \b {\l{Wireframing}}
\list \list