Extension:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 74% complete.
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced-invert.svg
CodeMirror
リリースの状態: 安定
Pride and codemirror.png
実装 ユーザー インターフェイス
説明 wikitextエディタにシンタックスハイライトを追加
作者 Pavel Astakhov (pastakhovトーク)
最新バージョン 4.0.0
互換性ポリシー Snapshots releases along with MediaWiki. master には後方互換性がありません。
MediaWiki 1.32+
PHP 5.3+
データベースの変更 いいえ
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
  • $wgCodeMirrorEnableBracketMatching
  • $wgCodeMirrorAccessibilityColors
  • $wgCodeMirrorLineNumberingNamespaces
translatewiki.net で翻訳を利用できる場合は、CodeMirror 拡張機能の翻訳にご協力ください

使用状況とバージョン マトリクスを確認してください。

Vagrant role codemirror
問題点 未解決のタスク · バグを報告

CodeMirror (コードミラー) 拡張機能はMediaWikiのwikitextエディタにシンタックスハイライトを追加する拡張機能です。 この拡張機能はシンタックスハイライトの切り替えを行うボタン Codemirror-icon.png を追加します。 2010 WikiEditor toolbarVisualEditor toolbar をサポートしています。

デフォルトの設定ではこの拡張機能は無効化されています。 有効化されると、標準のテキストエリアを CodeMirror library が提供するエディタで置換します。 無効化されると、その置換を取り消します。

The colors used in this extension have been optimised to provide higher contrast, accessibility and better readability.

Please note though, that the updated color scheme is currently only enabled by default for some wikis (see roadmap and configuration).

機能

Bracket matching

This feature allows highlighting of the closest matching pair of surrounding brackets while navigating through wikitext code using the cursor. Bracket matching will be active in both editors when syntax highlighting is turned on, in any namespace using these editors.

Please note that bracket matching is only enabled by default in some wikis (see roadmap and configuration).

Line numbering

In the wikitext edit mode line numbers are automatically displayed in both editors.

Please note that this feature is only enabled for the template namespace on most wikis (see roadmap and configuration).

ブラウザの対応状況

MediaWikiがサポートするブラウザは全てサポートしています。

インストール方法

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

設定

配色と書式のカスタマイズ方法は Meta help page を参考にしてください。 wikitextのシンタックスハイライトのスタイルを自由に設定することができます。 Used styles available here. You should place your own styles to common.css.

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

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

あなたの環境で上記の新しい機能を試すには、次のコードを追加してください。なお、これらの機能は将来デフォルト設定にする予定です。 その場合これらの設定は無視されます。

# Enable bracket matching in CodeMirror
$wgCodeMirrorEnableBracketMatching = true;

# Enable accessible colors in CodeMirror
$wgCodeMirrorAccessibilityColors = true;

# Enable line numbering in CodeMirror
# defaults to the template namespace `[ NS_TEMPLATE ]`
# `null` enables it for all namespace
# [] for disabling everywhere
$wgCodeMirrorLineNumberingNamespaces = null;

拡張機能の統合

もしあなたが作成した別のMediaWiki拡張機能が定義した独自のタグについてもCodeMirrorに正しくハイライトさせたい場合、Cite extensionPhpTags extension に従ってその拡張機能にCodeMirrorサポートを追加してください。

JavaScript integration

The following front-end hooks are used in this extension:

フック パラメーター
説明
ext.CodeMirror.switch 真偽値 Whether the CodeMirror editor is now shown
jQuery オブジェクト The current "editor", which is either the normal ‎<textarea /> or the .CodeMirror element.

実装予定

  • 定義リストのシンタックスハイライト ( ;foo :bar ) (phab:T170042)
  • 自動補完 (phab:T95100)
  • コードの折りたたみ T166098
  • ギャラリータグ内のシンタックスハイライト(<gallery> foo | bar </gallery>)

関連項目