Extension:CodeEditor

This extension comes with MediaWiki 1.31 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

MediaWiki extensions manual

CodeEditor Release status: stable
Description	Provides a syntax-highlighting code editor for site & user JS, CSS and Lua pages, integrating with advanced edit toolbar
Author(s)	Brion Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
Compatibility policy	master
MediaWiki	1.29+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history code review
Parameters $wgCodeEditorEnableCore
Hooks used EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetPreferences
Translate the CodeEditor extension if it is available at translatewiki.net
Check usage and version matrix.
Issues	Open tasks · Report a bug

The CodeEditor extension extends the WikiEditor advanced editing toolbar with an embedded Ace editor widget, providing some handy features for user/site JS, CSS pages, and when Extension:Scribunto is also installed, for pages in Module namespace:

• syntax highlighting for JavaScript, CSS and Lua
• auto-indent
• tab key produces tab indents (since 1.22), soft indents before.
• indent/unindent selection with tab/shift-tab
• syntax validity check for JavaScript
• Pair-matching for parenthesis, braces and square brackets

Currently the extension is under development, and details of activation and functionality are subject to change.

Contents

License

While this extension is licensed GNU General Public License v2.0 or later (GPL-2.0+) it makes use of the Ace editor software which is licensed BSD 3-clause "New" or "Revised" License (BSD-3-Clause).

Installation

The WikiEditor extension needs to be installed for this extension to work. Installing the Scribunto extension is optional.

• If using Vagrant , install with vagrant roles enable codeeditor --provision

Manual installation

• Download and place the file(s) in a directory called CodeEditor in your extensions/ folder.

• Add the following code at the bottom of your LocalSettings.php:

  wfLoadExtension( 'CodeEditor' );
  $wgDefaultUserOptions['usebetatoolbar'] = 1; // user option provided by WikiEditor extension
  

• Configure as required.
•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

$wgCodeEditorEnableCore

To disable the editor on JavaScript and CSS pages in the MediaWiki, User and other core namespaces, set $wgCodeEditorEnableCore = false; (default is "true")

$wgScribuntoUseCodeEditor

To use this extension for Scribunto, i.e. in the module namespace set $wgScribuntoUseCodeEditor = true; (default is "false")

This configuration parameter is provided by the Scribunto extension and must therefore be added after invoking the CodeEditor as well as the Scribunto extension which also needs to be installed for this to work.

$wgScribuntoUseGeSHi

To use this extension for Scribunto as well as Extension:SyntaxHighlight , to allow syntax highlighting in the module namespace set $wgScribuntoUseGeSHi = true; (default is "false")

This configuration parameter is provided by the Scribunto extension and must therefore be added after invoking the CodeEditor as well as the Scribunto extension. Both the Scribunto and SyntaxHighlight extension also need to be installed for this to work.

JavaScript

It is possible to change the configuration of the ACE editor, by hooking into the MediaWiki JS hook codeEditor.configure. The argument passed to your hook will be an ACE editor session.

WikiEditor integration

I've been integrating CodeEditor into the pluggable portions of Extension:WikiEditor as prep for Future editor work, since we'll want to be able to extend it to edit things that aren't plain wikitext, which'll need some changes to the toolbar setup and whatnot. JS/CSS here still return plain text in the end, making it an easier intermediate project. --brion 00:26, 14 June 2011 (UTC)

Good:

• special char insertions work, including quote pairs to surround text
• basic formatting insertions work, including link dialogs
• search/replace dialog works
  • ace's built-in search/replace UI also triggers from keyboard commands, still need to disable them! (onCommandKey)

Bad:

• multi-line formatting doesn't apply correctly (but really should that apply here? :)

Todo:

• remove toolbar buttons that don't apply (formatting, syntax help?)
• add toolbar buttons that are more directly useful
  • indent/outdent
  • insertion helpers for common keywords or code bits
  • help reference to MW JS API reference, JS & CSS specs/documentation

Issues

Known issues:

• probably explodes with classic toolbar now; use with Extension:WikiEditor toolbar. See also bugzilla:55419
• accessibility: tab/shift-tab are overridden. is there a consistent alternative for keyboard-reliant users?
• accessibility: accesskey on the original textarea needs to be moved over or otherwise handled
• scrollbar initializes too wide; need to trigger resize check after that's filled (maybe fixed?)
• cursor/scroll position not maintained over previews/show changes
• upstream ctrl+R, ctrl+L, ctrl+T are taken over by the editor, which is SUPER annoying