You are here

Home » API reference » Twitter 6.4

README.txt in Twitter 6.4

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.5 README.txt
  3. 6.3 README.txt
  4. 7.6 README.txt
  5. 7.3 README.txt
  6. 7.4 README.txt
  7. 7.5 README.txt
Introduction
============
Twitter module allows listing tweets in blocks or pages. Its integration with Views opens the
door to all sorts of formatting (ie. as an automatic slideshow with views_slideshow). It also
provides useful input filters to easily link Twitter accounts and searches within text.

Twitter's submodules allow posting to twitter, executing actions/rules when tweeting or login
with a Twitter account.

Installation
============
Twitter's REST API library is out of the module. Although this needs an extra step on installation,
it makes the library reusable for both Drupal 6 and 7 versions and also other modules.

To set it up, just download twitter.lib.php from https://github.com/juampy72/twitter-rest-php/downloads
to your libraries directory (normally sites/all/libraries) so its final location is
sites/all/libraries/twitter/twitter.lib.php

To verify that it has been installed correctly, view the Status Report at
http://yoursite/admin/reports/status.

OAuth
=====
OAuth module is required for all requests to the Twitter REST API 1.1.

When you download the OAuth module, get the latest stable release available at http://drupal.org/project/oauth

Once OAuth has been enabled, go to admin/settings/twitter and follow instructions in order
to provide your Application keys.

How to add a Twitter account to a Drupal user account
=====================================================
Read http://drupal.org/node/1253026 for details.

How to use the username and hashtag input filters
=================================================
1. Go to admin/settings/filters.
2. Select the input format where you want to use the filters.
3. At "Enabled filters" check the Twitter converters.

After that, clear cache and try to create a page with the following body:

#drupal @drupal

The above links to a search in Twitter over the #drupal tag and a to the @drupal profile.
These filters are avilable when configuring a tweets Views.

How to post to Twitter
======================
1. Enable the twitter_post submodule.
2. Make sure that your Twitter application at http://dev.twitter.com has read/write
   permissions.
3. Set up the OAuth section at admin/settings/twitter and add a Twitter account.
4. Go to admin/settings/twitter/post and select from which
   node types a user may post to Twitter and the default message.
5. Verify permissions at admin/user/permissions#module-twitter_post.
6. Edit or post new content and test the Post to Twitter field.

You can find further info at http://drupal.org/node/1016584.

How to sign in with Twitter
===========================
Existing and new users can sign in with Twitter by enabling the twitter_signin module.
The following scenarios are being contemplated so far:

* A visitor logs in with his Twitter account and, once authenticated at Twitter.com,
  she fills in his email in the Drupal registration form and receives an email to log
  in and set her account password.
* An existing user signs in with Twitter and then logs in into her Drupal user account.
  This results in the Twitter account getting related to the user account so next time
  Twitter sign in will work.
* An existing user with an already configured Twitter account can log in automatically
  by clicking on the Sign in with Twitter button.

File

README.txt
View source 
  1. Introduction

  2. ============

  3. Twitter module allows listing tweets in blocks or pages. Its integration with Views opens the

  4. door to all sorts of formatting (ie. as an automatic slideshow with views_slideshow). It also

  5. provides useful input filters to easily link Twitter accounts and searches within text.

  6. 

  7. Twitter's submodules allow posting to twitter, executing actions/rules when tweeting or login

  8. with a Twitter account.

  9. 

  10. Installation

  11. ============

  12. Twitter's REST API library is out of the module. Although this needs an extra step on installation,

  13. it makes the library reusable for both Drupal 6 and 7 versions and also other modules.

  14. 

  15. To set it up, just download twitter.lib.php from https://github.com/juampy72/twitter-rest-php/downloads

  16. to your libraries directory (normally sites/all/libraries) so its final location is

  17. sites/all/libraries/twitter/twitter.lib.php

  18. 

  19. To verify that it has been installed correctly, view the Status Report at

  20. http://yoursite/admin/reports/status.

  21. 

  22. OAuth

  23. =====

  24. OAuth module is required for all requests to the Twitter REST API 1.1.

  25. 

  26. When you download the OAuth module, get the latest stable release available at http://drupal.org/project/oauth

  27. 

  28. Once OAuth has been enabled, go to admin/settings/twitter and follow instructions in order

  29. to provide your Application keys.

  30. 

  31. How to add a Twitter account to a Drupal user account

  32. =====================================================

  33. Read http://drupal.org/node/1253026 for details.

  34. 

  35. How to use the username and hashtag input filters

  36. =================================================

  37. 1. Go to admin/settings/filters.

  38. 2. Select the input format where you want to use the filters.

  39. 3. At "Enabled filters" check the Twitter converters.

  40. 

  41. After that, clear cache and try to create a page with the following body:

  42. 

  43. #drupal @drupal

  44. 

  45. The above links to a search in Twitter over the #drupal tag and a to the @drupal profile.

  46. These filters are avilable when configuring a tweets Views.

  47. 

  48. How to post to Twitter

  49. ======================

  50. 1. Enable the twitter_post submodule.

  51. 2. Make sure that your Twitter application at http://dev.twitter.com has read/write

  52.    permissions.

  53. 3. Set up the OAuth section at admin/settings/twitter and add a Twitter account.

  54. 4. Go to admin/settings/twitter/post and select from which

  55.    node types a user may post to Twitter and the default message.

  56. 5. Verify permissions at admin/user/permissions#module-twitter_post.

  57. 6. Edit or post new content and test the Post to Twitter field.

  58. 

  59. You can find further info at http://drupal.org/node/1016584.

  60. 

  61. How to sign in with Twitter

  62. ===========================

  63. Existing and new users can sign in with Twitter by enabling the twitter_signin module.

  64. The following scenarios are being contemplated so far:

  65. 

  66. * A visitor logs in with his Twitter account and, once authenticated at Twitter.com,

  67.   she fills in his email in the Drupal registration form and receives an email to log

  68.   in and set her account password.

  69. * An existing user signs in with Twitter and then logs in into her Drupal user account.

  70.   This results in the Twitter account getting related to the user account so next time

  71.   Twitter sign in will work.

  72. * An existing user with an already configured Twitter account can log in automatically

  73.   by clicking on the Sign in with Twitter button.