Geodesic Solutions Community Wiki

Coming Soon!

The Twitter Feed addon allows your site's users to enter their Twitter username during the listing placement process. If they do so, their most recent Tweets will appear in a customizable module that you can place anywhere on the listing details page. The settings for the appearance and behavior of the feed are contained in a template file, addon/twitter_feed/twitter_feed.tpl.

This page will detail each of the settings in that file. By default, the portion to edit looks like this:

 version: 2, //internal system variable -- don't change this
  type: 'profile', //internal system variable -- don't change this
  rpp: 10, //number of tweets to show
  interval: 4000, //only used when features.behavior=default: time between adding each update, in milliseconds (e.g. 4000 = 4 seconds) 
  width: 250, //width of widget, in pixels or 'auto'
  height: 300, //height of widget, in pixels
  theme: {
    shell: {
      background: '#4174a6', //frame color
      color: '#FFFFFF' //frame text color 
    },
    tweets: {
      background: '#F7F7F7', //main background color
      color: '#000000', //text color
      links: '#4aed05' //link color
    }
  },
  features: {
    scrollbar: false, //show scrollbar on the side [true|false]
    loop: true, //only when behavior=default: loop back to beginning once complete [true|false]
    live: true, //poll for new updates [true|false]
    hashtags: true, //include any #hashtags in updates [true|false]
    timestamp: true, //show time each update was posted [true|false]
    avatars: true, //show user pictures to the left of each update [true|false]
    behavior: 'default' //default: automatically scroll || all: show all updates without scrolling (be sure to use scrollbar=true)
  }

As you can see, there are three main sections of options: the overall settings at the top, the "theme" settings in the middle, and the "features" settings at the bottom. Each setting includes a comment that gives a brief description of what it does, but this page will go into more detail on each.

These are the basic, numerical settings that describe how the feed will appear.

This is an internal setting, and should always be 2

This is an internal setting, and should always be 'profile'

This is the number of unique Tweets that will appear when the feed is loaded. The default value is 10

This is the time in milliseconds the script will wait between loading each tweet. Note that this only has an effect when using the "default" behavior (in the Features section). The default is 4000, which translates to 4 seconds.

The width in pixels of the feed, as it appears on the listing details page. Also accepts the value 'auto' for automatic width detection. Default is 250

The height in pixels of the feed, as it appears on the listing details page. Does NOT accept 'auto' as a value. Default is 300

These are settings that deal with the colors used in the feed. Each setting takes as its input an HTML-style RGB hex code.

The main "frame" color of the feed. Default is '#4174A6', which is the blue color used in the Geo v5 design

Text color for the frame header. Default is '#FFFFFF', or white.

Background color for the body of the feed display. Default is '#F7F7F7', which is a light grey.

Color of the text used for the actual tweets. Default is '#000000', or black.

Color of the links used in and around the tweet text. Default is '#4AED05', which is the green color used in the Geo v5 design

These settings describe the way tweets appear, and the way users can interact with the feed.

If this is set to true, a scrollbar will be shown on the right-hand side of the feed, to allow a viewer to scroll between displayed tweets. This is most useful when the "behavior" setting is all. Valid values for this setting are: true or false. Default is false.

This setting is only used when the "behavior" setting is default. Causes the feed to "loop" once finished, and show the first items again once it reaches the end. Valid values for this setting are: true or false. Default is true.

If this is set to true, the feed will periodically poll the Twitter servers for new tweets to show. Valid values for this setting are: true or false. Default is true.

Twitter users will sometimes include a descriptive "hashtag" at the end of a tweet. Setting this to false will cause hashtags to not be shown. Valid values for this setting are: true or false. Default is true.

If this is set to true, each tweet will be followed by a short text string describing how long ago it was made, such as "posted about 2 hours ago." Valid values for this setting are: true or false. Default is true.

If this is set to true, each tweet will show the profile image of its posting user to its left. Valid values for this setting are: true or false. Default is true.

Controls whether tweets will be loaded individually or all at the same time. Valid values for this setting are: 'default' or 'all'. Default is 'default'.