擴充功能:CodeEditor

請勿與 CodeMirror 混淆。

MediaWiki擴充功能手冊

CodeEditor 發行狀態： 穩定版
描述	對於網站和使用者JS、CSS和Lua頁面，提供一個與進階編輯工具列整合的語法突顯的代碼編輯器。
作者	Brooke Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
相容性政策	快照跟隨MediaWiki發布。 master分支不向後相容。
資料庫變更	否
參數 $wgCodeEditorEnableCore
使用的函數鉤 EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetPreferences
提供的函數鉤 CodeEditorGetPageLanguage
授權條款 GNU General Public License 2.0 or later BSD 3-clause "Modified" License
下載	下載擴充功能 Git [?]: 瀏覽儲存庫 (Phabricator · GitHub) Gerrit代碼審核 Git提交日誌 下載原始碼（tarball壓縮）
前往translatewiki.net翻譯CodeEditor擴充功能
問題	開啟的任務 · 回報錯誤

在 MediaWiki 1.46中，擴充功能:CodeMirror 取代了CodeEditor，成為MediaWiki針對所有內容類型的預設語法感知編輯器。

代碼編輯器擴充功能以一個嵌入式的Ace編輯器小工具擴大了WikiEditor進階編輯工具列，為使用者/網站的JavaScript頁面、CSS頁面、JSON頁面以及其他由已安裝Scribunto 擴充功能提供的頁面（如「Module」命名空間提供的Lua頁面）提供一些便利。 代碼編輯器不會在常規Wiki頁面（即內容模型為「wikitext」的頁面）上顯示。 (使用原始碼編輯器時，參見擴充功能:CodeMirror 的wikitext的語法突顯)。

它提供以下功能：

• 為JavaScript、CSS和Lua提供語法突顯
• 自動縮排
• 1.22版本起Tab鍵會生成制表符縮排，而之前是軟縮排。
• 使用Tab ↹/⇧ Shift+Tab ↹鍵進行縮排的增減
• 針對JavaScript的語法有效性檢查
• 括號、大括號和方括號的配對標示

安裝

此擴充功能隨附於MediaWiki 1.31及更新版本，因此您無需下載它。 但其餘的設置組態的指示仍須依循執行。

此擴充功能需要已安裝 WikiEditor 才能運轉。 可選安裝 Scribunto 擴充功能。

• 下載檔案，並解壓CodeEditor資料夾到extensions/目錄中。
  開發者和代碼貢獻人員應改從Git安裝此擴充功能，輸入：

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/CodeEditor
  

• 請新增下列程式碼到您的LocalSettings.php 檔案的底部：

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

• 按需求設定組態。
• 完成 – 請導覽至您的wiki上的Special:Version，以驗證此擴充功能已成功安裝。

使用Vagrant安裝：

• 如果你有使用Vagrant ，請透過vagrant roles enable codeeditor --provision安裝

組態

$wgCodeEditorEnabledModes

控制著與擴充功能:CodeMirror 衝突的臨時功能旗號。

$wgScribuntoUseCodeEditor

如要為 Scribunto（即「模組」命名空間）禁用此擴充功能，請設定 $wgScribuntoUseCodeEditor = false;，預設為「true」

此組態參數由Scribunto擴充功能提供，因此在CodeEditor和Scribunto擴充功能安裝後呼叫才能生效。

JavaScript

有可能透過連接到MediaWiki JS hook（也就是mw.hook( 'codeEditor.configure' ).add( ... )），改變ACE編輯器的組態。 傳遞給您的鉤的參數是一個ACE EditSession對象。

如果需要與CodeEditor實例的內容互動，請使用module-jquery.textSelection.$.fn.textSelection()。

授權條款

儘管此擴充功能以GNU通用公共許可證2.0版或更高版本（GPL-2.0+）授權，它同樣使用Ace編輯器軟體，而它則以BSD修改版（3-clause）授權條款「新版」或「修正版」（BSD-3-Clause）授權。

參閱

• Category:CodeEditorGetPageLanguage extensions – 透過 CodeEditorGetPageLanguage 勾點利用代碼編輯器的擴充功能。
• en:User:Nardog/CodeEditorAssist – 用於在頁面載入期間儲存使用者偏好設定的使用者指令碼