From d002ad9479035f773641d07d0dad54c1d1e207ff Mon Sep 17 00:00:00 2001 From: Marc-Andre Lureau Date: Tue, 12 Feb 2008 12:58:15 +0200 Subject: add sound-naming spec --- Makefile.in | 2 +- spec/sound-naming-spec.xml | 411 +++++++++++++++++++++++++++++++++++++++++++++ spec/sound-theme-spec.xml | 4 +- 3 files changed, 414 insertions(+), 3 deletions(-) create mode 100644 spec/sound-naming-spec.xml diff --git a/Makefile.in b/Makefile.in index 1a2e9fd..7af9792 100644 --- a/Makefile.in +++ b/Makefile.in @@ -10,7 +10,7 @@ distdir = $(PACKAGE)-$(VERSION) FILES = README Makefile.in configure.ac configure install-sh index.theme ChangeLog COPYING SOUND_SYSTEM = stereo 5.1 -SOUND_CONTEXTS = alert games notification support +SOUND_CONTEXTS = alert game notification support all: @: diff --git a/spec/sound-naming-spec.xml b/spec/sound-naming-spec.xml new file mode 100644 index 0000000..286ddc7 --- /dev/null +++ b/spec/sound-naming-spec.xml @@ -0,0 +1,411 @@ + + +
+ + Sound Naming Specification + Version 0.1 + February 12 2008 + + + Marc-Andre + Lureau + +
+ marc-andre.lureau@nokia.com +
+ + + + + + + Overview + +This specification gives direction on how to name the sounds that are +available for use by applications, when creating a sound theme. It +does so by laying out a standard naming scheme for sound creation, as +well as providing a minimal list of must have sounds, and a larger +list with many more examples to help with the creation of extended +sounds for third party applications, with different event types and +usage. + + + + + Context + + + The list of default Contexts for the sound theme are: + + + + Standard Contexts + + + + + Name + Description + Directory + + + + + Alert + + Sounds to alert the user of an action or event which may + have a major imact on the system or their current use + case, such as dialog-error. + + altert + + + Notification + + Sounds to notify the user that the system, or their + current use case has changed state in some way, e.g. new + email arriving, new non-critical update available... + + notification + + + Support + + Sounds that give the user feedback on their + actions. Sounds on window opening / closing for example. + + support + + + Game + + Sound used in games. + + game + + + +
+ + + + Sound Naming Guidelines + + + Here we define some guidelines for when creating new sounds that + extend the standardized list of sound names defined here, in + order to provide sounds for more specific events and usages. + + + + Sound names are in the en_US.US_ASCII locale. This means + that the allowable characters in the sound names, must + fall withing the US-ASCII character set. As a further + restriction, all sound names may only contain lowercase + letters, numbers, underscore, dash, or period + characters. Spaces, colons, slashes, and backslashes are + not allowed. Also, sound names must be spelled as they are + in the en_US dictionary. + + + + + The dash - character is used to separate + levels of specificity in sound names. For instance, we + use search-results as the generic item for all + mouse devices, and we use search-results-empty + for a USB mouse device. However, if the more specific item + does not exist in the current theme, and does exist in a + parent theme, the generic sound from the current theme is + preferred, in order to keep consistent style. + + + + + Sounds for branded applications should be named the same + as the binary executable for the application. + + + + + + + + Standard Sounds Names + + + This section describes the standard sounds names that should be + used by artists when creating themes, and by developers when + writing applications which will use the Sound Theme + Specification. + + + + Alerts + + This is to notify the user of an action or event which may + have a major imact on the system or their current use case. + + + + Standard Alerts Sounds + + + + Name + Description + + + + + network-error + + The sound used when an error occurs trying to intialize + the network connection of the computing device. + + + + dialog-error + + The sound used when a dialog is opened to explain an + error condition to the user. + + + + battery-low + + The sound used when the battery is low (below 20%, for + example). + + + + software-update-urgent + + The sound used when an urgent update is available + through the system software update program. + + + + +
+ + + + Notifications + + This is to alert the user that the system, or their current + use case has changed state in some way - mew email arriving, + new non-critical update to an application available. + + + + Standard Notifications Sounds + + + + Name + Description + + + + + search-results + + The sound used when one or more search results are + returned. + + + + search-results-empty + + The sound used when no search results are returned. + + + + system-lock-screen + + The sound used when the user locks their current + session. + + + + system-log-out + + The sound used when a user logs into the system or a + service (i.e. desktop login) + + + + system-log-in + + The sound used when a user logs out of the system or a + service (i.e. Gaim logout) + + + + battery-caution + + The sound used when the battery is (below 40%, for + example). + + + + dialog-information + + The sound used when a dialog is opened to give + information to the user that may be pertinent to the + requested action. + + + + software-update-available + + The sound used when an update is available for + software installed on the computing device, through + the system software update program. + + + + +
+ + + + Support + + This is to alert the user that the system, or their current + use case has changed state in some way - mew email arriving, + new non-critical update to an application available. + + + + Standard Support Sounds + + + + Name + Description + + + + + message-new + + The sound used when a new IM or email is recieved. + + + + message-sent + + The sound used when a new IM or email is sent. + + + + window-new + + The sound used when a new window or dialog is opened. + + + + window-close + + The sound used when an existing window is closed. + + + + dialog-ok + + The sound used for the OK button that might appear in + dialog windows. + + + + dialog-cancel + + The sound used for the Cancel button that might appear + in dialog windows. + + + + drag-accept + + The sound used when a file is accepted by a window, + such as a folder or IM conversation. + + + + trash-empty + + The sound used when the user emptys the trash. + + + + file-sendto-trash + + The sound used when a file or folder is sent to the + trash. + + + + +
+ + + + Game + + This is to alert the user that the system, or their current + use case has changed state in some way - mew email arriving, + new non-critical update to an application available. + + + + Standard Games Sounds + + + + Name + Description + + + + + game-over + + Guess what...! + + + + +
+ + + + + + Background + + The sound naming specification is heavily based on the "Sound + Naming Specification" by Rodney Dawes and the "Bango Project" + started by Jon Bolt. + + + + + Change History + + Version 0.1, February 12 2008, Marc-Andre Lureau + + + + + Created initial draft. + + + + + + +
diff --git a/spec/sound-theme-spec.xml b/spec/sound-theme-spec.xml index c6f3a04..d7efc5b 100644 --- a/spec/sound-theme-spec.xml +++ b/spec/sound-theme-spec.xml @@ -370,7 +370,7 @@ - Games + Game Sounds used for games. @@ -600,7 +600,7 @@ Loop=yes Background - The sound theme specification is based on the "Icon Theme + The sound theme specification is heavily based on the "Icon Theme Specification" by Alexander Larsson and Frans Englich. -- cgit