KDE TechBase is a Wiki - You can help! Please contribute! Questions?
Projects/Oxygen/Sound Theme Naming Specification
- NOTE - This section is under HEAVY development. Keep it as an orphaned page for the time being.
Contents |
[edit] 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.
[edit] Context
The contexts for a sound theme are (these are more or less placeholders as this schema is sorted out):
| 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 |
[edit] System Events
A list for now
- Network events
- Critical Stop
- Default Beep
- Show Toolbar
- System Notification
| 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 | KDE-Sys-Log-In-Short.ogg | yes |
| Logoff | User Logoff | Informational | KDE-Sys-Log-Out.ogg | yes |
| Logon Error | Wrong Username or Password | Error | KDE-Sys-App-Error.ogg | yes |
| Critical Error | Critical error occurred | Error | KDE-Sys-App-Error.ogg | yes |
| Information | General information pops-up | Informational | KDE-Sys-Message.ogg | yes |
| Print Error | Error before or wile printing | Error | KDE-Sys-Error-Printing.ogg | yes |
| Question Asked | Question is beeing asked | Question | KDE-Sys-Question.ogg | yes |
| Serious Error | Serious Error forcing app to quit | Error | KDE-Sys-App-Error-Serious.ogg | yes |
| Warning | Warning pops up | Attention | KDE-Sys-Warning.ogg | yes |
| No Matching Completion | No match in list (e.g. Search) | Informational | KDE-Sys-List-Match-No-ogg | yes |
| Something Special in App | App returns a special message | Informational | KDE-Sys-App-Special.ogg | yes |
| End of List | End of list reached | Informational | KDE-Sys-List-End.ogg | yes |
| More then one match | Multiple matches in list | Informational | KDE-Sys-List-Match-Multiple.ogg | |
| Error in app | App returns an error | Error | KDE-Sys-App-Error.ogg | yes |
| Very serious error | Very serious Error forcing app to quit | Error | KDE-Sys-App-Error-Serious-Very.ogg | yes |
| Cannot open file | Can't open one or more files | Error | KDE-Sys-File-Open-Foes.ogg | yes |
| Trash Emptied | Empty Trash | Attention | KDE-Sys-Trash-Emptied.ogg | yes |
[edit] User Interface Events
[edit] Desktop UI
| Name | Description | Filename |
|---|---|---|
| Minimize | ||
| Minimize to Tray | ||
| Maximize | ||
| Restore | ||
| Restore from Tray | ||
| Shade Up | ||
| Shade Down | ||
| Icon Hover | ||
| Icon Select |
[edit] 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 |
[edit] Application Level Events
[edit] Communication Events
| Name | Description | Type | Filename | Default |
|---|---|---|---|---|
| New Email | New email message is received | Informational | KDE-Im-New-Mail.ogg | yes |
| Incomming Message | New instant message is received | Informational | KDE-Im-Message-New.ogg | |
| Outgoing Message | Message sent | Informational | KDE-Im-Message-Out.ogg | yes |
| Nudge | Nudge Received | Adhoc | KDE-Im-Nudge.ogg | yes |
| Highlighted message received | Message with highlight word received | Attention | KDE-Im-Highlight-Msg.ogg | yes |
| Low Priority Message | Low priority message received | Informational | KDE-Im-Low-Priority.ogg | |
| Error Connecting | Error during connection | Error | KDE-Im-Error-On-Connection.ogg | yes |
| New Message Alert | New chat started with incomming message | Attention | KDE-Im-Msg-New.ogg | yes |
| User AuthoArization Action | Authorization Clearance | Question | KDE-Im-User-Auth.ogg | yes |
| Can't connect | Can't Connect to Service | Error | KDE-Im-Cant-Connect.ogg | yes |
| Network Problems | Network problem identified | Error | KDE-Im-Network-Problems.ogg | yes |
| Contact Online | Contact is now online | Informational | KDE-Im-Contact-In.ogg | |
| Contact Offline | Contact goes offline | Informatonal | KDE-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.
[edit] Miscellaneous and Cross-Category Events
- Successful (cd burn, file transfer, etc. Possibly separate these)
| Name | Description | Type | Filename | Default |
|---|---|---|---|---|
| Insert Medium | User needs to insert medium | Attention | KDE-K3B-Insert-Medium.ogg | yes |
| Burn failed | The burn process failed | Error | KDE-K3B-Finish-Error.ogg | yes |
| Burn successful | Burn Process successful | Informational | KDE-K3B-Finish-Success.ogg | yes |
[edit] 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 |