Extension:CodeEditor

The CodeEditor extension extends the wikied>Special:MyLanguage/Extension:WikiEditor|WikiEditor advanced editing toolbar with an embedded [http://ace.ajax.org/ Ace editor widget], providing some handy features for user/site JS, CSS pages, and when ext-scribunto>Special:MyLanguage/Extension:Scribunto|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.

Installation

 * Install wikied>Special:MyLanguage/Extension:WikiEditor|Extension:WikiEditor if not already present.


 * Get the extension with code-editor>Special:ExtensionDistributor/CodeEditor|distributor or [https://gerrit.wikimedia.org/r/p/mediawiki/extensions/CodeEditor.git git] and drop it into MediaWiki directory


 * Setup your localsettings>Special:MyLanguage/LocalSettings.php|LocalSettings.php and add:

== Configuration ==



In order to use this extension for ext-scribunto>Special:MyLanguage/Extension:Scribunto|Scribunto, set

JavaScript Configuration
It is possible to change the configuration of the ACE editor, by hooking into the res-loader>ResourceLoader/Default_modules#mediawiki_2|MediaWiki JS hook. The argument passed to your hook will be an [http://ace.c9.io/api/edit_session.html ACE editor session].

WikiEditor integration
''I've been integrating CodeEditor into the pluggable portions of wikied>Special:MyLanguage/Extension:WikiEditor|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! ([http://ace.c9.io/api/editor.html#Editor.onCommandKey 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

Compatibility
Browsers tested:
 * Firefox 4.0 / Linux
 * Chrome 10.0.648.204 / Linux

Browsers tested with issues:
 * Opera 11.10 / Linux: copy fails, paste sometimes crashes
 * IE 8.0.6001.18702 / Win XP: some newlines mysteriously removed, corrupting data; insertion point keeps resetting back to the top of the page after a click (arrow keys ok)
 * Safari / iPad 4.3 (8F190): renders ok, but can't set focus or scroll vertically. No focus means no typing. :(
 * [<tvar|ace-issues>https://github.com/ajaxorg/ace/issues/37</> There is some work in progress that needs merging upstream...]

Issues
Known issues:
 * probably explodes with classic toolbar now; use with wikied>Special:MyLanguage/Extension:WikiEditor</>|Extension:WikiEditor toolbar. See also 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
 * 'discard your changes?' check on tab close doesn't trigger 61117
 * scrollbar initializes too wide; need to trigger resize check after that's filled (maybe fixed?)
 * cursor/scroll position not maintained over previews/show changes
 * [<tvar|upstream>https://github.com/ajaxorg/ace/issues/210</> upstream] ctrl+R, ctrl+L, ctrl+T are taken over by the editor, which is SUPER annoying