Projects/Oxygen/Sound Theme Naming Specification

From KDE TechBase
  • 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 2. System Events
Name Description Type Filename Default
Startup during startup Adhoc
Shutdown during system shutdown Adhoc
Hibernate Cumputer Hibernates Informational
Standby Cumputer enters standby mode Informational
Logon User Logon Informational sys.log.in.ogg yes
Logoff User Logoff Informational sys.log.out.ogg yes
Logon Error Wrong Username or Password Error yes
Critical Error Critical error occurred Error sys.error.ogg yes
Information General information pops-up Informational sys.messagem.ogg yes
Print Error Error before or wile printing Error sys.error.print.ogg yes
Question Asked Question is beeing asked Question sys.question.ogg yes
Serious Error Serious Error forcing app to quit Error sys.app.error.serious.ogg yes
Warning Warning pops up Attention sys.warning.ogg yes
No Matching Completion No match in list (e.g. Search) Informational sys.list.match.no.ogg yes
Something Special in App App returns a special message Informational sys.app.special.ogg yes
End of List End of list reached Informational sys.list.end.ogg yes
More then one match Multiple matches in list Informational sys.list.match.multiple.ogg
Error in app App returns an error Error sys.app.error.ogg yes
Very serious error Very serious Error forcing app to quit Error sys.app.error.serious.very.ogg yes
Cannot open file Can't open one or more files Error sys.file.open.foes.ogg yes
Trash Emptied Empty Trash Attention sys.trash.emptied.ogg yes

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 4. 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 5. Communication Events
Name Description Type Filename Default
New Email New email message is received Informational im.new.mail.ogg yes
Incomming Message New instant message is received Informational im.msg.new.ogg
Outgoing Message Message sent Informational im.msg.out.ogg yes
Nudge Nudge Received Adhoc im.nudge.ogg yes
Highlighted message received Message with highlight word received Attention im.highlight.msg.ogg yes
Low Priority Message Low priority message received Informational im.low.priority.ogg
Error Connecting Error during connection Error im.error.on.connection.ogg yes
New Message Alert New chat started with incomming message Attention im.msg.new.ogg yes
User Authorization Action Authorization Clearance Question im.user.auth.ogg yes
Can't connect Can't Connect to Service Error im.cant.connect.ogg yes
Network Problems Network problem identified Error im.network.problems.ogg yes
Contact Online Contact is now online Informational im.contact.in.ogg
Contact Offline Contact goes offline Informatonal im.contact.out.ogg
Call Received Incomming call notification Attention yes
Join Request Received A Join request is received Informational yes
Note
These sounds can and should be used among all KDE communication applications, consider them generic and not application dependent.


Miscellaneous and Cross-Category Events

  • Successful (cd burn, file transfer, etc. Possibly separate these)
Table 6. CD/DVD Recording Actions
Name Description Type Filename
Insert Medium User needs to insert medium Attention k3b.insert.medium.ogg
Burn failed The burn process failed Error k3b.finish.error.ogg
Burn successful Burn Process successful Informational k3b.finish.success

Hardware Events

Table 7. 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