扩展:代码编辑器

此扩展已绑定在MediaWiki 1.31及以上版本 因此您不需要再次下载。 然而，您仍需要跟随提供的其他指示。

MediaWiki扩展手册

CodeEditor 发布状态： 稳定版
描述	对于网站和用户JS、CSS和Lua页面提供一个语法高亮的代码编辑器，与高级编辑工具栏相整合。
作者	Brion Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
兼容性方针	发行分支
MediaWiki	1.32+
数据庫更新	否
许可协议	GNU通用公眾授權條款2.0 or later
下载	下载扩展 Git [?]: 下载Git主线 浏览存储库 (GitHub) 提交历史 代码复核
参数 $wgCodeEditorEnableCore
使用的钩子 EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetPreferences
提供的钩子 CodeEditorGetPageLanguage
翻译CodeEditor扩展如果在translatewiki.net可用
检查使用和版本矩阵。
问题	开放的工作 · 报告错误

代码编辑器扩展给予WikiEditor高级编辑工具栏一个嵌入式的Ace编辑器部件，提供一些便捷的功能在用户/网站的JS、CSS页面和当Scribunto扩展安装后的模块名字空间的页面：

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

许可证

尽管此扩展以GNU通用公共许可证2.0版或更高版本（GPL-2.0+）授权，它同样使用Ace编辑器软件，而它则以3句版BSD许可证“新版”或“修正版”（BSD-3-Clause）授权。

安装

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

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

手动安装

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

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

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

• Configure as required.
•  完成 – 在您的wiki上导航至Special:Version，以验证扩展已成功安装。

配置

$wgCodeEditorEnableCore

要在MediaWiki、用户和其他核心名字空间中的JavaScript和CSS页面上禁用编辑器，设置$wgCodeEditorEnableCore = false;（默认为“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 扩展:语法高亮 , 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. 需要同时安装Scribunto和SyntaxHighlight扩展来实现此功能。

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