You are here

README.txt in TwitterField 7

Same filename and directory in other branches
  1. 6 README.txt
Description
-----------

This project aims to solve a common problem of displaying a twitter widget for a
specified username, that has been noted in various places, but never properly
developed.

The module (currently Drupal 7 only, but could easily be backported) implements 
a custom field formatter that takes the contents of a generic Text Field, 
attached to a Node, and treats it like a Twitter Username.   It then provides a
default template file (twitter-field-widget.tpl.php)  That can be overridden in 
your module, with the code generated after you configure a Twitter Profile
Widget and click the "Finish & Grab code" button at Twitter.com.

The default template provided by this module implements the Twitter Profile 
widget, with a basic color scheme. You may override the default template in your 
theme to use the custom code generated by the Profile widget generator, and may 
work with the Twitter search widget or the Twitter faves widget as well. 
Unfortunately, the Twitter List Widget requires knowledge of at least two pieces
of information (user-name, and list-name) and so it is currently not possible 
to override this widget type.

Todo
----

A planned enhancement would be to create a completely custom field type, which 
would allow for storage of two fields as one (needed for the Twitter List Widget 
implementation), but for now, we're piggybacking off of the simple text field 
type.

Usage
-----

1) Download and enable the module as usual. 
2) Create a text field called "Twitter ID" on one of your content types, with a 
max length of for example 30 characters.
3) Change the display format from "Default" to "Twitter Widget".
4) Profit!

Credits
-------

This module was used in combination with a custom view, to build our individual 
profile pages at Bluesparklabs.com. The initial module development sponsored by 
Bluespark Labs.

File

README.txt
View source
  1. Description
  2. -----------
  3. This project aims to solve a common problem of displaying a twitter widget for a
  4. specified username, that has been noted in various places, but never properly
  5. developed.
  6. The module (currently Drupal 7 only, but could easily be backported) implements
  7. a custom field formatter that takes the contents of a generic Text Field,
  8. attached to a Node, and treats it like a Twitter Username. It then provides a
  9. default template file (twitter-field-widget.tpl.php) That can be overridden in
  10. your module, with the code generated after you configure a Twitter Profile
  11. Widget and click the "Finish & Grab code" button at Twitter.com.
  12. The default template provided by this module implements the Twitter Profile
  13. widget, with a basic color scheme. You may override the default template in your
  14. theme to use the custom code generated by the Profile widget generator, and may
  15. work with the Twitter search widget or the Twitter faves widget as well.
  16. Unfortunately, the Twitter List Widget requires knowledge of at least two pieces
  17. of information (user-name, and list-name) and so it is currently not possible
  18. to override this widget type.
  19. Todo
  20. ----
  21. A planned enhancement would be to create a completely custom field type, which
  22. would allow for storage of two fields as one (needed for the Twitter List Widget
  23. implementation), but for now, we're piggybacking off of the simple text field
  24. type.
  25. Usage
  26. -----
  27. 1) Download and enable the module as usual.
  28. 2) Create a text field called "Twitter ID" on one of your content types, with a
  29. max length of for example 30 characters.
  30. 3) Change the display format from "Default" to "Twitter Widget".
  31. 4) Profit!
  32. Credits
  33. -------
  34. This module was used in combination with a custom view, to build our individual
  35. profile pages at Bluesparklabs.com. The initial module development sponsored by
  36. Bluespark Labs.