Structure Qt Virtual Keyboard

Présentation

Ce document décrit comment compiler le plugin « Qt Virtual Keyboard ».

Le projet est divisé en sous-projets suivants :

Options de configuration

Le tableau ci-dessous répertorie les options de premier niveau permettant de configurer les fonctionnalités du clavier virtuel. Ces options sont transmises à l'outil configure.

Intégration de Hunspell

Par défaut, HunspellInputMethod ne sera pas disponible tant que la bibliothèque Hunspell et les en-têtes de développement n’auront pas été détectés. Pour les cibles Linux/X11, la bibliothèque Hunspell peut être fournie en installant le paquet libhunspell-dev. Il est également possible de cloner le dépôt Git de Hunspell dans le répertoire src/plugins/hunspell/3rdparty/hunspell. Les sources sont automatiquement détectées par qmake et le projet sera configuré pour utiliser la version locale de Hunspell. Si les sources Hunspell sont utilisées, les fichiers de dictionnaire doivent également être copiés dans le répertoire src/plugins/hunspell/3rdparty/hunspell/data.

Voici un exemple de structure de répertoires après la mise en place des sources Hunspell et des fichiers de dictionnaire :

3rdparty
└── hunspell
    ├── data
    │   ├── en_GB.aff
    │   └── en_GB.dic
    ├── hunspell <-- Hunspell git repository
    └── CMakeLists.txt

Intégration de l’écriture manuscrite Cerence

L'intégration de l'écriture manuscrite Cerence prend en charge les moteurs alphabétiques et CJK (chinois, japonais, coréen). Les deux moteurs sont intégrés via T9WriteInputMethod. La méthode de saisie est initialisée avec un seul moteur à la fois. La sélection du moteur s'effectue automatiquement en fonction des paramètres régionaux de saisie actuels.

Compatibilité avec Cerence Handwriting

Qt Virtual Keyboard est compatible avec Cerence Handwriting v8.7 ou une version ultérieure.

Préparatifs pour la compilation de Cerence Handwriting

Le contenu du SDK doit être décompressé à l'aide du script unpack.py situé dans le répertoire cerence. Cela garantit une structure de répertoires correcte permettant à CMake de trouver le contenu.

$ cd src/plugins/cerence/
$ python unpack.py filename.zip

Le contenu sera ainsi décompressé dans le répertoire src/plugins/cerence/sdk, où CMake pourra le détecter automatiquement.

Vous pouvez également décompresser le contenu dans n’importe quel autre répertoire en ajoutant un paramètre supplémentaire à la ligne de commande. Dans ce cas, l’emplacement du SDK doit être indiqué au script configure.

configure ... -vkb-cerence-sdk /path/to/cerence/sdk

Structure du SDK Cerence

Le contenu extrait du SDK se présente comme suit :

sdk
├───t9write
│   ├───api
│   ├───data
│   │   ├───arabic
│   │   ├───hebrew
│   │   └───thai
│   └───lib
│       ├───linux
│       │   ├───arm64
│       │   │   ├───shared
│       │   │   │   ├───alphabetic
│       │   │   │   └───cjk
│       │   │   └───static
│       │   │       ├───alphabetic
│       │   │       └───cjk
│       │   └───x86_64
│       │       ├───shared
│       │       │   ├───alphabetic
│       │       │   └───cjk
│       │       └───static
│       │           ├───alphabetic
│       │           └───cjk
│       └───win32
│           ├───x86
│           │   ├───shared
│           │   │   ├───alphabetic
│           │   │   └───cjk
│           │   └───static
│           │       ├───alphabetic
│           │       └───cjk
│           └───x86_64
│               ├───shared
│               │   ├───alphabetic
│               │   └───cjk
│               └───static
│                   ├───alphabetic
│                   └───cjk
└───xt9
    ├───api
    ├───data
    └───lib
        ├───linux
        │   ├───arm64
        │   │   ├───shared
        │   │   └───static
        │   └───x86_64
        │       ├───shared
        │       └───static
        └───win32
            ├───x86
            │   ├───shared
            │   └───static
            └───x86_64
                ├───shared
                └───static

Le contenu de chaque répertoire est le suivant :

Le code d'intégration de Cerence Handwriting et XT9 est automatiquement activé lorsque le SDK Cerence est détecté.

Toutes les autres extensions doivent être supprimées du répertoire [qtbase]/plugins/virtualkeyboard avant de compiler les extensions Cerence afin d’éviter tout conflit de comportement lors de l’exécution. Les extensions Cerence ne nécessitent aucun autre plugin de clavier virtuel pour fonctionner.

Les bases de données d'écriture manuscrite et les bases de données linguistiques pour XT9 sont installées dans le répertoire [qtbase]/qtvirtualkeyboard/cerence. Il existe par ailleurs deux autres emplacements possibles pour ces fichiers :

• Un emplacement d’exécution personnalisé défini par des variables d’environnement
• L’option de ligne de commande -vkb-bundle-cerence pour intégrer les ressources dans les binaires du plugin

Intégration du SDK MyScript Text

MyScript Text est conçu pour développer des applications permettant la reconnaissance de texte manuscrit. MyScript Text prend en charge la reconnaissance de caractères isolés, de l’écriture cursive, de l’écriture en lettres majuscules et de l’écriture superposée. La reconnaissance de l’écriture superposée de MyScript est intégrée à Qt Virtual Keyboard. Elle permet de reconnaître des lettres, des mots ou des parties de mots écrits les uns au-dessus des autres, sans séparation explicite entre les fragments consécutifs. Elle est capable de fonctionner sur des appareils disposant de ressources mémoire et de CPU limitées.

Styles d’écriture manuscrite pris en charge par le SDK MyScript Text

L’utilisateur final peut écrire un fragment de mot par-dessus un autre, ou un caractère par-dessus un autre, comme illustré ci-dessous. Un espace entre deux mots écrits est automatiquement ajouté, ce qui évite d’avoir à effectuer un geste explicite.

Langues prises en charge par le SDK MyScript Text

MyScript Superimposed prend en charge 72 langues.

Installation des packages du SDK MyScript Text

L’équipe de livraison de MyScript peut vous fournir les paquets sous forme d’archives .zip. Pour accéder à l’ensemble du code, des outils et des ressources nécessaires à la création de votre propre application de reconnaissance d’écriture manuscrite, extrayez tous les paquets dans le même dossier de destination que src/plugins/myscript/sdk, où CMake pourra les détecter automatiquement.

Vous pouvez également extraire les paquets dans n’importe quel autre répertoire. Dans ce cas, l’emplacement du SDK doit être indiqué au script de configuration.

configure ... -vkb-myscript-sdk /path/to/myscript/sdk

La structure des fichiers doit ressembler à celle ci-dessous :

myscript
└── sdk
    ├─── conf
    ├─── doc
    ├─── edk
    ├─── engine
    │   └─── bin
    │       ├─── lin-arm64
    │       │   └─── *.so
    │       ├─── lin-armv7
    │       │   └─── *.so
    │       ├─── lin-armv7hf
    │       │   └─── *.so
    │       ├─── lin-x64
    │       │   └─── *.so
    │       ├─── lin-x86
    │       │   └─── *.so
    │       ├─── win-x64
    │       │   └─── *.dll
    │       ├─── win-x86
    │       │   └─── *.dll
    │       (etc.)
    ├─── rdk
    ├─── resources
    │   ├─── ar
    │   │   └─── *.res
    │   ├─── en_GB
    │   │   └─── *.res
    │   ├─── ja_JP
    │   │   └─── *.res
    │   ├─── ko_KR
    │   │   └─── *.res
    │   ├─── zh_CN
    │   │   └─── *.res
    │   (etc.)
    ├─── tools
    └─── voim
        ├─── api
        ├─── bin
        │   ├─── lin-arm64
        │   │   └─── *.so
        │   ├─── lin-armv7
        │   │   └─── *.so
        │   ├─── lin-armv7hf
        │   │   └─── *.so
        │   ├─── lin-x64
        │   │   └─── *.so
        │   ├─── lin-x86
        │   │   └─── *.so
        │   ├─── win-x64
        │   │   └─── *.dll
        │   ├─── win-x86
        │   │   └─── *.dll
        │   (etc.)
        └─── conf

Voici la description du contenu de chaque répertoire :

Configuration du certificat du SDK MyScript Text

Un certificat valide est obligatoire pour utiliser le SDK MyScript Text. Il s'agit d'une mesure de sécurité qui vous identifie de manière unique en tant que client légitime des technologies MyScript. Le certificat permet à MyScript de retracer l'identité des clients et les produits qui ont été achetés.

Le certificat est fourni dans le fichier « [your_login].vo.zip package ». Lorsque vous décompressez ce fichier, le certificat est automatiquement placé à l’emplacement approprié. Cela garantit que le certificat fonctionne immédiatement avec les services et les exemples de code qui vous ont été fournis.

Comment compiler « Qt Virtual Keyboard » avec le SDK MyScript Text

Le code d’intégration MyScript est automatiquement activé lorsque le SDK MyScript Text est détecté.

Les ressources linguistiques du SDK MyScript Text sont installées dans le répertoire [qtbase]/qtvirtualkeyboard/myscript.

Compilations statiques

Le Qt Virtual Keyboard peut être compilé et lié de manière statique à l’application. Cela implique que Qt soit également compilé de manière statique (à l’aide de l’option -static dans la ligne de commande configure).