MeeGo wiki - User contributions [en]

Maliit/Documentation/Examples

2011-07-13T17:27:08Z

Mikhas:

Moved to [http://wiki.maliit.org/Documentation/Examples upstream wiki].

Maliit/Documentation/Examples

2011-07-13T17:26:56Z

Mikhas: moved to upstream wiki

Moved to [http://wiki.maliit.org/Documentation/Examples upstream wiki].b

Maliit

2011-07-07T12:51:30Z

Mikhas: /* Screenshots, photos and videos */

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== Social Media ==

'''Facebook: ''' [http://www.facebook.com/home.php?sk=group_127020324047804 Maliit group]

'''Twitter/Identica: ''' Use the #maliit hashtag

== Upcoming events ==
* August 6th-12th - Desktop Summit Berlin. Workshops & BoFs planned

== News ==
* 24.06.2011 - MeeGo Freeday presentation/workshop in Berlin. [http://meetmeego.org/2011/06/15/meego-freeday-24-06-2011/ Announcement] (in german), [[Media:Maliit-input-methods-for-meego.pdf|Slides]], [http://www.youtube.com/watch?v=kmR0J699oGA Video]
* 21.06.2011 - Nokia's N9 announced, with input methods powered by Maliit [http://www.youtube.com/watch?v=JOI5g129rtM Video]
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 24.05.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Screenshots, photos and videos ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]
* [http://www.youtube.com/watch?v=JOI5g129rtM N9 and Swype integration (video)]
* [http://www.youtube.com/watch?v=X8or54Z72gw Terminal with virtual keyboard integration on N950 (video)]
<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE's Plasma Desktop
Image:Maliit-meego-ce-n900-landscape.jpg | MeeGo N900CE (landscape)
Image:Maliit-meego-ce-n900-portrait.jpg | MeeGo N900CE (portrait)
Image:Maliit_Nokia_N9.jpg | Nokia N9
</gallery>

{{MaliitNavigationBar}}

Maliit/Development

2011-07-07T06:50:08Z

Mikhas: fixing links in MeeGo packaging, adding OBS project link, too

{{MaliitNavigationBar}}

== Repositories ==
* [https://gitorious.org/maliit/maliit-framework Maliit framework]:<pre>git clone git@gitorious.org:maliit/maliit-framework.git</pre>
* [https://gitorious.org/maliit/maliit-plugins Maliit plugins (virtual keyboards etc.)]:<pre>git clone git@gitorious.org:maliit/maliit-plugins.git</pre>

For MeeGo 1.2, use the following branches instead of master:
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/commits/meego-1.2
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/commits/meego-1.2

== Releases ==
* Howtos: [[Maliit/Making_a_Release|Making a release]], [[Maliit/Writing_Release_Notes|Writing release notes]]
* 0.80.0 - Brave New World: [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Release notes], [http://gitorious.org/maliit/maliit-framework/archive-tarball/0.80.0 framework tarball], [http://gitorious.org/maliit/maliit-plugins/archive-tarball/0.80.0 plugins tarball].

== Contributing ==
We use gitorious to handle patches and reviews. Clone our repository, and create a merge request with the commits you want merged. As a general rule, do not send patches to the mailinglist.

If you are implementing a new feature, it is smart to discuss it on the mailing list first.
If you have a fix for a bug that affects Meego, file a bugreport at bugs.meego.com and link your merge request there.

We currently do not have a concrete policy for giving out commit rights to the mainline repositories. However, it is our intention that contributors
that builds up a track record with the project are able to get commit rights.
Do note that also those who have commit rights have to submit and get their merge requests reviewed prior to changes going in.

== Open bug reports ==

{{#bugzilla:
|columns=id,status,to,severity,version,summary
|group=priority
|grouporder=asc
|component=Virtual keyboard
|product=OS Base
|status=UNCONFIRMED,NEW,NEEDINFO,ASSIGNED,WAITING FOR UPSTREAM,REOPENED
|lastcomment=1
}}

== Bugreports, patches and merge requests in other projects ==
This area is for keeping track of things that concern Maliit or is done by the Maliit team in related projects.

* [https://bugzilla.novell.com/show_bug.cgi?id=701523 Maliit openSUSE OBS project request]
* [https://bugs.freedesktop.org/show_bug.cgi?id=38563 Maliit project request on freedesktop.org]

== Meego packaging ==
* [http://build.meego.com/project/show?project=devel%3Ainput-methods devel:input-methods on MeeGo OBS]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=maliit&repo_standard=1&repo_weekly=1&arch_armv8el=1&arch_i586=1&project=Trunk&defaults=0 Status in Trunk]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv8el=1&arch_i586=1&project=MeeGo%3A1.2%3Aoss&defaults=0 Status in 1.2]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv7el=1&arch_i586=1&lastbuild=1&project=MeeGo%3A1.1%3ACore&defaults=0 Status in 1.1]

== QA Reports ==

Latest inputmethod packages QA reports using recent Meego images can be found at the [http://qa-reports.meego.com/1.2/Handset/Basic%20Feature%20Testing/N900 QA Basic Feature Testing] section of [http://qa-reports.meego.com http://qa-reports.meego.com].

== Maliit google searches ==
References to Maliit from other places on the web. Search used: maliit keyboard OR "input method" OR meego -ang

* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&client=firefox-a&hs=HdI&tbo=1&rls=org.mozilla%3Aen-US%3Aunofficial&num=10&lr=&ft=i&cr=&safe=images&tbs=#q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=kfI&tbo=1&rls=org.mozilla:en-US:unofficial&prmd=ivns&ei=1XDeTf-CEtHIswb5sbXLBQ&start=0&sa=N&bav=on.2,or.r_gc.r_pw.&fp=bf4289d263b569cc&biw=1302&bih=937 Webpages]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=f0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmdo=1&tbm=dsc&prmd=ivns&source=lnms&ei=6HDeTeOzMYXs-gaQuYXvCQ&sa=X&oi=mode_link&ct=mode&ved=0CBcQ_AU Discussions]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=mbl&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=9&ved=0CCAQ_AUoCA&prmdo=1 Realtime]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=blg&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=8&ved=0CB8Q_AUoBw&prmdo=1 Blogs]

{{MaliitNavigationBar}}

Maliit/Documentation

2011-07-06T13:26:55Z

Mikhas: meego-im-uiserver => maliit-server

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

== FAQ ==
Frequently asked questions.

'''1. How to write my own input method?''' 
The recommended way to get started is to use the Maliit Plugin SDK and follow the [[Maliit/Documentation#Plugin_development_Quickstart|quickstart documentation]].

For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/minputmethodplugin.h MInputMethodPlugin],
[https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethod.h MAbstractInputMethod] and [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethodhost.h 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 [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick 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.

* Does Maliit work with non-compositing Window Managers?
* Which window managers are currently supported?

== Plugin Development Quickstart ==
How to get started developing plugins. This documentation is mainly for framework version 0.20.11-1 and newer. The C++ plugin API is compatible with all 0.20.x versions, and the QML interface is available from 0.20.9-1. Meego 1.2 has version 0.20.6. To develop there, one can install packages from Trunk/1.3.

Note that this is not intended to be 100% copy'n'paste step-by-step instructions. You may need to use common sense.

* [[Maliit/Installing|Install Maliit]] for your development environment
* [http://www.jonnor.com/files/maliit/maliit-plugin-sdk-0.1.0.tar.gz Download] the Maliit Plugin SDK
* Extract the examples
# In your favorite terminal:
tar -xf maliit-plugin-sdk-*.tar.gz
cd maliit-plugin-sdk/examples/
* Compile them
qmake
make
make install
* Have a look around. In the examples directory you will find a QML based plugin and a C++ based plugin.
# QML plugin code
ls plugins/quick/
# C++ plugin code
ls plugins/standard
* Try out one of the examples
# First enable both of the example input methods, along with the meego keyboard
gconftool-2 -s /meegotouch/inputmethods/onscreen/enabled -t list --list-type strings \
[libmeego-keyboard.so,en_gb.xml,libmeego-keyboard-quick.so,,libhelloworldplugin.so,,libexampleplugin.so,ExamplePluginSubview1]
# To activate the QML example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libhelloworldplugin.so,]
# To instead activate the C++ example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libexampleplugin.so,ExamplePluginSubview1]

# To test, start the Maliit server and a application with a Maliit inputcontext loaded
# Note: More documentation on this can be found on the Installing page
maliit-server > server.log &
QT_IM_MODULE=Maliit apps/plainqt/plainqt

# Tap/double tap on a text field to activate the input method
# You should now be able to see an input method which allows you to click to input "Hello World"

* Try changing the plugin code a bit, and reinstall and restart the Maliit server to try again.
# Do changes (start simple, maybe by changing the "Hello World" string to something else)

# Rebuild and reinstall plugins
make && make install
# Remember to restart the Maliit server for it to pick up the changed plugin

If you have any issues, first try to solve the problem by reading the instructions again, and maybe other documentation. If you cannot solve it, ask for help through one of our communication channels.

There are also several open source input plugins that one look at. See for instance
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard Meego Keyboard]
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick Meego Keyboard Quick]
* [https://github.com/foolegg/cute-input-method/tree/n9 cute-input-method]

== Feature documentation ==
See [[Maliit#Features]]

== API documentation ==
* [http://apidocs.meego.com/1.1/platform/html/meego-im-framework/main.html 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 [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382] and [https://bugs.meego.com/show_bug.cgi?id=14994 bug 14994]
* Generate from source code with doxygen.

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

== Technical documentation ==
* [[Media:Technical-overview-widget-reloc.pdf|Widget relocation in MTF]]
* More to come!

== Blogposts et.c. ==
(most recent first)
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/20/brave-new-world/ Brave New World]
* Michael Hasselmannn: [http://taschenorakel.de/michael/2011/06/10/decent-examples-last/ Decent examples, at last!]
* Jon Nordby: [http://www.jonnor.com/2011/06/example-plugins-for-maliit-available/ Example plugins for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/07/maliit-session-meego-spring-conference-2011/ Maliit Session at MeeGo Spring Conference 2011]
* Jan Arne Petersen: [http://blog.jpetersen.org/2011/05/29/maliit-packages-for-fedora/ Maliit packages for Fedora]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
* Jon Nordby: [http://www.jonnor.com/2011/04/introducing-maliit-on-screen-keyboard-in-gnome-3/ Introducing; Maliit on-screen keyboard in Gnome 3]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego Keyboard]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]

== 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 ===
* Creating and adding a new layout file to the keyboard
* Developing a new input method plugin
* Using Maliit in an application
* Integrating Maliit in a product
* Developing a new engine plugin
* Adding support for additional application toolkits

=== Documentation status ===

{|border="1" cellpadding="4" class="wikitable"
|-
! 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. [https://bugs.meego.com/show_bug.cgi?id=14382 Bug 14382]
|-
| apidocs.meego.com/1.2 || 10% || Our docs should be shown here. [https://bugs.meego.com/show_bug.cgi?id=14994 Bug 14994]
|-
| colspan=3 | '''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 || 60% || Example plugins exists, initial plugin SDK published. Need to remove the outdated tutorial from framework docs
|-
| 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 || ? ||
|-
| colspan=3 | '''Plugins'''
|-
| 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. ||
|-
|}

{{MaliitNavigationBar}}

Maliit/Documentation

2011-07-06T13:26:01Z

Mikhas: MInputContext => Maliit

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

== FAQ ==
Frequently asked questions.

'''1. How to write my own input method?''' 
The recommended way to get started is to use the Maliit Plugin SDK and follow the [[Maliit/Documentation#Plugin_development_Quickstart|quickstart documentation]].

For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/minputmethodplugin.h MInputMethodPlugin],
[https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethod.h MAbstractInputMethod] and [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethodhost.h 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 [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick 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.

* Does Maliit work with non-compositing Window Managers?
* Which window managers are currently supported?

== Plugin Development Quickstart ==
How to get started developing plugins. This documentation is mainly for framework version 0.20.11-1 and newer. The C++ plugin API is compatible with all 0.20.x versions, and the QML interface is available from 0.20.9-1. Meego 1.2 has version 0.20.6. To develop there, one can install packages from Trunk/1.3.

Note that this is not intended to be 100% copy'n'paste step-by-step instructions. You may need to use common sense.

* [[Maliit/Installing|Install Maliit]] for your development environment
* [http://www.jonnor.com/files/maliit/maliit-plugin-sdk-0.1.0.tar.gz Download] the Maliit Plugin SDK
* Extract the examples
# In your favorite terminal:
tar -xf maliit-plugin-sdk-*.tar.gz
cd maliit-plugin-sdk/examples/
* Compile them
qmake
make
make install
* Have a look around. In the examples directory you will find a QML based plugin and a C++ based plugin.
# QML plugin code
ls plugins/quick/
# C++ plugin code
ls plugins/standard
* Try out one of the examples
# First enable both of the example input methods, along with the meego keyboard
gconftool-2 -s /meegotouch/inputmethods/onscreen/enabled -t list --list-type strings \
[libmeego-keyboard.so,en_gb.xml,libmeego-keyboard-quick.so,,libhelloworldplugin.so,,libexampleplugin.so,ExamplePluginSubview1]
# To activate the QML example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libhelloworldplugin.so,]
# To instead activate the C++ example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libexampleplugin.so,ExamplePluginSubview1]

# To test, start the Maliit server and a application with a Maliit inputcontext loaded
# Note: More documentation on this can be found on the Installing page
meego-im-uiserver > server.log &
QT_IM_MODULE=Maliit apps/plainqt/plainqt

# Tap/double tap on a text field to activate the input method
# You should now be able to see an input method which allows you to click to input "Hello World"

* Try changing the plugin code a bit, and reinstall and restart the Maliit server to try again.
# Do changes (start simple, maybe by changing the "Hello World" string to something else)

# Rebuild and reinstall plugins
make && make install
# Remember to restart the Maliit server for it to pick up the changed plugin

If you have any issues, first try to solve the problem by reading the instructions again, and maybe other documentation. If you cannot solve it, ask for help through one of our communication channels.

There are also several open source input plugins that one look at. See for instance
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard Meego Keyboard]
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick Meego Keyboard Quick]
* [https://github.com/foolegg/cute-input-method/tree/n9 cute-input-method]

== Feature documentation ==
See [[Maliit#Features]]

== API documentation ==
* [http://apidocs.meego.com/1.1/platform/html/meego-im-framework/main.html 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 [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382] and [https://bugs.meego.com/show_bug.cgi?id=14994 bug 14994]
* Generate from source code with doxygen.

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

== Technical documentation ==
* [[Media:Technical-overview-widget-reloc.pdf|Widget relocation in MTF]]
* More to come!

== Blogposts et.c. ==
(most recent first)
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/20/brave-new-world/ Brave New World]
* Michael Hasselmannn: [http://taschenorakel.de/michael/2011/06/10/decent-examples-last/ Decent examples, at last!]
* Jon Nordby: [http://www.jonnor.com/2011/06/example-plugins-for-maliit-available/ Example plugins for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/07/maliit-session-meego-spring-conference-2011/ Maliit Session at MeeGo Spring Conference 2011]
* Jan Arne Petersen: [http://blog.jpetersen.org/2011/05/29/maliit-packages-for-fedora/ Maliit packages for Fedora]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
* Jon Nordby: [http://www.jonnor.com/2011/04/introducing-maliit-on-screen-keyboard-in-gnome-3/ Introducing; Maliit on-screen keyboard in Gnome 3]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego Keyboard]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]

== 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 ===
* Creating and adding a new layout file to the keyboard
* Developing a new input method plugin
* Using Maliit in an application
* Integrating Maliit in a product
* Developing a new engine plugin
* Adding support for additional application toolkits

=== Documentation status ===

{|border="1" cellpadding="4" class="wikitable"
|-
! 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. [https://bugs.meego.com/show_bug.cgi?id=14382 Bug 14382]
|-
| apidocs.meego.com/1.2 || 10% || Our docs should be shown here. [https://bugs.meego.com/show_bug.cgi?id=14994 Bug 14994]
|-
| colspan=3 | '''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 || 60% || Example plugins exists, initial plugin SDK published. Need to remove the outdated tutorial from framework docs
|-
| 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 || ? ||
|-
| colspan=3 | '''Plugins'''
|-
| 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. ||
|-
|}

{{MaliitNavigationBar}}

Maliit/Writing Release Notes

2011-07-06T12:22:39Z

Mikhas: add sed foo

{{MaliitNavigationBar}}

Use the template below to write release notes.

What's new?
===========

Write about an interesting aspect for this release.

Where can I get it?
===================

* framework:
http://gitorious.org/maliit/maliit-framework/archive-tarball/y.x
* plugins:
http://gitorious.org/maliit/maliit-plugins/archive-tarball/y.x

What is it?
===========

Maliit provides a flexible and cross-platform input method framework,
including a virtual keyboard. It works on all MeeGo user experiences,
and in other GNU/Linux distributions.

Visit http://maliit.org for more information about the project.

Who contributed to this release?
================================

* List authors of this release
$ git log ${previousTag}.. --raw | grep "^Author" | sed -e 's/Author:\s*$[^<]*$\w*<.*/* \1/g' | sort | uniq

What changed in detail?
=======================

CHANGES IN FRAMEWORK SINCE x.y
* List the details from the framework's NEWS file.

CHANGES IN PLUGINS SINCE x.y
* List the details from the plugins' NEWS file.

BUG FIXES
* List all bug fixes of framework and plugins.

{{MaliitNavigationBar}}

Maliit

2011-06-28T21:28:06Z

Mikhas: Fixed incorrect SF date

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== Upcoming events ==
* August 6th-12th - Desktop Summit Berlin. Workshops & BoFs planned

== News ==
* 24.06.2011 - MeeGo Freeday presentation/workshop in Berlin. [http://meetmeego.org/2011/06/15/meego-freeday-24-06-2011/ Announcement] (in german), [[Media:Maliit-input-methods-for-meego.pdf|Slides]], [http://www.youtube.com/watch?v=kmR0J699oGA Video]
* 21.06.2011 - Nokia's N9 announced, with input methods powered by Maliit [http://www.youtube.com/watch?v=JOI5g129rtM Video]
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 24.05.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]
* [http://www.youtube.com/watch?v=JOI5g129rtM N9 and Swype integration (video)]
<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
Image:Maliit-meego-ce-n900-landscape.jpg | MeeGo N900CE (landscape)
Image:Maliit-meego-ce-n900-portrait.jpg | MeeGo N900CE (portrait)
Image:Maliit_Nokia_N9.jpg | Nokia N9
</gallery>

{{MaliitNavigationBar}}

Maliit

2011-06-27T19:38:51Z

Mikhas: adding N9 announcement

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== Upcoming events ==
* August 6th-12th - Desktop Summit Berlin. Workshops & BoFs planned

== News ==
* 24.06.2011 - MeeGo Freeday presentation/workshop in Berlin. [http://meetmeego.org/2011/06/15/meego-freeday-24-06-2011/ Announcement] (in german), [[Media:Maliit-input-methods-for-meego.pdf|Slides]], [http://www.youtube.com/watch?v=kmR0J699oGA Video]
* 21.06.2011 - Nokia's N9 announced, with input methods powered by Maliit [http://www.youtube.com/watch?v=JOI5g129rtM Video]
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]
* [http://www.youtube.com/watch?v=JOI5g129rtM N9 and Swype integration (video)]
<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
Image:Maliit-meego-ce-n900-landscape.jpg | MeeGo N900CE (landscape)
Image:Maliit-meego-ce-n900-portrait.jpg | MeeGo N900CE (portrait)
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

{{MaliitNavigationBar}}

Maliit/Writing Release Notes

2011-06-27T13:30:54Z

Mikhas:

{{MaliitNavigationBar}}

Use the template below to write release notes.

What's new?
===========

Write about an interesting aspect for this release.

Where can I get it?
===================

* framework:
http://gitorious.org/maliit/maliit-framework/archive-tarball/y.x
* plugins:
http://gitorious.org/maliit/maliit-plugins/archive-tarball/y.x

What is it?
===========

Maliit provides a flexible and cross-platform input method framework,
including a virtual keyboard. It works on all MeeGo user experiences,
and in other GNU/Linux distributions.

Visit http://maliit.org for more information about the project.

Who contributed to this release?
================================

* List authors of this release
$ git log ${previousTag}.. --raw | grep "^Author: " | sort | uniq -c

What changed in detail?
=======================

CHANGES IN FRAMEWORK SINCE x.y
* List the details from the framework's NEWS file.

CHANGES IN PLUGINS SINCE x.y
* List the details from the plugins' NEWS file.

BUG FIXES
* List all bug fixes of framework and plugins.

{{MaliitNavigationBar}}

Maliit

2011-06-26T21:09:16Z

Mikhas: adding N900CE screenies

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== Upcoming events ==
* August 6th-12th - Desktop Summit Berlin. Workshops & BoFs planned

== News ==
* 24.06.2011 - MeeGo Freeday workshop in Berlin. [http://meetmeego.org/2011/06/15/meego-freeday-24-06-2011/ Announcement] (in german), [[Media:Maliit-input-methods-for-meego.pdf|slides]]
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]
* [http://www.youtube.com/watch?v=JOI5g129rtM N9 and Swype integration (video)]
<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
Image:Maliit-meego-ce-n900-landscape.jpg | MeeGo N900CE (landscape)
Image:Maliit-meego-ce-n900-portrait.jpg | MeeGo N900CE (portrait)
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

{{MaliitNavigationBar}}

File:Maliit-meego-ce-n900-portrait.jpg

2011-06-26T21:06:17Z

Mikhas: Maliit keyboard in MeeGo CE Summer Release, running on Nokia's N900. Taken by Gabriel Böhme (CC BY-NC-SA 3.0)

Maliit keyboard in MeeGo CE Summer Release, running on Nokia's N900.

Taken by Gabriel Böhme (CC BY-NC-SA 3.0)

File:Maliit-meego-ce-n900-landscape.jpg

2011-06-26T21:05:21Z

Mikhas: Maliit keyboard in MeeGo CE Summer Release, running on Nokia's N900. Taken by Gabriel Böhme (CC BY-NC-SA 3.0)

Maliit keyboard in MeeGo CE Summer Release, running on Nokia's N900.

Taken by Gabriel Böhme (CC BY-NC-SA 3.0)

Maliit

2011-06-26T18:03:00Z

Mikhas: Add slides for MeeGo Freeday workshop

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== Upcoming events ==
* August 6th-12th - Desktop Summit Berlin. Workshops & BoFs planned

== News ==
* 24.06.2011 - MeeGo Freeday workshop in Berlin. [http://meetmeego.org/2011/06/15/meego-freeday-24-06-2011/ Announcement] (in german), [[Media:Maliit-input-methods-for-meego.pdf|slides]]
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]
* [http://www.youtube.com/watch?v=JOI5g129rtM N9 and Swype integration (video)]
* [http://meetmeego.org/wp-content/uploads/2011/06/NokiaN900CE_SR12.jpg N900 Community Edition (Summer Release 2011), portrait mode]
* [http://meetmeego.org/wp-content/uploads/2011/06/NokiaN900CE_SR8.jpg N900 Community Edition (Summer Release 2011), landscape mode]
<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

{{MaliitNavigationBar}}

File:Maliit-input-methods-for-meego.pdf

2011-06-26T17:58:53Z

Mikhas: Slides for MeeGo Freeday workshop in Berlin (24.06.2011).

Slides for MeeGo Freeday workshop in Berlin (24.06.2011).

Maliit

2011-06-25T14:58:28Z

Mikhas: adding N900CE screenies, TODO: upload to wiki under http://creativecommons.org/licenses/by-nc-sa/3.0/us/

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== Upcoming events ==
* August 6th-12th - Desktop Summit Berlin. Workshops & BoFs planned

== News ==
* 24.06.2011 - MeeGo Freeday workshop in Berlin. [http://meetmeego.org/2011/06/15/meego-freeday-24-06-2011/ Announcement] (in german)
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]
* [http://www.youtube.com/watch?v=JOI5g129rtM N9 and Swype integration (video)]
* [http://meetmeego.org/wp-content/uploads/2011/06/NokiaN900CE_SR12.jpg N900 Community Edition (Summer Release 2011), portrait mode]
* [http://meetmeego.org/wp-content/uploads/2011/06/NokiaN900CE_SR8.jpg N900 Community Edition (Summer Release 2011), landscape mode]
<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

{{MaliitNavigationBar}}

Maliit

2011-06-24T20:20:51Z

Mikhas: /* Maliit in action */

Maliit/Making a Release

2011-06-21T00:15:11Z

Mikhas:

{{MaliitNavigationBar}}

1. Update the NEWS file

* git commit message:

Changes: Update NEWS for version y.x

* NEWS template:

y.x
===

CHANGES SINCE x.z
* List changes

BUG FIXES
* Fixes: BMC#12345 ...

2. For framework, bump version numbers in its config.pri
* git commit message:

Changes: Bump version to y.x

* MALIIT_VERSION: package version
* MALIIT_INTERFACE_VERSION: ???
* MALIIT_PLUGINS_INTERFACE_VERSION: plugins version
* MALIIT_PLUGINS_QUICK_INTERFACE_VERSION: plugins version for Qt Quick

3. Create a git tag

$ git tag -s -m "Released version y.x - ${insertWittyReleaseNameHere}" y.x

4. Push to repos (including the newly created tag)

$ git push --tags origin HEAD:master

* Keep in mind that a git tag is tied to a specific commit id. If you rebase your branch, then the commit id's will most likely change, meaning that your git tag will point to an old commit id. You will have to delete the tag and create a new one, in that case.

5. [[Maliit/Writing_Release_Notes|Write the release notes]] and send them to the appropriate mailing lists.

6. Update [[Maliit/Development#Releases| the list of releases]].

{{MaliitNavigationBar}}

Maliit/Documentation

2011-06-21T00:01:19Z

Mikhas: /* Blogposts et.c. */

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

== FAQ ==
Frequently asked questions.

'''1. How to write my own input method?''' 
The recommended way to get started is to use the Maliit Plugin SDK and follow the [[Maliit/Documentation#Plugin_development_Quickstart|quickstart documentation]].

For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/minputmethodplugin.h MInputMethodPlugin],
[https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethod.h MAbstractInputMethod] and [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethodhost.h 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 [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick 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.

* Does Maliit work with non-compositing Window Managers?
* Which window managers are currently supported?

== Plugin Development Quickstart ==
How to get started developing plugins. This documentation is mainly for framework version 0.20.11-1 and newer. The C++ plugin API is compatible with all 0.20.x versions, and the QML interface is available from 0.20.9-1. Meego 1.2 has version 0.20.6. To develop there, one can install packages from Trunk/1.3.

Note that this is not intended to be 100% copy'n'paste step-by-step instructions. You may need to use common sense.

* [[Maliit/Installing|Install Maliit]] for your development environment
* [http://www.jonnor.com/files/maliit/maliit-plugin-sdk-0.1.0.tar.gz Download] the Maliit Plugin SDK
* Extract the examples
# In your favorite terminal:
tar -xf maliit-plugin-sdk-*.tar.gz
cd maliit-plugin-sdk/examples/
* Compile them
qmake
make
make install
* Have a look around. In the examples directory you will find a QML based plugin and a C++ based plugin.
# QML plugin code
ls plugins/quick/
# C++ plugin code
ls plugins/standard
* Try out one of the examples
# First enable both of the example input methods, along with the meego keyboard
gconftool-2 -s /meegotouch/inputmethods/onscreen/enabled -t list --list-type strings \
[libmeego-keyboard.so,en_gb.xml,libmeego-keyboard-quick.so,,libhelloworldplugin.so,,libexampleplugin.so,ExamplePluginSubview1]
# To activate the QML example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libhelloworldplugin.so,]
# To instead activate the C++ example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libexampleplugin.so,ExamplePluginSubview1]

# To test, start the Maliit server and a application with a Maliit inputcontext loaded
# Note: More documentation on this can be found on the Installing page
meego-im-uiserver > server.log &
QT_IM_MODULE=MInputContext apps/plainqt/plainqt

# Tap/double tap on a text field to activate the input method
# You should now be able to see an input method which allows you to click to input "Hello World"

* Try changing the plugin code a bit, and reinstall and restart the Maliit server to try again.
# Do changes (start simple, maybe by changing the "Hello World" string to something else)

# Rebuild and reinstall plugins
make && make install
# Remember to restart the Maliit server for it to pick up the changed plugin

If you have any issues, first try to solve the problem by reading the instructions again, and maybe other documentation. If you cannot solve it, ask for help through one of our communication channels.

There are also several open source input plugins that one look at. See for instance
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard Meego Keyboard]
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick Meego Keyboard Quick]
* [https://github.com/foolegg/cute-input-method/tree/maliit cute-input-method]

== Feature documentation ==
See [[Maliit#Features]]

== API documentation ==
* [http://apidocs.meego.com/1.1/platform/html/meego-im-framework/main.html 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 [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382] and [https://bugs.meego.com/show_bug.cgi?id=14994 bug 14994]
* Generate from source code with doxygen.

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

== Technical documentation ==
* [[Media:Technical-overview-widget-reloc.pdf|Widget relocation in MTF]]
* More to come!

== Blogposts et.c. ==
(most recent first)
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/20/brave-new-world/ Brave New World]
* Michael Hasselmannn: [http://taschenorakel.de/michael/2011/06/10/decent-examples-last/ Decent examples, at last!]
* Jon Nordby: [http://www.jonnor.com/2011/06/example-plugins-for-maliit-available/ Example plugins for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/07/maliit-session-meego-spring-conference-2011/ Maliit Session at MeeGo Spring Conference 2011]
* Jan Arne Petersen: [http://blog.jpetersen.org/2011/05/29/maliit-packages-for-fedora/ Maliit packages for Fedora]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
* Jon Nordby: [http://www.jonnor.com/2011/04/introducing-maliit-on-screen-keyboard-in-gnome-3/ Introducing; Maliit on-screen keyboard in Gnome 3]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego Keyboard]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]

== 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 ===

{|border="1" cellpadding="4" class="wikitable"
|-
! 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. [https://bugs.meego.com/show_bug.cgi?id=14382 Bug 14382]
|-
| apidocs.meego.com/1.2 || 10% || Our docs should be shown here. [https://bugs.meego.com/show_bug.cgi?id=14994 Bug 14994]
|-
| colspan=3 | '''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 || ? ||
|-
| colspan=3 | '''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. ||
|-
|}

{{MaliitNavigationBar}}

Maliit/Development

2011-06-20T23:55:53Z

Mikhas: /* Repositories */

{{MaliitNavigationBar}}

== Repositories ==
* [https://gitorious.org/maliit/maliit-framework Maliit framework]:<pre>git clone git@gitorious.org:maliit/maliit-framework.git</pre>
* [https://gitorious.org/maliit/maliit-engines Maliit engines]:<pre>git clone git@gitorious.org:maliit/maliit-engines.git</pre>
* [https://gitorious.org/maliit/maliit-plugins Maliit plugins (virtual keyboards etc.)]:<pre>git clone git@gitorious.org:maliit/maliit-plugins.git</pre>

For MeeGo 1.2, use the following branches instead of master:
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/commits/meego-1.2
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/commits/meego-1.2

== Releases ==
* Howtos: [[Maliit/Making_a_Release|Making a release]], [[Maliit/Writing_Release_Notes|Writing release notes]]
* 0.80.0 - Brave New World: [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Release notes], [http://gitorious.org/maliit/maliit-framework/archive-tarball/0.80.0 framework tarball], [http://gitorious.org/maliit/maliit-plugins/archive-tarball/0.80.0 plugins tarball].

== Contributing ==
We use gitorious to handle patches and reviews. Clone our repository, and create a merge request with the commits you want merged. As a general rule, do not send patches to the mailinglist.

If you are implementing a new feature, it is smart to discuss it on the mailing list first.
If you have a fix for a bug that affects Meego, file a bugreport at bugs.meego.com and link your merge request there.

We currently do not have a concrete policy for giving out commit rights to the mainline repositories. However, it is our intention that contributors
that builds up a track record with the project are able to get commit rights.
Do note that also those who have commit rights have to submit and get their merge requests reviewed prior to changes going in.

== Open bug reports ==

{{#bugzilla:
|columns=id,status,to,severity,version,summary
|group=priority
|grouporder=asc
|component=Virtual keyboard
|product=OS Base
|status=UNCONFIRMED,NEW,NEEDINFO,ASSIGNED,WAITING FOR UPSTREAM,REOPENED
|lastcomment=1
}}

== Meego packaging ==
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&repo_weekly=1&arch_armv7el=1&arch_armv8el=1&arch_i586=1&project=Trunk&defaults=0 Status in Trunk]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv8el=1&arch_i586=1&project=MeeGo%3A1.2%3Aoss&defaults=0 Status in 1.2]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv7el=1&arch_i586=1&lastbuild=1&project=MeeGo%3A1.1%3ACore&defaults=0 Status in 1.1]

== QA Reports ==

Latest inputmethod packages QA reports using recent Meego images can be found at the [http://qa-reports.meego.com/1.2/Handset/Basic%20Feature%20Testing/N900 QA Basic Feature Testing] section of [http://qa-reports.meego.com http://qa-reports.meego.com].

== Maliit google searches ==
References to Maliit from other places on the web. Search used: maliit keyboard OR "input method" OR meego -ang

* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&client=firefox-a&hs=HdI&tbo=1&rls=org.mozilla%3Aen-US%3Aunofficial&num=10&lr=&ft=i&cr=&safe=images&tbs=#q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=kfI&tbo=1&rls=org.mozilla:en-US:unofficial&prmd=ivns&ei=1XDeTf-CEtHIswb5sbXLBQ&start=0&sa=N&bav=on.2,or.r_gc.r_pw.&fp=bf4289d263b569cc&biw=1302&bih=937 Webpages]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=f0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmdo=1&tbm=dsc&prmd=ivns&source=lnms&ei=6HDeTeOzMYXs-gaQuYXvCQ&sa=X&oi=mode_link&ct=mode&ved=0CBcQ_AU Discussions]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=mbl&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=9&ved=0CCAQ_AUoCA&prmdo=1 Realtime]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=blg&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=8&ved=0CB8Q_AUoBw&prmdo=1 Blogs]

{{MaliitNavigationBar}}

Maliit/Development

2011-06-20T23:48:16Z

Mikhas: /* Repositories */

{{MaliitNavigationBar}}

== Repositories ==
* [https://gitorious.org/maliit/maliit-framework Maliit framework]:<pre>git clone git@gitorious.org:maliit/maliit-framework.git</pre>
* [https://gitorious.org/maliit/maliit-engines Maliit engines]:<pre>git clone git@gitorious.org:maliit/maliit-engines.git</pre>
* [https://gitorious.org/maliit/maliit-plugins Maliit plugins (virtual keyboards etc.)]:<pre>git clone git@gitorious.org:maliit/maliit-plugins.git</pre>

For MeeGo 1.2, use the following branches instead of master:
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/commits/meego-1.2
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/commits/meego-1.2

== Contributing ==
We use gitorious to handle patches and reviews. Clone our repository, and create a merge request with the commits you want merged. As a general rule, do not send patches to the mailinglist.

If you are implementing a new feature, it is smart to discuss it on the mailing list first.
If you have a fix for a bug that affects Meego, file a bugreport at bugs.meego.com and link your merge request there.

We currently do not have a concrete policy for giving out commit rights to the mainline repositories. However, it is our intention that contributors
that builds up a track record with the project are able to get commit rights.
Do note that also those who have commit rights have to submit and get their merge requests reviewed prior to changes going in.

== Open bug reports ==

{{#bugzilla:
|columns=id,status,to,severity,version,summary
|group=priority
|grouporder=asc
|component=Virtual keyboard
|product=OS Base
|status=UNCONFIRMED,NEW,NEEDINFO,ASSIGNED,WAITING FOR UPSTREAM,REOPENED
|lastcomment=1
}}

== Meego packaging ==
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&repo_weekly=1&arch_armv7el=1&arch_armv8el=1&arch_i586=1&project=Trunk&defaults=0 Status in Trunk]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv8el=1&arch_i586=1&project=MeeGo%3A1.2%3Aoss&defaults=0 Status in 1.2]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv7el=1&arch_i586=1&lastbuild=1&project=MeeGo%3A1.1%3ACore&defaults=0 Status in 1.1]

== QA Reports ==

Latest inputmethod packages QA reports using recent Meego images can be found at the [http://qa-reports.meego.com/1.2/Handset/Basic%20Feature%20Testing/N900 QA Basic Feature Testing] section of [http://qa-reports.meego.com http://qa-reports.meego.com].

== Maliit google searches ==
References to Maliit from other places on the web. Search used: maliit keyboard OR "input method" OR meego -ang

* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&client=firefox-a&hs=HdI&tbo=1&rls=org.mozilla%3Aen-US%3Aunofficial&num=10&lr=&ft=i&cr=&safe=images&tbs=#q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=kfI&tbo=1&rls=org.mozilla:en-US:unofficial&prmd=ivns&ei=1XDeTf-CEtHIswb5sbXLBQ&start=0&sa=N&bav=on.2,or.r_gc.r_pw.&fp=bf4289d263b569cc&biw=1302&bih=937 Webpages]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=f0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmdo=1&tbm=dsc&prmd=ivns&source=lnms&ei=6HDeTeOzMYXs-gaQuYXvCQ&sa=X&oi=mode_link&ct=mode&ved=0CBcQ_AU Discussions]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=mbl&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=9&ved=0CCAQ_AUoCA&prmdo=1 Realtime]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=blg&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=8&ved=0CB8Q_AUoBw&prmdo=1 Blogs]

{{MaliitNavigationBar}}

Maliit/Development

2011-06-20T23:47:39Z

Mikhas: cleanup, repo names

{{MaliitNavigationBar}}

== Repositories ==
* [https://gitorious.org/maliit/maliit-framework Maliit framework]:<pre>git clone git@gitorious.org:maliit/maliit-framework.git</pre>
* [https://gitorious.org/maliit/maliit-engines Maliit engines]:<pre>git@gitorious.org:maliit/maliit-engines.git</pre>
* [https://gitorious.org/maliit/maliit-plugins Maliit plugins (virtual keyboards etc.)]:<pre>git clone git@gitorious.org:maliit/maliit-plugins.git</pre>

For MeeGo 1.2, use the following branches instead of master:
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/commits/meego-1.2
* https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/commits/meego-1.2

== Contributing ==
We use gitorious to handle patches and reviews. Clone our repository, and create a merge request with the commits you want merged. As a general rule, do not send patches to the mailinglist.

If you are implementing a new feature, it is smart to discuss it on the mailing list first.
If you have a fix for a bug that affects Meego, file a bugreport at bugs.meego.com and link your merge request there.

We currently do not have a concrete policy for giving out commit rights to the mainline repositories. However, it is our intention that contributors
that builds up a track record with the project are able to get commit rights.
Do note that also those who have commit rights have to submit and get their merge requests reviewed prior to changes going in.

== Open bug reports ==

{{#bugzilla:
|columns=id,status,to,severity,version,summary
|group=priority
|grouporder=asc
|component=Virtual keyboard
|product=OS Base
|status=UNCONFIRMED,NEW,NEEDINFO,ASSIGNED,WAITING FOR UPSTREAM,REOPENED
|lastcomment=1
}}

== Meego packaging ==
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&repo_weekly=1&arch_armv7el=1&arch_armv8el=1&arch_i586=1&project=Trunk&defaults=0 Status in Trunk]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv8el=1&arch_i586=1&project=MeeGo%3A1.2%3Aoss&defaults=0 Status in 1.2]
* [http://build.meego.com/project/monitor?commit=Filter%3A&succeeded=1&failed=1&unresolvable=1&broken=1&blocked=1&dispatching=1&scheduled=1&building=1&finished=1&signing=1&pkgname=inputmethod&repo_standard=1&arch_armv7el=1&arch_i586=1&lastbuild=1&project=MeeGo%3A1.1%3ACore&defaults=0 Status in 1.1]

== QA Reports ==

Latest inputmethod packages QA reports using recent Meego images can be found at the [http://qa-reports.meego.com/1.2/Handset/Basic%20Feature%20Testing/N900 QA Basic Feature Testing] section of [http://qa-reports.meego.com http://qa-reports.meego.com].

== Maliit google searches ==
References to Maliit from other places on the web. Search used: maliit keyboard OR "input method" OR meego -ang

* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&client=firefox-a&hs=HdI&tbo=1&rls=org.mozilla%3Aen-US%3Aunofficial&num=10&lr=&ft=i&cr=&safe=images&tbs=#q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=kfI&tbo=1&rls=org.mozilla:en-US:unofficial&prmd=ivns&ei=1XDeTf-CEtHIswb5sbXLBQ&start=0&sa=N&bav=on.2,or.r_gc.r_pw.&fp=bf4289d263b569cc&biw=1302&bih=937 Webpages]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=f0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmdo=1&tbm=dsc&prmd=ivns&source=lnms&ei=6HDeTeOzMYXs-gaQuYXvCQ&sa=X&oi=mode_link&ct=mode&ved=0CBcQ_AU Discussions]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=mbl&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=9&ved=0CCAQ_AUoCA&prmdo=1 Realtime]
* [http://www.google.de/search?q=maliit+keyboard+OR+%22input+method%22+OR+meego+-ang&hl=en&lr=&client=firefox-a&hs=S0x&tbo=1&rls=org.mozilla:en-US:unofficial&biw=1302&bih=937&prmd=ivns&source=lnms&tbm=blg&ei=23DeTZGDCcrHswbUwbzLBQ&sa=X&oi=mode_link&ct=mode&cd=8&ved=0CB8Q_AUoBw&prmdo=1 Blogs]

{{MaliitNavigationBar}}

Maliit/Making a Release

2011-06-20T23:40:07Z

Mikhas: Created page with "{{MaliitNavigationBar}} 1. Update the NEWS file * git commit message: Changes: Update NEWS for version y.x * NEWS template: y.x === CHANGES SINCE x.z * List changes ..."

Maliit/Viva la Revolution

2011-06-20T22:26:53Z

Mikhas:

[[Category:MaliitTasks]]
==Tasks==

These are the remaining tasks to make Maliit an independent upstream project and to remove any trace/dependency to LMT in Maliit framework and its reference keyboard.

{|border="1" cellpadding="4" class="wikitable"
|-
! Task
! Assignee
! Status
! Details
|-
| Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch. Maliit repo will be the new upstream project for Harmattan and MeeGo Input Methods.
|| Michael
|| 90%
||
* meegotouch-inputmethodframework → maliit-framework
* meegotouch-inputmethodengine → maliit-engine
* meegotouch-inputmethodkeyboard → maliit-plugin
* meegotouch-feedback → maliit-feedback
* meegotouch-feedbackreactionmaps → maliit-reactionmaps
* meegotouch-inputmethodbridges → maliit (Will contain the application developer facing API and the support for different toolkits.)
* Still need to move over code from other repos, currently only framework and plugins are live, but I will with other repos until main development really happens @ Maliit, simply to avoid sync mess.
|-
| Have consistent package names based on the repository names. The package names will depend on different naming conventions of different platforms.
||
|| 0%
||
|-
| Use consistent Maliit paths.
||
|| 100%
||
* /usr/include/meegoimframework → /usr/include/maliit/framework
* /usr/include/meego/meegoimengine → /usr/include/maliit/engine
* /usr/lib/meego-im-plugins → /usr/lib/maliit/plugins
* /usr/lib/meego-imengines/drivers → /usr/lib/maliit/engines
* /usr/share/meegotouch/virtual-keyboard → /usr/share/maliit/keyboard
|-
| Use Maliit based settings keys. (allow to use old ones through configure/runtime option)
||
|| 100%
||
* /meegotouch/inputmethods/plugins → /maliit/plugins
* /meegotouch/inputmethods/onscreen → /maliit/onscreen
* /meegotouch/inputmethods/virtualkeyboard → /malitt/keyboard
When switching to DConf we could just use /org/maliit/...
|-
| Provide prototype for styling through extended attributes.
||
|| 0%
|| Keep the idea of generated style container classes, as they provide nice type safety. But at the same time, allow controlling of those attributes through extended attributes API (domain "/style").
|-
| Analyse functional dependencies between key styles
||
|| 0%
|| Fight combinatorial state explosion in key styling, probably by defining functional dependencies ("A pressed key always uses Color#2 when highlighted") and by using a styling state machine for keys.
|-
| Register Maliit project @ [http://freedesktop.org freedesktop.org] in order to get own bugtracker and mailing lists
|| Jon
|| 0%
||
|}

Maliit/Viva la Revolution

2011-06-20T22:23:52Z

Mikhas:

[[Category:MaliitTasks]]
==Tasks==

These are the remaining tasks to make Maliit an independent upstream project and to remove any trace/dependency to LMT in Maliit framework and its reference keyboard.

{|border="1" cellpadding="4" class="wikitable"
|-
! Task
! Assignee
! Status
! Details
|-
| Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch. Maliit repo will be the new upstream project for Harmattan and MeeGo Input Methods.
|| Michael
|| 90%
||
* meegotouch-inputmethodframework → maliit-framework
* meegotouch-inputmethodengine → maliit-engine
* meegotouch-inputmethodkeyboard → maliit-plugin
* meegotouch-feedback → maliit-feedback
* meegotouch-feedbackreactionmaps → maliit-reactionmaps
* meegotouch-inputmethodbridges → maliit (Will contain the application developer facing API and the support for different toolkits.)
* Still need to move over code from other repos, currently only framework and plugins are live, but I will with other repos until main development really happens @ Maliit, simply to avoid sync mess.
|-
| Have consistent package names based on the repository names. The package names will depend on different naming conventions of different platforms.
||
|| 0%
||
|-
| Use consistent Maliit paths.
||
|| 100%
||
* /usr/include/meegoimframework → /usr/include/maliit/framework
* /usr/include/meego/meegoimengine → /usr/include/maliit/engine
* /usr/lib/meego-im-plugins → /usr/lib/maliit/plugins
* /usr/lib/meego-imengines/drivers → /usr/lib/maliit/engines
* /usr/share/meegotouch/virtual-keyboard → /usr/share/maliit/keyboard
|-
|| Use Maliit based settings keys. (allow to use old ones through configure/runtime option)
||
|| 100%
||
* /meegotouch/inputmethods/plugins → /maliit/plugins
* /meegotouch/inputmethods/onscreen → /maliit/onscreen
* /meegotouch/inputmethods/virtualkeyboard → /malitt/keyboard
When switching to DConf we could just use /org/maliit/...
|-
|| Provide prototype for styling through extended attributes.
||
|| 0%
|| Keep the idea of generated style container classes, as they provide nice type safety. But at the same time, allow controlling of those attributes through extended attributes API (domain "/style").
|-
|| Analyse functional dependencies between key styles
||
|| 0%
|| Fight combinatorial state explosion in key styling, probably by defining functional dependencies ("A pressed key always uses Color#2 when highlighted") and by using a styling state machine for keys.
|}

Template:MaliitNavigationBar

2011-06-20T20:27:33Z

Mikhas:

{| class="wikitable" style="width:100%;text-align:center"
! [[Maliit|Maliit - Input Methods for MeeGo]]
|-
| [[Maliit|Overview]] · [[Maliit/Documentation|Documentation]] · [[Maliit/Development|Development]] · [[Maliit/Installing|Installing]] · [[Maliit/Roadmap|Roadmap]] · [[Maliit/Ideas|Ideas]] · [[Maliit/Team|Team]]
|}

[[Category:Maliit]][[Category:MeeGo Input Methods]]

Maliit/Writing Release Notes

2011-06-20T20:09:10Z

Mikhas:

{{MaliitNavigationBar}}

Use the template below to write release notes.

What's new?
===========

Write about an interesting aspect for this release.

Where can I get it?
===================

* framework:
http://gitorious.org/maliit/maliit-framework/archive-tarball/y.x
* plugins:
http://gitorious.org/maliit/maliit-plugins/archive-tarball/y.x

What is it?
===========

Maliit provides a flexible and cross-platform input method framework,
including a virtual keyboard. It works on all MeeGo user experiences,
and in other GNU/Linux distributions.

Visit http://maliit.org for more information about the project.

Who contributed to this release?
================================

* List authors of this release
$ git log ${previousTag}.. --raw | grep "^Author: " | sort | uniq -c

What changed in detail?
=======================

CHANGES IN FRAMEWORK SINCE x.y
* List the details from the framework's NEWS file.

CHANGES IN FRAMEWORK SINCE x.y
* List the details from the plugins' NEWS file.

BUG FIXES
* List all bug fixes of framework and plugins.

{{MaliitNavigationBar}}

Maliit/Writing Release Notes

2011-06-20T20:08:40Z

Mikhas: Created page with "{{MaliitNavigationBar}} What's new? =========== Write about an interesting aspect for this release. Where can I get it? =================== * framework: http://gi..."

{{MaliitNavigationBar}}

What's new?
===========

Write about an interesting aspect for this release.

Where can I get it?
===================

* framework:
http://gitorious.org/maliit/maliit-framework/archive-tarball/y.x
* plugins:
http://gitorious.org/maliit/maliit-plugins/archive-tarball/y.x

What is it?
===========

Maliit provides a flexible and cross-platform input method framework,
including a virtual keyboard. It works on all MeeGo user experiences,
and in other GNU/Linux distributions.

Visit http://maliit.org for more information about the project.

Who contributed to this release?
================================

* List authors of this release
$ git log ${previousTag}.. --raw | grep "^Author: " | sort | uniq -c

What changed in detail?
=======================

CHANGES IN FRAMEWORK SINCE x.y
* List the details from the framework's NEWS file.

CHANGES IN FRAMEWORK SINCE x.y
* List the details from the plugins' NEWS file.

BUG FIXES
* List all bug fixes of framework and plugins.

{{MaliitNavigationBar}}

Maliit

2011-06-20T19:48:28Z

Mikhas:

{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Features ==

=== For end users ===
Following are the high level end-user features supported by Maliit:

* Multitouch virtual keyboard
** Landscape and portrait QWERTY with dedicated symbol views
** Support for multiple languages and scripts (e.g. latin, cyrillic, arabic, chinese)
*** See current layouts at [http://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard/layouts MeeGo gitorius]
** Number/phone number layouts for entering numbers/phone numbers
* Context sensitive and dynamic action key
** e.g. replacing enter icon with search icon and highlighting the key in search fields - and respective search key inactive when search field empty
* Context sensitive layouts
** e.g. replacing ',' key with '@' in e-mail address fields
* Simple interactions (as defined in [http://meego.com/developers/ui-design-guidelines/handset/meego-basics MeeGo Basics])
** Swipe sideways to easily switch between different active keyboard layouts and other input methods
** Swipe down to close virtual keyboard or alternatively tap outiside the active input area to close keyboard
* Low-latency haptics typing feedback (with feedback framework backend); sound,tactile

[[File:Text-input-1.png|Virtual keyboard interaction : opening and closing the keyboard]]

* Cut/Copy/Paste for text input
** Separate text editor widget for text input fields
* Error correction / word prediction for virtual keyboard (with error correction / prediction engine)
** Separate widget for correction/prediction candidates
* Hardware keyboard
** Long pressing of keys either to autorepeat (e.g. arrow keys, backspace) or to input secondary characters (e.g. numbers, symbols)
** Possibility to extend hardware keys with virtual keys (e.g. for additional symbols)

[[File:Text-input-2a.png|Text input with hardware keyboard]]

* Toolbar for appliction specific input content
** For placing buttons, labels etc.
** Toolbar located on top of virtual keyboard, with hardware keyboard in the bottom of the screen

[[File:Confirming.png|Placing application specific actions in the input toolbar, when application UI is not visible or "Enter" action is not adequate]]

* External input methods
** e.g. Bluetooth keyboards

=== For integrators and developers ===
* Input Methods can be implemented as plugins
* Error correction/prediction engines can be implemented as plugins
* Framework is licensed LGPL
* Keyboard has theming abilities via CSS file
* Meego Keyboard has customizable layout files
* Meego Feedback framework has swappable backends (for haptics et.c.)
* Support for additional toolkits can be done by using the DBus connection for the Input Context

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]

<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== News ==
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Roadmap ==
See [[Maliit/Roadmap]]

== Upcoming events ==
* June 24th, MeeGo Freeday workshop, details TBA.
* August 6th-12th - Desktop Summit Berlin.

== Ideas ==
See [[Maliit/Ideas]]

== Developers ==
See [[Maliit/Development]]

== Documentation ==
See [[Maliit/Documentation]]

{{MaliitNavigationBar}}

Maliit

2011-06-20T18:44:32Z

Mikhas: /* News */

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross-platform input method framework, including a virtual keyboard. It works on all MeeGo user experiences, and in other GNU/Linux distributions.

== Goals ==

Maliit aims to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we should provide:

'''A solid input method framework'''

This includes support for traditional input methods such as hardware and virtual keyboards. More exotic input methods should also be possible, such as handwriting recognition and voice input, and special purpose input methods such as date/time pickers, tag clouds, etc.

'''A core set of input methods'''

The default set of input methods should demonstrate the core capabilities of the framework and provide a good user experience that device manufacturers and integrators can use easily.

We also aim to:

'''Empower third-party developers'''

Customizing existing input methods or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Build a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Features ==

=== For end users ===
Following are the high level end-user features supported by Maliit:

* Multitouch virtual keyboard
** Landscape and portrait QWERTY with dedicated symbol views
** Support for multiple languages and scripts (e.g. latin, cyrillic, arabic, chinese)
*** See current layouts at [http://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard/layouts MeeGo gitorius]
** Number/phone number layouts for entering numbers/phone numbers
* Context sensitive and dynamic action key
** e.g. replacing enter icon with search icon and highlighting the key in search fields - and respective search key inactive when search field empty
* Context sensitive layouts
** e.g. replacing ',' key with '@' in e-mail address fields
* Simple interactions (as defined in [http://meego.com/developers/ui-design-guidelines/handset/meego-basics MeeGo Basics])
** Swipe sideways to easily switch between different active keyboard layouts and other input methods
** Swipe down to close virtual keyboard or alternatively tap outiside the active input area to close keyboard
* Low-latency haptics typing feedback (with feedback framework backend); sound,tactile

[[File:Text-input-1.png|Virtual keyboard interaction : opening and closing the keyboard]]

* Cut/Copy/Paste for text input
** Separate text editor widget for text input fields
* Error correction / word prediction for virtual keyboard (with error correction / prediction engine)
** Separate widget for correction/prediction candidates
* Hardware keyboard
** Long pressing of keys either to autorepeat (e.g. arrow keys, backspace) or to input secondary characters (e.g. numbers, symbols)
** Possibility to extend hardware keys with virtual keys (e.g. for additional symbols)

[[File:Text-input-2a.png|Text input with hardware keyboard]]

* Toolbar for appliction specific input content
** For placing buttons, labels etc.
** Toolbar located on top of virtual keyboard, with hardware keyboard in the bottom of the screen

[[File:Confirming.png|Placing application specific actions in the input toolbar, when application UI is not visible or "Enter" action is not adequate]]

* External input methods
** e.g. Bluetooth keyboards

=== For integrators and developers ===
* Input Methods can be implemented as plugins
* Error correction/prediction engines can be implemented as plugins
* Framework is licensed LGPL
* Keyboard has theming abilities via CSS file
* Meego Keyboard has customizable layout files
* Meego Feedback framework has swappable backends (for haptics et.c.)
* Support for additional toolkits can be done by using the DBus connection for the Input Context

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]

<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== News ==
* 20.06.2011 - First release (Maliit 0.80) as an independent project. [http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html Announcement]
* 17.06.2011 - Session at Qt Collaborator Summit 2011. [http://developer.qt.nokia.com/groups/qt_contributors_summit/wiki/Input_methods_and_Wayland_in_Qt_5 Session summary]
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Roadmap ==
See [[Maliit/Roadmap]]

== Upcoming events ==
* June 24th, MeeGo Freeday workshop, details TBA.
* August 6th-12th - Desktop Summit Berlin.

== Ideas ==
See [[Maliit/Ideas]]

== Developers ==
See [[Maliit/Development]]

== Documentation ==
See [[Maliit/Documentation]]

{{MaliitNavigationBar}}

Maliit/Ideas/Supporting Non X11 Platforms

2011-06-17T09:46:24Z

Mikhas:

At the moment, the X11 platform is the only platform supported by the Input Method. This page describes the approaches that can be taken to support non-x11 platforms. When we are talking about non-X11 platforms the following feature may be affected:
* Input method's process host
* Self-compositing
* Hardware keyboard mapping
* D-Bus API input context connection

The ideas in this page basically built on using Wayland as the display server.
https://meego.gitorious.org/~krh/meego-ux/krhs-meego-ux-daemon can be used as a reference.

== Process host ==
For the host of the input method, basically there are two approaches that can be done, depending on the requirements of the system that we want to support, and we want to support both approach and can be easily switch between those.

=== In-process ===
This approach will bring the input method in the same process as the application. The memory consumed by input method is shared with the application. It also affects the startup time of the application.

==== Implementation details ====
* Instantiate the MIMPluginManager inside an input context plugin
* Have a widget to show the plugin UI, replacing the MIMApplication passthrough window
* Some tricks needed so the widget does not steal the focus of the text entry widget (which would cause the input method plugin UI to be hidden).

This approach would be feasible for these use cases:
* QtCreator support: developing Qt application will automatically use MeeGo Input Method when text entry is activated
* Symbian support: overriding Symbian's default input method and use MeeGo Input Method instead in Qt applications (might not work in legacy Avkon applications)
* single process Lighthouse/Wayland: The startup time and memory consumption are no longer relevant here as there would be a single instance of input method in a single process Lighthouse scenario.

===== D-Bus connection =====
When used in-process, even though if the platform supports GLib D-Bus API, there is no point of having the connection using D-Bus API. Here the MInputContext may need to be modified to do direct call to the input method plugin.

=== Out-of-process ===
This approach will still need the presence of compositor or be part of the compositor.

==== Implementation details ====
The details here assume that QtQuick 2's QML based compositor would be implemented. And here, we can't use QtQuick 1.0 and possibly also the QGraphicsView based plugins.

* Instantiate MIMPluginManager inside a Wayland compositor by using a normal QML plugin infrastructure. So here, the MIMPluginManager needs to be possible to be recompiled as a QDeclarativeExtensionPlugin.
* In the compositor's main QML file, Maliit needs to be included, eg. something like:
<pre>
import QtQuick 2.0
import Maliit // Import Maliit's plugin manager

...
InputMethod {
id: inputMethod
anchors {
fill: parent
}
}
...

</pre>
* The QML needs to be crafted so the InputMethod needs to be on top of everything which needs input method.
* MIMPluginManager would still need to be responsible to insert the plugin's UI into the scene by just reparenting the plugin's UI into the <tt>inputMethod</tt> object there.

This approach would be feasible for multiprocess Lighthouse applications setup.

== Hardware keyboard mapping ==
Internally Wayland is still using xkb, but having a dedicated interface to manage the hardware keyboard would make sense.

[[Category:Maliit]]

Maliit/Rebranding

2011-06-16T17:23:20Z

Mikhas:

{{MaliitNavigationBar}}
With http://lists.meego.com/pipermail/meego-dev/2011-June/483406.html Maliit declared itself as an independent project. To strengthen the position of Maliit, we decided to go with a proper rebranding. This involves cleaning up old Harmattan/MeeGo Touch cruft in source code, installation paths, GConf keys, etc.

The upcoming changes will be reflected in new package names for MeeGo and the following version numbers for the framework libraries:
* '''0.2x''': Still uses MeeGo Touch.
* '''0.8x''': Compiles MeeGo Touch free version by default.
** Installation paths, library names and GConf keys now follow new Maliit naming conventions.
** This is a transitional release where legacy LMT support still exists. All LMT dependencies can be surpressed with qmake CONFIG+=nomeegotouch, (works in framework and plugins repo).
** No API break! New library structure will require recompilation though.
* '''0.9x''': Alpha release that will lead up to MeeGo 1.3
** Will contain API cleanups (not LMT related, but rather about removing cruft and cleanup).
** API cleanup should be done for all Maliit libraries (including engines and feedback API).
** In first release for the 0.9x series, the C++ based reference VKB (Maliit Keyboard) will be LMT-free.
* '''1.0''': The Maliit release that will go into MeeGo 1.3.
** From here on, we would consider our API stable, goal is API compatibility (not necessarily BC) for MeeGo 1.4, too, as we really don't want to force input method developers to keep adjusting to changing API's.
{{MaliitNavigationBar}}

Maliit/Rebranding

2011-06-16T17:22:55Z

Mikhas:

{{MaliitNavigationBar}}
With http://lists.meego.com/pipermail/meego-dev/2011-June/483406.html Maliit declared itself as an independent project. To strengthen the position of Maliit, we decided to go with a proper rebranding. This involves cleaning up old Harmattan/MeeGo Touch cruft in source code, installation paths, GConf keys, etc.

The upcoming changes will be reflected in new package names for MeeGo and the following version numbers for the framework libraries:
* '''0.2x''': Still uses MeeGo Touch.
* '''0.8x''': Compiles MeeGo Touch free version by default.
** Installation paths, library names and GConf keys now follow new Maliit naming conventions.
** This is a transitional release where old LMT support still exists. All LMT dependencies can be surpressed with qmake CONFIG+=nomeegotouch, (works in framework and plugins repo).
** No API break! New library structure will require recompilation though.
* '''0.9x''': Alpha release that will lead up to MeeGo 1.3
** Will contain API cleanups (not LMT related, but rather about removing cruft and cleanup).
** API cleanup should be done for all Maliit libraries (including engines and feedback API).
** In first release for the 0.9x series, the C++ based reference VKB (Maliit Keyboard) will be LMT-free.
* '''1.0''': The Maliit release that will go into MeeGo 1.3.
** From here on, we would consider our API stable, goal is API compatibility (not necessarily BC) for MeeGo 1.4, too, as we really don't want to force input method developers to keep adjusting to changing API's.
{{MaliitNavigationBar}}

Maliit/Rebranding

2011-06-16T16:58:05Z

Mikhas:

{{MaliitNavigationBar}}
With http://lists.meego.com/pipermail/meego-dev/2011-June/483406.html Maliit declared itself as an independent project. To strengthen the position of Maliit, we decided to go with a proper rebranding. This involves cleaning up old Harmattan/MeeGo Touch cruft in source code, installation paths, GConf keys, etc.

The upcoming changes will be reflected in new package names for MeeGo and the following version numbers for the framework libraries:
* '''0.2x''': Still uses MeeGo Touch
* '''0.8x''': Compiles MeeGo Touch free version by default.
** Installation paths, library names and GConf keys now follow new Maliit naming conventions.
** No API break! New library structure will require recompilation though.
* '''0.9x''': Alpha release that will lead up to MeeGo 1.3
** Will contain API cleanups (not LMT related, but rather about removing cruft and cleanup).
** API cleanup should be done for all Maliit libraries (including engines and feedback API).
** In first release for the 0.9x series, the C++ based reference VKB (Maliit Keyboard) will be LMT-free.
* '''1.0''': The Maliit release that will go into MeeGo 1.3.
** From here on, we would consider our API stable, goal is API compatibility (not necessarily BC) for MeeGo 1.4, too, as we really don't want to force input method developers to keep adjusting to changing API's.
{{MaliitNavigationBar}}

Maliit/Rebranding

2011-06-16T16:19:30Z

Mikhas:

{{MaliitNavigationBar}}
With http://lists.meego.com/pipermail/meego-dev/2011-June/483406.html Maliit declared itself as an independent project. To strengthen the position of Maliit, we decided to go with a proper rebranding. This involves cleaning up old Harmattan/MeeGo Touch cruft in source code, installation paths, GConf keys, etc.

The upcoming changes will be reflected in new package names for MeeGo and the following version numbers for the framework libraries:
* '''0.2x''': Still uses MeeGo Touch
* '''0.8x''': Compiles MeeGo Touch free version by default.
** Installation paths, library names and GConf keys now follow new Maliit naming conventions.
** No API break! New library structure will require recompilation though.
* '''0.9x''': Alpha release that will lead up to MeeGo 1.3
** Will contain API cleanups (not LMT related, but rather about removing cruft and cleanup).
** API cleanup should be done for all Maliit libraries (including engines and feedback API).
** The C++ based reference VKB (Maliit Keyboard) will be LMT-free.
* '''1.0''': The Maliit release that will go into MeeGo 1.3.
** From here on, we would consider our API stable, goal is API compatibility (not necessarily BC) for MeeGo 1.4, too, as we really don't want to force input method developers to keep adjusting to changing API's.
{{MaliitNavigationBar}}

Maliit/Rebranding

2011-06-16T16:12:59Z

Mikhas: Created page with "{{MaliitNavigationBar}} With http://lists.meego.com/pipermail/meego-dev/2011-June/483406.html Maliit declared itself as an independent project. To strengthen the position of Mali..."

{{MaliitNavigationBar}}
With http://lists.meego.com/pipermail/meego-dev/2011-June/483406.html Maliit declared itself as an independent project. To strengthen the position of Maliit, we decided to go with a proper rebranding. This involves cleaning up old Harmattan/MeeGo Touch cruft in source code, installation paths, GConf keys, etc.

The upcoming changes will be reflected in new package names for MeeGo and the following version numbers for the framework libraries:
* 0.2x: Still uses MeeGo Touch
* 0.8x: Compiles MeeGo Touch free version by default. Installation paths, library names and GConf keys now follow new Maliit naming conventions.
* 0.9x: Alpha release that will lead up to MeeGo 1.3, will contain API cleanups (not LMT related, but rather about removing cruft and cleanup). API cleanup should be done for all Maliit libraries (including engines and feedback API). The C++ reference VKB (Maliit Keyboard) will be LMT-free.
* 1.0: The Maliit release that will go into MeeGo 1.3. From here on, we would consider our API stable, goal is API compatibility (not necessarily BC) for MeeGo 1.4, too, as we really don't want to force input method developers to keep adjusting to changing API's.
{{MaliitNavigationBar}}

Maliit/Roadmap

2011-06-16T16:01:45Z

Mikhas: /* MeeGo 1.3 */

{{MaliitNavigationBar}}

Submit your ideas in [[Maliit/Ideas|Ideas page]] to get considered to be put into the roadmap.

== MeeGo 1.3 ==
Development in in progress.

=== Framework ===
* Use D-Bus datatype instead of serialized Qt types in D-Bus API (DONE)
* [[Maliit/Ideas/Supporting_Non_X11_Platforms|Support for non X11 platform]]
* Better support for Qt applications not linked to MeeGo Touch
** Orientation change
* Control panel replacement
** Unify settings, probably even hide the framework's GConf usage behind some API that can be used by apps and plugins.
** Take a look at meego-ux-settings, and how we could integrate into that, contact tripzero.
* [[Maliit/Rebranding|Maliit rebranding]]

=== MeeGo Keyboard ===
* Key magnification and accent pop-ups (DONE)
* New word prediction widgets: Word Ribbon (DONE)
* Extended support for CJK languages
* Remove libmeegotouch dependency (or perhaps develop the qml keyboard further?)

== MeeGo 1.2 ==
All items in this section are DONE.

=== Framework ===
* private D-Bus connection
* new information exposures:
** anchor position
** cursor position
* libmeegotouch removal
* self-compositing
* self-rotation animation

=== Engine framework ===
* New interface: Handwriting recognition
* New functionality: Dynamic virtual keyboard layout

[[Category:Maliit]]
[[Category:MeeGo Input Methods]]

{{MaliitNavigationBar}}

Community Office/Proposed CO Nominations June2011

2011-06-11T14:10:59Z

Mikhas: Nominating Andrew Flegg for TSG (This is a wiki, right? And we are supposed to edit it before the meeting, right?)

== Existing Roles and Responsibilities ==
* [[Community Office/Community Management|Community Management and Collaboration]]: [[User:Dawnfoster|Dawn Foster]]
* [[Community Office/Marketing|Project Marketing and Promotion]]: [[User:Qgil|Quim Gil]]
* [[Events]]: [http://meego.com/users/amyleeland Amy Leeland]

== Changes to existing structure ==
* [[User:Qgil|Quim Gil]] has asked to step down due to his changed role at Nokia.

== Nominations that remain ==
* [[Community Office/Community Management|Community Office Lead: Community Management and Collaboration]]: [[User:Dawnfoster|Dawn Foster]]
* [[Events]]: [http://meego.com/users/amyleeland Amy Leeland]

== New Proposed Nominations ==

Note: These need to be approved by the TSG before being finalized.

* [[Community Office/Marketing|Project Marketing and Promotion]]: Brian Warner (acting)
* Community Apps: Niels Breet
* Community Device Program: Randall Arnold
* Technical Steering Group: Andrew Flegg

Maliit/2011 Week23 New Repositories

2011-06-10T15:58:10Z

Mikhas: Replaced content with "DELETED"

DELETED

Maliit/2011 Week23 New Package Names

2011-06-10T15:57:58Z

Mikhas: Replaced content with "DELETED"

DELETED

Maliit/Viva la Revolution

2011-06-10T15:57:36Z

Mikhas:

[[Category:MaliitTasks]]
==Tasks==

These are the remaining tasks to make Maliit an independent upstream project and to remove any trace/dependency to LMT in Maliit framework and its reference keyboard.

{|border="1" cellpadding="4" class="wikitable"
|-
! Task
! Assignee
! Status
! Details
|-
| Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch. Maliit repo will be the new upstream project for Harmattan and MeeGo Input Methods.
|| Michael
|| 90%
||
* meegotouch-inputmethodframework → maliit-framework
* meegotouch-inputmethodengine → maliit-engine
* meegotouch-inputmethodkeyboard → maliit-plugin
* meegotouch-feedback → maliit-feedback
* meegotouch-feedbackreactionmaps → maliit-reactionmaps
* meegotouch-inputmethodbridges → maliit (Will contain the application developer facing API and the support for different toolkits.)
|-
| Have consistent package names based on the repository names. The package names will depend on different naming conventions of different platforms.
||
|| 0%
||
|-
| Use consistent Maliit paths.
||
|| 0%
||
* /usr/include/meegoimframework → /usr/include/maliit/framework
* /usr/include/meego/meegoimengine → /usr/include/maliit/engine
* /usr/lib/meego-im-plugins → /usr/lib/maliit/plugins
* /usr/lib/meego-imengines/drivers → /usr/lib/maliit/engines
* /usr/share/meegotouch/virtual-keyboard → /usr/share/maliit/keyboard
|-
|| Use Maliit based settings keys. (allow to use old ones through configure/runtime option)
||
|| 0%
||
* /meegotouch/inputmethods/plugins → /maliit/plugins
* /meegotouch/inputmethods/onscreen → /maliit/onscreen
* /meegotouch/inputmethods/virtualkeyboard → /malitt/keyboard
When switching to DConf we could just use /org/maliit/...
|-
|| Provide prototype for styling through extended attributes.
||
|| 0%
|| Keep the idea of generated style container classes, as they provide nice type safety. But at the same time, allow controlling of those attributes through extended attributes API (domain "/style").
|-
|| Analyse functional dependencies between key styles
||
|| 0%
|| Fight combinatorial state explosion in key styling, probably by defining functional dependencies ("A pressed key always uses Color#2 when highlighted") and by using a styling state machine for keys.
|}

Maliit/Viva la Revolution

2011-06-10T15:43:47Z

Mikhas: Created page with "==Tasks== {|border="1" cellpadding="4" class="wikitable" |- ! Description ! Status ! Details |- | Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/mee..."

==Tasks==
{|border="1" cellpadding="4" class="wikitable"
|-
! Description
! Status
! Details
|-
| Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch. Maliit repo will be the new upstream project for Harmattan and MeeGo Input Methods.
|| 90%
||
* meegotouch-inputmethodframework → maliit-framework
* meegotouch-inputmethodengine → maliit-engine
* meegotouch-inputmethodkeyboard → maliit-plugin
* meegotouch-feedback → maliit-feedback
* meegotouch-feedbackreactionmaps → maliit-reactionmaps
* meegotouch-inputmethodbridges → maliit (Will contain the application developer facing API and the support for different toolkits.)
|-
| Have consistent package names based on the repository names. The package names will depend on different naming conventions of different platforms.
|| 0%
||
|-
| Use consistent Maliit paths.
|| 0%
||
* /usr/include/meegoimframework → /usr/include/maliit/framework
* /usr/include/meego/meegoimengine → /usr/include/maliit/engine
* /usr/lib/meego-im-plugins → /usr/lib/maliit/plugins
* /usr/lib/meego-imengines/drivers → /usr/lib/maliit/engines
* /usr/share/meegotouch/virtual-keyboard → /usr/share/maliit/keyboard
|}

Maliit/2011 Week23 New Package Names

2011-06-10T15:36:15Z

Mikhas: Created page with "Category:MaliitTasks Status: 0% Have consistent package names based on the repository names. The package names will depend on different naming conventions of different pl..."

[[Category:MaliitTasks]]

Status: 0%

Have consistent package names based on the repository names. The
package names will depend on different naming conventions of different
platforms.

Maliit/2011 Week23 New Repositories

2011-06-10T15:33:53Z

Mikhas:

[[Category:MaliitTasks]]

Status: 90%

Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch.
Maliit repo will be the new upstream project for Harmattan and MeeGo Input Methods.

* meegotouch-inputmethodframework → maliit-framework
* meegotouch-inputmethodengine → maliit-engine
* meegotouch-inputmethodkeyboard → maliit-plugin
* meegotouch-feedback → maliit-feedback
* meegotouch-feedbackreactionmaps → maliit-reactionmaps
* meegotouch-inputmethodbridges → maliit (Will contain the application developer facing API and the support for different toolkits.)

Maliit/2011 Week23 New Repositories

2011-06-10T15:33:33Z

Mikhas: Created page with "Category:MaliitTasks Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch. Status: 90% * meegotouch-inputmethodframework → maliit-framew..."

[[Category:MaliitTasks]]

Get an own repostiory (gitorious.org/maliit) instead of meego.gitorious.org/meegotouch.
Status: 90%

* meegotouch-inputmethodframework → maliit-framework
* meegotouch-inputmethodengine → maliit-engine
* meegotouch-inputmethodkeyboard → maliit-plugin
* meegotouch-feedback → maliit-feedback
* meegotouch-feedbackreactionmaps → maliit-reactionmaps
* meegotouch-inputmethodbridges → maliit (Will contain the application developer facing API and the support for different toolkits.)

Maliit repo will be the new upstream project for Harmattan and MeeGo Input Methods.

Category:MaliitTasks

2011-06-10T15:26:59Z

Mikhas: Created page with "Tasks that need to be done in the Maliit project."

Tasks that need to be done in the Maliit project.

Maliit/Documentation

2011-06-10T10:37:02Z

Mikhas: /* Unanswered questions */

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

== FAQ ==
Frequently asked questions.

'''1. How to write my own input method?''' 
The recommended way to get started is to use the Maliit Plugin SDK and follow the [[Maliit/Documentation#Plugin_development_Quickstart|quickstart documentation]].

For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/minputmethodplugin.h MInputMethodPlugin],
[https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethod.h MAbstractInputMethod] and [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethodhost.h 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 [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick 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.

* Does Maliit work with non-compositing Window Managers?
* Which window managers are currently supported?

== Plugin Development Quickstart ==
How to get started developing plugins. This documentation is mainly for framework version 0.20.11-1 and newer. The C++ plugin API is compatible with all 0.20.x versions, and the QML interface is available from 0.20.9-1. Meego 1.2 has version 0.20.6. To develop there, one can install packages from Trunk/1.3.

Note that this is not intended to be 100% copy'n'paste step-by-step instructions. You may need to use common sense.

* [[Maliit/Installing|Install Maliit]] for your development environment
* [http://www.jonnor.com/files/maliit/maliit-plugin-sdk-0.1.0.tar.gz Download] the Maliit Plugin SDK
* Extract the examples
# In your favorite terminal:
tar -xf maliit-plugin-sdk-*.tar.gz
cd maliit-plugin-sdk/examples/
* Compile them
qmake
make
make install
* Have a look around. In the examples directory you will find a QML based plugin and a C++ based plugin.
# QML plugin code
ls plugins/quick/
# C++ plugin code
ls plugins/standard
* Try out one of the examples
# First enable both of the example input methods, along with the meego keyboard
gconftool-2 -s /meegotouch/inputmethods/onscreen/enabled -t list --list-type strings \
[libmeego-keyboard.so,en_gb.xml,libmeego-keyboard-quick.so,,libhelloworldplugin.so,,libexampleplugin.so,ExamplePluginSubview1]
# To activate the QML example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libhelloworldplugin.so,]
# To instead activate the C++ example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libexampleplugin.so,ExamplePluginSubview1]

# To test, start the Maliit server and a application with a Maliit inputcontext loaded
# Note: More documentation on this can be found on the Installing page
meego-im-uiserver > server.log &
QT_IM_MODULE=MInputContext apps/plainqt/plainqt

# Tap/double tap on a text field to activate the input method
# You should now be able to see an input method which allows you to click to input "Hello World"

* Try changing the plugin code a bit, and reinstall and restart the Maliit server to try again.
# Do changes (start simple, maybe by changing the "Hello World" string to something else)

# Rebuild and reinstall plugins
make && make install
# Remember to restart the Maliit server for it to pick up the changed plugin

If you have any issues, first try to solve the problem by reading the instructions again, and maybe other documentation. If you cannot solve it, ask for help through one of our communication channels.

There are also several open source input plugins that one look at. See for instance
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard Meego Keyboard]
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick Meego Keyboard Quick]
* [https://github.com/foolegg/cute-input-method/tree/maliit cute-input-method]

== Feature documentation ==
See [[Maliit#Features]]

== API documentation ==
* [http://apidocs.meego.com/1.1/platform/html/meego-im-framework/main.html 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 [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382] and [https://bugs.meego.com/show_bug.cgi?id=14994 bug 14994]
* Generate from source code with doxygen.

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

== Technical documentation ==
* [[Media:Technical-overview-widget-reloc.pdf|Widget relocation in MTF]]
* More to come!

== Blogposts et.c. ==
(most recent first)
* Michael Hasselmannn: [http://taschenorakel.de/michael/2011/06/10/decent-examples-last/ Decent examples, at last!]
* Jon Nordby: [http://www.jonnor.com/2011/06/example-plugins-for-maliit-available/ Example plugins for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/07/maliit-session-meego-spring-conference-2011/ Maliit Session at MeeGo Spring Conference 2011]
* Jan Arne Petersen: [http://blog.jpetersen.org/2011/05/29/maliit-packages-for-fedora/ Maliit packages for Fedora]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
* Jon Nordby: [http://www.jonnor.com/2011/04/introducing-maliit-on-screen-keyboard-in-gnome-3/ Introducing; Maliit on-screen keyboard in Gnome 3]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego Keyboard]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]

== 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 ===

{|border="1" cellpadding="4" class="wikitable"
|-
! 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. [https://bugs.meego.com/show_bug.cgi?id=14382 Bug 14382]
|-
| apidocs.meego.com/1.2 || 10% || Our docs should be shown here. [https://bugs.meego.com/show_bug.cgi?id=14994 Bug 14994]
|-
| colspan=3 | '''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 || ? ||
|-
| colspan=3 | '''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. ||
|-
|}

{{MaliitNavigationBar}}

Maliit/Documentation

2011-06-10T01:53:42Z

Mikhas: /* Blogposts et.c. */

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

== Feature documentation ==
See [[Maliit#Features]]

== API documentation ==
* [http://apidocs.meego.com/1.1/platform/html/meego-im-framework/main.html 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 [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382] and [https://bugs.meego.com/show_bug.cgi?id=14994 bug 14994]
* Generate from source code with doxygen.

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

== Technical documentation ==
* [[Media:Technical-overview-widget-reloc.pdf|Widget relocation in MTF]]
* More to come!

== Plugin development Quickstart ==
How to get started developing plugins. This documentation is mainly for framework version 0.20.11-1 and newer. The C++ plugin API is compatible with all 0.20.x versions, and the QML interface is available from 0.20.9-1. Meego 1.2 has version 0.20.6. To develop there, one can install packages from Trunk/1.3.

Note that this is not intended to be 100% copy'n'paste step-by-step instructions. You may need to use common sense.

* [[Maliit/Installing|Install Maliit]] for your development environment
* [http://www.jonnor.com/files/maliit/maliit-plugin-sdk-0.1.0.tar.gz Download] the Maliit Plugin SDK
* Extract the examples
# In your favorite terminal:
tar -xf maliit-plugin-sdk-*.tar.gz
cd maliit-plugin-sdk/examples/
* Compile them
qmake
make
make install
* Have a look around. In the examples directory you will find a QML based plugin and a C++ based plugin.
# QML plugin code
ls plugins/quick/
# C++ plugin code
ls plugins/standard
* Try out one of the examples
# First enable both of the example input methods, along with the meego keyboard
gconftool-2 -s /meegotouch/inputmethods/onscreen/enabled -t list --list-type strings \
[libmeego-keyboard.so,en_gb.xml,libmeego-keyboard-quick.so,,libhelloworldplugin.so,,libexampleplugin.so,ExamplePluginSubview1]
# To activate the QML example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libhelloworldplugin.so,]
# To instead activate the C++ example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libexampleplugin.so,ExamplePluginSubview1]

# To test, start the Maliit server and a application with a Maliit inputcontext loaded
# Note: More documentation on this can be found on the Installing page
meego-im-uiserver > server.log &
QT_IM_MODULE=MInputContext apps/plainqt/plainqt

# Tap/double tap on a text field to activate the input method
# You should now be able to see an input method which allows you to click to input "Hello World"

* Try changing the plugin code a bit, and reinstall and restart the Maliit server to try again.
# Do changes (start simple, maybe by changing the "Hello World" string to something else)

# Rebuild and reinstall plugins
make && make install
# Remember to restart the Maliit server for it to pick up the changed plugin

If you have any issues, first try to solve the problem by reading the instructions again, and maybe other documentation. If you cannot solve it, ask for help through one of our communication channels.

There are also several open source input plugins that one look at. See for instance
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard Meego Keyboard]
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick Meego Keyboard Quick]
* [https://github.com/foolegg/cute-input-method/tree/maliit cute-input-method]

== Blogposts et.c. ==
(most recent first)
* Michael Hasselmannn: [http://taschenorakel.de/michael/2011/06/10/decent-examples-last/ Decent examples, at last!]
* Jon Nordby: [http://www.jonnor.com/2011/06/example-plugins-for-maliit-available/ Example plugins for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/07/maliit-session-meego-spring-conference-2011/ Maliit Session at MeeGo Spring Conference 2011]
* Jan Arne Petersen: [http://blog.jpetersen.org/2011/05/29/maliit-packages-for-fedora/ Maliit packages for Fedora]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
* Jon Nordby: [http://www.jonnor.com/2011/04/introducing-maliit-on-screen-keyboard-in-gnome-3/ Introducing; Maliit on-screen keyboard in Gnome 3]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego Keyboard]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]

== FAQ ==
Frequently asked questions.

'''1. How to write my own input method?''' 
The recommended way to get started is to use the Maliit Plugin SDK and follow the [[Maliit/Documentation#Plugin_development_Quickstart|quickstart documentation]].

For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/minputmethodplugin.h MInputMethodPlugin],
[https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethod.h MAbstractInputMethod] and [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethodhost.h 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 [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick 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 ===

{|border="1" cellpadding="4" class="wikitable"
|-
! 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. [https://bugs.meego.com/show_bug.cgi?id=14382 Bug 14382]
|-
| apidocs.meego.com/1.2 || 10% || Our docs should be shown here. [https://bugs.meego.com/show_bug.cgi?id=14994 Bug 14994]
|-
| colspan=3 | '''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 || ? ||
|-
| colspan=3 | '''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. ||
|-
|}

{{MaliitNavigationBar}}

Maliit

2011-06-10T01:47:49Z

Mikhas: /* Maliit in action */

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

[[File:Maliit2.png|448px|link=]]

Maliit provides a flexible and cross platform input method framework. It is usable on all MeeGo user experiences, and in other GNU/Linux distributions as well.

== Communication channels ==

'''Mailing list:''' meego-inputmethods@lists.meego.com ([http://lists.meego.com/listinfo/meego-inputmethods listinfo] | [http://lists.meego.com/pipermail/meego-inputmethods/ archives])

'''Bugtracker:''' bugs.meego.com, Product: OS, Component: Virtual Keyboard ([https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_based_on=virtual%20keyboard&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=INDEFINITION&bug_status=ASSIGNED&bug_status=ACCEPTED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=WAITING&bug_status=REOPENED&component=Virtual%20keyboard&product=OS%20Base&known_name=virtual%20keyboard open bugs] |
[https://bugs.meego.com/enter_bug.cgi?product=OS%20Base&component=Virtual%20keyboard file new bug])

'''IRC:''' Visit us in #meego-inputmethods at freenode.net ([http://webchat.freenode.net/?randomnick=1&channels=meego-inputmethods&uio=d4 webchat])

== News ==
* 07.06.2011 - Session at MeeGo Spring Conference 2011. [http://sf2011.meego.com/program/sessions/developing-custom-input-methods-meego Info, Recording]
* 08.04.2011 - MeeGo Keyboard is relicensed with BSD license: [http://lists.meego.com/pipermail/meego-dev/2011-April/482578.html Announcement]
* 29.03.2011 - Held first offical IRC meeting: [[Maliit/Meetings|How can we simplify development and maintenance of input contexts?]]
* 04.03.2011 - API/ABI break in 0.20.0: [http://lists.meego.com/pipermail/meego-dev/2011-March/481869.html meego-im-framework is removing dependency to libmeegotouch from its API]
* 23.02.2011 - Packages available for Ubuntu Lucid/Maverick to ease development. [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ Blogpost], [[#Packages for Ubuntu .2810.04 Lucid Lynx .2F 10.10 Maveric Meerkat.29|documentation]]
* 17.02.2011 - Claudio Saavedra started on MeeGo+Gtk integration work, focusing on input methods. [http://people.gnome.org/~csaavedra/news-2011-02.html#D10 Blogpost]
* 13.02.2011 - MeeGo Tablet UX demoed at Mobile World Conference, with Swype keyboard. [http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 Pictures]
* 01.02.2011 - API/ABI break in 0.19.41: [http://lists.meego.com/pipermail/meego-dev/2011-February/481353.html meegoimframework interfaces related to orientation change will be changed]
* 15.11.2010 - Architect and Lead Developer of Maliit give talk at MeeGo Conference. [http://conference2010.meego.com/session/meego-touch-input-method-frameworks Info, Recording]
* 15.11.2010 - Linpus shows off MeeGo based slate at MeeGo Conference, with keyboard based on Maliit.
* 30.06.2010 - MeeGo Handset UX Day 1 release, first public release of MeeGo Input Methods. [http://meego.com/community/blogs/valhalla/2010/meego-handset-project-day-1-here Announcement]

== Roadmap ==
See [[Maliit/Roadmap]]

== Upcoming events ==
* June 24th, MeeGo Freeday workshop, details TBA.
* August 6th-12th - Desktop Summit Berlin.

== Goals ==

The overall goal of Maliit is to be ''the'' input method project for MeeGo and other GNU/Linux-based embedded/mobile platforms. To achieve this we aim to:

'''Provide a solid input method framework'''

This includes explicit support for traditional input methods like hardware and virtual keyboards. More exotic input methods like handwriting recognition and voice input, and special purpose input methods like date/time pickers, tag clouds, et.c. should also be possible.

'''Provide a core set of input methods'''

The default set of input methods should demonstrate the core capabilites of the framework, and provide a good user experience that device manufacturers and integrators can use with little to no adaptation.

'''Empower third-party developers'''

Customizing existing or developing powerful new input methods should be simple, regardless of whether it is for profit, research or fun.

'''Have a diverse community of contributors'''

Employees from different companies, freelancers, members of academia, hackers and volunteers should all be welcomed and encouraged to contribute to the project.

== Features ==

=== For end users ===
Following are the high level end-user features supported by Maliit:

* Multitouch virtual keyboard
** Landscape and portrait QWERTY with dedicated symbol views
** Support for multiple languages and scripts (e.g. latin, cyrillic, arabic, chinese)
*** See current layouts at [http://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard/layouts MeeGo gitorius]
** Number/phone number layouts for entering numbers/phone numbers
* Context sensitive and dynamic action key
** e.g. replacing enter icon with search icon and highlighting the key in search fields - and respective search key inactive when search field empty
* Context sensitive layouts
** e.g. replacing ',' key with '@' in e-mail address fields
* Simple interactions (as defined in [http://meego.com/developers/ui-design-guidelines/handset/meego-basics MeeGo Basics])
** Swipe sideways to easily switch between different active keyboard layouts and other input methods
** Swipe down to close virtual keyboard or alternatively tap outiside the active input area to close keyboard
* Low-latency haptics typing feedback (with feedback framework backend); sound,tactile

[[File:Text-input-1.png|Virtual keyboard interaction : opening and closing the keyboard]]

* Cut/Copy/Paste for text input
** Separate text editor widget for text input fields
* Error correction / word prediction for virtual keyboard (with error correction / prediction engine)
** Separate widget for correction/prediction candidates
* Hardware keyboard
** Long pressing of keys either to autorepeat (e.g. arrow keys, backspace) or to input secondary characters (e.g. numbers, symbols)
** Possibility to extend hardware keys with virtual keys (e.g. for additional symbols)

[[File:Text-input-2a.png|Text input with hardware keyboard]]

* Toolbar for appliction specific input content
** For placing buttons, labels etc.
** Toolbar located on top of virtual keyboard, with hardware keyboard in the bottom of the screen

[[File:Confirming.png|Placing application specific actions in the input toolbar, when application UI is not visible or "Enter" action is not adequate]]

* External input methods
** e.g. Bluetooth keyboards

=== For integrators and developers ===
* Input Methods can be implemented as plugins
* Error correction/prediction engines can be implemented as plugins
* Framework is licensed LGPL
* Keyboard has theming abilities via CSS file
* Meego Keyboard has customizable layout files
* Meego Feedback framework has swappable backends (for haptics et.c.)
* Support for additional toolkits can be done by using the DBus connection for the Input Context

== Maliit in action ==

Maliit is used on a number of devices and form factors, and can easily be adapted to run on new ones.

* [http://www.linpus.com/products_meego_slate.html Linpus Slate] ([http://www.linpus.com/images/slate/kb.png screenshot showing Linpus virtual keyboard])
* [http://appdeveloper.intel.com/en-us/meego-iso-esla Intel MeeGo Tablet] ([http://www.engadget.com/photos/new-meego-tablet-user-experience-hands-on-at-mwc-2011/#3877322 pictures showing Swype keyboard])
* [http://www.youtube.com/watch?v=l_7f3Lxd4_I GNOME3 on a WeTab (video)]

<gallery widths="250px" heights="250px" perrow="3">
Image:Lenovo_meego_vkb.jpg| [[Maliit/MeeGo 1.1#Netbook|MeeGo 1.1 Netbook]] with MeeGo Keyboard on Lenovo S10-3T Ideapad
Image:Meego1.1_handset_on_aava.jpg| [http://meego.com/downloads/releases/1.1/meego-v1.1-handset MeeGo 1.1 Handset] with MeeGo Keyboard on Aava Mobile
Image:tegra-vkb2.jpg| MeeGo 1.2 prerelease on [[ARM/TEGRA2|Advent Vega, Tegra2]]
Image:Maliit-on-lucid.png | Ubuntu Lucid (10.04)
Image:Maliit-in-GNOME3.jpg | GNOME3 on a WeTab
Image:Maliit-on-KDE-Plasma.jpg | KDE, using Plasma
[[File:TransparentPlaceholder.png|link=http://wikipedia.org|caption]]
</gallery>

== Ideas ==
See [[Maliit/Ideas]]

== Developers ==
See [[Maliit/Development]]

== Documentation ==
See [[Maliit/Documentation]]

{{MaliitNavigationBar}}

File:Maliit-on-KDE-Plasma.jpg

2011-06-10T01:46:58Z

Mikhas: Maliit running on KDE, using Plasma

Maliit running on KDE, using Plasma

Maliit/Documentation

2011-06-10T00:51:34Z

Mikhas: /* Blogposts et.c. */

[[Category:Maliit]][[Category:MeeGo Input Methods]]
{{MaliitNavigationBar}}

== Feature documentation ==
See [[Maliit#Features]]

== API documentation ==
* [http://apidocs.meego.com/1.1/platform/html/meego-im-framework/main.html 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 [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382] and [https://bugs.meego.com/show_bug.cgi?id=14994 bug 14994]
* Generate from source code with doxygen.

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

== Technical documentation ==
* [[Media:Technical-overview-widget-reloc.pdf|Widget relocation in MTF]]
* More to come!

== Plugin development Quickstart ==
How to get started developing plugins. This documentation is mainly for framework version 0.20.11-1 and newer. The C++ plugin API is compatible with all 0.20.x versions, and the QML interface is available from 0.20.9-1. Meego 1.2 has version 0.20.6. To develop there, one can install packages from Trunk/1.3.

Note that this is not intended to be 100% copy'n'paste step-by-step instructions. You may need to use common sense.

* [[Maliit/Installing|Install Maliit]] for your development environment
* [http://www.jonnor.com/files/maliit/maliit-plugin-sdk-0.1.0.tar.gz Download] the Maliit Plugin SDK
* Extract the examples
# In your favorite terminal:
tar -xf maliit-plugin-sdk-*.tar.gz
cd maliit-plugin-sdk/examples/
* Compile them
qmake
make
make install
* Have a look around. In the examples directory you will find a QML based plugin and a C++ based plugin.
# QML plugin code
ls plugins/quick/
# C++ plugin code
ls plugins/standard
* Try out one of the examples
# First enable both of the example input methods, along with the meego keyboard
gconftool-2 -s /meegotouch/inputmethods/onscreen/enabled -t list --list-type strings \
[libmeego-keyboard.so,en_gb.xml,libmeego-keyboard-quick.so,,libhelloworldplugin.so,,libexampleplugin.so,ExamplePluginSubview1]
# To activate the QML example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libhelloworldplugin.so,]
# To instead activate the C++ example
gconftool-2 -s /meegotouch/inputmethods/onscreen/active -t list --list-type string [libexampleplugin.so,ExamplePluginSubview1]

# To test, start the Maliit server and a application with a Maliit inputcontext loaded
# Note: More documentation on this can be found on the Installing page
meego-im-uiserver > server.log &
QT_IM_MODULE=MInputContext apps/plainqt/plainqt

# Tap/double tap on a text field to activate the input method
# You should now be able to see an input method which allows you to click to input "Hello World"

* Try changing the plugin code a bit, and reinstall and restart the Maliit server to try again.
# Do changes (start simple, maybe by changing the "Hello World" string to something else)

# Rebuild and reinstall plugins
make && make install
# Remember to restart the Maliit server for it to pick up the changed plugin

If you have any issues, first try to solve the problem by reading the instructions again, and maybe other documentation. If you cannot solve it, ask for help through one of our communication channels.

There are also several open source input plugins that one look at. See for instance
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/m-keyboard Meego Keyboard]
* [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick Meego Keyboard Quick]
* [https://github.com/foolegg/cute-input-method/tree/maliit cute-input-method]

== Blogposts et.c. ==
(most recent first)
* Jon Nordby: [http://www.jonnor.com/2011/06/example-plugins-for-maliit-available/ Example plugins for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/06/07/maliit-session-meego-spring-conference-2011/ Maliit Session at MeeGo Spring Conference 2011]
* Jan Arne Petersen: [http://blog.jpetersen.org/2011/05/29/maliit-packages-for-fedora/ Maliit packages for Fedora]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
* Jon Nordby: [http://www.jonnor.com/2011/04/introducing-maliit-on-screen-keyboard-in-gnome-3/ Introducing; Maliit on-screen keyboard in Gnome 3]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego Keyboard]
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]

== FAQ ==
Frequently asked questions.

'''1. How to write my own input method?''' 
The recommended way to get started is to use the Maliit Plugin SDK and follow the [[Maliit/Documentation#Plugin_development_Quickstart|quickstart documentation]].

For developing an input method plugin, the primary interface is Qt and C++. The most relevant classes are: [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/minputmethodplugin.h MInputMethodPlugin],
[https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethod.h MAbstractInputMethod] and [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodframework/blobs/master/src/mabstractinputmethodhost.h 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 [https://meego.gitorious.org/meegotouch/meegotouch-inputmethodkeyboard/trees/master/meego-keyboard-quick 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 ===

{|border="1" cellpadding="4" class="wikitable"
|-
! 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. [https://bugs.meego.com/show_bug.cgi?id=14382 Bug 14382]
|-
| apidocs.meego.com/1.2 || 10% || Our docs should be shown here. [https://bugs.meego.com/show_bug.cgi?id=14994 Bug 14994]
|-
| colspan=3 | '''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 || ? ||
|-
| colspan=3 | '''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. ||
|-
|}

{{MaliitNavigationBar}}