aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/doc/src
diff options
context:
space:
mode:
authorJarkko Koivikko <jarkko.koivikko@code-q.fi>2023-04-24 12:39:40 +0300
committerJarkko Koivikko <jarkko.koivikko@code-q.fi>2023-05-09 14:30:48 +0300
commit310650815c98ab5d87a36e7fb6805cdfc45df2dc (patch)
treeb5be9d1d2b3e18b199739397602be00f06f2694a /src/virtualkeyboard/doc/src
parentb59f7eeb0cfc4ed89522d24476d942e96c00d606 (diff)
Add example handwriting plugin
This can be used for demonstration and development purposes. The plugin is enabled by defining -DINPUT_vkb_handwriting:STRING=example-hwr In the cmake command line. Task-number: QTBUG-113024 Change-Id: I05fd8dab88ea4f0d040c39836f55dcd52bc3e332 Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Diffstat (limited to 'src/virtualkeyboard/doc/src')
-rw-r--r--src/virtualkeyboard/doc/src/build.qdoc6
-rw-r--r--src/virtualkeyboard/doc/src/handwriting.qdoc6
2 files changed, 10 insertions, 2 deletions
diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc
index 51957cfd..999a4c35 100644
--- a/src/virtualkeyboard/doc/src/build.qdoc
+++ b/src/virtualkeyboard/doc/src/build.qdoc
@@ -73,12 +73,14 @@ keyboard features. These options are passed to the \e configure tool.
if no other languages are specified.
\row
\li \e -vkb-handwriting
- \li \e [no|myscript-hwr|cerence-hwr]
+ \li \e [no|example-hwr|myscript-hwr|cerence-hwr]
\li Enables or disabled handwriting input
\li This flag enables handwriting input. By default, the engine is
automatically activated if it is located in the proper plugins folder
even without using of this option. But, in case MyScript and Cerence SDK
- co-exist, one of [no|myscript-hwr|cerence-hwr] must be configured.
+ co-exist, one of [no|myscript-hwr|cerence-hwr] must be configured. The
+ \l {Example Handwriting}{example-hwr} option needs to be explicitly
+ activated. This can be done for development and testing purposes.
\row
\li \e [-no]-vkb-arrow-keynavigation
\li
diff --git a/src/virtualkeyboard/doc/src/handwriting.qdoc b/src/virtualkeyboard/doc/src/handwriting.qdoc
index 0f6192c9..d205ca06 100644
--- a/src/virtualkeyboard/doc/src/handwriting.qdoc
+++ b/src/virtualkeyboard/doc/src/handwriting.qdoc
@@ -21,6 +21,12 @@ For instructions on how to activate and use the handwriting input mode, see the
For information about building Qt Virtual Keyboard with a particular
handwriting engine, see \l {Configuration Options}.
+\section1 Example Handwriting
+
+The Example Handwriting Plugin offers a simulated handwriting recognition experience
+producing random characters regardless of what is written. It serves as a tool for
+examining handwriting layouts and as a foundation for developing new plugins.
+
\section1 Cerence Handwriting
\l {https://cerence.com}{Cerence Handwriting}