扩展:代码编辑器

MediaWiki扩展手册Manual:Extensions

CodeEditor 发布状态：Extension status 稳定版
描述Template:Extension#description	Provides a syntax-highlighting code editor for site & user JS, CSS and Lua pages, integrating with advanced edit toolbar
作者Template:Extension#username	Brion Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
MediaWikiTemplate:Extension#mediawiki	1.27+
数据更新Template:Extension#needs-updatephp	否
许可协议Template:Extension#license	GNU General Public License 2.0 or later
下载	下载快照 (Git master) Git [?]: 存储库摘要 浏览文件树 (GitHub) 提交历史 代码复核
参数Template:Extension#parameters $wgCodeEditorEnableCore
使用的钩子Template:Extension#hook EditPage::showEditForm:initialManual:Hooks/EditPage::showEditForm:initial EditPage::showReadOnlyForm:initialManual:Hooks/EditPage::showReadOnlyForm:initial GetPreferencesManual:Hooks/GetPreferences
翻译CodeEditor扩展（如果在translatewiki.net可用）
检查使用和版本矩阵。
问题Phabricator	开放的工作 · 报告错误

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.

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).

安装

• 如果使用VagrantMediaWiki-Vagrant，请通过vagrant roles enable codeeditor --provision安装

手动安装

• 下载文件，并将其放置在您extensions/文件夹中的CodeEditor目录内。

• 将下列代码放置在您的LocalSettings.php的底部：

  wfLoadExtension( 'CodeEditor' );
  

• Y 完成 - 在您的wiki上导航至Special:Version，以验证扩展已成功安装。

配置

$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 Scributo 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 ScribuntoExtension:Scribunto as well as Extension:SyntaxHighlightExtension:SyntaxHighlight, to allow syntax highlighting in the module namespace set $wgScribuntoUseGeSHi = true; (default is "false")

This configuration parameter is provided by the Scributo 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.

Wiki编辑器集成

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

问题

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