Extension:FCKeditor (Official)

From MediaWiki.org
Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
Crystal Clear action run.png
FCKeditor extension (Official)

Release status: beta
Screenshot Extension FCKeditor.png
Implementation Page action, Extended syntax, User rights, Skin, Ajax, Parser extension
Description using the FCKeditor (WYSIWYG editor) for editing wiki pages
Author(s) FCKeditor team (Frederico Caldeira Knabben, Wiktor Walc, others)
Jack Phoenix
MediaWiki 1.16+
License GPL/LGPL/MPL
Download Download snapshot
Subversion [Help]

Browse source code
Example Sandbox

check usage (experimental)

FCKeditor extension enables a more intuitive WYSIWYG editor when editing pages on a MediaWiki-based site. It uses a special version of the FCKeditor, a WYSIWYG editor that outputs wiki text rather than the usual HTML that caused problems for MediaWiki integrations in the past.

Contents

[edit] Installation

[edit] Download the extension

[edit] MediaWiki 1.16 and newer

For MW 1.16 and later a new version is available on svn.wikimedia.org; it's a fork of the original FCKeditor extension and it requires 1.16. In this case, the extension is complete, i. e. unlike older versions it contains the FCKeditor/fckeditor itself. Note: If you had installed a previous version, involving a separate check-out from svn.fckeditor.net for the editor itself, you may have to remove the extensions/FCKeditor folder and check it out again from svn.wikimedia.org.

[edit] MediaWiki 1.15 and older

If you have a wiki running 1.15 or lower version of MW, you can still use the extension available from http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/FCKeditor/. The repository will go and fetch the required fckeditor. If you are a Windows user, read the SVN_Instructions for more details. On UNIX, in your $IP/extensions directory, you can type the following command to install the FCKeditor extension: svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/FCKeditor. See FCKeditor's download page for more details. Manual modifications were required for some older versions of FCKeditor. See Manual modifications for more info.

[edit] Verify/Rename Configuration Files

Verify if the files extensions/FCKeditor/fckeditor_config.js and extensions/FCKeditor/plugins/mediawiki/fckplugin.js does exist. In case they come with .txt extension, rename the files to .js extension.

[edit] Modify configuration file

After you've downloaded the extension and actual editor, add this line at the end of LocalSettings.php:

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

Also make sure $wgUseAjax is turned on (it is by default on newer MediaWikis).

[edit] Fix hook error

On php version (>= 5.3.0) the following error shows up with the HTTP download:

PHP Warning:  Parameter 1 to FCKeditor_MediaWiki::onCustomEditor() 
expected to be a reference, value given in 
C:\inetpub\wwwroot\Wiki_Neuro\includes\Hooks.php on line 133

Fix was to change FCKeditor.body.php

public function onCustomEditor(&$article, &$user) {

to

public function onCustomEditor($article, $user) {

Thanks and credits to solweig Note: This problem is caused by the PHP version and affects all versions of MediaWiki using the version from the HTTP download. The current 1.16.x snapshot does not produce this error.

[edit] Parameters

[edit] UserOptions

  1. Change the user options for new account: Manual:$wgDefaultUserOptions.
  2. Change the users' preferences: Manual:Maintenance scripts.
    - No SSH access? Look at Extension:MaintenanceShell.

[edit] Example

If you set $wgDefaultUserOptions['riched_start_disabled'] = 1; the rich editor does not get started automatically after clicking on the edit button of the page.

[edit] Translating

FCKeditor can be translated through translatewiki.net.

[edit] Reporting software bugs

Bugs and issues can be reported on the MediaWiki Bugzilla (select FCKeditor as the component): https://bugzilla.wikimedia.org/enter_bug.cgi?product=MediaWiki%20extensions&component=FCKeditor

You can find a list of known bugs (both open and fixed ones) here: https://bugzilla.wikimedia.org/buglist.cgi?component=FCKeditor&product=MediaWiki%20extensions

[edit] Wikis using this extension

Wikia was using it, and worked on the development of it, but as of 15 July 2009 it appears that it is not used on any of the Wikia wikis.

They rolled it out the 15th june 2009 according to this wikia forum entry and is used on most wikia wikis as of 4 october 2009 (for example the Novelas wiki). The most visited wikis like uncyclopedia however don't have the new editor because they chose to keep their old "skin" (the wikia WYSIWYG editor is only available for the new Monaco skin).--Ryk V 23:06, 3 October 2009 (UTC)

[edit] More information

For more information on the functionality of fckeditor please refer to the official site of the project

Retrieved from "http://www.mediawiki.org/wiki/Extension:FCKeditor_(Official)"
Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Toolbox