Extension:IPaper

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
IPaper
Release status: beta
Implementation Parser extension, Tag
Description Allows embedding of Scribd iPaper documents on wiki pages and thus all the formats that supports.
Author(s) Nick Boultbee for Symbian Foundation Ltd (declensiontalk)
Latest version 0.5
MediaWiki 1.14, though will probably work with other versions too.
PHP 5.0+
License GPL v2
Download IPaper.php, IPaper.i18n.php, scribd.php
Parameters
$wgIPaperScribdApiKey, $wgIPaperScribdApiSecret
Translate the IPaper extension if it is available at translatewiki.net
Check usage and version matrix.

The Extension:IPaper allows a user to see MS Office, OpenOffice, Postscript, PDF, RTF etc on their wiki. This is done by creating a viewer from scribd.

The editor will need a freely-available Scribd API Account which is easy to set up. A future release may not require this for simpler usage.

Usage[edit]

  1. First upload your document to Scribd.
  2. Embed the iPaper using the following syntax:

<ipaper>id|key=key|title=title|width=width|height=height|bgcolor=#ffffff</ipaper>

The only mandatory field is the id, which you can get from your uploaded page's URL See this useful help on the Symbian Developer wiki.

Download instructions[edit]

Please cut and paste each source file page found below and place each in a file of the same name in the $IP/extensions/IPaper/ directory of your installation. Note: $IP stands for the root directory of your MediaWiki installation, the same directory that holds LocalSettings.php .

Installation[edit]

To install this extension, add the following to LocalSettings.php :

// Put in your scribd account details here
$wgIPaperScribdApiKey = "your_scribd_api_key";
$wgIPaperScribdApiSecret = "your_scribd_api_secret"; 

require_once("$IP/extensions/IPaper/IPaper.php");

Configuration parameters[edit]

$wgIPaperScribdApiKey is a string that identifies your account at scribd.com. Look in your account settings to find your out. $wgIPaperScribdApiSecret is the secret key. Keep it secret! It should start with "sec-...".

For more help with the scribd API, please see their website

Code[edit]

You'll need these three files:

Copy and paste them to new files in directory called IPaper under extensions/.


Legal[edit]

This extension is in no way affiliated with Scribd, Inc, though uses their publicly-available PHP Client Library


See also[edit]