annotate README @ 185:5359a2383ebe

a bit more README
author Yoshiki Yazawa <yaz@honeyplnaet.jp>
date Tue, 05 Aug 2008 13:42:24 +0900
parents a18121e930b8
children 73d82bc23fab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
1 pidgin-twitter-0.7.0
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
2
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
3
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
4 1. What is this?
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
5
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
6 pidgin-twitter is a pidgin plugin to help posting and reading micro
184
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
7 blogs such as Twitter. Currently, pidgin-twitter supports Twitter,
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
8 Wassr and identi.ca.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
9
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
10 Features:
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
11 General
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
12 * display user icon (size configurable)
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
13 * translate sender's name and @<username> to link to the user's
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
14 home
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
15 * play sounds for specific senders/recipients
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
16 * show letter counter on the format toolbar
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
17
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
18 Twitter specific
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
19 * get/post twitter statuses via API
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
20 * escape pseudo commands like "w"
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
21 * suppress oops message return
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
22
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
23 Wassr specific
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
24 * Translate #<channel name> to link to the channel
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
25 * eliminate annoying post completion messages
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
26
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
27 identi.ca specific
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
28 * eliminate annoying echo backed messages.
76
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
29
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
30
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
31 2. Dependency
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
32
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
33 This plugin requires pidgin 2.4.0 or newer, glib-2.14.0 or newer and
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
34 libxml-2.6.27 or newer.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
35
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
36
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
37 3. How to build
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
38
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
39 Building pidgin-twitter plugin is very simple. Please do
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
40
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
41 ./configure
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
42 make
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
43 sudo make install
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
44
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
45
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
46 4. Usage
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
47
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
48 To enable pidgin-twitter, please check it as "Enabled" in pidgin's
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
49 plugins window. Almost all of features can be configured through
185
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
50 pidgin-twitter's paged preferences window. In this section, we explain
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
51 the features in page by page basis.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
52
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
53
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
54 4.1 Account page
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
55
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
56 4.1.1 Screen Name
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
57
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
58 You can specify your account names for each service here. These names
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
59 will be used for showing your icon in a conversation, and more, in
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
60 twitter, it will be used for authentication when API based access is
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
61 enabled.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
62
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
63 4.1.2 Get/post statuses via API
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
64
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
65 Since pidgin is an instant message client, it is natural that pidgin
184
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
66 uses XMPP protocol to access twitter. However, twitter has suspended
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
67 their IM gateway service for long time, for maintenance reason. So we
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
68 had decided to provide the other way to access to twitter using
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
69 twitter's public API.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
70
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
71 If you enables this feature, pidgin-twitter will get your timeline
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
72 and put your update via twitter API.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
73
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
74 4.1.3 Password
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
75
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
76 This password is used for basic authentication which is required to
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
77 access twitter via API.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
78
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
79 4.1.4 Retrieve interval
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
80
184
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
81 You can specify the interval between each retrievals by ten seconds.
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
82
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
83 4.2 Translation page
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
84
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
85 4.2.1 Translate @username to link
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
86
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
87 It toggles translation from a recipient name to the link to the
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
88 recipient.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
89
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
90 4.2.2 Translate sender name to link
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
91
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
92 It toggles translation from a sender name to the link to the sender.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
93
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
94 4.2.3 Translate channel name to link
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
95
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
96 It toggles translation from a channel name to the link to the
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
97 channel. This feature is available only for Wassr.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
98
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
99 4.3 Icon page
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
100
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
101 4.3.1 Show icon in conversation
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
102
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
103 It toggles show/hide icons for users in conversations.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
104
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
105 4.3.2 Icon size
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
106
184
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
107 Icon size in conversations can be specified by this spin button.
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
108
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
109 4.3.3 Enable update
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
110
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
111 It toggles enable/disable update for icons by the specified
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
112 period. See bellow for the period.
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
113
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
114 4.3.4 Update period
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
115
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
116 You can specify update period here in two ways. The first is times of
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
117 showing one particular icon before update. The later is days before
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
118 update.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
119
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
120
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
121 4.4 Sound page
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
122
185
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
123 4.4.1 Play sound on a reply to a specified recipient
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
124
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
125 It toggles play
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
126
185
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
127 This functionality is also able to be toggled on/off via configuration
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
128 window.
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
129
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
130
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
131
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
132 Usually, the first name might be your user name.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
133
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
134
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
135 4.4.2 Recipient list
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
136
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
137 Recipient list accommodates names of watched recipients. An user list
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
138 is a enumeration of usernames separated by a letter in ",:;". For
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
139 example, "foo bar" or "foo,bar" is a valid user list and a list like
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
140 "foo, bar" also works.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
141
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
142 These lists are independent to each other
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
143 so that you can maintain different groups to be watched.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
144
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
145
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
146 4.4.3 Sound type
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
147
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
148 Event type of sound to play is also configurable. By default, the
26
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
149 "Pounce Default" sound is specified since it may not be disabled by
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
150 configuration in pidgin's preferences. You can specify other sounds,
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
151 but be aware, you have to enable the event type of sound which you
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
152 specified for pidgin-twitter in pidgin's preferences.
3c45a1bc40a5 update README for 0.5.0
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 17
diff changeset
153
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
154
185
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
155 4.4.4 Play sound on a message from a specified sender
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
156
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
157 This is same to 4.4.1 except that it is for senders.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
158
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
159 4.4.5 Sender list
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
160
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
161 This is same to 4.4.2 except that it is for senders.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
162
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
163 Sender list accommodates names of
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
164 watched senders, instead.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
165
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
166 4.4.6 Sound type
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
167
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
168 This is same to 4.4.3 except that it is for senders.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
169
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
170 4.5 Utility page
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
171
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
172 4.5.1 Show text counter widget
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
173
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
174 Letter counter for composing message is useful for keeping track of
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
175 the length limit of twitter message and oops suppression will give
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
176 users who mainly use multi byte characters comfortable twittering.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
177
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
178 Letter counter will appear on the format bar in a pidgin conversation
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
179 window. This counter keeps track of length of composing string in
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
180 character since the hard limit of message length is applied by
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
181 character count basis. If the composing message exceeds 140
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
182 characters, the displayed number will turn red to notify the excess.
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
183 This feature is enabled by default. You can disable this via configure
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
184 window.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
185
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
186
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
187 4.5.2 Escape pseudo command in twitter
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
188
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
189 Escape pseudo command functionality is enabled by default. To disable
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
190 this feature, please uncheck it in the plugin configuration window. I
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
191 recommend you to leave it always enabled.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
192
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
193 From version 0.5.0, pidgin-twitter automatically escapes annoying
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
194 "pseudo command" in sending message. A pseudo command is a message
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
195 like "¤Ë¤Û¤ó¤´w" or "....w" and it will be wrongly interpreted as an
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
196 incomplete command message so that twitter gives us an error massage.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
197
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
198
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
199 4.5.3 Suppress oops message
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
200
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
201 Suppress oops message feature may require explanation. If we send a
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
202 message which is longer than 140 bytes, twitter will send us back an
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
203 oops message to notify the excess of the limit. However, the actual
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
204 limit is computed on internal representation of characters so that the
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
205 messages which does not exceed 140 letters will actually be
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
206 accepted. Suppress oops message feature will silently discards *false*
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
207 oops message in this situation. This feature can also be configured
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
208 via configure window.
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
209
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
210 4.5.4 Do not notify incoming message
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
211
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
212 (xxx)
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
213
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
214
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
215 4.5.5 Output log message
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
216
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
217 It toggles log messages for debugging. If you have any trouble, we
185
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
218 suggest to enable this feature and report us your problem with
5359a2383ebe a bit more README
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 184
diff changeset
219 obtained information.
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
220
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
221
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
222 5. History
28
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
223
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
224 0.4.0 (May 01 2008)
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
225 First public release.
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
226
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
227 0.5.0 (May 05 2008)
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
228 Added escape pseudo command functionality.
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
229
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
230 0.5.1 (May 05 2008)
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
231 Fixed a crash bug that each unload and reload pidgin-twitter cycle
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
232 resulted in crash.
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
233
53
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
234 0.6.0 (May 16 2008)
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
235 - Letter counter has been added.
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
236 - Suppress "false positive oops message" when sending message which
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
237 exceeds 140 bytes but within 140 characters.
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
238 - Pidgin-twitter now strips all markup elements from sending message.
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
239 This feature prevents this plugin from posting unexpected
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
240 excessively marked up message.
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
241 - Since pidgin-twitter no longer sends any marked up message, all
76
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
242 markup widgets in conversation window have been disabled.
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
243
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
244 0.7.0 alpha1 (June 28 2008)
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
245 - Show icon feature has been added.
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
246 - API based posting has been added.
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
247 - Notifications on message arrival can be disabled now.
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
248 - Annoying completion message which is returned from wassr service
63bd9ca28be0 - added nosuke and iratqq to the authors.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 53
diff changeset
249 will be automatically ignored.
28
73e817be3267 - Fixed a crash bug. Each unload/reload cycle caused crash due to unrefed regp.
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 26
diff changeset
250
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
251 0.7.0 (Aug 5 2008)
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
252 - Support for identi.ca has been added.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
253 - Icon support for wassr and identi.ca have been added.
184
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
254 - Icon size and icon visibility are now configurable.
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
255 - Automatic icon update has been implemented.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
256 - Translation from channel name to the link to the channel in wassr
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
257 has been added.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
258 - Disabling notifications on message arrival now works for wassr and
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
259 identi.ca too.
33
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
260
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
261 6. Acknowledgments
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
262
184
a18121e930b8 check typo by aspell and fix it
mojin <truffechampagne@gmail.com>
parents: 181
diff changeset
263 In the beginning of development, I (yazuuchi) got a number of valuable
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
264 feedbacks from nosuke (@konosuke) and mojin (@mojin).
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
265
33
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
266 The original letter counter has been developed by Dossy Shiobara in
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
267 convcharcount plugin.
abe31282e2de revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 28
diff changeset
268
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
269 In development for 0.6.0, mikanbako (@mikanbako) joined our team and
53
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
270 contributed numerous efforts. The original strip markup feature and
872f418ba45d - revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 47
diff changeset
271 the disable markup widgets feature has been developed by him.
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
272
181
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
273 API based posting has been contributed by nosuke in development for
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
274 0.7.0.
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
275
013e79e36f1a work in progress README for 0.7.0
Yoshiki Yazawa <yaz@honeyplnaet.jp>
parents: 76
diff changeset
276 We got numerous feedbacks from users in the #pidgin_twitter channel.
47
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
277
6774859df10b revised README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents: 33
diff changeset
278 Yoshiki Yazawa (@yazuuchi) and the pidgin-twitter team
17
21f27858e155 added README
Yoshiki Yazawa <yaz@cc.rim.or.jp>
parents:
diff changeset
279 yaz@honeyplanet.jp