Meego Wiki
Views

Maliit/Documentation/Examples

From MeeGo wiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "Currently these items are all TODO. = Guidelines for examples = All examples should show a single aspect of Maliit, and be self contained. The best way is to make the examples ...")
(moved to upstream wiki)
Line 1: Line 1:
-
Currently these items are all TODO.
+
Moved to [http://wiki.maliit.org/Documentation/Examples upstream wiki].b
-
 
+
-
= Guidelines for examples =
+
-
 
+
-
All examples should show a single aspect of Maliit, and be self contained.
+
-
The best way is to make the examples standalone.
+
-
An additional overview/demo application can be used to launch these standalone examples.
+
-
(similar to what GTK+ does)
+
-
 
+
-
Examples must be built as part of the standard build. Whenever possible
+
-
they should also have a sanity test that is a part of the ordinary test suite.
+
-
The existing examples in maliit-framework examples/ do this, and can be used as a base.
+
-
 
+
-
Examples should be installed as part of a normal install, both the binaries
+
-
and the source code. We do currently not have a ready solution for this, but it
+
-
could be done by adding similar logic as the maliit-plugin-sdk-dist.sh script
+
-
to the build system.
+
-
 
+
-
Check if we can use stuff from LMT widgetsgallery.
+
-
 
+
-
= Examples and testing =
+
-
Our UI tests currently have a number of test applications. For the simplest one
+
-
the tests should be able to use the examples we provide here instead of custom
+
-
ones. This reduces duplication and means our examples are tested.
+
-
 
+
-
Idea: Have applications with different toolkits and test all of them with our UI tests.
+
-
 
+
-
= Wanted examples =
+
-
 
+
-
== Plugin development examples ==
+
-
* Integrating a correction engine
+
-
* Attribute extensions - shown a couple of keys and allows to customize them
+
-
* Cycle-keys - Can be used to explain difference between preedit and commit
+
-
* How to handle rotation
+
-
 
+
-
== Application / Application Framework examples ==
+
-
Should be plain Qt and/or QML. Would use the new libmaliit library
+
-
+
-
* Attribute extensions - goes together with the plugin example
+
-
* Rotation - how to notify the IM framework about rotation changes
+
-
* Input Widget relocation
+
-
* Input Method hints
+
-
 
+
-
== Engine plugin development ==
+
-
* Handwriting
+
-
* Words
+
-
 
+
-
== Reference plugins ==
+
-
* Layouts
+
-
* Theming
+
-
* Adding an engine
+
-
 
+
-
== Feedback ==
+
-
* How to use reactionmaps
+
-
* How to use feedback FW api
+
-
* How to write a feedback backend
+
-
 
+
-
== Other ==
+
-
 
+
-
* Settings
+
-
* Hardware keyboard presence notification
+

Revision as of 17:26, 13 July 2011

Moved to upstream wiki.b

Personal tools