Documentation and sample code for the client library

Registered by Duncan McGreggor on 2010-08-31

We need to identify the greatest need for documenting the Open Input Framework. For example, we need to consider cases like the following:
 * What's the best way for a developer to enable a subset of gestures for a legacy application?
 * What's the best way to enable new MT HW for OIF?
 * How does one define a new gesture and have this be available up the entire OIF stack, all the way to applications?
 * How does one develop a GTK/GNOME application to make use of gestures in OIF?
 * How does one develop a Qt/KDE application to make use of gestures in OIF?

The goal of this examination would be to integrate a documentation procedure directly into our development process so that developers always have access to the latest and greatest. Given that touch is cutting-edge, we need to exert a special and concerted effort to make the touch stack on Linux easily accessibly by developers.

Deliverables from UDS-N:
 * record input from community on what they would like to see for documentation in OIF framework
 * record input from toolkit devs on what they would like to see for GEIS docs
 * record input from app developers on what docs would make them happiest for developing touch-enabled software
 * record input form OEM Services on what docs they need in order to customize Unity-based touch software/appliances/etc.

Tags: hci-n, hci, touch, multi-touch, multitouch, documentation, best-practices, policy, development-process

Blueprint information

Status:
Not started
Approver:
PS Project Management Team
Priority:
Undefined
Drafter:
None
Direction:
Needs approval
Assignee:
PS Project Management Team
Definition:
New
Series goal:
None
Implementation:
Unknown
Milestone target:
None

Related branches

Sprints

Whiteboard

Scheduling Notes:
  * since we need to coordinate with some community members first, let's have this session Weds. or later

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.