summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMats Honkamaa <mats.honkamaa@qt.io>2019-02-13 11:47:01 +0200
committerMiikka Heikkinen <miikka.heikkinen@qt.io>2019-02-18 16:06:53 +0000
commitc36a130f99b029094253ca74e9cbbc1f7e74df87 (patch)
tree59b9d247d9841f53a0a49397e516460ed2836be9
parentc0c4fa6176a53c63313f57bc07c8182bd2a4c636 (diff)
Create Known Issues page
Created Known Issues page, move known issues section from About Qt 3D Studio to the new page. Also added a known issue from QT3DS-2720. Task-number: QT3DS-2830 Change-Id: I31dba1e0f755761f210b788e425266aed51fcefa Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
-rw-r--r--doc/src/00-concepts.qdoc3
-rw-r--r--doc/src/about-qt3dstudio.qdoc18
-rw-r--r--doc/src/known-issues.qdoc55
3 files changed, 56 insertions, 20 deletions
diff --git a/doc/src/00-concepts.qdoc b/doc/src/00-concepts.qdoc
index 758180b1..ef65f215 100644
--- a/doc/src/00-concepts.qdoc
+++ b/doc/src/00-concepts.qdoc
@@ -48,7 +48,6 @@ interactive presentations, UIs and applications.
\div {align="center"}
\image animation-index.png
\enddiv
-
\row
\li \b {\l{Getting Started}}
\list
@@ -100,11 +99,11 @@ interactive presentations, UIs and applications.
\endlist
\li \b {\l{Getting Help}}
\list
+ \li \l{Known Issues}
\li \l{Glossary}
\li \l{Studio Keyboard Shortcuts}
\li \l{Viewer Keyboard Shortcuts}
\endlist
-
\row
\li {3,1} \note To report bugs and suggestions to the Qt Bug
Tracker, visit \l https://bugreports.qt.io.
diff --git a/doc/src/about-qt3dstudio.qdoc b/doc/src/about-qt3dstudio.qdoc
index 9e4290a8..ecfe6683 100644
--- a/doc/src/about-qt3dstudio.qdoc
+++ b/doc/src/about-qt3dstudio.qdoc
@@ -113,22 +113,4 @@ are then composited with items on upper layers drawing on top of the content on
A Studio presentation combines 3D assets with animations and \e{slides}. Slides can be thought
of as states and provide visual variations within the presentation.
-
-\section1 Known Issues
-
-\section2 Possible problems after automatic mesh optimization
-
-When loading a presentation made with an earlier version (2.0 beta2 or older) of Qt 3D Studio
-which has imported FBX or DAE models, you may see the following messagebox:
-
-\image {mesh_optimization.png}{Old presentation version}
-
-If your \b{imported} models are not visible in the Viewer after seeing the message, you need to
-edit your \c{*.uip} file(s) manually. Some older versions of Studio referenced meshes with revision
-number in the \c{*.uip} file, and that revision causes it to be missing in the scope of the
-Viewer.
-
-You'll need to find all occurrences of \c{.mesh#<revision_number>} from you \c{*.uip} and
-replace them with \c{.mesh}.
-
*/
diff --git a/doc/src/known-issues.qdoc b/doc/src/known-issues.qdoc
new file mode 100644
index 00000000..4fe7b09d
--- /dev/null
+++ b/doc/src/known-issues.qdoc
@@ -0,0 +1,55 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 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 Known Issues
+\page known-issues.html
+
+This section lists known issues in Qt 3D Studio. The development team is aware of them,
+and therefore, you do not need to report them as bugs.
+
+\section1 Possible Problems After Automatic Mesh Optimization
+
+When loading a presentation made with an earlier version (2.0 beta2 or older) of Qt 3D Studio
+which has imported FBX or DAE models, you may see the following message box:
+
+\image {mesh_optimization.png}{Old presentation version}
+
+If your \b{imported} models are not visible in the Viewer after seeing the message, you need to
+edit your \e .uip files manually. Some older versions of Studio referenced meshes with revision
+number in the \e .uip file, and that revision causes it to be missing in the scope of the
+Viewer.
+
+You need to find all occurrences of \c{.mesh#<revision_number>} from your \e .uip files and
+replace them with \c{.mesh}.
+
+\section1 QML Stream with Window Element Causes Viewer Crash
+
+Opening a project that has a QML stream including a Window element causes the viewer to crash.
+
+*/