aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2018-06-04 11:57:37 +0200
committerMitch Curtis <mitch.curtis@qt.io>2018-07-02 06:17:18 +0000
commitf71bd1863a1f29f4f19d5be05bc0f422e5cbffb0 (patch)
tree6a1bbe2750a2479eaca3a9f0b495fcba62ed8cd6
parenta4c615c51afb16b3177ee5517e8373657d2ddfc7 (diff)
Improve Handwriting Recognition documentation
- Provide an overview of handwriting recognition support - Add a GIF - List languages supported by each engine Task-number: QTBUG-68624 Change-Id: I26af8b8984fabd74855d067bd9818f6db0136cec Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--src/virtualkeyboard/doc/images/handwriting.gifbin0 -> 66802 bytes
-rw-r--r--src/virtualkeyboard/doc/src/handwriting.qdoc94
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc2
-rw-r--r--src/virtualkeyboard/doc/src/user-guide.qdoc1
4 files changed, 96 insertions, 1 deletions
diff --git a/src/virtualkeyboard/doc/images/handwriting.gif b/src/virtualkeyboard/doc/images/handwriting.gif
new file mode 100644
index 00000000..459150b8
--- /dev/null
+++ b/src/virtualkeyboard/doc/images/handwriting.gif
Binary files differ
diff --git a/src/virtualkeyboard/doc/src/handwriting.qdoc b/src/virtualkeyboard/doc/src/handwriting.qdoc
new file mode 100644
index 00000000..f9408f02
--- /dev/null
+++ b/src/virtualkeyboard/doc/src/handwriting.qdoc
@@ -0,0 +1,94 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $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$
+**
+****************************************************************************/
+
+/*!
+
+\page handwriting.html
+\contentspage {Handwriting Recognition} {Contents}
+
+\title Handwriting Recognition
+
+Qt Virtual Keyboard supports handwriting recognition through open source and
+commercially-licensed engines.
+
+\image handwriting.gif
+
+There are two modes in which to write: using the more compact handwriting panel
+(as shown above), or \l {HandwritingInputPanel}{fullscreen}.
+
+For instructions on how to activate and use the handwriting input mode, see the
+\l {user-guide-handwriting}{User Guide}.
+
+For information about building Qt Virtual Keyboard with a particular
+handwriting engine, see \l {Configuration Options}.
+
+\section1 Lipi Toolkit
+
+\l {http://lipitk.sourceforge.net/lipi-toolkit.htm}{Lipi Toolkit} is an
+open source handwriting recognition engine.
+
+Lipi Toolkit only supports handwriting written in the English language.
+
+\section1 T9 Write
+
+\l {https://www.nuance.com/mobile/mobile-solutions/text-input-solutions/t9-write.html}{T9 Write}
+is a commercial handwriting recognition engine.
+
+T9 Write supports handwriting written in the following languages:
+
+\list
+\li Arabic
+\li Bulgarian
+\li Croatian
+\li Czech
+\li Danish
+\li Dutch
+\li English
+\li Estonian
+\li Finnish
+\li French
+\li German
+\li Greek
+\li Hebrew
+\li Hungarian
+\li Italian
+\li Japanese
+\li Korean
+\li Norwegian
+\li Persian/Farsi
+\li Polish
+\li Portugese
+\li Romanian
+\li Russian
+\li Serbian
+\li Simplified Chinese
+\li Spanish
+\li Swedish
+\li Traditional Chinese
+\endlist
+
+*/
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 10a98354..35eb60b1 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -53,7 +53,7 @@
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 Handwriting support, with gestures for fullscreen input.
+ \li \l {Handwriting Recognition}{Handwriting support}, with gestures for fullscreen input.
\li Audio feedback.
\li Cross-platform functionality.
\endlist
diff --git a/src/virtualkeyboard/doc/src/user-guide.qdoc b/src/virtualkeyboard/doc/src/user-guide.qdoc
index fab465cd..b784178b 100644
--- a/src/virtualkeyboard/doc/src/user-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/user-guide.qdoc
@@ -52,6 +52,7 @@ with a "globe" icon:
The current language is displayed on the space bar key.
\section1 Handwriting
+\target user-guide-handwriting
The handwriting mode can be activated by pressing the handwriting key: