diff options
author | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2016-10-26 10:56:51 +0200 |
---|---|---|
committer | Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> | 2016-10-28 11:24:41 +0000 |
commit | 7314080060014b82cdbc16e90885b64e18da3902 (patch) | |
tree | 92f5bf272c34cd5644572d3f90d77edbba6fbc2a /doc | |
parent | 9bc6969feeb58313198a724846b528df2cdeea58 (diff) | |
download | neptune-ui-7314080060014b82cdbc16e90885b64e18da3902.tar.gz |
Doc: Add module documentation
Task-number: QTAUTO-252
Change-Id: I2cbc1c4107069cd51dad5aa043165282e5bf6be4
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Reviewed-by: Nedim Hadzic <nedim.hadzic@pelagicore.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/doc.pri | 15 | ||||
-rw-r--r-- | doc/neptune-ui-online.qdocconf | 20 | ||||
-rw-r--r-- | doc/neptune-ui-project.qdocconf | 22 | ||||
-rw-r--r-- | doc/neptune-ui.qdocconf | 21 | ||||
-rw-r--r-- | doc/src/images/infotainment-cluster-apps.png | bin | 0 -> 529763 bytes | |||
-rw-r--r-- | doc/src/images/infotainment-cluster-settings.png | bin | 0 -> 657485 bytes | |||
-rw-r--r-- | doc/src/images/infotainment-cluster.png | bin | 0 -> 532748 bytes | |||
-rw-r--r-- | doc/src/images/instrument-cluster.png | bin | 0 -> 134589 bytes | |||
-rw-r--r-- | doc/src/neptuneui-index.qdoc | 152 |
9 files changed, 230 insertions, 0 deletions
diff --git a/doc/doc.pri b/doc/doc.pri new file mode 100644 index 0000000..aa3c762 --- /dev/null +++ b/doc/doc.pri @@ -0,0 +1,15 @@ +isEmpty(VERSION): VERSION=1.0.0 +build_online_docs: { + QMAKE_DOCS_TARGETDIR = html + QMAKE_DOCS = $$PWD/neptune-ui-online.qdocconf +} else { + QMAKE_DOCS = $$PWD/neptune-ui.qdocconf +} + +CONFIG += prepare_docs +load(qt_docs_targets) + +OTHER_FILES += \ + $$PWD/*.qdocconf \ + $$PWD/src/*.qdoc \ + $$PWD/src/images/*.png diff --git a/doc/neptune-ui-online.qdocconf b/doc/neptune-ui-online.qdocconf new file mode 100644 index 0000000..6720923 --- /dev/null +++ b/doc/neptune-ui-online.qdocconf @@ -0,0 +1,20 @@ + +HTML.footer = \ + " </div>\n" \ + " <p class=\"copy-notice\">\n" \ + " <acronym title=\"Copyright\">©</acronym> 2016 Pelagicore AG.\n" \ + " Documentation contributions included herein are the copyrights of\n" \ + " their respective owners. " \ + " The documentation provided herein is licensed under the terms of the" \ + " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation" \ + " License version 1.3</a> as published by the Free Software Foundation. " \ + " Qt and respective logos are trademarks of The Qt Company Ltd. " \ + " in Finland and/or other countries worldwide. All other trademarks are property\n" \ + " of their respective owners. </p>\n" + +include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf) + +# Add an .html file with sidebar content, used in the online style +HTML.stylesheets += style/qt5-sidebar.html + +include(neptune-ui-project.qdocconf) diff --git a/doc/neptune-ui-project.qdocconf b/doc/neptune-ui-project.qdocconf new file mode 100644 index 0000000..d370d5f --- /dev/null +++ b/doc/neptune-ui-project.qdocconf @@ -0,0 +1,22 @@ +project = NeptuneUI +version = $QT_VERSION + +sourcedirs += src + +imagedirs += src/images + +depends += qtquick qtqml applicationmanager + +qhp.projects = NeptuneUI +qhp.NeptuneUI.file = neptuneui.qhp +qhp.NeptuneUI.namespace = io.qt.neptuneui.$QT_VERSION_TAG +qhp.NeptuneUI.virtualFolder = neptuneui +qhp.NeptuneUI.indexTitle = Neptune UI +qhp.NeptuneUI.indexRoot = + +qhp.NeptuneUI.filterAttributes = NeptuneUI $QT_VERSION +qhp.NeptuneUI.customFilters.NeptuneUI.name = Neptune UI $QT_VERSION +qhp.NeptuneUI.customFilters.NeptuneUI.filterAttributes = NeptuneUI $QT_VERSION + +navigation.landingpage = "Neptune UI" +navigation.homepage = "Qt Automotive Suite" diff --git a/doc/neptune-ui.qdocconf b/doc/neptune-ui.qdocconf new file mode 100644 index 0000000..6f81a65 --- /dev/null +++ b/doc/neptune-ui.qdocconf @@ -0,0 +1,21 @@ +include($QT_INSTALL_DOCS/global/qt-module-defaults-offline.qdocconf) +include(neptune-ui-project.qdocconf) + +HTML.footer = \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + " </div>\n" \ + "</div>\n" \ + "<div class=\"footer\">\n" \ + " <p>\n" \ + " <acronym title=\"Copyright\">©</acronym> 2016 Pelagicore AG.\n" \ + " Documentation contributions included herein are the copyrights of\n" \ + " their respective owners.<br>" \ + " The documentation provided herein is licensed under the terms of the" \ + " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation" \ + " License version 1.3</a> as published by the Free Software Foundation.<br>" \ + " Qt and respective logos are trademarks of The Qt Company Ltd. " \ + " in Finland and/or other countries worldwide. All other trademarks are property\n" \ + " of their respective owners. </p>\n" \ + "</div>\n" diff --git a/doc/src/images/infotainment-cluster-apps.png b/doc/src/images/infotainment-cluster-apps.png Binary files differnew file mode 100644 index 0000000..0d2e9c4 --- /dev/null +++ b/doc/src/images/infotainment-cluster-apps.png diff --git a/doc/src/images/infotainment-cluster-settings.png b/doc/src/images/infotainment-cluster-settings.png Binary files differnew file mode 100644 index 0000000..2efc44f --- /dev/null +++ b/doc/src/images/infotainment-cluster-settings.png diff --git a/doc/src/images/infotainment-cluster.png b/doc/src/images/infotainment-cluster.png Binary files differnew file mode 100644 index 0000000..e9e43ee --- /dev/null +++ b/doc/src/images/infotainment-cluster.png diff --git a/doc/src/images/instrument-cluster.png b/doc/src/images/instrument-cluster.png Binary files differnew file mode 100644 index 0000000..3fbc601 --- /dev/null +++ b/doc/src/images/instrument-cluster.png diff --git a/doc/src/neptuneui-index.qdoc b/doc/src/neptuneui-index.qdoc new file mode 100644 index 0000000..eae5718 --- /dev/null +++ b/doc/src/neptuneui-index.qdoc @@ -0,0 +1,152 @@ +/**************************************************************************** +** +** Copyright (C) 2016 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Automotive Suite. +** +** $QT_BEGIN_LICENSE:FDL-QTAS$ +** Commercial License Usage +** Licensees holding valid commercial Qt Automotive Suite 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$ +** +****************************************************************************/ + +/*! + \page neptuneui-index.html + \title Neptune UI + \brief A reference HMI for the OEMs to test the Qt Automotive Suite. + + Neptune provides IVI (infotainment) system, which depends on + \l {Qt Application Manager} for the necessary infrastructure. It comes with + support for a Head Unit and Cluster. The system also provides the + infrastructure to develop, maintain, and deploy applications. + + \borderedimage instrument-cluster.png + \caption QtQuick-based digital instrument cluster + + \borderedimage infotainment-cluster.png + \caption QtQuick-based Head Unit + + The Head Unit interface provides additional pages that are accessible + by swiping from right-to-left: + + \borderedimage infotainment-cluster-apps.png + \caption Available applications on the Head Unit + + \borderedimage infotainment-cluster-settings.png + \caption \uicontrol Settings that provides more control on the HEAD Unit and + Cluster. The \uicontrol{APP STORE} tab in the \uicontrol Settings page lets + you install/uninstall applications from the Head Unit. + + \section1 How to Run the UI? + + Typically the UI works out-of-the-box using Qt Creator, provided you choose + to run your application on Qt Automotive emulator, iMX6, or DriveCX targets. + You can also run the Neptune UI on a Linux desktop. To run it without Qt IVI, + use the following command from the cloned \e neptune-ui repository: + + \badcode + appman -r -c $AM_CONFIG_FILE -c am-config.yaml -I dummyimport + \endcode + + Where, \c appman is a utility provided by Qt Automotive Suite, + \c AM_CONFIG_FILE points to the Application Manager's \c config.yaml, and + \c dummyimport provides the necessary data, which is usually provided by + Qt IVI. + + \note The \c {-I dummyimport} part is not required if Qt IVI is installed. + + \section2 UI Configuration + + The UI configuration is split into several \c yaml files for the ease of + maintenance. The following is a list of those configuration files and their + purpose: + + \list + \li \c config.yaml - Defines the generic parameters such as the + install location for applications installed from the APP STORE, database, + and so on. + + \li \c am-config.yaml - Defines the Head Unit and Cluster-specific + configuration such as the built-in applications, their runtime (native or + qml), import paths, UI-specific configuration such as full-screen mode, + main QML file (if runtime is qml), and so on. + + \li \c info.yaml - Defines application-specific configuration such as the + main QML file, its imports, and so on. + \endlist + + The following is a sample \c am-config.yaml: + + \badcode + formatVersion: 1 + formatType: am-configuration + + # basic AM functionality - the built-in apps are in 'apps'. + + applications: + builtinAppsManifestDir: "apps" + + # QML apps will be able to import from modules... + + runtimes: + qml: + importPaths: [ "imports/shared" ] + + # ... as well as the SystemUI + + ui: + fullscreen: yes + mainQml: "Main.qml" + importPaths: [ "imports/shared", "imports/system" ] + additionalConfiguration: + appStoreServerUrl: 'http://chaos.pelagicore.net:8080' + styleConfig: "auto" + showCluster: yes + windowIcon: "imports/shared/assets/icons/active/apps@96.png" + + # development setup: no security + + flags: + noSecurity: yes + noUiWatchdog: yes + \endcode + + These options are also configurable from the command line as a + parameter to the \e appman utility. + + \note You must regenerate the yocto image for the desired target after + changing these \c yaml files. + + \section1 Related Information + + \list + \li \l{Manifest Definition}{Application manifest file} + \li \l{Main Configuration}{appman options} + \li \l{Building eLinux Image} + \li \l{README} + \endlist +*/ + +/*! + \externalpage http://code.qt.io/cgit/qt-apps/neptune-ui.git/tree/README.md + \title README +*/ +/*! + \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-custom-embedded-linux-image.html + \title Building eLinux Image +*/ |