You are here

Home » API reference » Twitter 7.5

README.txt in Twitter 7.5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.5 README.txt
  3. 6.3 README.txt
  4. 6.4 README.txt
  5. 7.6 README.txt
  6. 7.3 README.txt
  7. 7.4 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, login with a Twitter account, or listing the most recent tweet from a
specific account.


Installation
--------------------------------------------------------------------------------
The OAuth module is required:
  https://www.drupal.org/project/oauth

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/config/services/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/people/permissions:
    - Post a message 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 a message to Twitter using a 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/config/services/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, login with a Twitter account, or listing the most recent tweet from a

  10. specific account.

  11. 

  12. 

  13. Installation

  14. --------------------------------------------------------------------------------

  15. The OAuth module is required:

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

  17. 

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

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

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

  21. same, hence this error.

  22. 

  23. Once OAuth and Twitter have been enabled, go to admin/config/services/twitter

  24. and follow the instructions in order to provide the Twitter Application keys.

  25. 

  26. Further installation instructions can be found at:

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

  28. 

  29. 

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

  31. --------------------------------------------------------------------------------

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

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

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

  35. 

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

  37. 

  38. #drupal @drupal

  39. 

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

  41. @drupal account profile page.

  42. 

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

  44. body field, e.g.:

  45. 

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

  47. 

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

  49. 

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

  51. 

  52. 

  53. How to post to Twitter

  54. --------------------------------------------------------------------------------

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

  56. 

  57.  2. Verify permissions at admin/people/permissions:

  58.     - Post a message to Twitter

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

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

  61.     - Post a message to Twitter using a global account

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

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

  64. 

  65.  3. Go to admin/config/services/twitter/post and select from which node types a

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

  67. 

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

  69. 

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

  71. 

  72. 

  73. How to sign in with Twitter

  74. --------------------------------------------------------------------------------

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

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

  77. 

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

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

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

  81. 

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

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

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

  85. 

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

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

  88. 

  89. 

  90. Credits / Contact

  91. --------------------------------------------------------------------------------

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

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

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

  95. 

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

  97. 

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

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

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

  101. 

  102. 

  103. References

  104. --------------------------------------------------------------------------------

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

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

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

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

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

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

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