Difference between revisions of "Projects/Oxygen/Sound Theme Naming Specification"

Revision as of 17:30, 30 July 2007

NOTE - This section is under HEAVY development. Keep it as an orphaned page for the time being.

Overview

Sound is an important element used to communicate with users. It is important, then, that there be a unified and simplified way of organizing sounds. It should not be forgotten that the sounds should integrate with the looks of KDE4, they need to blend in.

Context

The contexts for a sound theme are (these are more or less placeholders as this schema is sorted out):

Table 1. Sound Theme Contexts
Name	Description	Directory
System Events	Sounds which are generally used to notify the user of events relating to the system, ie: startup, warning dialogs, etc	system
User Interface Events	Sounds associated with the desktop environment, such as minimize, shade, or kicker events	ui
Misc. Application Events	Sounds associated with application events, such as a successful cd burn, which don't fit within other categories	application

System Events

A list for now

Network events
Critical Stop
Default Beep
Show Toolbar
System Notification

Table 3. System Events
Name	Description	Type	Filename
Startup	during startup	Adhoc	sys.log.in.ogg
Shutdown	during system shutdown	Adhoc	sys.log.out.ogg
Hibernate	Cumputer Hibernates	Informational
Standby	Cumputer enters standby mode	Informational
Logon	User Logon	Informational
Logoff	User Logoff	Informational
Logon error	Wrong Username or Password	Error

User Interface Events

Desktop UI

Table 3. Desktop UI
Name	Description	Filename
Minimize
Minimize to Tray
Maximize
Restore
Restore from Tray
Shade Up
Shade Down
Icon Hover
Icon Select

Menu UI

Table 3. Menu UI
Name	Description	Filename
Menu Button Select	Selecting the K Menu	menu-button-select
Menu Browse	Browsing through the menu, on a new menu item hover	menu-browse
Menu Item Select	Selecting a menu item	menu-item-select

Application Level Events

Communication Events

Table 3. Communication Events
Name	Description	Filename
New Email	A new email message is received	new-email
New IM	a new instant message is received	new-message
New alert
Name mentioned in chat room?
Connected to messaging service
Disconnected from messaging service
Person Joins
Person Leaves
Receive Call
Receive Request to Join
Contact Online

Miscellaneous and Cross-Category Events

Successful (cd burn, file transfer, etc. Possibly separate these)

Hardware Events

Table 3. Hardware Events
Name	Description	Filename
Battery Charging
Running on AC
Low Battery Alarm
Critical Battery Alarm
Device Connected
Device Disconnected
Device Failed to Connect
Print sent to Queue
Print Complete

References

Tango Icon Specification

@@ Line 31: / Line 31: @@
 {| border="1"
 |+ Table 3.  System Events
-! Name !! Description !! Filename
+! Name !! Description !! Type !! Filename
 |-
-| Startup || during startup || sys.log.in.ogg
+| Startup || during startup || Adhoc || sys.log.in.ogg
 |-
-| Shutdown || during system shutdown || sys.log.out.ogg
+| Shutdown || during system shutdown || Adhoc || sys.log.out.ogg
 |-
-| Hibernate || Cumputer Hibernates ||
+| Hibernate || Cumputer Hibernates || Informational ||
 |-
-| Standby || Cumputer enters standby mode ||
+| Standby || Cumputer enters standby mode || Informational ||
 |-
-| Logon || User Logon ||
+| Logon || User Logon || Informational ||
 |-
-| Logoff || User Logoff ||
+| Logoff || User Logoff || Informational ||
 |-
-| Logon error || Wrong Username or Password ||
+| Logon error || Wrong Username or Password || Error ||
 |}