DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Social Connect

Author:Christopher
Created:2010-12-18T19:57:23
Changed by:Robert Lockerbie
Changed:2011-09-28T15:34:08.590000000
Classification:rl_socialconnect
Keywords:forEditors, forBeginners
Author:Robert Lockerbie
Email:robert.lockerbie@gmail.com
Language:en

img-1 img-2 EXT: Social Connect

Extension Key: rl_socialconnect

Language: en

Version: 1.00

Keywords: forEditors, forBeginners

Copyright 2006-2011, Robert Lockerbie, <robert.lockerbie@gmail.com>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents

`EXT: Social Connect 1 <#__RefHeading__5708_1738894311>`_

`Introduction 3 <#__RefHeading__5710_1738894311>`_

What does it do? 3

Screenshots 3

`Users manual 11 <#__RefHeading__467_413120346>`_

Quickstart 11

`Administration 12 <#__RefHeading__31511_818911409>`_

`Configuration 13 <#__RefHeading__31515_818911409>`_

Twitter Feed 13

Facebook Gallery 13

Flickr Gallery 14

YouTube Video Links 14

Facebook Like 15

Blog Feed 16

Ustream 16

`Known problems 17 <#__RefHeading__31525_818911409>`_

`To-Do list 18 <#__RefHeading__477_413120346>`_

`ChangeLog 19 <#__RefHeading__31623_818911409>`_

Introduction

What does it do?

This extension enables social media integration on your website.

It currently supports:

  • Twitter Feed – Basic twitter feed
  • Facebook Gallery – Show any public Facebook Gallery
  • Flickr Gallery – Show any public Flickr Gallery
  • YoutTube Video Links – Allows both single video and thumbnail lists
  • Facebook Like – Provides a simple way to add a facebook like button to a page
  • Blog feed – Currently supports Blogger and Wordpress
  • Ustream – Currently only allows single videos

Screenshots

Twitter feed backend

img-3 Twitter feed frontend """""""""""""""""""""

img-4 Facebook gallery backend """"""""""""""""""""""""

img-5 Facebook gallery frontend """""""""""""""""""""""""

img-6 img-7 Flickr gallery backend """"""""""""""""""""""

Quickstart

There are no special requirements for any of the plugins, simple import or download the extension from the repository and install the extension.

Create a new “Insert Plugin” content element and select the desired plugin.

Configuration of the plugins is handled completely by flexform.

Administration

Currently there are no advanced configuration options, it is all handled through the flexforms.

Configuration

There is no default CSS included, you will have to manually add this in. There is a basic stylesheet included, but I would recommend only using this as a guide. The quickest way to add this stylesheet is including in the header data of the page:

page.includeCSS.file7 = EXT:rl_socialconnect/templates/example.css

Some of the plugins require jQuery, jQuery UI and fancybox. A copy of jQuery and fancy box is available but not included by default. You will have to manually include these libraries.

page.includeJS.file5 = EXT:rl_socialconnect/templates/js/jQuery.js
page.includeJS.file6 = EXT:rl_socialconnect/templates/js/fancybox/jquery.fancybox-1.3.1.pack.js
page.includeCSS.file8 = EXT:rl_socialconnect/templates/js/fancybox/jquery.fancybox-1.3.1.css

It should be relatively straight forward to use any library you wish, just remember to modify the templates accordingly.

Twitter Feed

General
Twitter Screen Name

Property

Twitter Screen Name

Data type

string

Description

The screen name of the user who's tweets you want to show.

Default

Template

Property

Template

Data type

file

Description

The template file for the plugin.

Default

EXT:rl_socialconnect/templates/ustream/default.html

Limit

Property

Limit

Data type

int

Description

How many tweets to show.

Default

5

Limit Other

Property

Limit Other

Data type

string

Description

Manual limit for when the hard-coded values don't suit. Limit must be set to Other.

Default

Facebook Like

General
Display type

Property

Display type

Data type

Item

Description

Choose between the like button or the like box

Default

Like Button

The URL to like, defaults to the current page.

Property

The URL to like, defaults to the current page.

Data type

string

Description

The URL that will get liked, will default to the current page.

Default

Include a send button?

Property

Include a send button?

Data type

Boolean

Description

Default

true

Layout style: determines the size and amount of social context next to

Property

Layout style: determines the size and amount of social context next to the button.

Data type

Items

Description

Standard, button count, box count.

Default

Standard

Verb to display

Property

Verb to display

Data type

Items

Description

Default

like

Font

Property

Font

Data type

Items

Description

Override font

Default

Colour Scheme

Property

Colour Scheme

Data type

Items

Description

Light or dark

Default

light

Template

Property

Template

Data type

file

Description

The template file for the plugin.

Default

EXT:rl_socialconnect/templates/facebook/default.html

Blog Feed

General
Feed URL

Property

Feed URL

Data type

String

Description

RSS feed of a blogger or wordpress blog.

Default

Template

Property

Template

Data type

file

Description

The template file for the plugin.

Default

EXT:rl_socialconnect/templates/blog/default.html

Limit

Property

Limit

Data type

int

Description

How many blog entries to show

Default

4

Limit Other

Property

Limit Other

Data type

string

Description

Manual limit for when the hard-coded values don't suit. Limit must be set to Other.

Default

Ustream

General
Video ID

Property

Video ID

Data type

String

Description

ID of the video to play

Default

Template

Property

Template

Data type

file

Description

The template file for the plugin.

Default

EXT:rl_socialconnect/templates/ustream/default.html

Width

Property

Width

Data type

Int

Description

Video player width

Default

480

Height

Property

Height

Data type

Int

Description

Video player height

Default

296

Autoplay

Property

Autoplay

Data type

Boolean

Description

Default

false

Limit

Property

Limit

Data type

int

Description

How many blog entries to show

Default

4

Limit Other

Property

Limit Other

Data type

string

Description

Manual limit for when the hard-coded values don't suit. Limit must be set to Other.

Default

Known problems

When switching between plugins the template setting doesn't change, which may cause the plugin to output nothing. Make sure the template setting is correct when switching between plugins. This only applies when changing, for example, from the twitter feed to the flick feed.

The facebook galleries are fetched every time you edit the plugin record which can be slow depending on numerous factors.

The YouTube player doesn't work in IE9 64bit edition, due to there being no 64bit flash.

To-Do list

  • Possibly cache the Facebook galleries so they don't take so long to load every time.
  • Add similar gallery fetch system for the Flickr feed section.

ChangeLog

Create a file "ChangeLog" (see e.g. the extension "cal") to inform about changes or use this section to document all the changes through the versions.

Alternatively to using the following list: ChangeLog online (Forge gives the possibility to create a Roadmap very easily; change this link to point to YOUR extension)

1.0.0

Version

1.0.0

Changes

Initial release