Extension:MarkitUp MW

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
Crystal Clear action run.svg
markitUp MW
Release status: beta
Implementation Extended syntax
Description Integrate the markup editor markitUp into MediaWiki
Author(s) Carlo Polisini (capolisetalk)
Latest version 0.1 (05/02/2009)
MediaWiki tested on 1.13.x and 1.14.x
License GPL/MIT
Download Project page
Download snapshot
Subversion [Help]

Browse source code
View code changes

Note Note: No localisation updates provided by translatewiki.net .
Example markitUp demo site
Hooks used
EditPage::showEditForm:initial
Translate the MarkitUp MW extension if it is available at translatewiki.net
Check usage and version matrix.

Intro[edit]

This extension enables the markitUp toolbar when editing pages on a MediaWiki-based site. MarkitUp is a scriptable and skinnable markup editor based on Jquery javascript library and is very easy to customize and add macro to it.

What can this extension do?[edit]

This extension replace the default mediawiki toolbar with the markitUp toolbar. You can easily add new javascript Macros or interact with server side script via Ajax. Check the the markitUp examples page for some useful addons.

Download instructions[edit]

  • Method 1 (Separate packages download):
  1. Download the latest release of extension from here or you can also checkout the development code from SVN repository
  2. Get the latest release of markitUp editor and the Basic Wiki syntax set from markitUp site, the latest version tested is 1.1.5.
  • Method 2: Bundled installation, it could contain an outdated version of markitUp editor:
  1. Download the package here.

Installation[edit]

  1. Place the extesion files in $IP/extensions/MarkitUpMW/. If you have downloaded the bundled package decompress it in $IP/extensions/and go to step 4.
  2. Uncompress the markitUp editor archive and copy the markitup directory and jquery.pack.js in $IP/extensions/MarkitUpMW/.
  3. Uncompress the Basic Wiki syntax pack in $IP/extensions/MarkitUpMW/markitup/sets/
  4. Add the following to LocalSettings.php:
require_once("$IP/extensions/MarkitUpMW/markitup.php");

Customization[edit]

  • Add shortcut: you can edit $IP/extensions/MarkitUpMW/markitup/sets/wiki/set.js, refer to markitup doc.
  • Add new button: add a new definition in $IP/extensions/MarkitUpMW/markitup/sets/wiki/set.js and add a new icon in $IP/extensions/MarkitUpMW/markitup/sets/wiki/images/ then renaming it with the name of the definition. You can download some beautiful buttons here.

Note[edit]

  • The file markitup.php contains some uppercase lowercase errors so the plugin will fail on a case sensitive filesystem like Linux.
  • Fix is to make sure that uppercase and lowercase is correct. eg. Broken: /wiki/extensions/MarkitupMW/markitup.js Fixed: /wiki/extensions/MarkitUpMW/markitup.js

TODO[edit]

  1. Add an wiki parser to make the preview button work.

Credits[edit]