diff options
author | Yuntaek RIM <yuntaek.rim@myscript.com> | 2021-08-23 18:21:29 +0900 |
---|---|---|
committer | Jarkko Koivikko <jarkko.koivikko@code-q.fi> | 2021-09-03 07:50:11 +0000 |
commit | db71019c2dec128d43b2525010dfad77409bc306 (patch) | |
tree | 48f615014f9de7766dbb0cd00f804e4490b9945a /src/virtualkeyboard/doc/src | |
parent | 28a36e896ad48f17c341409cf25d99147492e34a (diff) |
[MyScript] Add CMake script for building MyScript HWR plugin
Pick-to: 6.2
Change-Id: Ia1857d967f7dbe99ae8b95c25fc2630551943682
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Yuntaek Rim <yuntaek.rim@myscript.com>
Diffstat (limited to 'src/virtualkeyboard/doc/src')
-rw-r--r-- | src/virtualkeyboard/doc/src/build.qdoc | 53 | ||||
-rw-r--r-- | src/virtualkeyboard/doc/src/handwriting.qdoc | 5 |
2 files changed, 43 insertions, 15 deletions
diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc index 2b636cfd..a765ba47 100644 --- a/src/virtualkeyboard/doc/src/build.qdoc +++ b/src/virtualkeyboard/doc/src/build.qdoc @@ -112,13 +112,12 @@ keyboard features. if no other languages are specified. \row \li \e -vkb-handwriting - \li [yes|no|cerence-hwr] + \li \e [no|myscript-hwr|cerence-hwr] \li Enables or disabled handwriting input - \li This flag enables handwriting input. By default, the first engine - available at build time is used. The engines are chosen in the - following order: \c cerence-hwr. To force handwriting - input using to use a specific engine, specify the engine to be used; - for example, \c {-vkb-handwriting cerence-hwr}. + \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. \row \li \e [-no]-vkb-arrow-keynavigation \li @@ -246,6 +245,22 @@ qmake $SRCDIR -- [options] \li \e n/a \li Enables bundling of XT9 resources \li This option bundles the XT9 resources in the plugin binary. +\row + \li \e -vkb-myscript-sdk + \li \e path/to/myscript/sdk + \li Configures the MyScript Text SDK location and enables the MyScript Handwriting integration. + \li The MyScript Text SDK (zip) which is unpacked to \e src/plugins/myscript/sdk, can be + picked up automatically by the build scripts. However, the SDK can be placed in different + location. In that case, the location must be passed to the build script using the \c -vkb-myscript-sdk + command line parameter. +\row + \li \e -vkb-myscript-arch + \li \e [x86|x64|armv7hf|armv7|arm64] + \li Configures the target CPU architecture + \li The MyScript Text SDK offers shared (dynamic) libraries for different CPU architectures + - \e [x86|x64|armv7hf|armv7|arm64] for Linux and \e [x86|x64] for Windows. It can automatically configured. + However, a user also can specify the target CPU architecture using the \c -vkb-myscript-arch + command line parameter. \endtable \section2 Building Documentation @@ -462,20 +477,27 @@ is no need for an explicit gesture. \section3 Language coverage of MyScript Text SDK -MyScript Superimposed supports 70 languages. +MyScript Superimposed supports 72 languages. \section3 MyScript Text SDK Packages Installation The MyScript delivery team can provide you the packages with various \c .zip archives. To access all the code, tools, and resources needed for building your own handwriting application, \b {extract all the packages in the same destination folder} as -\c src/plugins/myscript/3rdparty/myscript. +\c src/plugins/myscript/sdk, where the CMake can pick it up automatically. + +Alternatively, you can extract the packages to any other directory. +In this case, the location of the SDK must be passed to the \e configure script. + +\badcode +configure ... -vkb-myscript-sdk /path/to/myscript/sdk +\endcode The file hierarchy should look like below: \badcode -3rdparty -└── myscript +myscript +└── sdk ├─── conf ├─── doc ├─── edk @@ -485,6 +507,8 @@ The file hierarchy should look like below: │ │ └─── *.so │ ├─── lin-armv7 │ │ └─── *.so + │ ├─── lin-armv7hf + │ │ └─── *.so │ ├─── lin-x64 │ │ └─── *.so │ ├─── lin-x86 @@ -515,6 +539,8 @@ The file hierarchy should look like below: │ │ └─── *.so │ ├─── lin-armv7 │ │ └─── *.so + │ ├─── lin-armv7hf + │ │ └─── *.so │ ├─── lin-x64 │ │ └─── *.so │ ├─── lin-x86 @@ -566,15 +592,16 @@ security measure that uniquely identifies you as a legitimate customer of MyScri technologies. The certificate helps MyScript trace customers' identify and the products that have been purchased. -The certificate is delivered in the /c [your_login].vo.zip package. When you unzip +The certificate is delivered in the \c {[your_login].vo.zip package}. When you unzip this package, the certificate is automatically put in the appropriate location. This ensure that the certificate is instantly working within the services and code samples that you have been provided with. \section3 How to build Qt Virtual Keyboard with MyScript Text SDK -The MyScript Text SDK is included in the build of Qt Virtual Keyboard by either -adding \c CONFIG+=handwriting or \c CONFIG+=myscript to the qmake command line. +The MyScript integration code is automatically activated when the MyScript Text SDK is detected. + +Language resources for MyScript Text SDK are installed in the \e [qtbase]/qtvirtualkeyboard/myscript directory. \section2 Static builds diff --git a/src/virtualkeyboard/doc/src/handwriting.qdoc b/src/virtualkeyboard/doc/src/handwriting.qdoc index 328971df..1cf84582 100644 --- a/src/virtualkeyboard/doc/src/handwriting.qdoc +++ b/src/virtualkeyboard/doc/src/handwriting.qdoc @@ -65,7 +65,7 @@ Cerence Handwriting works with all languages supported by the virtual keyboard. \l {https://www.myscript.com}{MyScript} SDK is a commercial handwriting recognition engine. -MyScript SDK supports 71 handwriting recognition languages: +MyScript SDK supports 72 handwriting recognition languages: \table \row @@ -87,12 +87,13 @@ MyScript SDK supports 71 handwriting recognition languages: \li Croatian \li Czech \li Danish + \li Dutch, Flemish \endlist \li \list - \li Dutch, Flemish \li Dutch \li English - Canada \li English - Philippines + \li English - South Africa \li English - United Kingdom \li English - United States \li Estonian |