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

Doc: Restructure the QDS Manual

Browse Source 
Task-number: QDS-4248
Change-Id: I8361c44eee3ea338b5625851622a45ac202737ef
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Johanna Vanhatapio
2021-05-27 16:43:04 +03:00
parent e3c7a74f68
commit 2672bb2930
2 changed files with 264 additions and 226 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -27,45 +27,11 @@
\page qtdesignstudio-toc.html \page qtdesignstudio-toc.html
\title All Topics \title All Topics
\list \list
\li \l{Getting Started} \li \l{Getting Started} (REWRITE)
\list \list
\l {Exporting and Importing} \li \l Installation (NEW)
\list \li \l{User Interface}{Interface Overview}
\li \l{Exporting from Design Tools}
\list
\li \l{Exporting Designs from Adobe Illustrator}
\li \l{Exporting Designs from Adobe Photoshop}
\list
\li \l{Setting Up Qt Bridge for Adobe Photoshop}
\li \l{Using Qt Bridge for Adobe Photoshop}
\endlist
\li \l{Exporting Designs from Sketch}
\list
\li \l{Setting Up Qt Bridge for Sketch}
\li \l{Using Qt Bridge for Sketch}
\endlist
\li \l{Exporting Designs from Figma}
\list
\li \l{Setting Up Qt Bridge for Figma}
\li \l{Using Qt Bridge for Figma}
\endlist
\li \l{Exporting 3D Assets}
\list
\li \l{Exporting from Blender}
\li \l{Exporting from Maya}
\li \l{Exporting from Qt 3D Studio}
\endlist
\endlist
\li \l{Importing Designs}
\list
\li \l{Importing 2D Assets}
\li \l{Importing 3D Assets}
\endlist
\li \l{Exporting Components}
\endlist
\li \l{User Interface}
\list \list
\li \l{Selecting Modes} \li \l{Selecting Modes}
\li \l{Design Views} \li \l{Design Views}
@@ -87,20 +53,24 @@
\endlist \endlist
\li \l{Managing Workspaces} \li \l{Managing Workspaces}
\li \l{Managing Sessions} \li \l{Managing Sessions}
\li \l{Keyboard Shortcuts}
\endlist \endlist
\li \l{Creating Projects}{Projects}
\li \l{Use Cases} (NEW)
\li \l{Concepts and Terms}
\li \l{Examples and Tutorials}
\list
\li \l{Tutorials} \li \l{Tutorials}
\li \l{Qt Quick Best Practices} \li \l{Qt Quick Best Practices}
\list \list
\li \l{Creating Optimized 3D Scenes} \li \l{Creating Optimized 3D Scenes}
\endlist \endlist
\endlist \endlist
\li \l{Managing Projects} \li \l{Supported Platforms}
\list
\li \l{Creating Projects}
\li \l{Using Git}
\li \l{Converting UI Projects to Applications}
\endlist \endlist
\li \l{Creating UIs} \li \l{Wireframing} (NEW)
\list
\li \l {Creating UIs}{Creating 2D and 3D UIs}
\list \list
\li \l{Designing Application Flows} \li \l{Designing Application Flows}
\list \list
@@ -113,27 +83,54 @@
\li \l{Applying States in Flows} \li \l{Applying States in Flows}
\li \l{Reacting to External Events} \li \l{Reacting to External Events}
\endlist \endlist
\li \l{Creating Components} \endlist
\li \l {Creating Components}{Components} (NEW) (grid?)
\list
\li \l{Component Types}{Preset Components}
\list \list
\li \l{Shapes} \li \l{Shapes}
\li \l{Text} \li \l{Text}
\li \l{Images} \li \l{Images}
\li \l{UI Controls}
\li \l{User Interaction Methods} \li \l{User Interaction Methods}
\li \l{UI Controls}
\li \l{Lists and Other Data Models} \li \l{Lists and Other Data Models}
\li \l{2D Effects} \li \l{2D Effects}
\li \l{Logic Helpers} \li \l{Logic Helpers}
\li \l Animations \li \l Animations
\li \l{Setting Scene Environment}{Scene Environment}
\li \l{Adding 3D Views}{3D Views}
\li \l{Setting Group Properties}{Group}
\li \l{Adding 3D Models}{3D Models}
\li \l{Using Materials and Shaders}{Materials and Shaders}
\li \l{Attaching Textures to Materials}{Textures}
\li \l{Using 3D Materials}{3D Materials}
\li \l{Applying 3D Effects}{3D Effects}
\li \l{Using Custom Shaders}{Custom Shaders}
\li \l{Using Lights}{Lights}
\li \l{Using Scene Camera}{Cameras}
\endlist
\li \l {Creating Your Own Components}{Creating Custom Components}
\list
\li \l{Creating Buttons} \li \l{Creating Buttons}
\li \l{Creating Scalable Buttons and Borders} \li \l{Creating Scalable Buttons and Borders}
\li \l{Creating Custom Effects and Materials}
\endlist \endlist
\li \l{Specifying Component Properties} \li \l{Specifying Component Properties}
\li \l{Positioning Components} \li \l{Positioning Components}{Scalable Layouts}
\li \l{Using Custom Fonts}
\li \l{Annotating Designs} \li \l{Annotating Designs}
\li \l{UI Files}
\endlist \endlist
\li \l {Adding Dynamics} \endlist
\li \l{Prototyping} (NEW)
\list
\li Creating UI Logic
\li \l{Simulating Data Input}{Simulating Complex Experiences}
\list
\li \l{Loading Placeholder Data}
\li \l{Simulating Application Logic}
\li \l{Simulating Dynamic Systems}
\li \l{Using QML Modules with Plugins}
\endlist
\li \l{Adding Dynamics}{Dynamic Behaviors}
\list \list
\li \l{Creating Animations} \li \l{Creating Animations}
\list \list
@@ -147,35 +144,65 @@
\endlist \endlist
\li \l{Adding States} \li \l{Adding States}
\endlist \endlist
\li \l{Editing 3D Scenes} \li \l{Previewing}{Validating with Target Hardware}
\list
\li \l{Adding 3D Views}
\li \l{Using 3D Components}
\list
\li \l{Setting Group Properties}
\li \l{Adding 3D Models}
\li \l{Using Materials and Shaders}
\li \l{Attaching Textures to Materials}
\li \l{Using 3D Materials}
\li \l{Applying 3D Effects}
\li \l{Using Custom Shaders}
\li \l{Creating Custom Effects and Materials}
\li \l{Using Lights}
\li \l{Using Scene Camera}
\li \l{Setting Scene Environment}
\endlist
\endlist
\li \l{Previewing}
\list \list
\li \l{Previewing on Desktop} \li \l{Previewing on Desktop}
\li \l{Previewing on Devices} \li \l{Previewing on Devices}
\li \l{Previewing in Browsers} \li \l{Previewing in Browsers}
\endlist \endlist
\li \l{Advanced Topics} \li \l {Exporting and Importing}{Asset Creation with Other Tools}
\list \list
\li \l{Supported Platforms} \li \l{Exporting from Design Tools}
\li \l{Keyboard Shortcuts} \li \l{Exporting 2D Assets} (NEW)
\li \l{Coding} \list
\li \l{Exporting Designs from Adobe Illustrator}
\li \l{Exporting Designs from Adobe Photoshop}
\list
\li \l{Setting Up Qt Bridge for Adobe Photoshop}
\li \l{Using Qt Bridge for Adobe Photoshop}
\endlist
\li \l{Exporting Designs from Sketch}
\list
\li \l{Setting Up Qt Bridge for Sketch}
\li \l{Using Qt Bridge for Sketch}
\endlist
\li \l{Exporting Designs from Figma}
\list
\li \l{Setting Up Qt Bridge for Figma}
\li \l{Using Qt Bridge for Figma}
\endlist
\endlist
\li \l {Exporting 3D Assets}
\list
\li \l{Exporting from Blender}
\li \l{Exporting from Maya}
\li \l{Exporting from Qt 3D Studio}
\endlist
\li \l{Importing Designs}
\list
\li \l{Importing 2D Assets}
\list
\li \l{Using Custom Fonts}
\endlist
\li \l{Importing 3D Assets}
\endlist
\li \l{Exporting Components}
\li \l{To and from Qt Creator} (designer-developer workflow)
\endlist
\endlist
\li \l{Motion Design} (NEW)
\list
\li Introduction to Animation Techniques (NEW))
\li \l{Production Quality} (NEW)
\list
\li \l{Detailed Motion Design} (NEW)
\endlist
\li \l{Optimizing for Target Hardware} (NEW)
\endlist
\li \l{Implementing Applications} (NEW)
\list
\li Using Flows in Production (NEW)
\li \l{Coding}{Cross-Platform Development} (NEW)
\list \list
\li \l{Writing Code} \li \l{Writing Code}
\list \list
@@ -204,20 +231,23 @@
\li \l{Specifying Text Editor Settings} \li \l{Specifying Text Editor Settings}
\endlist \endlist
\endlist \endlist
\li \l{Simulating Data Input}
\list
\li \l{Loading Placeholder Data}
\li \l{Simulating Application Logic}
\li \l{Simulating Dynamic Systems}
\li \l{Using QML Modules with Plugins}
\endlist
\li \l{Debugging and Profiling} \li \l{Debugging and Profiling}
\list \list
\li \l{Debugging Qt Quick Projects} \li \l{Debugging Qt Quick Projects}
\li \l{Debugging a Qt Quick Example Application} \li \l{Debugging a Qt Quick Example Application}
\li \l{Profiling QML Applications}
\endlist \endlist
\li \l{Using External Tools} \li \l{Designer-Developer Workflow} (NEW)
\list
\li \l{Reusable Prototypes and Full UI Implementation} (NEW)
\li \l{Optimizing Specification and Implementation} (NEW)
\li \l{Parallel Development} (NEW)
\li \l{One Toolchain} (NEW)
\endlist
\endlist
\li \l{Advanced Topics}{Advanced Designer Topics} (NEW)
\list
\li Extending Component Functionality (NEW)
\li \l{UI Files}
\li \l{Managing Data Collection} \li \l{Managing Data Collection}
\list \list
\li \l {Collecting Usage Statistics} \li \l {Collecting Usage Statistics}
@@ -225,12 +255,17 @@
\li \l {Reporting Crashes} \li \l {Reporting Crashes}
\endlist \endlist
\endlist \endlist
\li \l{Help} \li \l{Developer Topics} (NEW)
\list
\li \l{Using Git}
\li \l{Converting UI Projects to Applications}
\li \l{Using External Tools}
\endlist
\li \l Help
\list \list
\li \l{Examples and Tutorials}
\li \l{Using the Help Mode} \li \l{Using the Help Mode}
\li \l{Frequently Asked Questions} \li \l{Frequently Asked Questions}
\li \l{Concepts and Terms} \li \l{How To}
\endlist \endlist
\li \l{Technical Support} \li \l{Technical Support}
\li \l{Acknowledgements} \li \l{Acknowledgements}

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

@@ -41,75 +41,78 @@
\li {4,1} \b {\l{All Topics}} \li {4,1} \b {\l{All Topics}}
\row \row
\li \inlineimage front-gs.png \li \inlineimage front-gs.png
\li \inlineimage front-projects.png
\li \inlineimage front-ui.png \li \inlineimage front-ui.png
\li \inlineimage studio-3d-scenes.png
\li \inlineimage studio-animation.png \li \inlineimage studio-animation.png
\row \row
\li \b {\l{Getting Started}} \li \b {\l{Getting Started}} (REWRITE)
\list \list
\li \l{Exporting and Importing} \li \l Installation
\li \l{User Interface} \li \l{User Interface}{Interface Overview}
\li \l{Design Views} \li \l{Creating Projects}{Projects}
\li \l{Tutorials} \li \l{Use Cases} (NEW)
\li \l{Qt Quick Best Practices} \li \l{Concepts and Terms}
\li \l{Examples and Tutorials}
\li \l{Supported Platforms}
\endlist \endlist
\li \b {\l{Managing Projects}} \li \b {\l{Wireframing}} (NEW)
\list \list
\li \l{Creating Projects} \li \l{Creating UIs}{Creating 2D and 3D UIs}
\li \l{Using Git} \li \l{Creating Components}{Components}
\li \l{Converting UI Projects to Applications}
\endlist
\li \b {\l{Creating UIs}}
\list
\li \l{Designing Application Flows}
\li \l{Creating Components}
\li \l{Specifying Component Properties} \li \l{Specifying Component Properties}
\li \l{Positioning Components} \li \l{Positioning Components}{Scalable Layouts}
\li \l{Annotating Designs} \li \l{Annotating Designs}
\endlist \endlist
\li \b {\l{Adding Dynamics}} \li \b {\l{Prototyping}} (NEW)
\list \list
\li \l{Creating Animations} \li Creating UI Logic
\li \l{Adding Connections} \li \l{Simulating Data Input}{Simulating Complex Experiences}
\li \l{Adding States} \li \l{Adding Dynamics}{Dynamic Behaviors}
\li \l{Previewing}{Validating with Target Hardware}
\li \l{Exporting and Importing}{Asset Creation with Other Tools}
\endlist
\li \b {\l{Motion Design}} (NEW)
\list
\li Introduction to Animation Techniques (NEW))
\li \l{Production Quality} (NEW)
\li \l{Importing for Content Creation Tools}
\li \l{Optimizing for Target Hardware} (NEW)
\endlist \endlist
\row \row
\li \inlineimage studio-3d-scenes.png
\li \inlineimage front-preview.png \li \inlineimage front-preview.png
\li \inlineimage front-advanced.png \li \inlineimage front-advanced.png
\li \inlineimage front-projects.png
\li \inlineimage front-help.png \li \inlineimage front-help.png
\row \row
\li \b {\l{Editing 3D Scenes}} \li \b {\l{Implementing Applications}} (NEW)
\list \list
\li \l{3D Editor} \li Using Flows in Production (NEW)
\li \l{Adding 3D Views} \li \l{Coding}{Cross-Platform Development} (NEW)
\li \l{Using 3D Components}
\endlist
\li \b {\l{Previewing}}
\list
\li \l{Previewing on Desktop}
\li \l{Previewing on Devices}
\li \l{Previewing in Browsers}
\endlist
\li \b {\l{Advanced Topics}}
\list
\li \l{Supported Platforms}
\li \l{Keyboard Shortcuts}
\li \l{Coding}
\li \l{Simulating Data Input}
\li \l{Debugging and Profiling} \li \l{Debugging and Profiling}
\li \l{Designer-Developer Workflow} (NEW)
\endlist \endlist
\li \b {\l{Help}} \li \b {\l{Advanced Topics}{Advanced Designer Topics}} (NEW)
\list
\li Extending Component Functionality (NEW)
\li \l{UI Files}
\li \l {Managing Data Collection}
\endlist
\li \b {\l{Developer Topics}} (NEW)
\list
\li \l{Using Git}
\li \l{Converting UI Projects to Applications}
\li \l{Using External Tools}
\endlist
\li \b {\l Help}
\list \list
\li \l{Examples and Tutorials}
\li \l{Using the Help Mode} \li \l{Using the Help Mode}
\li \l{Frequently Asked Questions} \li \l{Frequently Asked Questions}
\li \l{Concepts and Terms} \li \l{How-To}
\endlist \endlist
\row \row
\li {4,1} \note To report bugs and suggestions to the \li {4,1} \note To report bugs and suggestions to the
\l{https://bugreports.qt.io/}{Qt Project Bug Tracker}, \l{https://bugreports.qt.io/}{Qt Project Bug Tracker},
select \uicontrol {Help > Report Bug}. select \uicontrol {Help > Report Bug} in QDS.
To copy and paste detailed information about your system to the To copy and paste detailed information about your system to the
bug report, select \uicontrol Help > bug report, select \uicontrol Help >
\uicontrol {System Information}. \uicontrol {System Information}.