adium 5629:2950ac3f4aa2: Finally some half-decent documentation ...
commits at adium.im
commits at adium.im
Sun Jul 7 12:44:56 UTC 2013
details: http://hg.adium.im/adium/rev/2950ac3f4aa2
revision: 5629:2950ac3f4aa2
branch: adium-1.5.8
author: Robert Vehse <robertvehse at fastmail.fm>
date: Sun Jul 07 14:44:37 2013 +0200
Finally some half-decent documentation on our events system and our visual notifications (Notification Center, Growl and Mist).
diffs (273 lines):
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/DefaultEvents.png
Binary file AdiumHelp/gfx/DefaultEvents.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/GetInfoThirdPane.png
Binary file AdiumHelp/gfx/GetInfoThirdPane.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/Growl notification.png
Binary file AdiumHelp/gfx/Growl notification.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/GrowlNotification1.png
Binary file AdiumHelp/gfx/GrowlNotification1.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/GrowlNotification2.png
Binary file AdiumHelp/gfx/GrowlNotification2.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/MistNotification.png
Binary file AdiumHelp/gfx/MistNotification.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/gfx/NotificationCenterNotification.png
Binary file AdiumHelp/gfx/NotificationCenterNotification.png has changed
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/pgs/AdiumDocumentation.html
--- a/AdiumHelp/pgs/AdiumDocumentation.html Fri Jul 05 22:42:57 2013 +0200
+++ b/AdiumHelp/pgs/AdiumDocumentation.html Sun Jul 07 14:44:37 2013 +0200
@@ -102,13 +102,16 @@
<div class="taskboxtable">
<table width="100%" border="0" cellspacing="0" cellpadding="0" summary="One column table with heading">
<tr>
- <td width="150" rowspan="2" valign="top"><img src="../gfx/Growl notification.png" height="auto" width="150" border="0" alt="Example Growl Notification" /> </td>
+ <td width="150" rowspan="2" valign="top"><img src="../gfx/GrowlNotification1.png" height="auto" width="150" border="0" alt="Example Growl Notification" /> </td>
<td valign="top" colspan="3"><p>Adium sports a variety of advanced features.</p></td>
</tr>
<tr>
<td><ul>
<li><a href="AdvancedFeatures-AdiumXtras.html">Adium Xtras ▸</a></li>
- <li><a href="AdvancedFeatures-GrowlSupport.html">Growl support ▸</a></li>
+ <li><a href="AdvancedFeatures-Events.html">Events ▸</a></li>
+ <ul>
+ <li><a href="AdvancedFeatures-VisualNotifications.html">Visual notifications ▸</a></li>
+ </ul>
<li><a href="AdvancedFeatures-FileTransfer.html">File transfer ▸</a></li>
<li><a href="AdvancedFeatures-AddressBookIntegration.html">Address Book integration ▸</a></li>
<li><a href="AdvancedFeatures-OTREncryption.html">OTR encryption ▸</a></li>
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/pgs/AdvancedFeatures-Events.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/AdiumHelp/pgs/AdvancedFeatures-Events.html Sun Jul 07 14:44:37 2013 +0200
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<meta name="keywords" content="events, actions, applescript, growl, notifications" />
+<meta name="description" content="Events" />
+<title>Events</title>
+<link href="../css/topicpage.css" type="text/css" rel="stylesheet" media="all" />
+</head>
+<body>
+<div id="banner"> <a name="tabs" id="tabs"></a>
+ <div id="navleft"><a class="navleftsty" href="../AdiumHelp.html">Adium Help</a> <a class="navleftsty" href="AdiumDocumentation.html">Adium Documentation</a></div>
+</div>
+<div id="mainbox">
+ <div id="caticon"> <img src="../gfx/AdiumIcon.png" alt="Adium Icon" height="32" width="32" border="0" /> </div>
+ <div id="pagetitle">
+ <h1>Events</h1>
+ </div>
+ <p>Adium features a highly-customisable "Events" system which allows you to tie certain "actions" to "events" and save settings of this kind as "presets".</p>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>What are "events" and "actions"?</h3>
+ </div>
+ <div class="taskboxtext">
+ <p>Events are all kinds of things happening in Adium like messages being sent or contacts changing their status. Actions are things that are done when those events occur, for example a sound being played, the bouncing of the dock icon or sending a message.</p>
+ <p>Here are some examples of actions being tied to events:</p>
+ <ul>
+ <li>display (<a class="ext_link" href="http://growl.info">Growl</a>- or <a class="ext_link" href="http://support.apple.com/kb/ht5362">Notification-Center</a>-type) visual notifications when you receive new messages</li>
+ <li>play a sound when contacts sign on</li>
+ <li>open a chat window when a specific contacts signs on.</li>
+ </ul>
+ <p>For events, actions can be added and removed. Events can be edited globally and on a per-contact basis.</p>
+ </div>
+ </div>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>What are "presets"?</h3>
+ </div>
+ <div class="taskboxtext">
+ <p>Depending on the situation, you might like to have different actions for events. To avoid having to edit all events every time, you can save global event settings as presets. Adium comes with three pre-existing presets: "Default Notifications", "Audio Notifications" and "Visual Notifications".</p>
+ </div>
+ </div>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>Editing events globally</h3>
+ </div>
+ <div class="taskboxtext">
+ <p>To edit an event globally, first open the <strong>Events</strong> section of Adium's preferences.</p>
+ <p>To add an action for an event</p>
+ <ul>
+ <li>Select the event.</li>
+ <li>Click the "+" button.</li>
+ <li>Choose the action, edit settings (some actions have them) as desired and click "OK".</li>
+ </ul>
+ <p>To remove an action tied to an event</p>
+ <ul>
+ <li>Click the arrow next to the event to display actions attached to it.</li>
+ <li>Select the action you want to remove.</li>
+ <li>Click the "-" button.</li>
+ </ul>
+ <p>To edit the settings for an existing action</p>
+ <ul>
+ <li>Select the action.</li>
+ <li>Click the "Edit" button.</li>
+ <li>Make changes as desired and click "OK".</li>
+ </ul>
+ <p align="center"> <img src="../gfx/DefaultEvents.png" width="400" " alt="" /></p>
+ </div>
+ </div>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>Editing events on a per-contact basis</h3>
+ </div>
+ <div class="taskboxtext">
+ <p>To edit an event on a per-contact basis, first click "Get Info…" (⇧⌘I) from the <strong>Contact</strong> menu and select the third pane called "Events".</p>
+ <p>To add an action for an event</p>
+ <ul>
+ <li>Select the event.</li>
+ <li>Click the "+" button.</li>
+ <li>Choose the action, edit settings (some actions have them) as desired and click "OK".</li>
+ </ul>
+ <p>To remove an action tied to an event</p>
+ <ul>
+ <li>Click the arrow next to the event to display actions attached to it.</li>
+ <li>Select the action you want to remove.</li>
+ <li>Click the "-" button.</li>
+ </ul>
+ <p>To edit the settings for an existing action</p>
+ <ul>
+ <li>Select the action.</li>
+ <li>Click the "Edit" button.</li>
+ <li>Make changes as desired and click "OK".</li>
+ </ul>
+ <p align="center"> <img src="../gfx/GetInfoThirdPane.png" width="200" " alt="" /></p>
+ </div>
+ </div>
+</div>
+<script type="text/javascript" src="../js/help.js"></script>
+</body>
+</html>
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/pgs/AdvancedFeatures-GrowlSupport.html
--- a/AdiumHelp/pgs/AdvancedFeatures-GrowlSupport.html Fri Jul 05 22:42:57 2013 +0200
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,64 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="content-type" content="text/html; charset=utf-8" />
-<meta name="keywords" content="growl, notifications" />
-<meta name="description" content="Built into the application." />
-<title>Growl support</title>
-<link href="../css/topicpage.css" type="text/css" rel="stylesheet" media="all" />
-</head>
-<body>
-<div id="banner"> <a name="tabs" id="tabs"></a>
- <div id="navleft"><a class="navleftsty" href="../AdiumHelp.html">Adium Help</a> <a class="navleftsty" href="AdiumDocumentation.html">Adium Documentation</a></div>
-</div>
-<div id="mainbox">
- <div id="caticon"> <img src="../gfx/AdiumIcon.png" alt="Adium Icon" height="32" width="32" border="0" /> </div>
- <div id="pagetitle">
- <h1>Growl support</h1>
- </div>
- <p><a href="http://growl.info/about.php">Growl</a> lets Mac OS X applications unobtrusively tell you when things happen. In its default configuration, Growl fades a floating notification into the top-right corner of your screen for a moment and then fades it out again. This help page informs how to set up Growl.</p>
- <p align="center"> <img src="../gfx/Growl notification.png" alt="" /></p>
- <div class="taskboxline">
- <div class="taskboxheader">
- <h3>Installing Growl</h3>
- </div>
- <div class="taskboxtext">
- <p>As of Adium 1.5, Adium is able to show Growl notifications without the Growl application installed. This feature is called <a href="http://growl.info/notetodevelopers">Mist</a>.</p>
- <p>If you want to use a different style or use some of the more advanced features of Growl, you will have to either buy the application from the Mac App Store, or get an older and free version from <a href="http://growl.info/downloads">http://growl.info/downloads</a>.</p>
- </div>
- </div>
- <div class="taskboxline">
- <div class="taskboxheader">
- <h3>Configuring Growl notifications</h3>
- </div>
- <div class="taskboxtext">
- <p>The following events notify you via Growl by default:</p>
- <ul>
- <li>Contact signs on</li>
- <li>Message received (Background Chat)</li>
- <li>File transfer requested</li>
- <li>File transfer completed successfully</li>
- <li>File transfer failed</li>
- <li>Error occurs</li>
- </ul>
- <p>To turn certain notifications off, or to make Adium post additional ones, you need to set up one or more events. You can do this globally as well as on a per-contact basis.</p>
- <ul>
- <li>To change the global Growl notification settings edit the events in Adium's "Events" preferences.</li>
- <li>To edit the Growl notification settings for a specific contact, open the "Get Info" window for this contact and edit the events in the third pane.</li>
- </ul>
- </div>
- </div>
- <div class="taskboxline">
- <div class="taskboxheader">
- <h3>Disabling and uninstalling Growl</h3>
- </div>
- <div class="taskboxtext">
- <p>To disable Adium's built-in Mist notifications, enter this command in Terminal.app: <code>defaults write -g com.growl.growlframework.mist.enabled -bool NO</code>.<p>
- <p>To uninstall the Growl application, follow the <a href="http://growl.info/documentation/growl-package-removal.php">instructions on the Growl website</a>.</p>
- </div>
- </div>
-</div>
-<script type="text/javascript" src="../js/help.js"></script>
-</body>
-</html>
diff -r 2988ca04c611 -r 2950ac3f4aa2 AdiumHelp/pgs/AdvancedFeatures-VisualNotifications.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/AdiumHelp/pgs/AdvancedFeatures-VisualNotifications.html Sun Jul 07 14:44:37 2013 +0200
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="content-type" content="text/html; charset=utf-8" />
+<meta name="keywords" content="notification, center, growl, visual, alert" />
+<meta name="description" content="Visual notifications" />
+<title>Visual notifications</title>
+<link href="../css/topicpage.css" type="text/css" rel="stylesheet" media="all" />
+</head>
+<body>
+<div id="banner"> <a name="tabs" id="tabs"></a>
+ <div id="navleft"><a class="navleftsty" href="../AdiumHelp.html">Adium Help</a> <a class="navleftsty" href="AdiumDocumentation.html">Adium Documentation</a></div>
+</div>
+<div id="mainbox">
+ <div id="caticon"> <img src="../gfx/AdiumIcon.png" alt="Adium Icon" height="32" width="32" border="0" /> </div>
+ <div id="pagetitle">
+ <h1>Visual notifications</h1>
+ </div>
+ <p>Visual notifications are a means of unobtrusively informing you when things happen, for example when you receive a message. In their default configuration, they fade into the top-right corner of your screen for a moment and then fade out again.</p>
+ <p>Adium features comprehensive support for visual notifications by ways of OS X's very own <a class="ext_link" href="http://support.apple.com/kb/ht5362">Notification Center</a> (on OS X 10.8 and later), third-party software <a class="ext_link" href="http://growl.info">Growl</a> as well as built-in notifications called "Mist" (on OS 10.7 and older).</p>
+ <p>This page explains the three different notification mechanisms mentioned above. See <a href="AdvancedFeatures-Events.html">Events</a> on how to tell Adium when to display visual notifications.<p>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>Notification Center support (OS X 10.8 and later)</h3>
+ </div>
+ <p align="center"> <img src="../gfx/NotificationCenterNotification.png" alt="" /></p>
+ <div class="taskboxtext">
+ <p>Apple introduced "Notification Center" (NC) in OS X 10.8 ("Mountain Lion").</p>
+ </div>
+ </div>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>Growl support</h3>
+ </div>
+ <p align="center"> <img src="../gfx/GrowlNotification1.png" alt="" /></p>
+ <p align="center"> <img src="../gfx/GrowlNotification2.png" alt="" /></p>
+ <div class="taskboxtext">
+ <p>The third-party application Growl.app has been around about as long as Adium itself – a long time before Apple introduced "Notification Center" (NC) in OS X 10.8 ("Mountain Lion").</p>
+ <p>While Growl.app is the obvious solution for users on previous versions of OS X, it also has a lot to offer to OS X users on 10.8, especially in the way of customisability and extendability. For example, there are dozens of different styles to choose from.</p>
+ <p>To install Growl.app either <a class="ext_link" href="https://itunes.apple.com/de/app/growl/id467939042?mt=12">buy the application from the Mac App Store</a>, or get an older and free version from <a class="ext_link" href="http://growl.info/downloads">http://growl.info/downloads</a>.</p>
+ <p>If you have Growl.app installed and would prefer to use Notification Center notifications for Adium, you need make the change in Growl's preferences.</p>
+ <p>To uninstall the Growl application, follow the <a class="ext_link" href="http://growl.info/documentation/growl-package-removal.php">instructions on the Growl website</a>.</p>
+ </div>
+ </div>
+ <div class="taskboxline">
+ <div class="taskboxheader">
+ <h3>Built-in notifications ("Mist", OS X 10.7 and older)</h3>
+ </div>
+ <p align="center"> <img src="../gfx/MistNotification.png" alt="" /></p>
+ <div class="taskboxtext">
+ <p>As of Adium 1.5, Adium is able to show Growl-style notifications on OS X versions 10.7 and 10.6 without the Growl application installed. This feature is called <a class="ext_link" href="http://growl.info/notetodevelopers">Mist</a>.</p>
+ <p>If you want to use a different style or use some of the more advanced features of Growl, you will have to either <a class="ext_link" href="https://itunes.apple.com/de/app/growl/id467939042?mt=12">buy the application from the Mac App Store</a>, or get an older and free version from <a class="ext_link" href="http://growl.info/downloads">http://growl.info/downloads</a>.</p>
+ <p>To disable Mist notifications, enter this command in Terminal.app: <code>defaults write -g com.growl.growlframework.mist.enabled -bool NO</code>. Please note that this affects any apps that support built-in Mist notifications like Adium does.<p>
+ </div>
+ </div>
+</div>
+<script type="text/javascript" src="../js/help.js"></script>
+</body>
+</html>
More information about the commits
mailing list