2.0Spec

API Specification

Stephen M. Webb

Canonical Ltd.

Version 2.0


Chapter 1. Overview and Scope

Table of Contents

Introduction
Rationale

This document describes geis, an interface between an application and an underlying gesture recognition system.

Introduction

A GEIS implementation provides a mechanism for recognizing user interface gestures on various configurable devices and for propagating those recognized gestures to subscribed applications.

Rationale

The purpose of geis is to provide a consistent and stable application programming interface for gesture recognition and propagation on multiple target platforms (for example, Linux, Unix, and Windows), multiple target input devices (for example mice, touch pads, mutitouch touchscreens, tables, nunchuks), and multiple alternative gesture recognition engines. Different gesture engines may be available on the same platform.

To the extent possible, geis itself is independent of definitions and concepts specific to any native input systems or display or other feedback systems. there are, however, some places where native concepts must be mapped to the more abstract geis concepts, including the definition of native windows used for constraining gesture recognition on input devices to a specific region.

Chapter 2. Operation

The general usage of geis is the following sequence of operations.

  1. initialize geis
  2. enumerate the available gesture-capable input devices
  3. enumerate the available gesture types
  4. create gesture regions
  5. create gesture filters for various input devices, gesture types, and regions
  6. create gesture subscriptions for various filters
  7. add gesture subscriptions to geis
  8. main loop: handle gesture and touch events
  9. dispose of geis

Chapter 3. Interface

General Types

This specification makes use of several basic types that are defined more exactly by the language bindings.

The fundamental basic types include the following.

string

textual data

boolean

values on the range [true, false]

cardinal

integral numeric values

real

real-valued numeric values

The compound fundamental type include the following.

listOf ..

a collection of ..

rangeOf

an ordered pair of .. indicating the range [min, max]

Geis

The geis object encapsulates an instance of the underlying API implementation. Because it may be necessary to allocate (and deallocate) resources, such as network connections or dynamically loaded objects, the API implementation is given object semantics to allow control of resource allocation or deallocation by the application.

State Variables

The geis object has a number of implicit state variables acessible through the configuration interface. In addition, there is an implicit event queue state variable. None of these implicit state variables are a part of the specified public interface of the geis object except as documented under Actions below.

Actions

Open

Creates and initializes a geis instance.

This Action could be implemented as an object constructor in some language bindings.

Arguments
NameData TypeDirection
hints_inGeisHintsin
hints_outGeisHintsout
hints_in

Hints as to desired runtime configuration of geis.

hints_out
Actual runtime configuration of geis.
Effects on State
Initializes the underlying geis API implementation.
Errors

(to be documented)

Close

Closes and destroys a geis instance.

This Action could be implemented as an object destructor or finalizer in some language bindings.

Arguments

The CloseGeis action takes no arguments.

Effects on State
The geis API instance is destroyed and any allocated resources are freed. The geis instance is not longer valid after performing this action. Any subsequent actions performed on this geis instance or any related sub-objects is an error and results are undefined.
Errors

(to be documented)

GetConfiguration

Gets a configuration value from the underlying geis implementation.

Arguments
NameData TypeDirection
config_itemcardinalin
config_value(1)out
config_item

Identifies the confiuration item to retrieve.

Available configuration items should be documented with the actual implemntation and are not a part of this specification.

config_value

The configuration value retrieved.

The type of the configuration value depends on the particular configuration item retrieved.

Effects on State

(to be documented)

Errors

(to be documented)

SetConfiguration

Sets a configuration value from the underlying geis implementation.

Arguments
NameData TypeDirection
config_itemcardinalin
config_value(1)in
config_item

Identifies the confiuration item to retrieve.

Available configuration items should be documented with the actual implemntation and are not a part of this specification.

config_value

The configuration value to set.

The type of the configuration value depends on the particular configuration item retrieved.

Effects on State

(to be documented)

Errors

(to be documented)

AddSubscription

Adds a subscription.

Arguments
NameData TypeDirection
subscription_idcardinalin
subscription_id

Identifies the subscription to be added.

Effects on State
Subscriobes to a set or subset of gestures in the underlying gesture recognition pipeline.
Errors

(to be documented)

RemoveSubscription

Removed an identified subscription from the recognition pipeline.

Arguments
NameData TypeDirection
subscription_idcardinalin
subscription_id

Identifies the subscription to be removed.

Effects on State
Removes the identified subscription from the underlying gesture recognition pipeline.
Errors

(to be documented)

DispatchEvents

Pumps the internal event loop in the geis instance.

Arguments
NameData TypeDirection
eventGeisEventout
event

Next event, if any.

Effects on State

Performs internal event dispatch.

Errors

(to be documented)

Attributes

State Variables

NameData TypeAllowed ValuesDefault Value
attr_typeGeisAttrTypen/an/a
attr_namestringn/an/a
attr_value(1)n/an/a

Actions

Input Devices

All gestures originate through gesture-capable input devices. Such devices might include mice, touchscreens, touchpads, tables, gloves, or other manipulation devices.

An application may choose to accept gestural input from any capable input device or to limit gesture input to that from one or a select few input devices, as required. To allow this, the geis API delivers events indicating the availability, or unavailability, of all capable device and the application may decide to include the devices in the list of those of interest as it sees fit. Each gesture device event delivered contains a list of zero or more attributes the application may use to make this decision.

Input devices may be capable of appearing or disappearing dynamically during the life of an application.

There are two main classes of input devices: relative (such as mice or trackpads) and absolute (such as touchscreens).

State Variables

NameData TypeAllowed ValuesDefault Value
device_idcardinaln/an/a
device_namestringn/an/a
device_attr_countcardinaln/an/a
device_attrslistOf GeisAttrdevice attributesn/a

device_id

Uniquely identifies the particular gesture-capable input device.

device_name

The name of the gesture-capable input device as given by the system. The input device name is not guarantted to be unique.

device_attr_count

The number of GeisAttr values in the device_attrs list.

device_attrs

A collection of device attributes as identified by the system.

Actions

There are no specified actions that may be performed on input devices.

Events

The following events related to input devices may be received any time between geis open and close actions.

GeisInputDeviceAvailable

Indicates a new gesture-capable input device has become available. Applications may choose to modify existing filters to add the new device, and may wish to track available input devices explicitly.

GeisInputDeviceUnavailable

Indicates a gesture-capable input device has become unavailble. The device will automatically be removed from existing filters. This event is delivered to applications in case they are explicitly tracking available input devices.

Gesture Types

A gesture type is a defined sequence of gestural actions with specific relations to each other. For example, a pinch gesture type applies to a gesture in which two or more touches are moving toward (or away from) each other, whereas a drag gesture has one or more touches moving approximately parallel to each other.

Gesture types are defined by the underlying gesture recognition engine and, if available, any programmable gesture recognition engine present. Gesture types are mae available to the application to allow for only a subset of available gesture types to be chosen for recognition.

State Variables

NameData TypeAllowed ValuesDefault Value
type_idcardinaln/an/a
type_namestringn/an/a
type_attr_countcardinaln/an/a
type_attrslistOf GeisAttrgesture type attributesn/a

type_id

Uniquely identifies the gesture type. The gesture type id is generated by the system.

type_name

A user-friendly gesture type name. The gesture type name is not guaranteed to be unique. It is determined by elements of the udnerlying gesture recognition pipeline (fixed or programmable) and may be localized.

type_attr_count

The number of gesture type attributes in type_attrs.

type_attrs

A list of GeisAttrs associated with the identified gesture type. A given gesture instance may or may not have all of the gesture attributes enumerated in this list.

Actions

There are no specified actions that may be performed on gesture types.

Events

The following events related to gesture types may be received any time between geis open and close actions.

GeisGestureTypeAvailable

Indicates a new gesture type has become available. Applications may choose to modify existing filters to add the new gesture type, and may wish to track available gesture types explicitly.

During noremal geis operation, a separate event for each gesture type defined in the fixed recognition pipeline should be delivered prior to setting any subscriptions. Gesture types defined in the programmable recognition pipeline may appear and disappear at any time as programs are loaded or unloaded.

GeisGestureTypeUnavailable

Indicates a gesture type has become unavailable. This event is not expected to be delivered if only a fixed recognition pipeline is available, but may be delivered if a programmable recognition pipeline is in use.

Regions

Regions are used to describe feeback areas (for example, windows on a screeen) in which gestural input is accepted.

An application is very likely, but not required, to limit its acceptance of gestures to those performed in its own feedback regions. For example, most applications would be ibnterested only in those gestures performed within its own windows on the screen.

State Variables

NameData TypeAllowed ValuesDefault Value
region_idcardinaln/an/a

region_id

Uniquely identifies the particular region. Generated automatically on creation of the region.

Actions

CreateRegion

Arguments

(to be documented)

Effects on State

(to be documented)

Errors

(to be documented)

DestroyRegion

Arguments

(to be documented)

Effects on State

(to be documented)

Errors

(to be documented)

Filters

Filters are use to limit the gestures recognized by the underlying gesture recognition pipeline in some way.

State Variables

NameData TypeAllowed ValuesDefault Value
filter_idcardinaln/an/a

filter_id

Uniquely identifies the particular filter. Generated automatically on creation of the filter.

Actions

CreateFilter

Creates a new empty filter object. This action may be implemnted as a class constructor by the language bindings.

Arguments
This action requires no arguments.
Effects on State

Creates a new filter object.

Errors
(to be documented)

DestroyFilter

Destroys an existing filter object. This action may be implemnted as a class destructor or finalizer by the language bindings.

Arguments
NameData TypeDirection
filter_idcardinalin
filter_id
Identifies the filter to destroy.
Effects on State

Destroys an identified filter object. Further operations on the filter object are invalid and will raise an error condition.

Destroyed filters will be automatically removed from any subscriptions to which they have been added.

Errors
(to be documented)

AddInputDevice

Adds an input device to the filter. A filter will allow gestures only from those input devices explicitly added.

Arguments
NameData TypeDirection
device_idcardinalin
device_id

Identifies the input device to be added.

The special value GEIS_ALL_INPUT_DEVICES may be used to create a filter that will allow gestures from all available input devices.

The default action of a filter is to allow no input devices to be used for gesture recognition.

Effects on State
(to be documented)
Errors

(to be documented)

RemoveInputDevice

Removes an input device froms the filter.

Arguments
NameData TypeDirection
device_idcardinalin
device_id
Identifies the input device to be removed.
Effects on State
Errors

(to be documented)

AddGestureType

Arguments

Adds gesture type to the filter. A filter will allow gesture of only those types that have been added.

NameData TypeDirection
type_idcardinalin
type_id

Identifies the gesture type to add to the filter.

The special value GEIS_ALL_GESTURE_TYPES may be used to create a filter that will allow gestures of all available types.

The default action of a filter is to allow no gesture types to be recognized.

Effects on State
(to be documented)
Errors

(to be documented)

RemoveGestureType

Arguments

Removes a gesture type from the filter.

NameData TypeDirection
type_idcardinalin
type_id
Identifies the gesture_type to remove from the filter.
Effects on State
(to be documented)
Errors

(to be documented)

AddRegion

Arguments

Adds a region to the filter. A filter will aloow gesture only on those regions added.

NameData TypeDirection
region_idcardinalin
region_id
Identifies the region to be added to the filter.
Effects on State
(to be documented)
Errors

(to be documented)

RemoveRegion

Arguments

Removes a region from the filter.

NameData TypeDirection
region_idcardinalin
region_id
Identifies the region to be removed from the filter.
Effects on State
(to be documented)
Errors

(to be documented)

Subscriptions

Subscriptions are aggregates of one or more filters, with optional flags, indicating to geis which gestures should be propagated.

State Variables

NameData TypeAllowed ValuesDefault Value
subscription_idcardinaln/an/a
subscription_flagssee belowsee belowGEIS_SUBSCRIPTION_NONE

subscription_id

Uniquely identifies the particular subscription. Generated automatically on creation of the subscription.

Actions

CreateSubscription

Creates a new empty subscription object. This action may be implemnted as a class constructor by the language bindings.

Arguments
NameData TypeDirection
subscription_flags(1)in
subscription_flags

Indicates special subscription actions. Flag values may be logically ored together.

The following flags are defined.

NameDescription
GEIS_SUBSCRIPTION_NONE

No special handling.

GEIS_SUBSCRIPTION_GRAB

Grabs all filtered gestures, even from any subregions.

GEIS_SUBSCRIPTION_CONT

Sends gesture continuations.

Effects on State

Creates a new subscription object with a unique sunscription_id.

Errors

(to be documented)

DestroySubscription

Destroys an existing subscription. This action may be implemnted as a class destructor or finalizer by the language bindings.

Arguments
NameData TypeDirection
subscription_idcardinalin
subscription_id
Identifies the subscription to destroy.
Effects on State

Destroys an identified subscription. Further operations on the subscription are invalid and will raise an error condition.

Filters associated with the subscription remain valid.

Errors

(to be documented)

AddFilter

Adds a filter to the subscription.

Arguments
NameData TypeDirection
filter_idcardinalin
filter_id
Identifies the filter to be added.
Effects on State

(to be documented)

Errors

(to be documented)

RemoveFilter

Removes an filter from the subscription.

Arguments
NameData TypeDirection
filter_idcardinalin
filter_id
Identifies the filter to be removed.

Events

During initial geis setup, events will be delivered to indicate the availability of various input devices and gesture types. Once subscriptions are in place, additional events will indicate gesture transitions and, possibly, other touch events.

Events have an event type and a list of attributes specific to each type, as documented below.

State Variables

NameData TypeAllowed ValuesDefault Value
event_typeGeisEventTypen/an/a

event_type

Distinguishes the type of the event received. GeisEventType has at least the following values.

NameDescription
GEIS_EVENT_DEVICE_AVAILABLE

A new gesture-capable input device has become available.

GEIS_EVENT_DEVICE_UNAVAILABLE

A gesture-capable input device has become unavailable.

GEIS_GESTURE_TYPE_AVAILABLE

A new gesture type has become available.

GEIS_GESTURE_TYPE_UNAVAILABLE

A gesture type has become unavailable.

GEIS_EVENT_GESTURE_STARTED

A new gesture has started.

GEIS_EVENT_GESTURE_UPDATED

A gesture has updated its state.

GEIS_EVENT_GESTURE_FINISHED

A gesture has updated its state and has been recognized as finishing.

GEIS_EVENT_TOUCH

Reports touch events that are not part of a recognized gesture.

GEIS_EVENT_ERROR

An error has been detected in the underlying gesture recognition pipeline.

Actions

Appendix A. Input Device Attributes

Appendix B. Gesture Attributes

Attribute NameAttribute TypeDescription
gesture idcardinal

Uniquely identifies the gesture instance.

anglereal

(to be documented)

angle deltareal

(to be documented)

angular velocityreal

(to be documented)

boundingbox x1real

(to be documented)

boundingbox y1real

(to be documented)

boundingbox x2real

(to be documented)

boundingbox y2real

(to be documented)

child window idcardinal

(to be documented)

delta xreal

(to be documented)

delta yreal

(to be documented)

device idcardinal

(to be documented)

event window idcardinal

(to be documented)

focus xreal

(to be documented)

focus yreal

(to be documented)

gesture namestring

The name of the gesture type of the current gesture event.

position xreal

(to be documented)

position yreal

(to be documented)

radial velocityreal

(to be documented)

radius deltareal

(to be documented)

radiusreal

(to be documented)

root window idcardinal

(to be documented)

timestampreal

(to be documented)

touchescardinal

(to be documented)

velocity xreal

(to be documented)

velocity yreal

(to be documented)

Appendix C. Gesture Primitives

Table of Contents

Drag
Pinch
Rotate
Tap

Drag

(to be documented)

Pinch

(to be documented)

Rotate

(to be documented)

Tap

(to be documented)

Appendix D. GNU Free Documentation License

Version 1.3, 3 November 2008

Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document “free” in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

The “publisher” means any person or entity that distributes copies of the Document to the public.

A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

  1. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
  2. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
  3. State on the Title page the name of the publisher of the Modified Version, as the publisher.
  4. Preserve all the copyright notices of the Document.
  5. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
  6. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
  7. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
  8. Include an unaltered copy of this License.
  9. Preserve the section Entitled “History”, Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled “History” in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
  10. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the “History” section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
  11. For any section Entitled “Acknowledgements” or “Dedications”, Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
  12. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
  13. Delete any section Entitled “Endorsements”. Such a section may not be included in the Modified Version.
  14. Do not retitle any existing section to be Entitled “Endorsements” or to conflict in title with any Invariant Section.
  15. Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties — for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements”.

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See Copyleft.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

11. RELICENSING

“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.

“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

ADDENDUM: How to use this License for your documents

To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:

Copyright © YEAR YOUR NAME

Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.3 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in
the section entitled “GNU Free Documentation License”.

If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with… Texts.” line with this:

with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts
being LIST, and with the Back-Cover Texts being LIST.

If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.

If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.

Multitouch/APIs/GEIS/2.0Spec (last edited 2010-10-22 15:00:55 by host194)