facebookalbum Plugin

Compatible with DokuWiki

2012-01-25, 2011-05-25, 2010-11-07

This plugin allows you to display your Facebook Albums/Pictures in DokuWiki

Last updated on: 2012-04-13
Provides: Syntax
Repository: Source

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Tagged with album, facebook, gallery, photo, picture

By Jannes Drost-Tenfelde

This pluging allows you to connect to your Facebook page and display the page's photo albums in DokuWiki. This plugin uses the Facebook PHP SDK , PHP and FQL.

Installation

External requirements: This plugin requires the following additional components that must be installed separately:

this plugin uses the Facebook PHP SDK , which requires
- the CURL PHP extension to be installed
- the JSON PHP extension to be installed
Additionally, you must create a Facebook App, which allows you to connect to Facebook using
- App ID, which identifies your Facebook App (you can have multiple Apps)
- App Secret, which secures your Facebook App

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Examples/Usage

Displays the photoalbum of the fanpage. The appid, secret and fanpageid must be defined in the Configuration
```
{{facebookalbum>}}
```

Displays all photo albums of the fanpage

{{facebookalbum>appid=123456&secret=123456&fanpageid=123456}}

See the plugin in action here

Syntax

{{facebookalbum>key=value&..&key=value}}

key	the parameter key to set	optional
value	the parameter value to set	optional

Multiple key=value parameters can be set using the & as a seperator.

Available parameters:

Key	Type	Comments	Requirement	Version
`appid`	string	This is the mandatory App ID of your Facebook App	If the parameter is not set as part of the syntax, the configuration parameter is used instead.	all
`secret`	string	This is the mandatory App Secret of your Facebook App	If the parameter is not set as part of the syntax, the configuration parameter is used instead	all
`fanpageid`	string	This is the ID of your Facebook page. You can find this ID by going to your Facebook page. Typically, the link of your page looks like https://www.facebook.com/#!/pages/<page name>/<page ID>. Copy the page ID from the URL and use it in the syntax.	optional. If the parameter is not set as part of the syntax, the configuration parameter is used instead	all
`order`	string	Default: `DESC` Allows you to sort by the album names. Valid values are `ASC` and `DESC`.	optional	all
`ignore`	string	Default: `cover pictures` Allows you to give a list of album names that you wish to igore. The album names must be seperated by a \|. Example: cover pictures\|wall pictures	optional	all

Configuration and Settings

Key	Type	Comments	Requirement	Version
`appid`	string	This is the mandatory App ID of your Facebook App	If the parameter is not set as part of the syntax, the configuration parameter is used instead.	all
`secret`	string	This is the mandatory App Secret of your Facebook App	If the parameter is not set as part of the syntax, the configuration parameter is used instead	all
`fanpageid`	string	This is the ID of your Facebook page. You can find this ID by going to your Facebook page. Typically, the link of your page looks like https://www.facebook.com/#!/pages/<page name>/<page ID>. Copy the page ID from the URL and use it in the syntax.	If the parameter is not set as part of the syntax, the configuration parameter is used instead	all
`order`	string	See Syntax parameters. If the syntax parameter is not set, the configuration parameter will be used instead.	optional	all
`ignore`	string	See Syntax parameters. If the syntax parameter is not set, the configuration parameter will be used instead.	optional	all
`album_template`	string	This parameter allows you to configure the representation of your facebook photo albums. You can use DokuWiki syntax and use the template tags described in Display templates to fill in specific album information.	mandatory
`picture_template`	string	This parameter allows you to configure the representation of your facebook pictures. You can use DokuWiki syntax and use the template tags described in Display templates to fill in specific album information.	mandatory

Display templates

The configuration parameters album_template and picture_template allow you to have full flexibility on how you wish to display your albums and pictures. These templates use the standard DokuWiki syntax.

Template tags

Tag	Template	Comments	Version
`{name}`	album_template	The album name	all
`{url}`	album_template	This holds the generated URL that opens up the pictures of the album.	all
`{image_url}`	album_template picture_template	For album_template, this holds the URL to the cover image of the album. For picture_template, this holds the Thumbnail of the picture.	all
`{caption}`	picture_template	This holds the caption of the picture	all
`{album_name}`	picture_template	This holds the album name of the picture	all
`{image_small_url}`	picture_template	This is the URL of a resized version of the picture. This is generated by Facebook.	all
`{image_large_url}`	picture_template	This is the URL of the original picture.	all

Development

Change Log

2012-04-13
- Initial release

Known Bugs and Issues

ToDo/Wish List

FAQ

Discussion

Thank you for your contributions!

Table of Contents