diff options
author | Andreas Eliasson <andreas.eliasson@qt.io> | 2023-01-25 11:02:36 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2023-01-26 16:36:36 +0000 |
commit | ee264e4c3a13544d203036c1930bc11fb791916a (patch) | |
tree | 2b539439fab11641e7fd2ab60fad9950b164fe79 | |
parent | 602179aa1d16634561d0f7a2ffd637b10913de56 (diff) |
Doc: Revise Qt Virtual Keyboard module landing page
* Add CMake and qmake sections.
* Make the technical guide an overview; It's not really a guide.
* Move general info from the landing page to the overview page.
* Move sections to make the landing page consistent with other modules.
* Make minor punctuation fixes.
Fixes: QTBUG-105592
Change-Id: I7a1358c93841f63702c88ab796da14b8799ce0d7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
(cherry picked from commit 79adc3cc5395e33309123c7665d9891e4799aba8)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r-- | src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc | 64 | ||||
-rw-r--r-- | src/virtualkeyboard/doc/src/technical-guide.qdoc | 46 | ||||
-rw-r--r-- | src/virtualkeyboard/doc/src/user-guide.qdoc | 2 |
3 files changed, 61 insertions, 51 deletions
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc index 6ae1d75c..037acf44 100644 --- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc +++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc @@ -13,54 +13,34 @@ integrate 3rd party input engines. The input methods can be implemented in C++ or QML. - \section1 Features + \section1 Using the Module - Key features of the Qt Virtual Keyboard include: + \include {module-use.qdocinc} {using the c++ api} - \list - \li Customizable keyboard layouts and styles with dynamic switching. - \li Predictive text input with word selection. - \li Character preview and alternative character view. - \li Automatic capitalization and space insertion. - \li Scalability to different resolutions. - \li Support for different character sets (Latin, Simplified/Traditional Chinese, - Hindi, Japanese, Arabic, Hebrew, Korean, and others). - \li Support for most common input \l {Supported Languages}{languages}, - with possibility to easily extend the language support. - \li Left-to-right and right-to-left input. - \li Hardware key support for 2-way and 5-way navigation. - \li \l {Handwriting Recognition}{Handwriting support}, with gestures for fullscreen input. - \li Audio feedback. - \li Cross-platform functionality. - \li Supports both \l {Integration Method}{Qt Quick and Qt Widgets applications}. - \endlist - - \section1 Supported Languages - - \include layouts.qdocinc layout-list + \section2 Building with CMake - \section1 Third-party Plugins + \include {module-use.qdocinc} {building with cmake} {VirtualKeyboard} - The Qt Virtual Keyboard supports third-party plugins from the following vendors: - \list - \li \l {Cerence XT9 Advanced Input}{Cerence XT9} advanced input. - \li \l {Handwriting Recognition#Cerence Handwriting}{Cerence Handwriting} text input. - \li \l {Handwriting Recognition#MyScript}{MyScript} Text handwriting recognition - \endlist + \section2 Building with qmake - \l {Building Qt Virtual Keyboard} describes how to integrate these plugins - into the Qt Virtual Keyboard. + \include {module-use.qdocinc} {building_with_qmake} {virtualkeyboard} - \section1 Guides + \section1 Articles and Guides \list \li \l {Building Qt Virtual Keyboard} \li \l {Deployment Guide} - \li \l {Technical Guide} + \li \l {Qt Virtual Keyboard Overview} \li \l {User Guide} \endlist - \section1 API Reference + \section1 Examples + + \list + \li \l{Qt Virtual Keyboard Examples} + \endlist + + \section1 Reference \list \li \l{Qt Virtual Keyboard API for Applications} @@ -69,20 +49,16 @@ \li \l{Qt Virtual Keyboard C++ Classes} \endlist - \section1 Examples - - \list - \li \l{Qt Virtual Keyboard Examples} - \endlist \section1 Licenses and Attributions - Qt Virtual Keyboard is available under commercial licenses from \l{The Qt Company}. - In addition, it is available under the \l{GNU General Public License, version 3}. + Qt Virtual Keyboard is available under commercial licenses from + \l{The Qt Company}. In addition, it is available under the + \l{GNU General Public License, version 3}. See \l{Qt Licensing} for further details. - Furthermore Qt Virtual Keyboard potentially contains third party - modules under following permissive licenses: + Furthermore, Qt Virtual Keyboard potentially contains third party + modules under the following permissive licenses: \generatelist{groupsbymodule attributions-qtvirtualkeyboard} */ diff --git a/src/virtualkeyboard/doc/src/technical-guide.qdoc b/src/virtualkeyboard/doc/src/technical-guide.qdoc index b048af6e..37909a17 100644 --- a/src/virtualkeyboard/doc/src/technical-guide.qdoc +++ b/src/virtualkeyboard/doc/src/technical-guide.qdoc @@ -3,17 +3,53 @@ /*! -\page technical-guide.html +\page qtvirtualkeyboard-overview.html +\title Qt Virtual Keyboard Overview +\brief Describes the technical details of the Qt Virtual Keyboard module. -\title Technical Guide +This document provides a technical overview of the Qt Virtual Keyboard plugin. -\section1 Overview +\section1 Features -This document provides a technical overview of the Qt Virtual Keyboard plugin. +Key features of the Qt Virtual Keyboard include: + +\list + \li Customizable keyboard layouts and styles with dynamic switching. + \li Predictive text input with word selection. + \li Character preview and alternative character view. + \li Automatic capitalization and space insertion. + \li Scalability to different resolutions. + \li Support for different character sets (Latin, Simplified/Traditional Chinese, + Hindi, Japanese, Arabic, Hebrew, Korean, and others). + \li Support for most common input \l {Supported Languages}{languages}, + with possibility to easily extend the language support. + \li Left-to-right and right-to-left input. + \li Hardware key support for 2-way and 5-way navigation. + \li \l {Handwriting Recognition}{Handwriting support}, with gestures for fullscreen input. + \li Audio feedback. + \li Cross-platform functionality. + \li Supports both \l {Integration Method}{Qt Quick and Qt Widgets applications}. +\endlist + +\section1 Supported Languages + +\include layouts.qdocinc layout-list + +\section1 Third-party Plugins + +The Qt Virtual Keyboard supports third-party plugins from the following vendors: +\list + \li \l {Cerence XT9 Advanced Input}{Cerence XT9} advanced input. + \li \l {Handwriting Recognition#Cerence Handwriting}{Cerence Handwriting} text input. + \li \l {Handwriting Recognition#MyScript}{MyScript} Text handwriting recognition +\endlist + +\l {Building Qt Virtual Keyboard} describes how to integrate these plugins +into the Qt Virtual Keyboard. \section1 Basic Concepts -The Qt Virtual Keyboard project is a Qt input context plugin which implements +The Qt Virtual Keyboard project is a Qt input context plugin that implements QPlatformInputContextPlugin and QPlatformInputContext interfaces. These interfaces allow the plugin to be used as a platform input context plugin in Qt applications. diff --git a/src/virtualkeyboard/doc/src/user-guide.qdoc b/src/virtualkeyboard/doc/src/user-guide.qdoc index 3e7c93f9..e1352d14 100644 --- a/src/virtualkeyboard/doc/src/user-guide.qdoc +++ b/src/virtualkeyboard/doc/src/user-guide.qdoc @@ -7,8 +7,6 @@ \title User Guide -\section1 Overview - This document explains how to interact with the virtual keyboard. \section1 Opening the Keyboard |