You are here

Home » API reference » Twitter Profile Widget 8.2

README.txt in Twitter Profile Widget 8.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Theming
 * Developers
 * Maintainers

INTRODUCTION
------------
This module provides GET integration with the Twitter API. After registering API credentials, create any number of widgets, each of which will display tweets from any account or timeline. Per-widget configuration includes whether to display replies & retweets and how many tweets should display.

By design, the default "theming" is minimal. Developers are expected to customize the display via their chosen theme.


INSTALLATION
------------
1. Install as you would normally install a contributed drupal module. See:
  https://www.drupal.org/documentation/install/modules-themes/modules-8
  for further information.

2. Go to 'Manage > Extend', and enable the Twitter Profile Widget module (drush en twitter_profile_widget).

CONFIGURATION
-------------
1. You first need a Twitter App. This is different from the Twitter widget ID, and allows you to connect to the Twitter API. To get a Twitter App, sign in to Twitter and go to https://apps.twitter.com/ . Copy the "key" and "secret" associated with your new app.

2. After installing the module in Drupal, go to Configuration > Media > Twitter Widgets (admin/config/media/twitter_profile_widget). Enter the Twitter App key and secret you created in step #1.

3. Go to Admin > Structure > Block Layout > Add custom block (/admin/structure/block/block-content) and create one or more widgets. The "description" is internal, to identify different widgets.

4. Now that you have Twitter widgets set up, you can display them in any part of your site via block display.

THEMING
-------
By design, the display of tweets  provided by this module is minimal. Developers can copy the twitter_widget.html.twig file from the /templates directory and add it to their theme and customize as necessary.

To negate the CSS provided by this module, remove the {{ attach_library('twitter_profile_widget/twitter-profile-widget') }} from the twig file, or point it to your own defined library.

DEVELOPERS
----------
The Twitter Profile Widget provides ways for developers to extend or customize the framework. All available hooks are listed in twitter_profile_widget.api.php.

PHP 7 has different requirements for cURL requests over HTTPS. If you are use
PHP 7 and get the error "Uncaught PHP Exception Exception: "SSL certificate problem: unable to get local issuer certificate," you will need to resolve this
in your PHP setup.

MAINTAINERS
-----------
Current maintainers:
 * Mark Fullmer (mark_fullmer) - https://www.drupal.org/u/mark_fullmer

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3.  * Introduction

  4.  * Requirements

  5.  * Installation

  6.  * Configuration

  7.  * Theming

  8.  * Developers

  9.  * Maintainers

  10. 

  11. INTRODUCTION

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

  13. This module provides GET integration with the Twitter API. After registering API credentials, create any number of widgets, each of which will display tweets from any account or timeline. Per-widget configuration includes whether to display replies & retweets and how many tweets should display.

  14. 

  15. By design, the default "theming" is minimal. Developers are expected to customize the display via their chosen theme.

  16. 

  17. 

  18. INSTALLATION

  19. ------------

  20. 1. Install as you would normally install a contributed drupal module. See:

  21.   https://www.drupal.org/documentation/install/modules-themes/modules-8

  22.   for further information.

  23. 

  24. 2. Go to 'Manage > Extend', and enable the Twitter Profile Widget module (drush en twitter_profile_widget).

  25. 

  26. CONFIGURATION

  27. -------------

  28. 1. You first need a Twitter App. This is different from the Twitter widget ID, and allows you to connect to the Twitter API. To get a Twitter App, sign in to Twitter and go to https://apps.twitter.com/ . Copy the "key" and "secret" associated with your new app.

  29. 

  30. 2. After installing the module in Drupal, go to Configuration > Media > Twitter Widgets (admin/config/media/twitter_profile_widget). Enter the Twitter App key and secret you created in step #1.

  31. 

  32. 3. Go to Admin > Structure > Block Layout > Add custom block (/admin/structure/block/block-content) and create one or more widgets. The "description" is internal, to identify different widgets.

  33. 

  34. 4. Now that you have Twitter widgets set up, you can display them in any part of your site via block display.

  35. 

  36. THEMING

  37. -------

  38. By design, the display of tweets  provided by this module is minimal. Developers can copy the twitter_widget.html.twig file from the /templates directory and add it to their theme and customize as necessary.

  39. 

  40. To negate the CSS provided by this module, remove the {{ attach_library('twitter_profile_widget/twitter-profile-widget') }} from the twig file, or point it to your own defined library.

  41. 

  42. DEVELOPERS

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

  44. The Twitter Profile Widget provides ways for developers to extend or customize the framework. All available hooks are listed in twitter_profile_widget.api.php.

  45. 

  46. PHP 7 has different requirements for cURL requests over HTTPS. If you are use

  47. PHP 7 and get the error "Uncaught PHP Exception Exception: "SSL certificate problem: unable to get local issuer certificate," you will need to resolve this

  48. in your PHP setup.

  49. 

  50. MAINTAINERS

  51. -----------

  52. Current maintainers:

  53.  * Mark Fullmer (mark_fullmer) - https://www.drupal.org/u/mark_fullmer