From e9c9cd129676e0e13a76ab4bd6506bb0922fd6a0 Mon Sep 17 00:00:00 2001 From: Johanna Vanhatapio Date: Mon, 24 Mar 2025 15:25:26 +0200 Subject: [PATCH] Doc: Edit how to Run/Live Preview - Added info about the run toolbar Fixes: QDS-14601 Change-Id: I09274fe51a31cea7509236728161ba0835262cb4 Reviewed-by: Mats Honkamaa --- .../examples/doc/3DsceneTutorial.qdoc | 2 +- doc/qtdesignstudio/examples/doc/loginui3.qdoc | 4 ++-- doc/qtdesignstudio/examples/doc/sidemenu.qdoc | 4 ++-- .../examples/doc/simplekeyboard.qdoc | 4 ++-- .../studio-designer-developer-workflow.qdoc | 3 ++- .../qtdesignstudio-live-preview-desktop.qdoc | 8 ++++---- .../src/how-to/qtdesignstudio-run-project.qdoc | 4 ++-- .../src/overviews/qtquick-prototyping.qdoc | 8 ++++---- .../src/qtdesignstudio-qt-ui-viewer.qdoc | 18 +++++++++--------- .../src/qtdesignstudio-simulink.qdoc | 8 ++++++-- .../qtdesignstudio-3d-materials-shaders.qdoc | 8 ++++---- .../src/views/qtquick-timeline.qdoc | 5 ++--- 12 files changed, 40 insertions(+), 36 deletions(-) diff --git a/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc b/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc index 90a3f2aba29..782f6da5a20 100644 --- a/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc +++ b/doc/qtdesignstudio/examples/doc/3DsceneTutorial.qdoc @@ -66,7 +66,7 @@ scene. \image 3d-scene-bread-crumb.png \endlist - When you run the application or live preview, notice that you don't see much of the materials. + When you run the application or \uicontrol {Live Preview}, notice that you don't see much of the materials. The next step is to set up the environmental light. \section1 Adding environmental lighting to the scene diff --git a/doc/qtdesignstudio/examples/doc/loginui3.qdoc b/doc/qtdesignstudio/examples/doc/loginui3.qdoc index 3ff1952b5d8..7fc39ade2ff 100644 --- a/doc/qtdesignstudio/examples/doc/loginui3.qdoc +++ b/doc/qtdesignstudio/examples/doc/loginui3.qdoc @@ -37,7 +37,7 @@ enter to create an account. You are already familiar with the tasks in this section from the previous \e {Login UI} tutorials. - To preview the changes that you make, select the \uicontrol Run dropdown menu from the + To preview the changes that you make, select the run dropdown menu from the top toolbar, and then select \uicontrol {Live Preview}, or select \key {Alt+P}. To add the entry field needed on the second page to the \e Screen01 @@ -103,7 +103,7 @@ \image loginui3-states.webp All states in the States view. - The live preview displays the default state, \e login: + \uicontrol {Live Preview} displays the default state, \e login: \image loginui3-login-state-preview.webp Preview of the login state. diff --git a/doc/qtdesignstudio/examples/doc/sidemenu.qdoc b/doc/qtdesignstudio/examples/doc/sidemenu.qdoc index 966bc6e9b0d..3d2c5aebd8d 100644 --- a/doc/qtdesignstudio/examples/doc/sidemenu.qdoc +++ b/doc/qtdesignstudio/examples/doc/sidemenu.qdoc @@ -98,8 +98,8 @@ In addition, we set the \uicontrol Checked property to \c true for the first button instance on the menu bar to make it appear selected. - We can now select the \imagerunsmall - (\uicontrol Run) button to run the application and test our menu bar. + We can now select the run dropdown from the top toolbar, and then select + \uicontrol {Run App} to run the application and test our menu bar. \section1 Creating a side menu diff --git a/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc b/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc index 665d8b6a556..d00ac75c49d 100644 --- a/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc +++ b/doc/qtdesignstudio/examples/doc/simplekeyboard.qdoc @@ -18,8 +18,8 @@ text into \l{Text Edit} or \l{Text Input} components. For more information about using it, see \l{User Guide}{Virtual Keyboard: User Guide}. - To test the virtual keyboard, you need to select the \imagerunsmall - (\uicontrol Run) button to run the example on the desktop or a device. + To test the virtual keyboard, select the run dropdown in the top toolbar, + and then select \uicontrol Run to run the example on the desktop or a device. The keyboard is not available during preview. \section1 Using a virtual keyboard diff --git a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc index 998f89b74d2..585045a7ec6 100644 --- a/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc +++ b/doc/qtdesignstudio/src/developers/studio-designer-developer-workflow.qdoc @@ -81,7 +81,8 @@ accessible in the \uicontrol Projects view. \image qtcreator-qt-design-studio-project.webp "Qt Design studio projects in Qt Creator after successful import" - \li To run the project, select \uicontrol Run. + \li To run the project, select the run dropdown from the top toolbar, and then select + \uicontrol {Live Preview}. \endlist \note \QDS 4.4 and earlier versions have a project structure where diff --git a/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc b/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc index 809377d7527..9c81638b42e 100644 --- a/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc +++ b/doc/qtdesignstudio/src/how-to/qtdesignstudio-live-preview-desktop.qdoc @@ -11,10 +11,10 @@ To preview the currently active QML file on the desktop: \list 1 - \li Select \uicontrol Run dropdown from the top toolbar and select + \li Select the run dropdown from the top toolbar, and then select \uicontrol {Live Preview}. \li Select \imagerunproject. - \image studio-live-preview.webp Live preview a \QDS project on the desktop + \image studio-live-preview.webp Selecting Live Preview in the run dropdown menu. \note Alternatively, select \key {Alt+P}. \endlist @@ -22,8 +22,8 @@ To preview any QML file in the project: \list 1 - \li Select \uicontrol Run dropdown from the top toolbar and select - \uicontrol {Live Preview}. + \li Select the run dropdown from the top toolbar, and then select + \uicontrol {Live Preview}. \li Select \imagerunproject. \li Right-click the filename in the \l Projects view, and select \uicontrol {Preview File}. diff --git a/doc/qtdesignstudio/src/how-to/qtdesignstudio-run-project.qdoc b/doc/qtdesignstudio/src/how-to/qtdesignstudio-run-project.qdoc index 3ce54852e74..c67ac150784 100644 --- a/doc/qtdesignstudio/src/how-to/qtdesignstudio-run-project.qdoc +++ b/doc/qtdesignstudio/src/how-to/qtdesignstudio-run-project.qdoc @@ -12,8 +12,8 @@ \list 1 \li Open the project with \QDS. - \li Select \uicontrol Run dropdown from the top toolbar and select - \uicontrol {Run App}. + \li Select the run dropdown from the top toolbar, and then select + \uicontrol {Run App}. \li Select \imagerunproject. \image studio-run-project.webp {Run a \QDS project} diff --git a/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc b/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc index ea9cc8da1e2..a8381c7cc49 100644 --- a/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc +++ b/doc/qtdesignstudio/src/overviews/qtquick-prototyping.qdoc @@ -46,10 +46,10 @@ \li \l {Validating with target hardware} - You can use the live preview feature to preview a UI file or the - entire UI on the desktop, as well as on Android and embedded Linux - devices. The changes you make to the UI are instantly visible - to you in the preview. + You can use the \uicontrol {Live Preview} feature to preview a UI + file or the entire UI on the desktop, as well as on Android and + embedded Linux devices. The changes you make to the UI are instantly + visible to you in the preview. \li \l {Asset creation with other tools} diff --git a/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc index ae3ef6c0342..9daf726a849 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc @@ -29,17 +29,17 @@ \list 1 \li Open \QUV on your Android device. Find the IP address and note it down. \li Open or create a project in \QDS. - \li Select \uicontrol Run dropdown from the top toolbar and select + \li Select the run dropdown from the top toolbar, and then select \uicontrol {Device Manager}. - \image studio-run-dropdown.webp Device Manager in the Run dropdown + \image studio-run-dropdown.webp Device Manager in the run dropdown \li In \uicontrol {Set target device IP} write the IP address you have noted from \QUV. Then, select \imageplus. Your device is now added to the list of available devices. \list \li To update the device name, edit \uicontrol Alias. - \li To show your device in the \uicontrol Run dropdow, + \li To show your device in the run dropdown, always keep \uicontrol Enabled turned on. \li If you are connected to the same network, and \QUV is running on your Android device, the \uicontrol Status is Online. @@ -50,8 +50,8 @@ \note You can connect multiple Android devices to \QDS. Then, run a \QDS - project on any of the devices by selecting them from - \uicontrol Run dropdown, and selecting \imagerunproject. + project on any of the devices by selecting them from the run dropdown, and + selecting \imagerunproject. \section1 Previewing a \QDS project in \QUV @@ -60,8 +60,8 @@ \list 1 \li Open or create a project in \QDS. \li Open \QUV on your Android device. - \li Select your Android device from the \uicontrol Run dropdown. - \image studio-run-dropdown-with-added-device.webp {Android device listed in the Run dropdown} + \li Select your Android device from the run dropdown. + \image studio-run-dropdown-with-added-device.webp Android device listed in the run dropdown. \li Select \imagerunproject. \endlist @@ -82,11 +82,11 @@ \list 1 \li Open or create a project in \QDS. - \li Select \uicontrol Run dropdown from the top toolbar and select + \li Select the run dropdown from the top toolbar, and then select \uicontrol {Device Manager}. \li Select the device you want to remove from the list of devices and select \imageminus. - \image studio-devicemanager-remove-device.webp Remove a device from the Device Manager + \image studio-devicemanager-remove-device.webp Remove a device from Device Manager. \endlist */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc index 9c38b150886..82335bd7294 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-simulink.qdoc @@ -170,6 +170,10 @@ \image studio-binding-editor.png "The Binding Editor window" - Run the simulation by first clicking the \uicontrol Run icon in \QDS and - then the \uicontrol Run icon in Simulink. + To run the simulation: + \list 1 + \li Select the run dropdown in the \QDS top toolbar, + and then select \uicontrol {Run App}. + \li Select the \uicontrol Run icon in Simulink. + \endlist */ diff --git a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc index d708caae067..f235fe8ab55 100644 --- a/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc +++ b/doc/qtdesignstudio/src/qtquick3d-editor/qtdesignstudio-3d-materials-shaders.qdoc @@ -11,10 +11,10 @@ \image studio-qtquick-3d-material.webp "Material attached to model in Design mode" Materials and shaders define how object surfaces are rendered in \QDS and - live preview. As you change the properties of materials, new shaders are - generated accordingly, and the property values are bound. The complexity of - a shader depends on a combination of the properties that are set on it, and - the context of the scene itself. + \uicontrol {Live Preview}. As you change the properties of materials, new + shaders are generated accordingly, and the property values are bound. + The complexity of a shader depends on a combination of the properties that + are set on it, and the context of the scene itself. It is recommended that you use the \l {Material Editor and Browser} when working with materials, but you can also add materials using the components diff --git a/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc b/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc index 6e89964991f..715a822fc51 100644 --- a/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-timeline.qdoc @@ -239,9 +239,8 @@ button or select \key Space. \endlist - To preview the whole UI, select the - \uicontrol {Live Preview} button on the top toolbar - or select \key Alt + \key P. + To preview the whole UI, select the run dropdown from the top toolbar, + and then select \uicontrol {Live Preview}, or select \key Alt + \key P. \section1 Animating rotation