Changes between Initial Version and Version 1 of Documentation/UserInterface/Preferences/Alerts

Jan 5, 2009 4:41:29 PM (11 years ago)

Adds the alert preferences to the project


  • Documentation/UserInterface/Preferences/Alerts

    v1 v1  
     2''This is part of the [wiki:Documentation Documentation Project], please help document Colloquy if you know anything that would be relevant here for other users to know about.'' 
     4= Alert Preferences = 
     6[[Image(AlertPreferences1-1.png, nolink)]][[BR]] 
     7''Figure 0.1'' 
     9=== 1. Highlight words === 
     10Highlight words is one of our best features. Your current nickname is always a highlight word, so don't bother adding it here. You can add words you would like alerted to in this box. This can be your first name, your program, any word at all. You can also use /regex/ here, if you need a more precise alert. If you need more than one word to highlight, "add quotes" to get them all together. 
     12=== 2. Mute all notification sounds === 
     13Some alerts give off sounds to them. It can be a pain to go through the whole list and disable each sound individually, so we give you the option to turn them all off at once. This also is a great option if you go to work and can't be bothered by sounds, but would like to hear them at home. 
     15=== 3. Chat Event === 
     16[[Image(AlertPreferences1-2.png, nolink)]][[BR]] 
     17''Figure 3.1'' 
     19This gives you the entire list of things you can change the Alert for. You need to have what event you want to add or remove an alert from selected in this drop-down to make changes to it. The one you currently have selected will have a checkmark next to it. Make absolutely sure you have the right event selected before you modify the alerts! 
     21=== 4. Play sound === 
     22[[Image(AlertPreferences1-3.png, nolink)]][[BR]] 
     23''Figure 4.1'' 
     25Sometimes you want to hear a sound for specific events. Checking this will let you choose an array of sound choices, as seen in ''Figure 4.1''. Every time the event goes off, the sound will go off as well. If you check "...only if Colloquy is in the background", the sound will only happen if you are not actively in Colloquy. Please note that if you have "Mute all notification sounds" checked, you will not hear any of these sounds. 
     27=== 5. Bounce Colloquy icon in the Dock === 
     28When the event you are modifying goes off, you may wish to see the Colloquy icon in the Dock bounce to get your attention. This happens by default in the event "Highlight Word Was Mentioned." Using this as an example, when someone mentions my nickname, or a highlight word, Colloquy's icon will bounce. The next option is only available if the Bounce option is turned on. Checking "...repeatedly until Colloquy is in the front." will have the Colloquy icon bounce continously until you click the Colloquy icon, or a Colloquy window. 
     30=== 6. Show event bubble === 
     31[[Image(AlertPreferences1-4.png, nolink)]][[BR]] 
     32''Figure 6.1'' 
     34If you want to see an event bubble, or a <a href="">growl notication</a> when the event you are currently modifying happens, check this box. By default, the alert "Unhandled Notice Message" is turned on. When used, you will get an alert like the one in ''Figure 6.1''. This alert is using Growl, and not the built-in Colloquy bubbles. The options below can further customize this option, and will only be useable when this is turned on. If you d not wish to see the bubble when you are currently in Colloquy, check "...only if Colloquy is in the background." Or perhaps you don't want the bubble to go away until you are done reading it. If that is the case, check "...and keep on screen until activated". The bubble will then stay on screen until you click it.