Contents

OSR MediaWiki Project

The following files and information have been prepared for the OSR Mediawiki project by Jo Kay. For further information email: joannamkay@gmail.com.


OSR MediaWiki Project Downloads

You can view these templates in action by logging in as a guest user. Login: jasper Password: cat. You then need to edit preferences and select the OSR skins.

OSR MediaWiki Skins Installation

The following zip files contain skin files for the OSR MediaWiki:

  • Template Version 1
  • Template Version 2
  • Template Version 3

Download and unzip to the '/skins' directory.


OSR MediaWiki Extensions Installation

The following extensions are recommended to provide added functionality to the OSR MediaWiki. Instructions for installation of each extension and an example of it's use has been included below.

Add Article to Category

  • Download Add Article to Category Extension
  • Adds an inputbox (for create new article) to each category page.
  • New pages will include "" automatically.
  • Assists in maintaining searchability of the mediawiki by encouraging users to categorise their documents.



Installation

  1. Download the extension here
  2. Upload the articletocategory.php to your extensions/ directory.
  3. Add the following code to your LocalSettings.php file: 
require_once("$IP/extensions/articletocategory.php");

Example



Article Comments

  • Provides a means for creating inline blog-like comment forms for regular wiki article.
  • Comments submitted by users appear on the Article's 'Talk' page.
  • See: ArticleComments

Installation

  1. Download ArticleComments, and be sure to rename the downloaded file to ArticleComments.php.
  2. Drop this script in $IP/extensions
  3. Enable the extension by adding this line to your LocalSettings.php: 
require_once('extensions/ArticleComments.php');

Usage

Once installed, you (or editors of your wiki) may add comment forms to any article.

To do so, simply add this text to the body of your page where you'd like the comment form to appear: 

<comments />

Additional info on advanced usage of this extension can be viewed on the Article Comments Project homepage.

Example

An example of the comment form is included below. You can view comments here.

Name (required):

Website:

Comment:



Bookmarking

  • Download the Bookmarking Extension here.
  • Adds social bookmarking links strip in to a page. Currently supports del.icio.us.

Installation

  1. Copy the code below in to a file named extensions/Bookmarking.php
  2. Create an icon with the name \common\images\delicious.gif
  3. Modify the text <your site> with the url of your site
  4. Modify the the text in the link that is created as you see fit. Take care not to change the \" characters.
  5. Add the following to your wiki's LocalSettings.php 
require_once 'extensions/Bookmarking.php';

Usage

Enter the code <bookmarking></bookmarking> where you want the bookmark strip to appear.

Example

Add to your del.icio.us Add this article to your del.icio.us account!


Breadcrumbs

  • Shows the users path through the wiki in the title area of each article (page).
  • Provides last 5 links visited to enable easier navigation throughout the wiki.
  • See: Breadcrumbs

Installation

  1. Download the latest snapshot and extract it to your extensions directory
  2. Add 'require_once("$IP/extensions/BreadCrumbs/BreadCrumbs.php");' into your wiki's LocalSettings.php file.

Example

  • Currently installed on this wiki.


CategorySuggest

  • Download Category Suggest Extension
  • Adds input box to edit and upload page which allows users to assign categories to the article.
  • Provides category suggestions from the database based on user input.

Installation

  1. unzip the zip place the files into the extensions folder: $IP/extensions/CategorySuggest/.
  2. Add the following to LocalSettings.php 
require_once("$IP/extensions/CategorySuggest/CategorySuggest.php");

Example

  • Currently installed on this wiki. View any 'edit page' to see in action.


FCKEdit

  • Adds Wysiwyg editor to Mediawiki for easier text formating etc. Edit a page on this wiki to see FCKEdit in action.
  • See: FCKEdit for further information.
  • To install follow the FCKeditor Integration Guide

Example

Image:Fckedit.jpg

  • FCKEdit is currently installed on this wiki.


FlashMP3

  • Adds a simple Flash-player for playback of mp3-files
  • See: FlashMP3

Installation Instructions:

  1. Copy & paste the code available @ FlashMP3 in a file called flashmp3.php and place it in your extensions directory of your MediaWiki folder.
  2. Download the Audio Player plugin from 1pixelout. From the zip-archive copy the files audio-player.js and player.swf in a new folder called audio_player in your extensions directory.
  3. Put this line near the end of your LocalSettings.php in the MediaWiki root folder to include the extension. 'require_once('extensions/flashmp3.php');'

Allow file uploads:

To be able to upload mp3-files to your MediaWiki also do the following steps:

  1. Allow uploading of mp3-files by adding this line near the end of your LocalSettings.php. '$wgFileExtensions[] = 'mp3';
  2. Set the maximum size for file uploads in your php.ini.
  3. Set the maximum size for file uploads by adding this line to your LocalSettings.php. '$wgMaxUploadSize = '50MB';'

Usage

Example




FLVPlayer

  • Allows the display of flv movies within a wiki article
  • FLVPlayer

Installation

  1. Download the latest version of the code
  2. Copy the code into a file named FLVPlayer.php
  3. Save the file in the extensions/flvplayer directory of your mediawiki folder
  4. Add the line include('extensions/flvplayer/FLVPlayer.php'); to the end of your LocalSettings.php file (The name of your file is case sensitive!)
  5. Download the latest Flowplayer file from sourceforge.net (not newer than 1.8)
  6. Extract FlowPlayer.swf from the zip file and place it in the extensions/flvplayer directory of your mediawiki folder

Allow file uploads

To be able to upload flv-files to your MediaWiki also do the following steps:

  1. Allow uploading of mp3-files by adding this line near the end of your LocalSettings.php. '$wgFileExtensions[] = 'flv';'
  2. Set the maximum size for file uploads in your php.ini.
  3. Set the maximum size for file uploads by adding this line to your LocalSettings.php. '$wgMaxUploadSize = '50MB';'

Usage

Example




SimpleFeed

Installation

  1. Save SimpleFeed.php to extensions/ and make sure the server has permission to read it.
  2. Save simplepie.inc to extensions/.
  3. Create extensions/cache, set correct write permissions using chmod (www-user, or equivalent, should be allowed to write).
  4. Add include("./extensions/SimpleFeed.php"); to the last line of LocalSettings.php before the end ?>.
  5. If you are in a corporate environment, check out any proxy servers or firewalls.

Usage

There are two arbitrary fields that must be present. These are the url argument, and the content between the <feed>[...]</feed> tags. A simple example is shown below: 

<feed url="http://newsrss.bbc.co.uk/rss/newsonline_uk_edition/front_page/rss.xml">
== [{PERMALINK} {TITLE}] ==
'''{DATE}, by {AUTHOR}'''
{DESCRIPTION}
</feed>

This will pull the BBC News feed and output five posts. For every post, it will output the data between the feed tags, replacing {PERMALINK}, {TITLE}, {DATE}, {AUTHOR} and {DESCRIPTION} with the appropriate information.

Example




Skype

  • Download the Skype Extension here.
  • Adds a Skype Me button to an article (page)
  • Useful for providing clear contacts and discussion channels

Installation

  1. Copy the Skype Extension Code into a file (e.g. skype.php)
  2. Save the file in the extensions directory of your MediaWiki folder
  3. Add the line require_once('extensions/skype.php'); to the end of your LocalSettings.php file

Usage

  • Add a Skype button by including the line:  <skype>Skype-Username</skype> in the wiki.
  • Additional syntax for usage is available on the Skype Extension page.

Example

My status


SpamBlacklist

Installation

The extension might work with MediaWiki version 1.6.0 or greater.

  1. Save the SpamBlacklist files to a subdirectory called SpamBlacklist in your extensions directory. 
  2. Add the following line to LocalSettings.php in your MediaWiki root directory: 
require_once( "$IP/extensions/SpamBlacklist/SpamBlacklist.php" );

The primary source for a MediaWiki-compatible blacklist file is the Wikimedia spam blacklist on Meta-Wiki, at http://meta.wikimedia.org/wiki/Spam_blacklist. The default configuration loads this list once every 10-15 minutes. However, the Wikimedia spam blacklist can only be edited by trusted administrators.For information on creating Custom Black and White lists visit the SpamBlacklist Extension page.

Example

  • Currently installed on this wiki.




YouTube

  • Download the Youtube Extension
  • Allows for direct embedding of YouTube videos in MediaWiki articles

Installation

  1. Copy the Youtube Extension code to extensions/YouTube.php
  2. Add the following line to LocalSettings.php in your MediaWiki root directory: 
require_once('extensions/YouTube.php');

Usage

To add the link in the wiki: <youtube>FileNameOfYouTubeVideo</youtube>

Example




Additional MediaWiki Extensions

We are currently exploring the following extensions, and may recommend installation in the near future:


OSR MediaWiki Widgets Installation

Mediawiki Widgets allow for the use of a range of useful Web 2.0 widgets within MediaWiki articles. These allow for the inclusion of more dynamic, web based content within mediawiki pages.


Installation

To install the MediaWiki Widgets extension please follow these steps:

Install the Smarty PHP templating engine

The Widget extension uses Smarty PHP templating engine to provide simple templating functionality within widget pages. All parameters passed to widget are converted into Smarty parameters.

Install the Widget

  1. Download the Widget Extension and extract it to $IP/extension/ folder
  2. Add the following to LocalSettings.php:
    require_once("$IP/extensions/Widgets/Widgets.php");
  3. Create Widget Pages for each widget you wish to install in the Widgets Namespace. For further instructions visit the MediaWiki Widgets Repository.

Folder permissions

Also, $IP/extensions/Widgets/compiled_templates/ folder should be made writable by web server (this is where Smarty stores pre-compiled templates).

User rights

This extension adds Widget namespace, but due to potential security implications that can result from using insecure widget code, this namespace is only editable by users who have editwidgets permission (widgeteditor group is also created to add users to, see Help:User rights management for more details).

To allow widgets to be editable by sysops, add the following to your 'LocalSettings.php' file: 

$wgGroupPermissions['sysop']['editwidgets'] = true;


Currently Installed Widgets

The following widgets have been installed:



Usage and Examples

You can view a page with an example of each embedded in the page below.


Blip.tv Feed

To insert this widget, use the following code: 

{{#widget:Blip.tv
|id=329701
|width=400
|height=255
}}

Width and hight are optional, 400x255 is a default, "id" is a video number from embed code URL (not blip.tv page URL).

Example




Feed

To insert this widget, use the following code: 

{{#widget:Feed
|feedurl=http://www.techpresentations.com/feed/
|chan=y
|num=5
|desc=50
|date=n
|targ=n
}}

Parameters

  • feedurl - URL of the feed to show
  • chan - show channel info or not (y/title/n)
  • num - number of items to show (0 means all available)
  • desc - number of characters to show from description (0 means show full description)
  • date - show date (y/n)
  • targ - open links in new window (y/n)

Sample result




Flickr

This widget allows users to add a Flickr badge to a wikipage.

To insert this widget, use the following code: 

 {{#widget:Flickr|query=searchterm}}

Example


www.flickr.com



Flickr/SlideShow

This widget allows you to add a Flickr search slideshow to your wiki page.

To insert this widget, use the following code: 

 {{#widget:Flickr/SlideShow|query=searchterm|width=300|height=300}}

Width and height are optional, 500 is a default. Note: Small sizes don't work very well in slideshow.

Sample result




Google Calendar

This widget allows you to add Google Calendar widget to your wiki page.

To insert this widget, use the following code: 

{{#widget:Google Calendar
|id=si8ocqn3duj6f8int3h57jm8qeunplut@import.calendar.google.com
|color=528800
|id=p2m2av9dhrh4n1ub7jlsc68s7o@group.calendar.google.com
|color=2952A3
|id=usa@holiday.calendar.google.com
|color=B1440E
}}

Parameters

  • id - is a calendar ID (including @calendar.google.com, come match user email addresses) - can be found on calendar settings page
  • title - new title if you want to override calendar title (optional)
  • height and width define calendar dimensions, 100%x600 is default (only width can be defined in %).
  • color - events color (hex value. e.g. 5229A3) - only color used in Google's wizard can be used.
  • bgcolor - events color (hex value. e.g. ffcc66)
  • weekstart - first day of the week (1-7)
  • lang - interface language (en, fr, ru and etc).
  • view - default view MONTH (default)/WEEK/AGENDA)
  • timezone - time zone defined as a string like "America/New_York", should be automatically detected if omitted
  • You can also trigger parts of the interface on and off:
    • showtitle - true (default)/false - shows title
    • shownav - true (default)/false - shows navigation arrows
    • showdate - true (default)/false - shows date
    • showtabs - true (default)/false - shows view tabs
    • showcals - true (default)/false - shows a calendar list
    • showprint - true (default)/false - shows a print icon
    • showtz - true (default)/false - shows timezone
    • border - true/false (default) - draws thin border around the widget
  • app - for Google Apps for Your Domain Calendars, specify the domain name for the account (http://www.google.com/calendar/hosted/yourdomain.com/render)

Example





Google Documents

Allows for the embedding of Google Docs in mediawiki pages.

To insert this widget, use the following code: 

{{#widget:Google Document
|key=dcn37mcz_28dq983f3t
|width=500
|height=300
}}

Parameters

  • docid - docID parameter in document URL
  • width and height define document dimensions, 500x300 is default

Example





Google Forms

This widget allows you to add Google Spreadsheet Forms to your wiki page.

To insert this widget, use the following code: 

{{#widget:Google Form
|key=po-s58YMwf85Q3UxRzdGOBw
|width=600
|height=750
}}

Parameters

  • key - key parameter in emailing/embedding URL
  • width and height define form dimensions, 300x400 is default, but you might want to copy it from embed code since size depends on fields you have.

Example





Google Maps

This widget allows you to add Google Maps widget to your wiki page.

To use this widget include the following code in your page: 

{{#widget:Google Maps
|key=ABQIAAAAq_i4aTseMGLic8bgu1NQHRRuMGSDM4hOrlKevQrS9qsdJ_NOCxRsXLLNmhAg5xMn9btyuqHxCavIxw
|width=600
|height=400
|lat=55.754796
|lng=37.621479
|zoom=12
|static=yes
|centermarker=yes
}}

Parameters

  • key - Google developer key for your site (you must get your own or it will not work).
  • height and width define map dimensions, 420x350 is default
  • lat - map center latitude
  • lng - map center longitude
  • zoom - zoom level (defaults to 16)
  • xml - URL of XML (KML/GeoRSS) data source (only one can be used for now) *
  • Markers:
    • centermarker - if set, then marker is added in the center of the map
    • Cusrom markers are defined using marker.name.lat and marker.name.lng
  • Controls:
    • maptypecontrol - buttons that let the user toggle between map types (such as Map and Satellite)
    • largemapcontrol - displays a large pan/zoom control used on Google Maps
    • smallmapcontrol - displays a smaller pan/zoom control used on Google Maps
    • smallzoomcontrol - displays a small zoom control (no panning controls) used in the small map blowup windows used to display driving directions steps on Google Maps
    • scalecontrol - displays a map scale
    • overviewmapcontrol - displays a collapsible overview map in the corner of the screen
    • hierarchicalmaptypecontrol - displays a selection of nested buttons and menu items for placing many map type selectors

Map types

By default, map is displayed using dynamic user interface with movable map, controls, loadable XML and so on.

If you want static map image to be displayed, add static=yes which will tell widget to use Google Static Maps API. It does not support XML (KML or GeoRSS) and controls, but supports markers. Use this one when you want map to load faster and to avoid JavaScript slowing down your page. Static map is also used for graceful degradation when dynamic map is specified, but client doesn't support dynamic features like JavaScript.

Example





Google Presentations

Allows users to embed Google Presentation documents.

To insert this widget, use the following code: 

{{#widget:Google Presentation|docid=dcn37mcz_22cmnwnwf8}}

Parameters

  • docid - docid parameter in document URL
  • size - (optional) allows you to change the size of presentation from small (410x342) to medium (555x451) or large (700x599)

Example





Google Spreadsheets

To insert this widget, use the following code: 

{{#widget:Google Spreadsheet
|key=po-s58YMwf85Q3UxRzdGOBw
|width=500
|height=300
}}

Parameters

  • key - key parameter in document URL
  • width and height define spreadsheet dimensions, 500x300 is default, but you might want to copy it from embed code since size depends on fields you have

Security NOTE

Keep in mind that to use this widget you must make the document you're publishing to be open for everybody to see which might be undesirable for some uses (intranets, closed groups and etc.)

Example





Google Street View

This widget allows you to add Google Street View widget to your wiki page.
User:Sergey_Chernyshev

To insert this widget, use the following code: 

{{#widget:Google Street View
|key=ABQIAAAAq_i4aTseMGLic8bgu1NQHRRuMGSDM4hOrlKevQrS9qsdJ_NOCxRsXLLNmhAg5xMn9btyuqHxCavIxw
|lat=40.758153
|lng=-73.985355
|yaw=370.64659986187695
|pitch=-20
|zoom=0
}}

Parameters

  • key - Google developer key for your site (you must get your own or it will not work).
  • lat - lattitude of street view location
  • lng - longitude of street view location
  • height and width define view dimensions, 420x350 is default
  • yaw - defines the rotation angle around the camera locus in degrees relative from true north. Yaw angles are measured clockwise (90 degrees is true east)
  • pitch - defines the angle variance "up" or "down" from the camera's initial default pitch, which is often (but not always) flat horizontal. (For example, an image taken on a hill will likely exhibit a default pitch that is not horizontal.) Pitch angles are measured with negative values looking up (to -90 degrees straight up and orthogonal to the default pitch) and positive values looking down (to +90 degrees straight down and orthogonal to the default pitch)
  • zoom - defines the zoom level of this view (effectively proscribing the "field of view") with 0 being fully zoomed-out. Different Street View locations may provide higher or lower zoom levels.

Example





Google Video

This widget allows you to add Google Video player to your wiki page.

To insert this widget, use the following code: 

{{#widget:Google Video
|docid=-4567104036778249401
|width=400
|height=326
}}

Width and hight are optional, 400x326 is a default, "docid" is a docid parameter in the URL.

Example


[[Category:Widgets]]


Picasa

This widget allows you to add Picasa Web albums to your wiki page.

To insert this widget, use the following code: 

{{#widget:Picasa
|user=victor.laskin
|album=5196794879516869825
|width=600
|height=400
|captions=1
|autoplay=0
}}

Example





Scribd

To insert this widget, use the following code: 

{{#widget:Scribd
|id=2881106
|access_key=key-2iauog0xawlbp6a4yxph
|name=SS-MediaCard-2008-English-Long
|width=450
|height=500
}}

Parameters

  • id is a number in the video page URL
  • access_key is a string that must be copied from embed code for the document
  • width and hight are optional, 450x500 is a default
  • name is optional title of the document

Example


SS-MediaCard-2008-English-Long - Upload a doc
Read this doc on Scribd: SS-MediaCard-2008-English-Long




SlideShare

This widget allows you to add SlideShare slideshows to your wiki page. It replaces original SlideShare extension.

To insert this widget, use the following code: 

{{#widget:Slideshare
|doc=semantic-media-wiki-semantic-forms-1205504882436734-4
|width=425
|height=348
}}

Width and hight are optional, 425x348 is a default. "doc" is a parameter from embed code they give.

Example





Widgetbox

This widget allows you to add any widget from Widgetbox widget library.

To insert this widget, use the following code: 

{{#widget:Widgetbox|id=38032dd9-3488-4157-b0b9-a8c9c4a76223}}

'id' is panelId URL parameter in their embed code.

Example




OSR MediaWiki Skins Screenshots

Template Version 1:

Image:Osr1.jpg


Template Version 2:

Image:Osr2.jpg


Template Version 3:

Image:Induction4.jpg



Retrieved from "http://jaspercat.net/wiki/index.php?title=OSRinstall"