Project

General

Profile

Paste
Download (2.29 KB) Statistics
| Branch: | Revision:

root / drupal7 / sites / all / modules / twitter_block / readme.txt @ 66b5cbf6

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

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

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

    
27
REQUIREMENTS
28
------------
29

    
30
Twitter Block has one dependency.
31

    
32
Drupal core modules
33
 * Block
34

    
35
INSTALLATION
36
------------
37

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

    
41
PERMISSIONS
42
------------
43

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

    
47
USAGE
48
-----
49

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

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

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

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

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

    
69
Theming
70
-------
71

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

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