Drost-Tenfelde.de

Personal website of Jannes Drost-Tenfelde, resident bass trombone player at Cologne Concert Brass and Brass Band Merum

User Tools

Site Tools


Sidebar

General

Upcoming Events

Music

Media

IT

Additional

dokuwiki:plugins:facebookalbum

facebookalbum Plugin

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

Install the plugin:

  • Extract the archive into your lib/plugins directory. Make sure the files are put into a directory called facebookalbum.
  • Done! You are now ready to use facebookalbum.

Examples/Usage

  • {{facebookalbum>}} 1)
  • {{facebookalbum>appid=123456&secret=123456&fanpageid=123456}} 2)

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

Known Bugs and Issues

ToDo/Wish List

FAQ

Discussion

Thank you for your contributions!

1) Displays the photoalbum of the fanpage. The appid, secret and fanpageid must be defined in the Configuration
2) Displays all photo albums of the fanpage
dokuwiki/plugins/facebookalbum.txt · Last modified: 2013/01/22 22:40 (external edit)

Page Tools