Plugin Directory

Changeset 421835

08/10/11 20:35:45 (7 years ago)

initial commit, version 1.0

29 added
1 edited


  • social/trunk/README.txt

    r421081 r421835  
    1 test 
     1=== Social === 
     2Contributors: crowdfavorite, alexkingorg 
     3Tags: comments, facebook, twitter 
     4Requires at least: 3.2 
     5Tested up to: 3.2.1 
     6Stable tag: 1.0 
     8Broadcast posts to Twitter and/or Facebook, pull in items from each as comments, and allow commenters to use their Twitter/Facebook identities. 
     10== Description == 
     12Brought to you by [MailChimp](http://mailchimp.com/), [Social](http://mailchimp.com/social-plugin-for-wordpress/) is a lightweight plugin that handles a lot of the heavy lifting of making your blog seamlessly integrate with social networking sites [Twitter](http://twitter.com/) and [Facebook](http://facebook.com/). 
     14**Broadcast Published Posts** 
     16Through use of a proxy application, you can associate your Twitter and Facebook accounts with your blog and its users. Once you publish a new post, you can then choose to automatically broadcast a message to any accounts authenticated with the overall blog or your current logged-in user. 
     18- Automatically broadcast posts to Twitter and/or Facebook 
     19- Supports multiple accounts associated per user and per blog 
     20- Customize the broadcast message using tokens 
     22**Pull in Tweets and Replies as Comments** 
     24When publishing to Facebook and Twitter, the discussion is likely to continue there. Through Social, we can aggregate the various mentions, retweets, @replies, comments and responses and republish them as WordPress comments. 
     26- Automatically polls Twitter and Facebook for mentions of your post 
     27- Displays mentions inline with comments 
     28- Filter comments by originating source (Facebook, Twitter, or your blog as comments) 
     29- Allow users to reply to the offsite responses 
     31**Comment as Facebook and/or Twitter Identity** 
     33Many individuals use Facebook or Twitter as their primary identity(ies) on the web. Allow your commenters to log in and leave a comment as that identity. Furthermore, they can publish their response directly to their Twitter or Facebook account. 
     35- Allow users to leave comments as Facebook or Twitter identity 
     36- Twitter hovercard support (with @anywhere API key) 
     37- Links point back to users' Facebook or Twitter profiles 
     38- Indicators let you and visitors know people are who they say they are 
     40== Installation == 
     421. Upload `social` to the `/wp-content/plugins/` directory or install it from the Plugin uploader 
     432. Activate the plugin through the `Plugins` menu in the WordPress administrator dashboard 
     443. Visit your profile page under `Users > Profile` to associate Twitter and Facebook accounts with your profile 
     454. Visit the settings page under `Settings > Social` to associate Twitter and Facebook accounts with your blog 
     465. Change your plugin directory or uploads writable to allow the cron jobs to fetch new comments from Twitter and Facebook 
     476. Register for and add your [Twitter @anywhere API key](http://dev.twitter.com/anywhere) to the settings page to enable Twitter hovercards 
     49== Frequently Asked Questions == 
     51= Who created this plugin? = 
     53Social was conceptualized and co-designed by the fine folks at [MailChimp](http://mailchimp.com "Email Marketing from MailChimp") led by [Aarron Walter](http://aarronwalter.com/). The application proxy is maintained and hosted by [MailChimp](http://mailchimp.com) and the plugin was co-designed and developed by [Crowd Favorite](http://crowdfavorite.com/ "Custom WordPress and web development"). 
     55= How can I customize the comments form in my theme? = 
     57We recommend using CSS styles to selectively change the look and feel of your comments and comment form. The classes `social-comments-[no-comments|wordpress|twitter|facebook|pingbacks]` are available as as class names. More specific classes include: 
     59- `.social-comment-header `- contains the author information, avatar, and meta information 
     60- `.social-comment-inner` - a wrapper for the actual comment content, allowing more freedom with comment styling. 
     61- `.social-comment-body` - the container for the comment content. 
     62- `.social-comment-collapsed` - use this hook to create a more compact version of a comment.  hide comment text, shrink the size of the avatar, etc. 
     63- `.social-post-form` - where the comment form controls reside.  Use this hook to customize the look of form inputs and labels. 
     64- `#facebook_signin` - style the link that activates Facebook oAuthorization 
     65- `#twitter_signin` - style the link that activates Facebook oAuthorization 
     66- `.social-quiet` - a muted typography style, for subdued display of text 
     67- `.bypostauthor` - a class added to the comment thread to style comments from the author of the post 
     69The icons used for the plugin are currently 16x16 pixels, and reside in a vertical sprite with each icon at 100px intervals.  Adhering to these intervals will ensure that icon positions will not need to change 
     71Note: we do not recommend making changes to the included plugin files as they may be overwritten during an upgrade. 
     73= Can I define a custom comments.php for Social? = 
     75Yes, if you'd rather create more 'advanced' customizations beyond CSS tweaks simply add the following line to your theme's `functions.php` file: 
     77    define('SOCIAL_COMMENTS_FILE', STYLESHEETPATH.'/social-comments.php'); 
     79Then you will need to create the `social-comments.php` file with your custom markup (perhaps copy it directly from the provided comments.php in the plugin) into your theme's directory.  
     81= How can I define custom JS and/or CSS, or disable Social's JS/CSS? = 
     83There are three constants that can be altered to your liking: 
     851. `SOCIAL_ADMIN_CSS` - CSS file for WP-Admin. 
     862. `SOCIAL_ADMIN_JS` - JS file for WP-Admin. 
     873. `SOCIAL_COMMENTS_CSS` - CSS file for the comments form. 
     884. `SOCIAL_COMMENTS_JS` - JS file used on the comments form and WP-Admin 
     90To define custom JS/CSS in your theme's functions.php add the following line (Replace `SOCIAL_ADMIN_CSS` with one of the 
     91constants listed above): 
     93    define('SOCIAL_ADMIN_CSS', STYLESHEETPATH.'/path/to/stylesheet.css'); 
     95To disable Social's JS/CSS in your theme's functions.php add the following line (Replace `SOCIAL_ADMIN_CSS` With one of 
     96the constants defined above): 
     98    define('SOCIAL_ADMIN_CSS', false); 
     100= Why are the tabs on my comment form not displaying correctly? = 
     102Chances are your theme is missing the `<?php wp_footer(); ?>` snippet in the footer.php. 
     104= How often are comments aggregated from Facebook and Twitter? = 
     106Once a post has been broadcasted to Facebook and/or Twitter Social will attempt to aggregate comments every 2, 4, 8, 12, 24, 48, and every 24 hours after the 48 hour mark after being broadcasted. If the post was broadcasted more than 48 hours ago, and there have been no replies through Facebook and/or Twitter then aggregation for that post will stop. 
     108These are performed using cron jobs noted below. 
     110= How are comments aggregated from Facebook and Twitter? = 
     112When the aggregation process runs Social uses the Facebook and Twitter search APIs to aggregate comments to the system. 
     114For Twitter, Social first searches for retweets and mentions of the broadcasted tweet using the following API calls: /statuses/retweets/:id, /statuses/mentions. Social then stores those IDs in a collection of aggregated comments. Social then hits Twitter's search API and uses the http://example.com?p=:id and the permalink generated by get_permalink($post_id) to search for tweets that contain a link to the blog post. Social then iterates over the search results and adds them to the collection, if the tweet does not already exist in the collection. 
     116For Facebook, Social first uses the Facebook search API to find any post that has the http://example.com?p=:id or the permalink generated by wp_get_permalink($post_id). These posts are then stored in a collection. Next, Social loads the comments for the broadcasted post by calling http://graph.facebook.com/:id/comments. Social then iterates over the search results and adds them to the collection, if the comment does not already exist in the collection. 
     118For both Facebook and Twitter, the final collection of tweets/comments are then added to the blog post as comments. The IDs of the tweets and comments are then stored to the database so when aggregation runs again the tweets and comments already aggregated are not duplicated. 
     120= What tweets will be seen by the Twitter search during aggregation? = 
     122Currently it seems Twitter will only return results using http://example.com/?p=:id and the permalink generated by get_permalink($post_id) if the full link is in the Tweet, or if the URL is minified using t.co URLs. Social can not guarantee that Tweets will be aggregated if any other URL shortening service is used. 
     124= What CRON jobs are built into Social? = 
     126Currently Social contains 2 CRON jobs: 
     1281. `cron_15` 
     1292. `cron_60` 
     131= How can I override Social's internal CRON service with system CRON jobs? = 
     133If you want to run system CRON jobs and disable Social's built in CRON jobs then do the following: 
     1351. Go to Social's settings page. 
     1362. Disable Social's internal CRON mechanism by selecting "Yes" under "Disable Internal CRON Mechanism" and clicking on "Save Settings". 
     1373. Now you should have an API key that you'll find under "API Key" under "Disable Internal CRON Mechanism". Use this API key for the "api_key" parameter on the URL your system CRON fires. 
     138    - An example system CRON could run `http://example.com/?social_cron=cron_15&api_key=your_api_key_here` 
     140= How can I hook into a CRON for extra functionality? = 
     142If you want to hook into a CRON for extra functionality for a service, all you have to do is add an action: 
     144    <?php add_action(Social::$prefix.'cron_15', array('Your_Class', 'your_method')); ?> 
     146= How can I turn on and off Twitter's @Anywhere functionality? = 
     148To utilize Twitter's @Anywhere functionality (hovercards appearing on linked @usernames) you will need to have an @Anywhere application set up. If you don't have an application already created, 
     149visit http://dev.twitter.com/anywhere. 
     151Once you have an Consumer API key, login to your WordPress installation and navigate to Settings -> Social -> Twitter @Anywhere Settings. Enter your `Consumer key` in the input box and click on "Save Settings". 
     153If you want to disable the @Anywhere functionality, simply remove the API key from the Social settings page and click "Save Settings". 
     155= Does the proxy application have access to my passwords now? = 
     157No, the proxy acts just like any Twitter or Facebook application. We've simply pass commands back and forth through this application so you don't have to set up your own. 
     159== Screenshots == 
     1611. Allow your visitors to leave a comment as their Facebook or Twitter identities 
     1632. Social settings screen to connect accounts, set up default broadcast settings and more 
     1653. Post edit screen settings: broadcast the post, manually import comments, view a log of imported items 
     1674. View of replies imported from Twitter as comments, @anywhere support  
     169== Changelog == 
     171= 1.0 = 
     172* Initial release 
Note: See TracChangeset for help on using the changeset viewer.