1This is similar in spirit (and heavily based on) to the [Sound naming spec][]. 2 3# Overview 4 5This specification gives direction on how to name the Event types 6(triggering feedbacks such as running the haptic motor or blinking an 7LED) that are available for use by applications, when creating a 8feedback theme. It does so by laying out a standard naming scheme for 9Event creation, as well as providing a minimal list of must have 10Events, and a larger list with many more examples to help with the 11creation of extended Events for third party applications, with 12different event types and usage. 13 14# Context 15 16The list of default contexts for the feedback theme are: 17 18- Alerts: Events to alert the user of an action or event which may 19 have a major impact on the system or their current use 20- Notifications: Events to trigger feedback to notify the user that 21 the system, or their current use case has changed state in some way, 22 e.g. new email arriving 23- Actions: Event that notify the user on their actions. 24- Input Event: This triggers feedbacks that give direct response to 25 input events from the user, such as key presses on an on screen 26 keyboard 27 28# Event naming guides 29 30Here we define some guidelines for when creating new Event names 31that extend the standardized list of Event names defined here, in 32order to provide Events for more specific events and usages. 33 34Event names are in the en_US.US_ASCII locale. This means that the 35characters allowed in the Event names must fall within the US-ASCII 36character set. As a further restriction, all Event names may only 37contain lowercase letters, numbers, underscore, dash, or period 38characters. Spaces, colons, slashes, and backslashes are not 39allowed. Also, sound names must be spelled as they are in the en_US 40dictionary. 41 42Events for branded applications should be named the same as the binary 43executable for the application, prefixed by the string “x-”, to avoid 44name space clashes with future standardized names. Example: 45“x-openoffice-foobar”. 46 47## Standard Event names 48 49This section describes the standard Event names that should be used 50by artists when creating themes, and by developers when writing 51applications which will use the Feedback Theme Specification. 52 53### Alerts 54 55- battery-low: The Event used when the battery is low (below 20%, for example). 56- power-unplug-battery-low: The power cable has been unplugged and the battery level is low. 57 58### Notifications 59 60- camera-focus: The event used when the camera got focus. 61- camera-shutter: The event used when a photo was taken. 62- message-new-instant: The event used when a new IM is received. 63- message-new-sms: The event used when a new sms is received. 64- message-new-email: The event used when a new email is received. 65- message-missed-email: The event used when an email was received but not seen by the user. 66- message-missed-instant: The event used when a instant message was received but not seen by the user. 67- message-missed-notification: The event used when a notification was shown but not seen by the user. 68- message-missed-sms: The event used when a sms message was received but not seen by the user. 69- phone-incoming-call: The event used when a phone/voip call is coming in. 70- phone-missed-call: The event used when a phone/voip call is was incoming but not answered. 71- phone-outgoing-busy: The event used when for outgoing phone/voip call when the responder is busy/not available. 72- phone-hangup: The event used when a phone/voip call is hung up. 73- phone-failure: The event used when a phone/voip call is terminated because of a failure. 74- battery-caution: The event used when the battery is nearing exhaustion (below 40%, for example). 75- battery-full: The event used when the battery is fully loaded up. 76- device-added: The event used when a device has become available to the desktop, i.e. due to USB plugging. 77- power-plug: The power cable has been plugged in. 78- power-unplug: The power cable has been unplugged. 79- alarm-clock-elapsed: A user configured alarm elapsed. 80- timeout-completed: A user configured timeout completed (e.g. a stop watch). 81 82### Actions 83 84- message-sent-instant: The sound used when a new IM is sent. 85- bell-terminal: The sound to use as a terminal bell. 86- theme-demo: A event that should be played for demoing this theme. Usually 87 this should just be an alias for a very representative sound (such as 88 a incoming phone call) of a theme that would work nicely as a demo event for 89 a theme in the theme selector dialog. 90 91### Input Event 92 93- button-pressed: The event used when a button is pressed. 94- button-released: The event used when a button is released. 95- window-close: The sound used when an existing window is closed. 96 97[Sound naming spec]: http://0pointer.de/public/sound-naming-spec.html 98