Extension:CodeMirror

MediaWiki 拡張機能マニュアル

CodeMirror リリースの状態: 安定
実装	ユーザー インターフェイス
説明	ウィキテキスト エディターに構文強調表示機能を提供する
作者	Pavel Astakhov (pastakhovトーク)
最新バージョン	4.0.0
互換性ポリシー	リリースブランチ
MediaWiki	1.32+
PHP	5.3+
データベースの変更	いいえ
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー
パラメーター $wgCodeMirrorEnableBracketMatching
使用するフック BeforePageDisplay GetPreferences ResourceLoaderGetConfigVars
translatewiki.net で翻訳を利用できる場合は、CodeMirror 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
Vagrant role	codemirror
問題点	未解決のタスク · バグを報告

CodeMirror (コードミラー) 拡張機能はMediaWikiのウィキテキスト エディターに構文強調表示機能を提供します。ツールバーに $logo アイコンのボタンを追加し、構文強調表示の有効無効を切り替えられるようにします。ビジュアルエディター ツールバーだけではなく2010年版ウィキエディター ツールバーにも対応しています。 It adds a button with the icon to the editing toolbar that allows for switching syntax highlighting on and off. It supports the 2010 WikiEditor toolbar as well as the VisualEditor toolbar.

既定では無効で、有効に切り替えると標準のtextareaを[$codemirror CodeMirror library]から呼び出したエディタに置換します。無効に切り替えると、それと逆の処理をします。 When switching on, it will replace the standard textarea with the editor provided by CodeMirror library. When switching off, it will be the opposite effect.

ユーザーはウィキ文の強調表示の書式を設定できます。 また書式を固定するには、common.cssに記述してください。 もしより良い書式がある場合は教えてくれるようお願いします。 Used styles available here. You should place your own styles to common.css. If you have found better styles please let me know.

ブラウザーへの対応

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

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

スクリーンショット

• 
• 

デモ動画

インストール

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

手動インストール

• Install either the WikiEditor extension or the VisualEditor extension in wikitext mode, as instructed on their pages; at least one of these is required for this extension to work.
• ダウンロードして、ファイルを extensions/ フォルダー内の CodeMirror という名前のディレクトリ内に配置します。
• 以下のコードを LocalSettings.php の末尾に追加します:

  wfLoadExtension( 'CodeMirror' );
  

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

設定

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

上記のコードを LocalSettings.php の末尾に追加します。

配色と書式のカスタマイズはハイテクコミュニティの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