Add a user guide

This will document user interaction with the keyboard,
as currently we only have technical documentation. Things such as
gestures are documented here.

Change-Id: I6c7144b37d0dd087c8a28b36af2e4f2dfe0e06ba
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>

2 files changed, 85 insertions, 0 deletions

diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 39ba7bd3..12c4f6b7 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -43,6 +43,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 Audio feedback.
         \li Cross-platform functionality.
     \endlist
@@ -81,6 +82,7 @@
     \li \l {Building Qt Virtual Keyboard}
     \li \l {Deployment Guide}
     \li \l {Technical Guide}
+    \li \l {User Guide}
     \endlist
 
     \section1 C++ Classes
diff --git a/src/virtualkeyboard/doc/src/user-guide.qdoc b/src/virtualkeyboard/doc/src/user-guide.qdoc
new file mode 100644
index 00000000..3fdee9ea
--- /dev/null
+++ b/src/virtualkeyboard/doc/src/user-guide.qdoc
@@ -0,0 +1,83 @@
+/******************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd
+** All rights reserved.
+** For any questions to The Qt Company, please use contact form at http://qt.io
+**
+** This file is part of the Qt Virtual Keyboard module.
+**
+** Licensees holding valid commercial license for Qt may use this file in
+** accordance with the Qt License Agreement provided with the Software
+** or, alternatively, in accordance with the terms contained in a written
+** agreement between you and The Qt Company.
+**
+** If you have questions regarding the use of this file, please use
+** contact form at http://qt.io
+**
+******************************************************************************/
+
+/*!
+
+\page user-guide.html
+\contentspage {User Guide} {Contents}
+
+\title User Guide
+
+\section1 Overview
+
+This document explains how to interact with the virtual keyboard.
+
+\section1 Opening the Keyboard
+
+Once \l {Deployment Guide}{properly installed}, the virtual keyboard can be
+opened by clicking on a text input field.
+
+\section1 Language
+
+The language can be changed by pressing the language key, which is illustrated
+with a "globe" icon:
+
+\image language-icon.png
+
+The current language is displayed on the space bar key.
+
+\section1 Handwriting
+
+The handwriting mode can be activated by pressing the handwriting key:
+
+\image handwriting-mode-icon.png
+
+\section2 Gestures
+
+\table
+\header
+    \li Gesture
+    \li Lipi Toolkit
+    \li T9 Write
+\row
+    \li Backspace
+    \li \image gesture-single-left.png
+    \li \image gesture-single-left.png
+\row
+    \li Space
+    \li \image gesture-single-right.png
+    \li \image gesture-single-right.png
+\row
+    \li Enter
+    \li Gesture not available
+    \li \image gesture-single-down-left.png
+\row
+    \li Reset word
+    \li \image gesture-double-left.png
+    \li Gesture not available
+\row
+    \li Toggle input mode
+    \li \image gesture-single-up.png
+    \li Gesture not available
+\row
+    \li Toggle text case
+    \li \image gesture-double-up.png
+    \li Gesture not available
+\endtable
+
+*/