Extension:IPaper

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
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)
Last version 0.5
MediaWiki 1.14, though will probably work with other versions too.
PHP >5
License GPL v2
Download IPaper.php, IPaper.i18n.php, scribd.php
Parameters

$wgIPaperScribdApiKey, $wgIPaperScribdApiSecret

Check usage (experimental)

Contents

[edit] What can this extension do?

This extension allow the usage of a new <ipaper></ipaper> tag to embed the flash-based document viewer from scribd, allowing you to view just about any document that is supported on their site (MS Office, OpenOffice, Postscript, PDF, RTF etc)

You'll need a freely-available Scribd API Account - it's easy to set up. A future release may not require this for simpler usage.

This extension is in no way affiliated with Scribd, Inc, though uses their publicly-available PHP Client Library It's just an easy way to use the iPaper document viewer within a Mediawiki context. Try it!

[edit] Usage

  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.

[edit] Download instructions

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.

[edit] Installation

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");

[edit] Configuration parameters

$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

[edit] Code

You'll need these three files:

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

Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox