Maliit/Documentation

Maliit - Input Methods for MeeGo
Overview · Development · Installing · Roadmap

Contents 1 Feature documentation 2 API documentation 3 Technical documentation 4 Blogposts et.c. 5 FAQ 5.1 Unanswered questions 6 Documentation working area 6.1 Important cases 6.2 Documentation status

Feature documentation

See Maliit#Features

API documentation

• Old MeeGo 1.1 Input method engine and framework - note that there has been changes in API since then
• Documentation webpage for the latest git version and Meego version has been requested. See bug 14382 and bug 14994
• Generate from source code with doxygen.

Some of the documentation is slighly outdated, and we are working to improve this. Use our communication channels if there are any issues.

Technical documentation

• Widget relocation in MTF
• More to come!

Blogposts et.c.

• Michael Hasselmann: MeeGo Input Methods for your desktop
• Michael Hasselmann: Customizing the Meego Keyboard
• Jon Nordby: Introducing; Maliit on-screen keyboard in Gnome 3
• Michael Hasselmann: Painting Strategy in MeeGo's Virtual Keyboard
• Michael Hasselmann: Writing QML-based input methods for Maliit
• Jan Arne Petersen: Maliit packages for Fedora

FAQ

Frequently asked questions.

1. How to write my own input method?
For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: MInputMethodPlugin, MAbstractInputMethod and MAbstractInputMethodHost.

Since version 0.20.9-1 of the framework (May 2011), the MInputMethodQuick API allows one to also easily write input methods using QML. See the MeegoKeyboardQuick code for an example. As of May 2011 this interface is not yet feature complete with the C++ one. Contributions welcomed.

Unanswered questions

Please add any questions you may have here.

Documentation working area

Here is the working area to keep track of the status of and work on the documentation.

• Goal: Every aspect of Maliit is well-documented, and the documentation easily accessible.
• Primary focus is on consumers of Maliit: Third-party developers and integrators

Important cases

• Developing a new input method plugin
• Developing a new engine plugin
• Integrating Maliit in a product
• Adding support for additional application toolkits

Documentation status

Item	Status	Description
wiki.meego.com/Maliit	90%	Our public webpage/wiki page, starting point for all information about our project. In pretty good shape.
apidocs.meego.com/git-tip	10%	Our docs should be shown here. Bug 14382
apidocs.meego.com/1.2	10%	Our docs should be shown here. Bug 14994
Framework
Overall architecture	30%	Some docs exists in framework source tree, but is very outdated
Input Method/framework settings system	0%
Input Method Plugin<->Framework interaction	0%	What the interaction concepts are (both user and technical), and what is done on each side to support this
Input Method Framework Window handling	0%	Passthrough window, Self-compositing, plugin pixmap drawing, rotation animation. Maybe covered by above item?
Input Method Plugin API	40%	Tutorial is outdated. Should provide a well-commented plugin example/skeleton that is built as part of our build (to avoid bitrot)
Input Context DBus API	0%
Toolkit integration concepts	20%	Key concepts like pre-edit injection, and widget relocation should be documented. Purpose: make it easy for others to improve toolkit integration, and to bring new people up to date. Widget relocation is documented.
Toolkit integration/support status	10%	Implicitly all keyboard features/IM are available for MTF. No documentation about plain Qt, QML, Clutter or Gtk+
Engine interfaces	?	Correction/prediction/suggestion/handwriting, both plugin side and IM side
Feedback framework	?
Meego Keyboard
Meego Keyboard theming (CSS)	100%	Docs in keyboard source tree.
Meego Keyboard layouts	100%	Docs in keyboard source tree.
Meego Keyboard features	100%	Documented on wiki page.

Maliit - Input Methods for MeeGo
Overview · Development · Installing · Roadmap