Personal tools

Wikiwyg

From OrganicDesign Wiki

Jump to: navigation, search

1 What is Wikiwyg?

Wikiwyg is a WYSIWYG browser editor framework for wikis. It is designed to be pluggable on top of existing wiki engines, with little or no change to the wiki engine's core software.

Wikiwyg has been successfully integrated with the following wiki engines: Socialtext, Kwiki, MediaWiki, Trac and TWiki.

Wikiwyg is designed to be a modal editor. You can flip back and forth between WYSIWYG and WikiText and Preview modes in a single editing session. Other available/possible modes are Raw-HTML and Multi-User modes. Wikiwyg can even be configured to use just WikiText mode, and still provides many user benefits over a traditional textarea.

Wikiwyg currently support WYSIWYG mode in Firefox and IE 6+. It supports WikiText mode in those browsers, and Safari as well. In unsupported browsers, a Wikiwyg integration should fall back to the wiki engine's regular edit interface.

2 Wikiwyg on MediaWiki

The base code for the wikiwyg environment is maintained by SocialText and can be accessed via their wikiwyg svn repository here

The Mediawiki extension that enables wikiwyg to work with Mediawiki is being released to the community for further development.

In it's current state, the "Extension" is actually 2 extensions and a patch to MediaWiki. The two extensions are in share/MediaWiki/extensions

MediaWikiWyg.php - the glue code that allows Mediawiki to work with Wikiwyg EZParser.php - Adds a simple interface to the Mediawiki Parser. Used to generate the HTML view when switching editing modes.

The patch is available as share/MediaWiki/mediawiki-1.7alpha.patch. The patch could conceivably be removed once the extension was able to change the way that templates and some other similar things are rendered, and once it is possible for an extension to allow a piece of JavaScript to be included before wikibits (or if the frame-breaking code could be somehow modified so that an extension could disable it).

By default, the code is expecting the entire directory (the directory containing this README file) to be checked out in the documentroot of the site, so you may need to adjust the paths to some of the JavaScript files if that is not the case for your setup.

Let me know if you have any success with it, or if you need some help figuring out how to use it.

Jason Richey: jasonr@wikia.com

3 See also

The GNU Project Debian Linux Ubuntu Linux Wikipedia online encycopedia MediaWiki