From 26a0199c36baa58e4b5ec1efd93e0d4d7387411c Mon Sep 17 00:00:00 2001 From: Mats Honkamaa Date: Wed, 11 Oct 2023 12:43:58 +0300 Subject: [PATCH] Doc: Add open project instructions to tutorials MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added a small section that descibes how to open the tutorial project. Task-number: QDS-10127 Change-Id: I1f3de12e1928246ad505391dd24d3f57c21d3be9 Reviewed-by: Johanna Vanhatapio Reviewed-by: Qt CI Patch Build Bot Reviewed-by: Esa Törmänen --- doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc | 2 ++ doc/qtdesignstudio/examples/doc/StateTransitions.qdoc | 2 ++ doc/qtdesignstudio/examples/doc/animationTutorial.qdoc | 2 ++ doc/qtdesignstudio/examples/doc/multilanguage.qdoc | 5 ++--- doc/qtdesignstudio/src/run-tutorial-project.qdocinc | 4 ++++ 5 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 doc/qtdesignstudio/src/run-tutorial-project.qdocinc diff --git a/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc b/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc index 78a3490113f..37340999157 100644 --- a/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc +++ b/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc @@ -41,6 +41,8 @@ Besides the 3D model, the 3D scene also has the default camera and the default directional light. + \include run-tutorial-project.qdocinc + \section1 Adding Materials to the 3D Models First, use materials from \uicontrol {Content Library} on the ball bearing. diff --git a/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc b/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc index 2c2729d77ad..ad8ae0005e0 100644 --- a/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc +++ b/doc/qtdesignstudio/examples/doc/StateTransitions.qdoc @@ -30,6 +30,8 @@ All assets you need for this tutorial are included in the Car Demo project. + \include run-tutorial-project.qdocinc + \section1 Creating States First, you create the different states. In this tutorial, you create four diff --git a/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc b/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc index d5b71b91bdb..66fb2009670 100644 --- a/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc +++ b/doc/qtdesignstudio/examples/doc/animationTutorial.qdoc @@ -52,6 +52,8 @@ This tutorial requires that you know the basics of \QDS, see \l{Getting Started}. + \include run-tutorial-project.qdocinc + \section1 Creating a Timeline Animation First, you create an animation where the ball bearing continuously rotates diff --git a/doc/qtdesignstudio/examples/doc/multilanguage.qdoc b/doc/qtdesignstudio/examples/doc/multilanguage.qdoc index 5bb3dd56450..8689960cbb8 100644 --- a/doc/qtdesignstudio/examples/doc/multilanguage.qdoc +++ b/doc/qtdesignstudio/examples/doc/multilanguage.qdoc @@ -20,14 +20,13 @@ \l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/multi-language%20tutorial/Loginui2}{here} before you start. - Download the project and open the \e loginui2.qmlproject file in \QDS - to get started. - This project consists of a login page with a couple of text elements. Additionally, you will use a JSON translation file in this tutorial. Download it from \l{https://git.qt.io/public-demos/qtdesign-studio/-/tree/master/tutorial%20projects/multi-language}{here}. + \include run-tutorial-project.qdocinc + \section1 JSON Translation File The JSON translation file you are using in this project has the following diff --git a/doc/qtdesignstudio/src/run-tutorial-project.qdocinc b/doc/qtdesignstudio/src/run-tutorial-project.qdocinc new file mode 100644 index 00000000000..3be68b2d69f --- /dev/null +++ b/doc/qtdesignstudio/src/run-tutorial-project.qdocinc @@ -0,0 +1,4 @@ +\section1 Running the Tutorial Project + +To open the tutorial project in \QDS, open the \e{.qmlproject} file located +in the root folder of the downloaded project.