Extension:CodeMirror

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

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

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

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

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

この拡張機能で使用される色は、より高いコントラスト、アクセシビリティ、読みやすさを提供するために最適化されています。 The colors provide better access for people with limited vision as well as for users working in bright daylight conditions. (more information)

機能

ブラケットマッチング

この機能は、カーソルが任意の括弧の間にある場合、最も内側の括弧のペアを強調表示し、カーソルが括弧の直下にある場合、対応する括弧を強調表示するものです。 ブラケットマッチングは、シンタックスハイライトがオンの場合、両方のエディターで、これらのエディターを使用しているすべてのネームスペースで有効になります。

行番号表示

wikitext編集モードでは、行番号はどちらのエディタでも自動的に表示されます。

この機能は、ほとんどのウィキでテンプレート名前空間に対して、また一部のウィキではすべての名前空間に対して有効になっています (ロードマップ設定を参照)。

Colorblind mode

For users who have difficulty distinguishing between colors, CodeMirror offers a colorblind-friendly mode. This feature can be activated on wikis with CodeMirror enabled by navigating to the Special:Preferences page.

 


With the colorblind-friendly scheme active, the colors of the following page elements change:

Headings, symbols, signatures, section names, magic words #E4A400
Templates #9C3A00
HTML tags, references, mathematical expressions #56B4E9
Variables #009E73

In addition, background highlights and colors are removed from all text and objects. Bolding and underlining behavior remains unaffected.


ブラウザの対応状況

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

インストール方法

  • Vagrant を使用している場合は、vagrant roles enable codemirror --provisionでインストールしてください。
手動インストール
  • 先にWikiEditor 拡張機能かVisualEditor 拡張機能のどちらかをインストールしておく必要があります。
  • ダウンロードして、ファイルをextensions/フォルダー内のCodeMirrorという名前のディレクトリ内に配置します。
  • 以下のコードをLocalSettings.phpの末尾に追加します:
    wfLoadExtension( 'CodeMirror' );
    
  • 必要に応じて設定します。
  •   完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

配色と書式のカスタマイズ方法は Meta help page を参考にしてください。 wikitextのシンタックスハイライトのスタイルを自由に設定することができます。 古いスタイルはこちらで入手可能です。 common.css に自分のスタイルを配置する必要があります。

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

# CodeMirrorの使用をデフォルトで有効にし、ユーザーが無効にできるようにした。
$wgDefaultUserOptions['usecodemirror'] = 1;

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

# CodeMirrorでブラケットマッチを有効にする
$wgCodeMirrorEnableBracketMatching = true;

# CodeMirrorでアクセシブルカラーを有効にする
$wgCodeMirrorAccessibilityColors = true;

# CodeMirrorで行番号を有効にする
# デフォルトはテンプレートの名前空間 [ NS_TEMPLATE ]
# nullで、すべての名前空間に対して有効になります。
# どこでも無効化できるよう[]
$wgCodeMirrorLineNumberingNamespaces = null;

拡張機能の統合

MediaWiki拡張機能が新しいタグを追加し、CodeMirrorがその中のコンテンツを適切にハイライトすることを確認したい場合、拡張機能にCodeMirrorサポートを追加することができます。ここに2つの例があります。Cite拡張機能PhpTags拡張機能です。

JavaScriptの統合

この拡張機能では、以下の[1]が使用されています。

フック パラメーター
説明
ext.CodeMirror.switch 真偽値 CodeMirrorエディタが表示されるようになったかどうか
jQuery オブジェクト 現在の "エディタ "であり、通常の‎<textarea />または.CodeMirrorの要素である。

実装予定

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

関連項目