You are here

Home » API reference » Twitter 6.5

README.txt in Twitter 6.5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.3 README.txt
  3. 6.4 README.txt
  4. 7.6 README.txt
  5. 7.3 README.txt
  6. 7.4 README.txt
  7. 7.5 README.txt
Twitter
-------
The 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
--------------------------------------------------------------------------------
The OAuth module is required:
  https://www.drupal.org/project/oauth

Note: only the v6.x-3.x releases of OAuth have been tested, the older v6.x-2.x
releases may not work.

When installing the Twitter module without the above being available, Drupal
will complain about a missing "oauth_common" module. This module is actually
provided by the OAuth project - the module name and project name are not the
same, hence this error.

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

Further installation instructions can be found at:
  https://www.drupal.org/node/1346824


How to use the username, hashtag and embedded tweet input filters
--------------------------------------------------------------------------------
1. Go to admin/settings/filters.
2. Select the text format where the filters are to be added to.
3. At "Enabled filters" check the Twitter filters.

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

#drupal @drupal

This will link to a search in Twitter for the #drupal hashtag, and to the
@drupal account profile page.

To display a single tweet in a page, insert a full URL to a tweet in a node's
body field, e.g.:

https://twitter.com/drupal/status/580521032664145920

These filters are avilable when configuring list of tweets in Views.

Note: These filters may be used without OAuth being configured.


How to post to Twitter
--------------------------------------------------------------------------------
 1. Install and configure OAuth, as described above.

 2. Verify permissions at admin/user/permissions:
    - post to twitter
      Users with this permission will be able to post to Twitter using an
      authenticated account that they have added to the site.
    - post to twitter with global account
      Users with this permission will be able to post to Twitter using an
      account that is set up with the "is global" option.

 3. Go to admin/settings/twitter/post and select from which node types a user
    may post to Twitter, and the default message that will be posted.

 4. Add a Twitter account and try to edit or post content.

Further information can be found at https://www.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 supported so far:

* A visitor logs in with their Twitter account and, once authenticated at
  Twitter.com, fills in their email in the Drupal registration form and receives
  an email to log in and their account password.

* An existing user signs in with Twitter and then logs in into their Drupal user
  account. This results in the Twitter account mecoming 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.


Credits / Contact
--------------------------------------------------------------------------------
Currently maintained by Damien McKenna [1]. Originally written by James Walker
[2] with many contributions by Michael Hellein [3], Juampy Novillo Requena [4],
Chris Burgess [5], Jeff Eaton [6] and others in the community.

Ongoing development is sponsored by Mediacurrent [7].

The best way to contact the authors is to submit an issue, be it a support
request, a feature request or a bug report, in the project issue queue:
  https://www.drupal.org/project/issues/twitter


References
--------------------------------------------------------------------------------
1: https://www.drupal.org/u/damienmckenna
2: https://www.drupal.org/u/walkah
3: https://www.drupal.org/u/michaek
4: https://www.drupal.org/u/juampynr
5: https://www.drupal.org/u/xurizaemon
6: https://www.drupal.org/u/eaton
7: http://www.mediacurrent.com/

File

README.txt
View source 
  1. Twitter

  2. -------

  3. The Twitter module allows listing tweets in blocks or pages. Its integration

  4. with Views opens the door to all sorts of formatting (ie. as an automatic

  5. slideshow with views_slideshow). It also provides useful input filters to easily

  6. link Twitter accounts and searches within text.

  7. 

  8. Twitter's submodules allow posting to Twitter, executing actions/rules when

  9. tweeting or login with a Twitter account.

  10. 

  11. 

  12. Installation

  13. --------------------------------------------------------------------------------

  14. The OAuth module is required:

  15.   https://www.drupal.org/project/oauth

  16. 

  17. Note: only the v6.x-3.x releases of OAuth have been tested, the older v6.x-2.x

  18. releases may not work.

  19. 

  20. When installing the Twitter module without the above being available, Drupal

  21. will complain about a missing "oauth_common" module. This module is actually

  22. provided by the OAuth project - the module name and project name are not the

  23. same, hence this error.

  24. 

  25. Once OAuth and Twitter have been enabled, go to admin/settings/twitter and

  26. follow the instructions in order to provide the Twitter Application keys.

  27. 

  28. Further installation instructions can be found at:

  29.   https://www.drupal.org/node/1346824

  30. 

  31. 

  32. How to use the username, hashtag and embedded tweet input filters

  33. --------------------------------------------------------------------------------

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

  35. 2. Select the text format where the filters are to be added to.

  36. 3. At "Enabled filters" check the Twitter filters.

  37. 

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

  39. 

  40. #drupal @drupal

  41. 

  42. This will link to a search in Twitter for the #drupal hashtag, and to the

  43. @drupal account profile page.

  44. 

  45. To display a single tweet in a page, insert a full URL to a tweet in a node's

  46. body field, e.g.:

  47. 

  48. https://twitter.com/drupal/status/580521032664145920

  49. 

  50. These filters are avilable when configuring list of tweets in Views.

  51. 

  52. Note: These filters may be used without OAuth being configured.

  53. 

  54. 

  55. How to post to Twitter

  56. --------------------------------------------------------------------------------

  57.  1. Install and configure OAuth, as described above.

  58. 

  59.  2. Verify permissions at admin/user/permissions:

  60.     - post to twitter

  61.       Users with this permission will be able to post to Twitter using an

  62.       authenticated account that they have added to the site.

  63.     - post to twitter with global account

  64.       Users with this permission will be able to post to Twitter using an

  65.       account that is set up with the "is global" option.

  66. 

  67.  3. Go to admin/settings/twitter/post and select from which node types a user

  68.     may post to Twitter, and the default message that will be posted.

  69. 

  70.  4. Add a Twitter account and try to edit or post content.

  71. 

  72. Further information can be found at https://www.drupal.org/node/1016584.

  73. 

  74. 

  75. How to sign in with Twitter

  76. --------------------------------------------------------------------------------

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

  78. module. The following scenarios are being supported so far:

  79. 

  80. * A visitor logs in with their Twitter account and, once authenticated at

  81.   Twitter.com, fills in their email in the Drupal registration form and receives

  82.   an email to log in and their account password.

  83. 

  84. * An existing user signs in with Twitter and then logs in into their Drupal user

  85.   account. This results in the Twitter account mecoming related to the user

  86.   account so next time Twitter sign-in will work.

  87. 

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

  89.   automatically by clicking on the "Sign in with Twitter" button.

  90. 

  91. 

  92. Credits / Contact

  93. --------------------------------------------------------------------------------

  94. Currently maintained by Damien McKenna [1]. Originally written by James Walker

  95. [2] with many contributions by Michael Hellein [3], Juampy Novillo Requena [4],

  96. Chris Burgess [5], Jeff Eaton [6] and others in the community.

  97. 

  98. Ongoing development is sponsored by Mediacurrent [7].

  99. 

  100. The best way to contact the authors is to submit an issue, be it a support

  101. request, a feature request or a bug report, in the project issue queue:

  102.   https://www.drupal.org/project/issues/twitter

  103. 

  104. 

  105. References

  106. --------------------------------------------------------------------------------

  107. 1: https://www.drupal.org/u/damienmckenna

  108. 2: https://www.drupal.org/u/walkah

  109. 3: https://www.drupal.org/u/michaek

  110. 4: https://www.drupal.org/u/juampynr

  111. 5: https://www.drupal.org/u/xurizaemon

  112. 6: https://www.drupal.org/u/eaton

  113. 7: http://www.mediacurrent.com/