Extension:CodeMirror

MediaWiki 拡張機能マニュアル

CodeMirror リリースの状態: 安定
実装	User interface
説明	ウィキテキスト エディターに構文強調表示機能を提供する
作者	Pavel Astakhov (pastakhovtalk)
MediaWiki	1.32+
PHP	5.3+
データベースの変更	いいえ
ライセンス	GNU General Public License 2.0 or later
ダウンロード	スナップショットをダウンロード Git [?]: Git master をダウンロード リポジトリの参照 (GitHub) コミット履歴 コード レビュー
例	test.foxway.org
使用するフック BeforePageDisplay GetBetaFeaturePreferences GetPreferences
translatewiki.net で翻訳を利用できる場合は、CodeMirror 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点	未解決のタスク · バグを報告

CodeMirror (コードミラー) 拡張機能はMediaWikiのウィキテキスト エディターに構文強調表示機能を提供します。ツールバーに アイコンのボタンを追加し、構文強調表示の有効無効を切り替えられるようにします。ビジュアルエディター ツールバーだけではなく2010年版ウィキエディター ツールバーにも対応しています。

既定では無効で、有効に切り替えると標準のtextareaをCodeMirror libraryから呼び出したエディタに置換します。無効に切り替えると、それと逆の処理をします。

ユーザーはウィキ文の強調表示の書式を設定できます。 また書式を固定するには、common.cssに記述してください。 もしより良い書式がある場合は教えてくれるようお願いします。

ブラウザーへの対応

テストはまだ完成ではありません!

MediaWikiがサポートするブラウザは全てサポートしています。 最新型のブラウザとは部分的に適合しない部分があります。

スクリーンショット

• 
• 
• 

デモ動画

インストール

• ダウンロードして、ファイルを extensions/ フォルダー内の CodeMirror という名前のディレクトリ内に配置します。

• 以下のコードを LocalSettings.php の末尾に追加します:

  wfLoadExtension( 'CodeMirror' );
  

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

MediaWiki 1.24 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.24 以前) にインストールする必要がある場合は、wfLoadExtension( 'CodeMirror' ); の代わりに以下を使用する必要があります:

require_once "$IP/extensions/CodeMirror/CodeMirror.php";

設定

# Enables use of CodeMirror by default but still allow users to disable it
$wgDefaultUserOptions['usecodemirror'] = 1;

以下のコードを $LocalSettings の末尾に追加します。

配色と書式のカスタマイズはハイテクコミュニティのmeta:Community Tech/Wikitext editor syntax highlighting#Color and style customizationマニュアルに説明があります。

拡張機能の統合

MediaWiki 拡張機能に新規のタグが追加されても、その内容を含めてCodeMirrorに適切に強調表示させるには、CodeMirrorをサポートする拡張機能を追加します。例えば次の2例があります。Cite extension及びPhpTags extension。

やるべきこと

• 強調表示の指定のリスト( ;foo :bar ) (phab:T170042)
• 自動補完 (phab:T95100)
• brace matching (phab:T15302)
• code folding T166098
• ギャラリーのタグ内の強調表示(<gallery> foo | bar </gallery>)

関連項目

• User:Remember the dot/Syntax highlighter ー 1ユーザーによる考察
• Extension:VisualEditor
• Extension:WikiEditor
• Extension:CodeEditor
• Community Tech/Wikitext editor syntax highlighting (includes information on customizing the colors)
• c:Category:MediaWiki extension CodeMirror