Extension:WYSIWYG

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual - list
Crystal Clear action run.png
WYSIWYG

Release status: stable

WYSIWYG editor screenshot.png
Implementation Page action, Extended syntax, User rights, Skin, Ajax
Description The WYSIWYG extension allows the easy insertion and enhanced editing of formatted data like tables, headings, enumerations etc. while they are displayed exactly like the final output.
Author(s) ontoprise GmbH
Last version 1.7.0 (2012-04-25)
MediaWiki 1.16.x and
1.17.x only
Database changes no
License GPL
Download see download section
Parameters

$wgDefaultUserOptions

Hooks used
ParserAfterTidy

EditPage::showEditForm:initial
EditPage::showEditForm:fields
EditPageBeforePreviewText
EditPagePreviewTextEnd
CustomEditor
LanguageGetMagic
ParserBeforeStrip
ParserBeforeInternalParse
EditPageBeforeConflictDiff
SanitizerAfterFixTagAttributes
MakeGlobalVariablesScript
GetPreferences
DoEditSectionLink
OutputPageParserOutput
BeforePageDisplay

Check usage and version matrix

The WYSIWYG extension enables a more intuitive editing of pages on a MediaWiki-based site. When this extension is installed, the tab 'Edit' in the command bar on top of every page leads directly in the wysiwyg editing mode.

It uses a special version of the CKeditor that outputs wiki text rather than the usual HTML that caused problems for MediaWiki integrations in the past.

All references to smwplus.net are gone, probably forever.
Warning Warning: Be sure that you check the dependencies for this extensions. Other combinations will most likely fail.

Contents

Features of the WYSIWYG extension [edit]

The WYSIWYG extension supports:

  • importing / insertion of tables, images, formatting stuff like enumerations, font style etc. as well as links
  • real copy and paste without postprocessing
  • working with the known Word-like toolbar arrangement
  • using special characters
  • real time spell-checking with recommender function
  • undo/redo and find and replace functionality

Usage [edit]

The WYSIWYG extension 1.6 has been approved for the following browsers:
* Firefox,
* Internet Explorer 8,
* Google Chrome

Download [edit]

WYSIWYG (dependencies, download, help)
MediaWiki WYSIWYG Download Help page
1.17.x 1.6.0-0 3.5 MB Installing WYSIWYG 1.6.0-x
1.7.0-1 3.5 MB Installing WYSIWYG 1.7.0-x
1.18.x User made (experimental) 2.5MB See the same installation as for 1.17.x (Installing WYSIWYG 1.7.0-x)
1.20.2 User made (experimental) 2.5MB See the same installation as for 1.17.x (Installing WYSIWYG 1.7.0-x)
1.20.2 User patched (PHP 5.4.8 compatible) 3MB Installation on Mediawiki 17.x to 20.x


Installation on Mediawiki 1.17.x to 1.20.x [edit]

For several weeks the developer's site was down, so instructions on installation were retrieved from Google cache and published here. Please use at your own risk.

Requirements [edit]

  • MediaWiki 1.17.x to 1.20.x

Installation [edit]

1. Download WYSIWYG extension from Sourceforge

2. Extract the zip-file

3. In the folder "wysiwyg-1.7.0_0/extensions/" you'll find the "WYSIWYG/" folder, copy this into "<your wiki folder>/extensions/"

4. Add the following line to your LocalSettings.php to initialize the extension:

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

5. Define the group rights, the easiest is to grant all users access:

$wgGroupPermissions['*']['wysiwyg']=true;

or only for registered users:

$wgGroupPermissions['registered_users']['wysiwyg']=true;

'Now the WYSIWYG Extension is installed and ready to use.'

Note [edit]

Ontoprise also distributes a pre-configured and easy-to-install bundle named "SMW+" containing the WYSIWYG Extension, MediaWiki, SMW, Halo and further useful extensions:

  • SMW+ (free Community Edition available)

Please note that if Halo extension is installed, the WYSIWYG extension also enables calling its functions (Semantic Toolbar, Query Interface, template picker) and allows to embed web services and wiki magicwords.