Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 286 lines (167 sloc) 12.962 kb
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
1 === Twitter Tools ===
2 Contributors: alexkingorg, crowdfavorite
037ce8c @alexkingorg initial progress on README
alexkingorg authored
3 Tags: twitter, tweet, integration, post, notify, integrate, archive, widget, shortcode, social
154cc58 @alexkingorg support for Social v2.10's CRON actions
alexkingorg authored
4 Requires at least: 3.8
b1922e1 Bump to 3.1.1
Chris Mospaw authored
5 Tested up to: 4.2
6 Stable tag: 3.1.1
225090a @alexkingorg updating README and adding screenshots
alexkingorg authored
7 License: GPLv2
8 License URI: http://www.gnu.org/licenses/gpl-2.0.html
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
9
037ce8c @alexkingorg initial progress on README
alexkingorg authored
10 Twitter Tools is a plugin that creates a complete integration between your WordPress blog and your Twitter account.
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
11
225090a @alexkingorg updating README and adding screenshots
alexkingorg authored
12 == Description ==
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
13
037ce8c @alexkingorg initial progress on README
alexkingorg authored
14 Twitter Tools integrates with Twitter by giving you the following functionality:
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
15
225090a @alexkingorg updating README and adding screenshots
alexkingorg authored
16 * Connect multiple Twitter accounts (via Social)
037ce8c @alexkingorg initial progress on README
alexkingorg authored
17 * Archive the tweets from your Twitter accounts (downloaded every 10 minutes)
18 * Create a blog post from each of your tweets
19 * Create a tweet on Twitter whenever you post in your blog, with a link to the blog post (via Social)
20 * Browse your tweets locally by @mention, #hashtag or user account (optionally display these publicly)
21
22 Twitter Tools leverages Social's connection to Twitter so that you don't have to create an app and copy keys around. It supports multiple accounts (must be authorized as "global" accounts in Social) with settings on a per-account basis.
23
bc8974f @alexkingorg more questions and answers
alexkingorg authored
24 **Support Level:** Product Support (we want to fix bugs and make the product great, but do not provide individual support).
25
26 **Developers:** [Fork and contribute on GitHub](https://github.com/crowdfavorite/wp-twitter-tools
27 ).
037ce8c @alexkingorg initial progress on README
alexkingorg authored
28
29 == Installation ==
30
225090a @alexkingorg updating README and adding screenshots
alexkingorg authored
31 _Twitter Tools relies on the <a href="http://wordpress.org/extend/plugins/social/">Social</a> plugin to connect to Twitter. If you aren't already using this plugin please install it before installing Twitter Tools._
037ce8c @alexkingorg initial progress on README
alexkingorg authored
32
33 1. Download the plugin archive and expand it (you've likely already done this).
34 2. Put the 'twitter-tools' directory into your wp-content/plugins/ directory.
35 3. Go to the Plugins page in your WordPress Administration area and click 'Activate' for Twitter Tools.
36 4. Go to the Twitter Tools Options page (Settings > Twitter Tools) to set up your Twitter information and preferences.
37
38
39 == Upgrading ==
40
41 If you have upgraded from an older version of Twitter Tools, your data will need to be converted to the new Twitter Tools format. On the Twitter Tools Options page you will see a prompt to upgrade if appropriate. Follow the steps to convert your data.
42
43 Twitter Tools now stores complete Twitter data along with your basic tweet content. Over time, Twitter Tools will request this data for upgraded tweets. This process make take a few days, as only 10 tweets are requested per hour (to avoid egatively impacting your rate limit).
44
45
618046d @alexkingorg filled out the README
alexkingorg authored
46 == Connecting Accounts ==
47
48 Any Twitter accounts connected on the Social settings page are available for Twitter Tools. You can enable them on a per-account account basis, as well as specifying per-account preferences for creating blog posts, etc. (on the Twitter Tools options screen).
49
50
037ce8c @alexkingorg initial progress on README
alexkingorg authored
51 == Managing your Tweets ==
52
618046d @alexkingorg filled out the README
alexkingorg authored
53 You can view, edit and delete (or unpublish) the local copy of your Tweets right in your WordPress admin. Navigate the tweets from the "Tweets" menu item and manage them just as you would any other post type. Twitter Tools does not know if you've deleted a tweet on Twitter, so you'll need to also delete the copy of the tweet from the admin to remove it from your WordPress site.
54
037ce8c @alexkingorg initial progress on README
alexkingorg authored
55
56 == Displaying your Tweets ==
57
618046d @alexkingorg filled out the README
alexkingorg authored
58 Twitter Tools include options to create URLs for your local tweets using the following scheme:
59
60 - single tweet: http://alexking.org/tweets/253580615113400321
61 - account archive: http://alexking.org/tweet-accounts/alexkingorg
62 - @mention archive: http://alexking.org/tweet-mentions/sogrady
63 - #hashtag archive: http://alexking.org/tweet-hashtags/monktoberfest
64
65 You can enable public URLs for your tweets in your Twitter Tools settings. If you choose not to enable public URLs for your tweets, you can still vuew and manage them from within the admin screens.
66
67 = Shortcode =
68
69 You can use a shortcode to display a list of tweets.
70
71 [aktt_tweets account="alexkingorg"]
72
73 If you want, you can specify some additional parameters to control how many tweets are displayed:
74
75 [aktt_tweets account="alexkingorg" count="5" offset="0"]
76
77 You can also choose to explicitly include or exclude replies and retweets:
78
79 [aktt_tweets account="alexkingorg" include_rts="0" include_replies="1"]
80
81 If you want to limit the tweets to specific @mentions or #hashtags, you can to that as well:
82
83 [aktt_tweets account="alexkingorg" mentions="crowdfavorite,twittertools" hashtags="wordpress,plugin,twittertools"]
84
85 = Widget =
86
87 The options for the shortcode are also available for the Twitter Tools widget via a few settings.
88
89 = Create Blog Posts =
90
91 Twitter Tools can create a blog post from each of your Tweets. This feature can be enabled on a per-account basis. If there is an image included in the media data of the tweet Twitter Tools will try to save that image as the featured image for the post and append it to the blog post content.
92
93 Please note that this will take effect for all future tweets, it does not retroactively create posts for older tweets (though you could pretty easily script it to do so if you desired).
94
95
96 == Customization ==
97
98 Twitter Tools is designed to be customizable via the standard hook/filter API. If you find you need additional hooks (or to suggest other bug fixes and enhancements) please create a pull request on GitHub.
99
100 https://github.com/crowdfavorite/wp-twitter-tools
101
102 Get creative! Here are some examples of ways to use more of the full Twitter data to create links back into Twitter where appropriate:
103
104 - linking to the original tweet on Twitter
105 - linking to "in reply to" tweets
106
107
00b5ba0 @alexkingorg wp.org wants it spelled out
alexkingorg authored
108 == Frequently Asked Questions ==
618046d @alexkingorg filled out the README
alexkingorg authored
109
110 = What if I don't want to use Social's comment display? =
111
112 All of Social's features (broadcasting, comment display, looking for responses on Twitter and Facebook and the ability to log in with Twitter or Facebook) can be disabled on Social's settings screen.
113
114 = Will Twitter Tools pull in my entire tweet archive from Twitter? =
115
7dd9142 @alexkingorg add pointer to Gist
alexkingorg authored
116 Twitter Tools starts archiving from the time you enable it. It does not try to download your entire tweet history. However, there is code in Twitter Tools that can be scripted to download and import tweets. You can put together the pieces with your own code to create the combination of features you desire. Here's an Gist to get you started:
117
118 https://gist.github.com/3470627
618046d @alexkingorg filled out the README
alexkingorg authored
119
89cf7eb @alexkingorg add some FAQs
alexkingorg authored
120 = What happened to the digest features? =
121
122 The digest features never worked reliably and were removed in version 3.0. Another developer is welcome to make a plugin that uses the underlying features of Twitter Tools to implement digest features.
123
124 = What happened to the default hashtags feature? =
125
126 These are no longer needed in 3.0+ since the default broadcast message is now fully customizable in the Social settings. Add your hashtags to your default broadcast message template.
127
bc8974f @alexkingorg more questions and answers
alexkingorg authored
128 = How do I use a URL-shortener like bit.ly? =
129
130 Since Twitter Tools no longer does broadcasting, this is really a [question for Social](http://wordpress.org/extend/plugins/social/faq/). As noted in that FAQ, Social uses the built-in "short URL" feature of WordPress that supports any number of services via their plugins.
131
225090a @alexkingorg updating README and adding screenshots
alexkingorg authored
132 == Screenshots ==
133
134 1. Show your tweets on your site (optional).
135 2. Tweets can be viewed by account, @mention or #hashtag.
136 3. Manage your tweets in the standard WordPress admin interface.
137 4. View tweets by @mention, #hashtag, etc.
138 5. Easy interface to for per-account settings.
139
140
141 == Upgrade Notice ==
142
064f14b @alexkingorg up version to 3.1
alexkingorg authored
143 Version 3.1 brings support for Social 2.10's CRON action names and requires Social 2.10 and WordPress 3.8. It also adds a setting for the publish/draft status of blog posts created from tweets. Now you can set your blog posts to be created as drafts, then publish only the ones you choose to. We've also improved native RT support.
94615d8 @alexkingorg up version # and upgrade notice
alexkingorg authored
144
618046d @alexkingorg filled out the README
alexkingorg authored
145
146 == Changelog ==
147
b1922e1 Bump to 3.1.1
Chris Mospaw authored
148 = 3.1.1 =
149
4a6444e @alexkingorg Update README.txt
alexkingorg authored
150 * (new) Use Twitter icon in admin menu
151
b1922e1 Bump to 3.1.1
Chris Mospaw authored
152
064f14b @alexkingorg up version to 3.1
alexkingorg authored
153 = 3.1 =
154cc58 @alexkingorg support for Social v2.10's CRON actions
alexkingorg authored
154
155 * (new) Requires Social v2.10
b165697 @alexkingorg update README
alexkingorg authored
156 * (new) Setting for post status when creating blog posts from tweets (thanks <a href="https://github.com/crowdfavorite/wp-twitter-tools/pull/22">ShawnDrew</a>)
1368901 @alexkingorg always link mentions since Twitter killed @anywhere support. Fixes #18
alexkingorg authored
157 * (change) Twitter has ended @anywhere so go ahead and link usernames all the time
154cc58 @alexkingorg support for Social v2.10's CRON actions
alexkingorg authored
158 * (fix) Support for Social v2.10's CRON actions - tweets automatically download again
1368901 @alexkingorg always link mentions since Twitter killed @anywhere support. Fixes #18
alexkingorg authored
159 * (fix) Handle native RTs better (thanks <a href="https://github.com/crowdfavorite/wp-twitter-tools/issues/19">trustin</a>)
154cc58 @alexkingorg support for Social v2.10's CRON actions
alexkingorg authored
160
064f14b @alexkingorg up version to 3.1
alexkingorg authored
161
93fd8a7 @alexkingorg support for Twitter API v 1.1, bumping to version 3.0.4 for release
alexkingorg authored
162 = 3.0.4 =
163
164 * Support for Twitter API v1.1.
165
166
0a3ad6b @alexkingorg fix a typo that could prevent proper backfilling of tweet data (thanks @...
alexkingorg authored
167 = 3.0.3 =
168
169 * Fix a typo that could prevent proper backfilling of tweet data
170
171
74601af @alexkingorg changelog update
alexkingorg authored
172 = 3.0.2 =
173
174 * Add `aktt_tweet_create_blog_post` filter to allow other plugins/code to make programatic decisions about when to create blog posts from tweets
175 * Add `aktt_tweet_create_blog_post_format` filter to allow post format to changed or omitted
176 * Properly apply title prefix when creating blog posts
177 * Address misc. multi-byte string issues
178 * Fix GMT/local time issues and set time properly for tweets and posts
179 * Properly enable featured image for tweet post type by merging with existing enabled post types
180
181
8986ffe @alexkingorg set post date properly to GMT time
alexkingorg authored
182 = 3.0.1 =
183
184 * Set categories and post tags properly on posts created from tweets
185 * Set GMT date explicitly for blog posts created from tweets (fixes time offset issue)
74601af @alexkingorg changelog update
alexkingorg authored
186 * Make enabled/disabled accounts more explicit visually
8986ffe @alexkingorg set post date properly to GMT time
alexkingorg authored
187
188
618046d @alexkingorg filled out the README
alexkingorg authored
189 = 3.0 =
190
191 * Complete rewrite!
192 * Integrates with Social (required) to provide a vastly improved set-up experience
193 * Broadcasting features are now handled via the Social plugin
194 * Tweets are stored as a custom post type, providing easy admin access to edit or delete tweets as needed
195 * Tweets are cross-linked and browsable via custom taxonomies for accounts, @mentions and #hashtags
196 * Full Twitter is now stored with each tweet
197 * Comprehensive upgrade routine to migrate existing data and backfill upgraded tweets with full Twitter data
198 * Additional control over which tweets are displayed via shortcode and widget
199 * Daily and weekly digest functionality has been removed
200
201
202 = 2.4 =
203
204 * Replaced 401 authentication with OAuth.
205 * Now relies on WordPress to provide JSON encode/decode functions.
206 * WP 3.0 compatibility fix for hashtags plugin (set default hashtags properly).
207 * WP 3.0 compatibility fix for creating duplicate post meta.
208 * Added support form to settings page.
209
210
211 = 2.3.1 =
212
213 * Fixed a typo that was breaking the latest tweet template tag.
214
215
216 = 2.3 =
217
218 * Added nonces
219 * Patched several potential security issues (thanks Mark Jaquith)
220 * Load JS and CSS in separate process to possibly avoid some race conditions
221
222
223 = 2.2.1 =
224
225 * Typo-fix that should allow resetting digests properly (not sure when this broke, thanks lionel_chollet).
226
227
228 = 2.2 =
229
230 * The use of the native `json_encode()` function, required by the changes in WordPress 2.9 (version 2.1) created a problem for users with servers running 32-bit PHP. the `json_decode()` function treats the tweet ID field as an integer instead of a string, which causes the issues. Thanks to Joe Tortuga and Ciaran Walsh for sending in the fix.
231
232
233 = 2.1.2 =
234
235 * Missed one last(?) instance of Services_JSON
236
237
238 = 2.1.1 =
037ce8c @alexkingorg initial progress on README
alexkingorg authored
239
618046d @alexkingorg filled out the README
alexkingorg authored
240 * Missed replacing a couple of instances of Services_JSON
037ce8c @alexkingorg initial progress on README
alexkingorg authored
241
242
618046d @alexkingorg filled out the README
alexkingorg authored
243 = 2.1 =
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
244
618046d @alexkingorg filled out the README
alexkingorg authored
245 * Make install code a little smarter
246 * Add unique index on tweet ID columns, remove duplicates and optimize table
247 * Track the currently installed version for easier upgrades in the future
248 * Cleanup around login test code
249 * Add action on Update Tweets (aktt_update_tweets)
250 * Add a shortcode to display recent tweets
251 * Exclude replies in aktt_latest_tweet() function (if option selected)
252 * Better RegEx for username and hashtag linking
253 * Use site_url() and admin_url(), losing backward compatibility but gaining SSL compatibility
254 * Added WordPress HelpCenter contact info to settings page
255 * Use standard meta boxes (not backwards compatible) for post screen settings
256 * Change how Services_JSON is included to be compatible with changes in WP 2.9 and PHP < 5.2
257 * Digest functionality is marked as experimental, they need to be fundamentally rewritten to avoid race conditions experienced by some users
258 * Misc code cleanup and bug fixes
259 * Added language dir and .pot file
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
260
618046d @alexkingorg filled out the README
alexkingorg authored
261 Bit.ly plugin
037ce8c @alexkingorg initial progress on README
alexkingorg authored
262
618046d @alexkingorg filled out the README
alexkingorg authored
263 * Changed RegEx for finding URLs in tweet content (thanks Porter Maus)
264 * Added a j.mp option
265 * Cleaned up the settings form
266 * Added a trim() on the API Key for people that struggle with copy/paste
267 * Use admin_url(), losing backward compatibility but gaining SSL compatibility
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
268
618046d @alexkingorg filled out the README
alexkingorg authored
269 Exclude Category plugin
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
270
618046d @alexkingorg filled out the README
alexkingorg authored
271 * Use admin_url(), losing backward compatibility but gaining SSL compatibility
037ce8c @alexkingorg initial progress on README
alexkingorg authored
272
618046d @alexkingorg filled out the README
alexkingorg authored
273 Hashtags plugin
037ce8c @alexkingorg initial progress on README
alexkingorg authored
274
618046d @alexkingorg filled out the README
alexkingorg authored
275 * Use admin_url(), losing backward compatibility but gaining SSL compatibility
826aa5d @alexkingorg readme outline, default settings fix, additional filter, handle duplicat...
alexkingorg authored
276
037ce8c @alexkingorg initial progress on README
alexkingorg authored
277
618046d @alexkingorg filled out the README
alexkingorg authored
278 = 2.0 =
037ce8c @alexkingorg initial progress on README
alexkingorg authored
279
618046d @alexkingorg filled out the README
alexkingorg authored
280 * Added various hooks and filters to enable other plugins to interact with Twitter Tools.
281 * Added option to set blog post tweet prefix
282 * Added CSS classes for elements in tweet list
283 * Initial release of Bit.ly for Twitter Tools - enables shortening your URLs and tracking them on your Bit.ly account.
284 * Initial release of #hashtags for Twitter Tools - enables adding hashtags to your blog post tweets.
285 * Initial release of Exclude Category for Twitter Tools - enables not tweeting posts in chosen categories.
Something went wrong with that request. Please try again.