Extension:CodeEditor

この拡張機能は MediaWiki 1.31 以降に同梱されています。 そのため再度ダウンロードする必要はありません。 しかし、提供されているその他の手順に従う必要はあります。

CodeMirror と混同しないでください。

MediaWiki 拡張機能マニュアル

CodeEditor リリースの状態: 安定
説明	サイトや利用者のJavaScript、CSS、Luaページ用、構文強調コードエディターを提供します。これは高機能編集ツールバーに統合されたものです。
作者	Brooke Vibber Derk-Jan Hartman authors of Ace (ace.c9.io)
互換性の方針	MediaWiki とともにリリースされるスナップショット。 master には後方互換性がありません。
MediaWiki	>= 1.43
データベースの変更	いいえ
ライセンス	GPL-2.0-or-later AND BSD-3-Clause
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (Phabricator · GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー
パラメーター $wgCodeEditorEnableCore
使用するフック EditPage::showEditForm:initial EditPage::showReadOnlyForm:initial GetPreferences
提供するフック CodeEditorGetPageLanguage
四半期ごとのダウンロード数	119 (Ranked 48th)
使用中の公開ウィキ	8,385 (Ranked 17th)
translatewiki.net で翻訳を利用できる場合は、CodeEditor 拡張機能の翻訳にご協力ください
問題点	未解決のタスク · バグを報告

CodeEditor拡張機能はWikiEditor高機能編集ツールバーを埋め込み、Ace エディター ウィジェットで拡張して、利用者やサイトがJavaScript、CSS、JSONのページを編集するときに便利な機能を提供します。そして拡張機能Scribunto もインストールされている場合はLuaページ、すなわちModule名前空間のページに対していくつかの便利な機能を提供します。 コードエディターは、通常のウィキページ(コンテンツモデルが「ウィキテキスト」のページ)には表示されません。 (ソースエディター使用時のウィキテキストの構文強調表示については、Extension:CodeMirror を参照してください。)

以下の機能を提供します:

• JavaScript・CSS・Luaのための構文ハイライト
• オートインデント

• tab key produces tab indents (since 1.22), soft indents before.

• Tab ↹/⇧ Shift+Tab ↹ によってインデントを下げたり戻したりできます
• JavaScriptの構文を検査します。

• Pair-matching for parenthesis, braces and square brackets

インストール

この拡張機能は、WikiEditor拡張機能が必要です。 任意でScribunto拡張機能もインストールしてください。

• ダウンロードして、ファイルをextensions/フォルダー内のCodeEditorという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用して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
  

• 必要に応じて設定します。
•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

Vagrantでのインストール:

• Vagrant を使用している場合は、vagrant roles enable codeeditor --provisionでインストールしてください。

設定

$wgCodeEditorEnableCore

MediaWiki、利用者、その他のコア名前空間で JavaScript と CSSのエディターを無効にするには、$wgCodeEditorEnableCore = false; を設定します (既定値は true)。

$wgScribuntoUseCodeEditor

Scribunto (モジュール名前空間)でこの拡張機能を無効にするには、$wgScribuntoUseCodeEditor = false; を設定します(既定値は true)。

このパラメータはScribunto拡張機能によって提供されるため、CodeEditorとScribuntoの両方の拡張機能を呼び出した後で追加する必要があります。

JavaScript

It is possible to change the configuration of the ACE editor, by hooking into the MediaWiki JS hook (i.e. mw.hook( 'codeEditor.configure' ).add( ... )). The argument passed to your hook will be an ACE EditSession object.

If you need to interact with the contents of a CodeEditor instance, use module-jquery.textSelection.$.fn.textSelection().

ライセンス

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

関連項目

• Category:CodeEditorGetPageLanguage extensions – extensions that make use of CodeEditor through the CodeEditorGetPageLanguage hook.
• en:User:Nardog/CodeEditorAssist – a user script to save user preferences across page loads