Initial commit5.10

Add overview documentation for Qt for Automation

Change-Id: I6520a271305af66cf0feb8a31afae13d253488a9
Sanity-Review: Qt Sanity Bot <qt_sanitybot@qt-project.org>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>

10 files changed, 453 insertions, 0 deletions

diff --git a/.qmake.conf b/.qmake.conf
new file mode 100644
index 0000000..138038d
--- /dev/null
+++ b/.qmake.conf
@@ -0,0 +1,3 @@
+load(qt_build_config)
+
+MODULE_VERSION = 5.10.0
diff --git a/doc.pro b/doc.pro
new file mode 100644
index 0000000..65d9262
--- /dev/null
+++ b/doc.pro
@@ -0,0 +1,2 @@
+TEMPLATE = subdirs
+SUBDIRS = src
diff --git a/src/external-resources.qdoc b/src/external-resources.qdoc
new file mode 100644
index 0000000..9b95236
--- /dev/null
+++ b/src/external-resources.qdoc
@@ -0,0 +1,123 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of Qt for Automation.
+**
+** $QT_BEGIN_LICENSE:GPL$
+** 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 General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 or (at your option) any later version
+** approved by the KDE Free Qt Foundation. The licenses are as published by
+** the Free Software Foundation and appearing in the file LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \externalpage https://doc.qt.io/QtQuickCompiler
+    \title Qt Quick Compiler
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/
+    \title Qt Creator
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtWebBrowser/
+    \title Qt Web Browser
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-visual-editor.html
+    \title Qt Creator: Developing Qt Quick Applications
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-analyze-mode.html
+    \title Qt Creator: Analyzing Code
+*/
+
+/*!
+    \externalpage https://doc.qt.io/qtcreator/creator-debugging.html
+    \title Qt Creator: Debugging
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtForDeviceCreation/index.html
+    \title Qt for Device Creation
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtForDeviceCreation/b2qt-installation-guides.html
+    \title Qt for Device Creation: Installation Guides
+*/
+
+/*!
+    \externalpage https://www.qt.io/download-open-source/#section-2
+    \title Qt Online Installer Download
+*/
+
+/*!
+    \externalpage https://www.qt.io/download/
+    \title Download Qt
+*/
+
+/*!
+    \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-supported-platforms.html#supported-development-hosts
+    \title Supported Development Hosts
+*/
+
+/*!
+    \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-requirements-x11.html
+    \title Requirements for Linux/X11
+*/
+
+/*!
+    \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-requirements-windows.html
+    \title Requirements for Windows
+*/
+
+/*!
+    \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-building-and-running.html#building-and-running-an-example
+    \title Building and Running an Example
+*/
+
+/*!
+    \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-about-b2qt.html
+    \title About Boot to Qt
+*/
+
+/*!
+    \externalpage http://doc.qt.io/QtForDeviceCreation/qtee-custom-embedded-linux-image.html#configuring-qt-creator
+    \title Configuring Qt Creator
+*/
+
+/*!
+    \externalpage http://blog.qt.io/blog/2017/07/07/qt-webgl-streaming-merged/
+    \title Qt Quick WebGL Streaming
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtMQTT/index.html
+    \title Qt MQTT
+*/
+
+/*!
+    \externalpage https://doc.qt.io/QtKNX/index.html
+    \title Qt KNX
+*/
diff --git a/src/online/qtforautomation.qdocconf b/src/online/qtforautomation.qdocconf
new file mode 100644
index 0000000..b596b73
--- /dev/null
+++ b/src/online/qtforautomation.qdocconf
@@ -0,0 +1,11 @@
+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
+
+# override defaults for Qt module documentation
+HTML.nosubdirs = "false"
+HTML.outputsubdir = "qtforautomation"
+
+include(../qtforautomation-project.qdocconf)
+
diff --git a/src/online/style/qt5-sidebar.html b/src/online/style/qt5-sidebar.html
new file mode 100644
index 0000000..48fe272
--- /dev/null
+++ b/src/online/style/qt5-sidebar.html
@@ -0,0 +1,15 @@
+<div class="sectionlist normallist">
+    <div class="heading">
+        <a name="reference"></a>
+        <h2 id="reference">Qt for Automation</h2>
+    </div>
+    <div class="indexboxcont indexboxbar">
+      <ul>
+        <li><a href="qtautomation-overview.html">Overview</a></li>
+        <li><a href="qtautomation-install.html">Install Instructions</a></li>
+        <li><a href="/QtMQTT/index.html">Qt MQTT</a></li>
+        <li><a href="/QtKNX/index.html">Qt KNX</a></li>
+        <li><a href="/QtForDeviceCreation/index.html">Qt for Device Creation</a></li>
+      </ul>
+    </div>
+</div>
diff --git a/src/qtforautomation-project.qdocconf b/src/qtforautomation-project.qdocconf
new file mode 100644
index 0000000..0420dd6
--- /dev/null
+++ b/src/qtforautomation-project.qdocconf
@@ -0,0 +1,36 @@
+project                       = QtForAutomation
+description                   = Qt for Automation Documentation
+version                       = $QT_VERSION
+url                           = https://doc.qt.io/QtForAutomation
+
+sourcedirs                   += .
+
+qhp.projects                  = QtForAutomation
+
+qhp.QtForAutomation.file                = qtforautomation.qhp
+qhp.QtForAutomation.namespace           = org.qt-project.qtforautomation.$QT_VERSION_TAG
+qhp.QtForAutomation.virtualFolder       = qtforautomation
+qhp.QtForAutomation.indexTitle          = Qt for Automation
+qhp.QtForAutomation.indexRoot           =
+
+qhp.QtForAutomation.filterAttributes    = qtforautomation $QT_VERSION qtrefdoc
+qhp.QtForAutomation.customFilters.Qt.name = QtAutomation $QT_VERSION
+qhp.QtForAutomation.customFilters.Qt.filterAttributes = qtforautomation $QT_VERSION
+
+qhp.QtForAutomation.subprojects                   = manual
+qhp.QtForAutomation.subprojects.manual.title      = Qt for Automation
+qhp.QtForAutomation.subprojects.manual.indexTitle = Qt for Automation TOC
+qhp.QtForAutomation.subprojects.manual.selectors  = manual
+
+tagfile                       = qtforautomation.tags
+
+# check dependencies, linking using external URLs for now
+depends += qtmqtt qtknx
+
+# dependencies to Qt docs
+depends += qtdoc qtquickcontrols2 qtwebengine qtvirtualkeyboard qtquick qtserialbus
+
+buildversion = "Qt for Automation $QT_VER"
+
+macro.QTA = "Qt for Automation"
+navigation.homepage = "Qt for Automation"
diff --git a/src/qtforautomation-toc.qdoc b/src/qtforautomation-toc.qdoc
new file mode 100644
index 0000000..556739a
--- /dev/null
+++ b/src/qtforautomation-toc.qdoc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of Qt for Automation.
+**
+** $QT_BEGIN_LICENSE:GPL$
+** 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 General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 or (at your option) any later version
+** approved by the KDE Free Qt Foundation. The licenses are as published by
+** the Free Software Foundation and appearing in the file LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \contentspage {Qt for Automation}
+    \page qtautomation-toc.html
+    \title Qt for Automation TOC
+
+    \omit
+    This file is used only for generating the TOC for the help file to be
+    displayed in the Qt Creator Help mode Contents view.
+    \endomit
+
+    \list
+        \li \l {Qt for Automation Overview}{Overview}
+        \li \l {Installing Qt for Automation}{Install Instructions}
+        \li \l {Related Information}
+    \endlist
+*/
diff --git a/src/qtforautomation.qdoc b/src/qtforautomation.qdoc
new file mode 100644
index 0000000..d0b6e56
--- /dev/null
+++ b/src/qtforautomation.qdoc
@@ -0,0 +1,202 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of Qt for Automation.
+**
+** $QT_BEGIN_LICENSE:GPL$
+** 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 General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 or (at your option) any later version
+** approved by the KDE Free Qt Foundation. The licenses are as published by
+** the Free Software Foundation and appearing in the file LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page qtautomation-index.html
+    \title Qt for Automation
+    \nextpage {Qt for Automation Overview}{Overview}
+
+    \e {\QTA} is a collection of software components, tools, and services
+    targeted for the development of  automation systems: Connected
+    \e {'Internet of Things'} edge devices, backend services, and their
+    supporting applications.
+
+    \QTA builds on top of Qt for Application Development and
+    \l {Qt for Device Creation}, providing the same great integrated
+    development environment, libraries and tools for creating embedded devices
+    and applications on all platforms supported by Qt. Additional modules are
+    provided for machine-to-machine communication, building automation, and
+    remote access of desktop applications.
+
+    To help with potential issues faced during development, industry-specific
+    consultancy services are part of the \QTA offering.
+
+    \section1 Contents
+
+    \list
+        \li \l {Qt for Automation Overview}{Overview}
+        \li \l {Installing Qt for Automation}{Install Instructions}
+        \li \l {Related Information}
+    \endlist
+
+    \section1 Related Information
+
+    \list
+        \li \l {Qt MQTT}
+        \li \l {Qt KNX}
+        \li \l {Qt for Device Creation}
+    \endlist
+*/
+
+/*!
+    \page qtautomation-overview.html
+    \title Qt for Automation Overview
+    \previouspage {Qt for Automation}
+    \nextpage {Installing Qt for Automation}
+
+    \section1 Components
+
+    \QTA includes several components built on Qt and the \l {Qt Creator}
+    integrated development environment.
+
+    \section2 Qt
+
+    Cross-platform \l {http://www.qt.io/}{Qt} development libraries
+    and core tools are developed through an open-source collaboration model.
+    Qt is a full development framework designed to streamline the creation of
+    applications and user interfaces for desktop, embedded, and mobile
+    platforms.
+
+    The Qt libraries provide high-level APIs for a large variety of both
+    non-GUI and GUI related functionality. For UI creation, Qt provides a
+    number of approaches: traditional C++, declarative UI design with
+    \l {Qt Quick} or HTML5/hybrid user interfaces with the \l {Qt WebEngine}
+    module.
+
+    For overview about Qt libraries see the \l {Qt reference documentation}.
+
+    Qt modules that are especially useful for automation:
+
+    \list
+        \li \l {Qt Virtual Keyboard} - complete virtual keyboard solution with
+            word-prediction and multiple languages supported.
+        \li \l {Qt Quick Controls 2} - provides a set of controls for building
+            complete user interfaces in Qt Quick.
+        \li \l {Qt Quick Compiler} - enables compiling .qml source files into
+            application binaries, improving load times and security for code
+            assets.
+        \li \l {Qt WebEngine} - provides a web browser engine based on the
+            \l {https://www.chromium.org}{Chromium} project.
+        \li \l {Qt Serial Bus} - access various industrial serial buses and
+               protocols such as ModBus.
+        \li \l {Qt Quick WebGL Streaming} Plugin - allows running Qt Quick
+               applications remotely in a WebGL-enabled browser.
+    \endlist
+
+    \section2 Development Environment
+
+    The development environment in \QTA is built around \l {Qt Creator}.
+
+    \list
+      \li \l {Qt Creator: Developing Qt Quick Applications}
+      \li \l {Qt Creator: Analyzing Code}
+      \li \l {Qt Creator: Debugging}
+    \endlist
+
+    \section2 Qt Configuration Tool
+
+    The \l {Qt Configuration Tool} allows browsing and selecting features that
+    are included in the Qt build configuration, making it easy to optimize Qt
+    libraries for minimal footprint, performance and start-up time.
+
+    \section2 Automation APIs
+
+    \QTA comes with additional modules for machine-to-machine communication
+    and building automation:
+
+    \b {Qt MQTT}
+
+    \l {http://mqtt.org}{MQTT} (Message Queue Telemetry Transport) is an extremely
+    lightweight machine-to-machine (M2M) connectivity protocol utilizing the
+    publish-and-subscribe paradigm, and is suitable for carrying telemetry data
+    with minimal overhead.
+
+    \list
+      \li \l {Qt MQTT}
+    \endlist
+
+    \b {Qt KNX}
+
+    \l {http://www.knx.org}{KNX} is a stardard for controlling home and building
+    management equipment, such as lighting, blinds and shutters, security systems,
+    heating and energy management, and more.
+
+    \list
+      \li \l {Qt KNX}
+    \endlist
+
+    \section1 Deployment
+
+    Device deployment can be done directly from the Qt Creator IDE to a
+    device connected via USB or local area network, or to an emulator
+    running the same full software stack as the devices.
+
+    As with any Qt application, the same project can be deployed to
+    desktop or mobile targets as well.
+*/
+
+/*!
+    \page qtautomation-install.html
+    \title Installing Qt for Automation
+    \previouspage {Qt for Automation Overview}{Overview}
+
+    \QTA is available under a commercial license, or alternatively under the
+    \e {GNU General Public License version 3}. \l{Download Qt} page helps to
+    find the license that suits your need. The license is associated with a
+    Qt Account, which is required to install the product.
+
+    \section1 Prerequisites
+
+    \QTA is based on the \l {Qt for Device Creation} offering so the
+    prerequisites are the same for both. For more information about how to install and
+    configure these prerequisites on your development host, see
+    \l {Requirements for Linux/X11} and \l {Requirements for Windows}.
+
+    \section1 Installing
+
+    \list 1
+     \li Download the \l{Qt Online Installer Download}{Qt online installer}.
+
+     \note On Linux, the installer needs executable permissions before you
+           can run it.
+
+     \li Run the installer and select \uicontrol Next to get to the Qt account
+         section.
+
+     \li Enter your Qt account credentials and select \uicontrol Next to run
+         a license check against the Qt account.
+
+     \li Select \uicontrol Next again to choose an install path.
+
+     \li Select \uicontrol Next to see available packages to install from.
+
+     \li Select \b{Qt for Automation} and at least one \b Qt version
+     from the list, and follow the instructions to complete the installation.
+    \endlist
+*/
diff --git a/src/qtforautomation.qdocconf b/src/qtforautomation.qdocconf
new file mode 100644
index 0000000..506c8dd
--- /dev/null
+++ b/src/qtforautomation.qdocconf
@@ -0,0 +1,2 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults-offline.qdocconf)
+include(qtforautomation-project.qdocconf)
diff --git a/src/src.pro b/src/src.pro
new file mode 100644
index 0000000..16390b0
--- /dev/null
+++ b/src/src.pro
@@ -0,0 +1,14 @@
+TEMPLATE = aux
+
+build_online_docs {
+    QMAKE_DOCS = $$PWD/online/qtforautomation.qdocconf
+} else {
+    QMAKE_DOCS = $$PWD/qtforautomation.qdocconf
+}
+
+DISTFILES += \
+    $$PWD/*.qdocconf \
+    $$PWD/online/*.qdocconf \
+    $$PWD/online/style/qt5-sidebar.html \
+    $$PWD/src/*.qdoc
+