You are here

Home » API reference » Twitter Block 8.2

README.txt in Twitter Block 8.2

Same filename and directory in other branches
  1. 8.3 README.txt
  2. 6 readme.txt
  3. 7.2 readme.txt
  4. 7 readme.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Permissions
 * Usage
 * Theming

INTRODUCTION
------------

Current Maintainers:

 * ZenDoodles http://drupal.org/user/226976
 * cweagans http://drupal.org/user/404732
 * Devin Carlson http://drupal.org/user/290182
 * Naveen Valecha http://drupal.org/user/2665733

Twitter Block is a lightweight module which allows administrators to create
blocks which display embedded timelines.

Twitter Block will never provide advanced Twitter integration such as OAuth
user authentication or the ability to tweet from Drupal. These capabilities are
provided by other modules such as Twitter (http://drupal.org/project/twitter).

REQUIREMENTS
------------

Twitter Block has one dependency.

Drupal core modules
 * Block

INSTALLATION
------------

Twitter Block can be installed via the standard Drupal installation process
(http://drupal.org/documentation/install/modules-themes/modules-8).

PERMISSIONS
------------

The ability to create, edit and delete Twitter Block blocks relies on the block
module's "Administer blocks" permission.

USAGE
-----

Administrators can visit the Blocks administration page where they can create
new Twitter Block blocks and update or delete existing Twitter Block blocks.

Administrators can also position Twitter Block blocks as they can with standard
or custom blocks provided by the core Block module.

Each Twitter Block block requires a unique widget ID which determines, among
other things, the source (user timeline, favourites, list or search) of the
tweets to display.

You can view a list of your existing embedded timeline widgets (and their
widget IDs) or create new embedded timeline widgets by visiting
https://twitter.com/settings/widgets (make sure that you're logged in).

You can determine a widget's ID by editing it and inspecting the URL (which
should be in the form of https://twitter.com/settings/widgets/WIDGET_ID/edit)
or by looking at the widget's embed code (look for
data-widget-id="WIDGET_ID").

Theming
-------

Embedded Timelines offer a number of customization options such as theme, layout
and border color but, due to the way embedded timelines are implemented, custom
theming using CSS can be difficult.

To add custom CSS to embedded timelines check out the
(http://github.com/kevinburke/customize-twitter-1.1) Customize Twitter project.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Permissions

  8.  * Usage

  9.  * Theming

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. Current Maintainers:

  15. 

  16.  * ZenDoodles http://drupal.org/user/226976

  17.  * cweagans http://drupal.org/user/404732

  18.  * Devin Carlson http://drupal.org/user/290182

  19.  * Naveen Valecha http://drupal.org/user/2665733

  20. 

  21. Twitter Block is a lightweight module which allows administrators to create

  22. blocks which display embedded timelines.

  23. 

  24. Twitter Block will never provide advanced Twitter integration such as OAuth

  25. user authentication or the ability to tweet from Drupal. These capabilities are

  26. provided by other modules such as Twitter (http://drupal.org/project/twitter).

  27. 

  28. REQUIREMENTS

  29. ------------

  30. 

  31. Twitter Block has one dependency.

  32. 

  33. Drupal core modules

  34.  * Block

  35. 

  36. INSTALLATION

  37. ------------

  38. 

  39. Twitter Block can be installed via the standard Drupal installation process

  40. (http://drupal.org/documentation/install/modules-themes/modules-8).

  41. 

  42. PERMISSIONS

  43. ------------

  44. 

  45. The ability to create, edit and delete Twitter Block blocks relies on the block

  46. module's "Administer blocks" permission.

  47. 

  48. USAGE

  49. -----

  50. 

  51. Administrators can visit the Blocks administration page where they can create

  52. new Twitter Block blocks and update or delete existing Twitter Block blocks.

  53. 

  54. Administrators can also position Twitter Block blocks as they can with standard

  55. or custom blocks provided by the core Block module.

  56. 

  57. Each Twitter Block block requires a unique widget ID which determines, among

  58. other things, the source (user timeline, favourites, list or search) of the

  59. tweets to display.

  60. 

  61. You can view a list of your existing embedded timeline widgets (and their

  62. widget IDs) or create new embedded timeline widgets by visiting

  63. https://twitter.com/settings/widgets (make sure that you're logged in).

  64. 

  65. You can determine a widget's ID by editing it and inspecting the URL (which

  66. should be in the form of https://twitter.com/settings/widgets/WIDGET_ID/edit)

  67. or by looking at the widget's embed code (look for

  68. data-widget-id="WIDGET_ID").

  69. 

  70. Theming

  71. -------

  72. 

  73. Embedded Timelines offer a number of customization options such as theme, layout

  74. and border color but, due to the way embedded timelines are implemented, custom

  75. theming using CSS can be difficult.

  76. 

  77. To add custom CSS to embedded timelines check out the

  78. (http://github.com/kevinburke/customize-twitter-1.1) Customize Twitter project.