diff options
author | Mats Honkamaa <mats.honkamaa@qt.io> | 2018-12-04 15:23:50 +0200 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@qt.io> | 2018-12-04 13:38:59 +0000 |
commit | bd82b0dd42f148e6419fece514fef5b6f07796e8 (patch) | |
tree | 4cf3cbe7f806aeb60bb9407d681a1031b3573b33 | |
parent | fd767e95f5d1cc157b5bcfcb22e65d5d9828dabd (diff) |
Create pages for main categories
Created sub-pages for each of the 5 main categories. This is needed for
the sidebar menu and also for unifying with i.e. creator and design
studio manuals. Also needed to rename the quick start guide page.
Task-number: QT3DS-2708
Change-Id: Icea5009857c21eb4f42aa18621630b7d389445a8
Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
-rw-r--r-- | doc/src/00-concepts.qdoc | 15 | ||||
-rw-r--r-- | doc/src/11-quick-start-guides/quick-start-guide.qdoc (renamed from doc/src/11-quick-start-guides/10-getting-started.qdoc) | 5 | ||||
-rw-r--r-- | doc/src/animations.qdoc | 48 | ||||
-rw-r--r-- | doc/src/deployment.qdoc | 42 | ||||
-rw-r--r-- | doc/src/getting-help.qdoc | 46 | ||||
-rw-r--r-- | doc/src/getting-started.qdoc | 66 | ||||
-rw-r--r-- | doc/src/graphics.qdoc | 68 | ||||
-rw-r--r-- | doc/src/scripting.qdoc | 53 | ||||
-rw-r--r-- | doc/style/qt5-sidebar.html | 12 |
9 files changed, 337 insertions, 18 deletions
diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc index 3860efc1..9f392d11 100644 --- a/doc/src/00-concepts.qdoc +++ b/doc/src/00-concepts.qdoc @@ -50,16 +50,16 @@ interactive presentations, UIs and applications. \enddiv \row - \li \b {Getting Started} + \li \b {\l{Getting Started}} \list \li \l{About Qt 3D Studio} - \li \l{Getting Started}{Quick Start Guide} + \li \l{Quick Start Guide} \li \l{Tutorials} \li \l{Best Practices} \li \l{Studio Index} \li \l{Viewer Index} \endlist - \li \b {Graphics} + \li \b {\l{Graphics}} \list \li \l{Working with 3D Content}{3D Assets} \li \l{Layers} @@ -68,7 +68,7 @@ interactive presentations, UIs and applications. \li \l{Using Sub-Presentations}{Sub-Presentations} \li \l{Stereoscopic Rendering} \endlist - \li \b {Animations} + \li \b {\l{Animations}} \list \li \l{Studio: Timeline Palette}{The Timeline} \li \l{Dynamic Keyframes} @@ -86,19 +86,18 @@ interactive presentations, UIs and applications. \div {align="center"} \image help-index.png \enddiv - \row - \li \b {Scripting} + \li \b {\l{Scripting}} \list \li \l{Using Data Inputs}{Data Input} \li \l{Using Behavior Scripts}{Behavior} \li \l{File Formats} \endlist - \li \b {Deployment} + \li \b {\l{Deployment}} \list \li \l{Viewer Remote Deployment} \endlist - \li \b {Getting Help} + \li \b {\l{Getting Help}} \list \li \l{Studio Keyboard Shortcuts} \li \l{Viewer Keyboard Shortcuts} diff --git a/doc/src/11-quick-start-guides/10-getting-started.qdoc b/doc/src/11-quick-start-guides/quick-start-guide.qdoc index 9d9cf8a7..7b5a4362 100644 --- a/doc/src/11-quick-start-guides/10-getting-started.qdoc +++ b/doc/src/11-quick-start-guides/quick-start-guide.qdoc @@ -27,9 +27,8 @@ /*! -\title Getting Started -\page getting-started.html -\ingroup qt3dstudio-quick-start-guides +\title Quick Start Guide +\page quick-start-guide.html \section1 Introduction This guide will teach you how to create your first Qt 3D Studio project. Additionally it will diff --git a/doc/src/animations.qdoc b/doc/src/animations.qdoc new file mode 100644 index 00000000..33a83075 --- /dev/null +++ b/doc/src/animations.qdoc @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Animations +\page animations.html + +\list + \li + \l{Studio: Timeline Palette}{The Timeline} + + The timeline palette provides direct access to all elements in your scene, and also gives you + control over the animation and timing within a slide. + + \li + \l{Dynamic Keyframes} + + Dynamic keyframes are a powerful feature that allow you to smoothly interpolate between different + animated values on different slides. + +\endlist + +*/ diff --git a/doc/src/deployment.qdoc b/doc/src/deployment.qdoc new file mode 100644 index 00000000..6332832b --- /dev/null +++ b/doc/src/deployment.qdoc @@ -0,0 +1,42 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Deployment +\page deployment.html + +\list + \li + \l{Viewer Remote Deployment} + + Qt 3D Studio supports remote deployment to Qt 3D Studio Viewer. This enables seeing design + changes live in the target device, for example an Android tablet. + +\endlist + +*/ diff --git a/doc/src/getting-help.qdoc b/doc/src/getting-help.qdoc new file mode 100644 index 00000000..9e5d5685 --- /dev/null +++ b/doc/src/getting-help.qdoc @@ -0,0 +1,46 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Getting Help +\page getting-help.html + +\list + \li + \l{Studio Keyboard Shortcuts} + + A list of all keyboard shortcuts for the Studio. + + \li + \l{Viewer Keyboard Shortcuts} + + A list of all keyboard shortcuts for the Viewer. + +\endlist + +*/ diff --git a/doc/src/getting-started.qdoc b/doc/src/getting-started.qdoc new file mode 100644 index 00000000..928bedf4 --- /dev/null +++ b/doc/src/getting-started.qdoc @@ -0,0 +1,66 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Getting Started +\page getting-started.html + +\list + \li + \l{About Qt 3D Studio} + + All about the Qt 3D Studio suite concept including requirements, copyright notices and known + issues. + + \li + \l{Quick Start Guide} + + The quick start guide is the best way to get started if you are new to Qt 3D Studio. + + \li + \l{Tutorials} + + A collection of tutorials. + + \li + \l{Best Practices} + + A collection of best practices guides. + + \li + \l{Studio Index} + + A more in-depth introduction to the Qt 3D Studio editor. + + \li + \l{Viewer Index} + + A more in-depth introduction to the Qt 3D Studio viewer. +\endlist + +*/ diff --git a/doc/src/graphics.qdoc b/doc/src/graphics.qdoc new file mode 100644 index 00000000..ce7939da --- /dev/null +++ b/doc/src/graphics.qdoc @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Graphics +\page graphics.html + +\list + \li + \l{Working with 3D Content}{3D Assets} + + Best practices on how to work with 3D content in Studio, and how to import 3D content from + various 3D content creation tools. + + \li + \l{Layers} + + A single Studio presentation combines one or more layers. The visual result of each layer comes + from rendering a 3D scene, 2D scene, or sub-presentation. + + \li + \l{Materials and shaders} + + Materials and shaders define how object surfaces are rendered in Studio and Viewer. + + \li + \l{Light Properties}{Lights} + + In Qt 3D Studio, scenes are illuminated with one or more lights. + + \li + \l{Using Sub-Presentations}{Sub-Presentations} + + Sub-Presentations is a feature which allows a Studio presentation or a QML file to + be embedded in a Studio presentation. + + \li + \l{Stereoscopic rendering} + + This is a technical preview on how stereoscopic rendering could work in Qt 3D Studio. +\endlist + +*/ diff --git a/doc/src/scripting.qdoc b/doc/src/scripting.qdoc new file mode 100644 index 00000000..01553ccd --- /dev/null +++ b/doc/src/scripting.qdoc @@ -0,0 +1,53 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of Qt 3D Studio. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + +\title Scripting +\page scripting.html + +\list + \li + \l{Using Data Inputs}{Data Input} + + Qt 3D Studio supports data-driven animations. This makes it possible to control timeline + animations, object properties and slides with data input. + + \li + \l{Using Behavior Scripts}{Behavior} + + Qt 3D Studio supports using behavior scripts. Included in Studio is a set of behavior scripts, + these can be found in the scripts asset library. + + \li + \l{File Formats} + + File formats of custom effect, materials and shaders. + +\endlist + +*/ diff --git a/doc/style/qt5-sidebar.html b/doc/style/qt5-sidebar.html index eb007c75..765cf6ff 100644 --- a/doc/style/qt5-sidebar.html +++ b/doc/style/qt5-sidebar.html @@ -6,15 +6,13 @@ <div class="indexboxcont indexboxbar"> <ul> <li><a href="getting-started.html">Getting Started</a></li> - <li><a href="qt3dstudio-studio.html">Studio</a></li> - <li><a href="qt3dstudio-viewer.html">Viewer</a></li> + <li><a href="graphics.html">Graphics</a></li> + <li><a href="animations.html">Animations</a></li> + <li><a href="scripting.html">Scripting</a></li> + <li><a href="deployment.html">Deployment</a></li> + <li><a href="getting-help.html">Getting Help</a></li> <li><a href="runtime/index.html">Runtime</a></li> <li><a href="runtime/qt3d-runtime-qml.html">QML API Reference</a></li> <li><a href="runtime/qt3d-runtime-cpp.html">C++ API Reference</a></li> - <li><a href="qt3dstudio-file-formats.html">File Formats</a></li> - <li><a href="qt3dstudio-best-practices.html">Best Practices</a></li> - <li><a href="requirements.html">Requirements</a></li> - <li><a href="experimental-features.html">Experimental Features</a></li> - <li><a href="copyright-notices.html">Copyright Notices</a></li> </ul> </div> |