Meego Wiki
Views

Maliit/Documentation

From MeeGo wiki
< Maliit(Difference between revisions)
Jump to: navigation, search
(→FAQ: add an entry)
(Moved (upstream) to http://wiki.maliit.org/Documentation)
 
(26 intermediate revisions not shown)
Line 1: Line 1:
-
[[Category:Maliit]][[Category:MeeGo Input Methods]]
+
Moved (upstream) to http://wiki.maliit.org/Documentation
-
{{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 has been requested. See [https://bugs.meego.com/show_bug.cgi?id=14382 bug 14382]
+
-
* 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. ==
+
-
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/02/24/meego-input-methods-your-desktop/ MeeGo Input Methods for your desktop]
+
-
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/04/10/customizing-meego-keyboard/ Customizing the Meego 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/05/10/painting-strategy-meegos-virtual-keyboard/ Painting Strategy in MeeGo's Virtual Keyboard]
+
-
* Michael Hasselmann: [http://taschenorakel.de/michael/2011/05/12/writing-qml-based-input-methods-maliit/ Writing QML-based input methods for Maliit]
+
-
 
+
-
== FAQ ==
+
-
Frequently asked questions.
+
-
 
+
-
'''1. How to write my own input method?'''<br>
+
-
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, 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
+
-
 
+
-
=== Documentation status ===
+
-
 
+
-
{|border="1" cellpadding="4"  class="wikitable"
+
-
|-
+
-
! Item
+
-
! Status
+
-
! Description
+
-
|-
+
-
| wiki.meego.com/Maliit || 80% || Our public webpage/wiki page, starting point for all docs. 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]
+
-
|-
+
-
| Overall architecture || 30% || Some docs exists in framework source tree, but is very outdated
+
-
|-
+
-
| Input Method/framework settings system || 0% ||
+
-
|-
+
-
| Input Method Plugin<->Framework interaction || 0% || What the interaction concepts are (both user and technical), and what is done on each side to support this
+
-
|-
+
-
| Input Method Framework Window handling || 0% || Passthrough window, Self-compositing, plugin pixmap drawing, rotation animation. Maybe covered by above item?
+
-
|-
+
-
| Input Method Plugin API || 40% || Tutorial is outdated. Should provide a well-commented plugin example/skeleton that is built as part of our build (to avoid bitrot)
+
-
|-
+
-
| Input Context DBus API || 0% ||
+
-
|-
+
-
| Toolkit integration concepts || 20% || Key concepts like pre-edit injection, and widget relocation should be documented. Purpose: make it easy for others to improve toolkit integration, and to bring new people up to date. Widget relocation is documented.
+
-
|-
+
-
| Toolkit integration/support status || 10% || Implicitly all keyboard features/IM are available for MTF. No documentation about plain Qt, QML, Clutter or Gtk+
+
-
|-
+
-
| Engine interfaces || ? || Correction/prediction/suggestion/handwriting, both plugin side and IM side
+
-
|-
+
-
| Feedback framework || ? ||
+
-
|-
+
-
| Meego Keyboard 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}}
+

Latest revision as of 15:34, 12 July 2011

Moved (upstream) to http://wiki.maliit.org/Documentation

Retrieved from "http://wiki.meego.com/Maliit/Documentation"
Personal tools