From 97ed5a2bdd0f1ae3c9d0799c3d7dcc78366fdb60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guido=20G=C3=BCnther?= Date: Sun, 29 Sep 2024 11:28:28 +0200 Subject: [PATCH] event-naming-spec: Copy-edit Gbp-Dch: Ignore --- doc/Event-naming-spec-0.0.0.md | 61 +++++++++++++++++----------------- 1 file changed, 30 insertions(+), 31 deletions(-) diff --git a/doc/Event-naming-spec-0.0.0.md b/doc/Event-naming-spec-0.0.0.md index d8fbcf3..5d7d656 100644 --- a/doc/Event-naming-spec-0.0.0.md +++ b/doc/Event-naming-spec-0.0.0.md @@ -23,7 +23,7 @@ The list of default contexts for the feedback theme are: - Notifications: Events to trigger feedback to notify the user that the system, or their current use case has changed state in some way, e.g. new email arriving -- Actions: Event that notify the user on their actions. +- Actions: Event that notify the user on their actions. - Input Event: This triggers feedbacks that give direct response to input events from the user, such as key presses on an on screen keyboard @@ -61,31 +61,31 @@ These events are meant to be used by applications. #### Notifications -- camera-focus: The event used when the camera got focus. -- camera-shutter: The event used when a photo was taken. -- message-new-instant: The event used when a new IM is received. -- message-new-sms: The event used when a new sms is received. -- message-new-email: The event used when a new email is received. -- message-missed-email: The event used when an email was received but not seen by the user. -- message-missed-instant: The event used when a instant message was received but not seen by the user. -- message-missed-notification: The event used when a notification was shown but not seen by the user. -- message-missed-sms: The event used when a sms message was received but not seen by the user. -- phone-incoming-call: The event used when a phone/voip call is coming in. -- phone-missed-call: The event used when a phone/voip call is was incoming but not answered. -- phone-outgoing-busy: The event used when for outgoing phone/voip call when the responder is busy/not available. -- phone-hangup: The event used when a phone/voip call is hung up. -- phone-failure: The event used when a phone/voip call is terminated because of a failure. -- alarm-clock-elapsed: A user configured alarm elapsed. -- timeout-completed: A user configured timeout completed (e.g. a stop watch). +- *camera-focus*: The event used when the camera got focus. +- *camera-shutter*: The event used when a photo was taken. +- *message-new-instant*: The event used when a new IM is received. +- *message-new-sms*: The event used when a new sms is received. +- *message-new-email*: The event used when a new email is received. +- *message-missed-email*: The event used when an email was received but not seen by the user. +- *message-missed-instant*: The event used when a instant message was received but not seen by the user. +- *message-missed-notification*: The event used when a notification was shown but not seen by the user. +- *message-missed-sms*: The event used when a sms message was received but not seen by the user. +- *phone-incoming-call*: The event used when a phone/voip call is coming in. +- *phone-missed-call*: The event used when a phone/voip call is was incoming but not answered. +- *phone-outgoing-busy*: The event used when for outgoing phone/voip call when the responder is busy/not available. +- *phone-hangup*: The event used when a phone/voip call is hung up. +- *phone-failure*: The event used when a phone/voip call is terminated because of a failure. +- *alarm-clock-elapsed*: A user configured alarm elapsed. +- *timeout-completed*: A user configured timeout completed (e.g. a stop watch). #### Actions -- message-sent-instant: The sound used when a new IM is sent. +- *message-sent-instant*: The sound used when a new IM is sent. #### Input Events -- button-pressed: The event used when a button is pressed. -- button-released: The event used when a button is released. +- *button-pressed*: The event used when a button is pressed. +- *button-released*: The event used when a button is released. ### System Components @@ -93,9 +93,9 @@ These events are meant to be used by system components. #### Actions -- bell-terminal: The sound to use as a terminal bell. -- screen-capture: A screenshot was made -- theme-demo: A event that should be played for demoing this theme. Usually +- *bell-terminal*: The sound to use as a terminal bell. +- *screen-capture*: A screenshot was made +- *theme-demo*: A event that should be played for demoing this theme. Usually this should just be an alias for a very representative sound (such as a incoming phone call) of a theme that would work nicely as a demo event for a theme in the theme selector dialog. @@ -107,16 +107,15 @@ These events are meant to be used by system components. #### Notifications -- battery-caution: The event used when the battery is nearing exhaustion (below 40%, for example). -- battery-full: The event used when the battery is fully loaded up. -- device-added: The event used when a device has become available to the desktop, i.e. due to USB plugging. -- message-new-cellbroadcast: The event used when a new cell broadcast message is received. -- power-plug: The power cable has been plugged in. -- power-unplug: The power cable has been unplugged. +- *battery-caution*: The event used when the battery is nearing exhaustion (below 40%, for example). +- *battery-full*: The event used when the battery is fully loaded up. +- *device-added*: The event used when a device has become available to the desktop, i.e. due to USB plugging. +- *message-new-cellbroadcast*: The event used when a new cell broadcast message is received. +- *power-plug*: The power cable has been plugged in. +- *power-unplug*: The power cable has been unplugged. #### Input Events -- window-close: The sound used when an existing window is closed. - +- window-close: The sound used when an existing window is closed. [Sound naming spec]: http://0pointer.de/public/sound-naming-spec.html