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 |
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>`_
`Users manual 11 <#__RefHeading__467_413120346>`_
`Administration 12 <#__RefHeading__31511_818911409>`_
`Configuration 13 <#__RefHeading__31515_818911409>`_
`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¶
Twitter feed frontend """""""""""""""""""""
Facebook gallery backend """"""""""""""""""""""""
Facebook gallery frontend """""""""""""""""""""""""
Flickr gallery backend """"""""""""""""""""""
Flickr gallery frontend¶
YouTube video links backend """""""""""""""""""""""""""
YouTube video links frontend """"""""""""""""""""""""""""
Facebook like backend """""""""""""""""""""
Facebook like frontend """"""""""""""""""""""
Blog feed backend """""""""""""""""
Blog feed frontend """"""""""""""""""
Ustream backend """""""""""""""
Usream frontend """""""""""""""
Users manual ------------
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 Gallery¶
General¶
Facebook User ID¶
Property
Facebook User ID
Data type
string
Description
The Facebook gallery owners Facebook ID. See http://socialmediaseo.net/2010/02/20/how-to-find-facebook-id/ for information on getting the ID.
Default
Galleries to show¶
Property
Galleries to show
Data type
items
Description
First enter a valid facebook ID and save the record. This will then be filled with any available galleries which you can choose from.
Default
Template¶
Property
Template
Data type
file
Description
The template file for the plugin.
Default
EXT:rl_socialconnect/templates/facebook/default.html
Limit¶
Property
Limit
Data type
int
Description
How many gallery photos 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
Flickr Gallery¶
General¶
Flickr User ID¶
Property
Flickr User ID
Data type
string
Description
User ID of the photos you want to show.
Default
Tags¶
Property
Tags
Data type
string
Description
Comma separated list of tags to filter the photos by.
Default
Template¶
Property
Template
Data type
file
Description
The template file for the plugin.
Default
EXT:rl_socialconnect/templates/flickr/default.html
Limit¶
Property
Limit
Data type
int
Description
How many gallery photos 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
YouTube Video Links¶
General¶
Display Type¶
Property
Display Type
Data type
item
Description
Choose between a list of videos with a popup player dialog, or a single video.
Default
Video Links
YouTube Video IDs (first one is used for single)¶
Property
YouTube Video IDs (first one is used for single)
Data type
string
Description
Youtube video ids to show, one per line.
Single video display type uses the first item.
Default
Template¶
Property
Template
Data type
file
Description
The template file for the plugin.
Default
EXT:rl_socialconnect/templates/youtube/default.html
Video settings¶
Video width¶
Property
Video width
Data type
int
Description
Width of the player
Default
533
Video height¶
Property
Video height
Data type
int
Description
Height of the player
Default
300
Auto hide (only relevant if controls are enabled)¶
Property
Auto hide (only relevant if controls are enabled)
Data type
Item
Description
See settings
Default
Show video progress bar and the video player controls throughout the video
Start the video as soon as the page loads¶
Property
Start the video as soon as the page loads
Data type
Boolean
Description
Default
true
Enable controls¶
Property
Enable controls
Data type
Boolean
Description
Default
false
Display information like the video title and uploader before the video¶
Property
Display information like the video title and uploader before the video starts playing
Data type
Boolean
Description
Default
false
Display the search box when video is minimised¶
Property
Display the search box when video is minimised
Data type
Boolean
Description
Default
false
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