DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:facebookalbum

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:facebookalbum [2015-10-28 14:23] jdtplugin:facebookalbum [2019-01-12 15:09] (current) – Added bugtracker LarsDW223
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
-description: This plugin allows you to display your Facebook Albums/Pictures in DokuWiki.+description: This plugin allows you to display your Facebook Albums/Pictures in DokuWiki
 author     : Jannes Drost-Tenfelde  author     : Jannes Drost-Tenfelde 
 email      : info@drost-tenfelde.de email      : info@drost-tenfelde.de
Line 11: Line 11:
 conflicts  conflicts 
 similar    : facebookwall, facebookevents similar    : facebookwall, facebookevents
-tags       : facebook, photo, album, picture, gallery, fb+tags       : facebook, photo, album, picture, gallery
  
-downloadurl: https://github.com/jdtProjects/dokuwiki/blob/master/published/plugin_facebookalbum_1_0.zip +downloadurl: https://github.com/jdtProjects/dokuwiki/raw/master/published/plugin_facebookalbum_1_0.zip 
-bugtracker : +bugtracker : https://github.com/jdtProjects/dokuwiki/issues
 sourcerepo : https://github.com/jdtProjects/dokuwiki/tree/master/facebookalbum sourcerepo : https://github.com/jdtProjects/dokuwiki/tree/master/facebookalbum
-donationurl: http://drost-tenfelde.de/doku.php/donate+donationurl: http://drost-tenfelde.de/donate 
 + 
 +screenshot_img: 
 ---- ----
  
 This pluging allows you to connect to your Facebook page and display the page's photo albums in DokuWiki. This pluging allows you to connect to your Facebook page and display the page's photo albums in DokuWiki.
-This plugin uses the [[https://github.com/facebook/php-sdk/|Facebook PHP SDK]], [[http://php.net/|PHP]] and [[https://developers.facebook.com/docs/reference/fql/|FQL]].+This plugin uses the [[https://github.com/facebook/php-sdk/|Facebook PHP SDK]] FIXME, [[http://php.net/|PHP]] and [[https://developers.facebook.com/docs/reference/fql/|FQL]].
  
 ===== Installation ===== ===== Installation =====
  
 :!: **External requirements:** This plugin requires the following additional components that must be installed separately: :!: **External requirements:** This plugin requires the following additional components that must be installed separately:
-  * This plugin uses the [[https://github.com/facebook/php-sdk/|Facebook PHP SDK]], which requires +  * this plugin uses the [[https://github.com/facebook/php-sdk/|Facebook PHP SDK]] FIXME, which requires 
-    * The CURL PHP extension to be installed  +    * the CURL PHP extension to be installed  
-    * The JSON PHP extension to  be installed+    * the JSON PHP extension to  be installed
   * Additionally, you must create a [[https://developers.facebook.com/apps/|Facebook App]], which allows you to connect to Facebook using   * Additionally, you must create a [[https://developers.facebook.com/apps/|Facebook App]], which allows you to connect to Facebook using
     * App ID, which identifies your Facebook App (you can have multiple Apps)     * App ID, which identifies your Facebook App (you can have multiple Apps)
     * App Secret, which secures your Facebook App         * App Secret, which secures your Facebook App    
  
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
  
 ===== Examples/Usage ===== ===== Examples/Usage =====
  
-  * ''%%{{facebookalbum>}}%%'' ((Displays the photoalbum of the fanpage. The appid, secret and fanpageid must be defined in the Configuration)) +  * Displays the photoalbum of the fanpage. The appid, secret and fanpageid must be defined in the Configuration<code>{{facebookalbum>}}</code> 
-  * ''%%{{facebookalbum>appid=123456&secret=123456&fanpageid=123456}}%%'' ((Displays all photo albums of the fanpage))+  * Displays all photo albums of the fanpage<code>{{facebookalbum>appid=123456&secret=123456&fanpageid=123456}}</code>
  
-See the plugin in action [[http://www.drost-tenfelde.de/?id=dokuwiki:plugins:facebookalbum:demo|here]].+See the plugin in action [[http://www.drost-tenfelde.de/?id=dokuwiki:plugins:facebookalbum:demo|here]] FIXME
  
 ===== Syntax ===== ===== Syntax =====
Line 52: Line 54:
 Available parameters: Available parameters:
  
-^ Key  ^ Type  ^ Comments  ^ Requirement  ^  Version +^ Key           ^ Type   ^ Comments  ^ Requirement  ^  Version 
-| appid | string | This is the mandatory App ID of your [[https://developers.facebook.com/apps/|Facebook App]] | If the parameter is not set as part of the syntax, the configuration parameter is used instead. | all | +''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 [[https://developers.facebook.com/apps/|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 | +''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 | +''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 |+''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 ===== ===== Configuration and Settings =====
  
-^ Key      ^ Type   ^ Comments  ^ Requirement  ^ Version +^ Key                   ^ Type   ^ Comments  ^ Requirement  ^ Version 
-| appid | string | This is the mandatory App ID of your [[https://developers.facebook.com/apps/|Facebook App]] | If the parameter is not set as part of the syntax, the configuration parameter is used instead. | all | +''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 [[https://developers.facebook.com/apps/|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 | +''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 | +''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 | +''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** | 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** | all 
-| 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** | all+''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** | all
  
 ===== Display templates ===== ===== 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.+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 ===== ===== Template tags =====
  
-^ Tag  ^ Template  ^ Comments  ^ Version +^ Tag                       ^ Template       ^ Comments  ^ Version 
-| {name} | album_template | The album name | all | +''%%{name}%%''            | album_template | The album name | all | 
-| {url} | album_template | This holds the generated URL that opens up the pictures of the album. | 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 | +''%%{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 | +''%%{caption}%%''         | picture_template | This holds the caption of the picture | all | 
-| {album_name} | picture_template | This holds the album name 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_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 |+''%%{image_large_url}%%'' | picture_template | This is the URL of the original picture. | all |
  
 ===== Development ===== ===== Development =====
Line 89: Line 91:
 === Change Log === === Change Log ===
  
-  * **2012-04-13** [[http://www.drost-tenfelde.de/lib/exe/fetch.php?media=dokuwiki:plugin_facebookalbum_1_0.zip|Version 1.0]]+  * **2012-04-13**
     * Initial release     * Initial release
  
plugin/facebookalbum.1446038598.txt.gz · Last modified: 2015-10-28 14:23 by jdt

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki