Extension:CodeMirror

This page is a translated version of the page Extension:CodeMirror and the translation is 93% complete.

Other languages:

Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎magyar • ‎português do Brasil • ‎sicilianu • ‎svenska • ‎čeština • ‎українська • ‎العربية • ‎中文 • ‎日本語 • ‎한국어

**MediaWiki 拡張機能マニュアル**
CodeMirror リリースの状態: 安定

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

CodeMirror (コードミラー) 拡張機能はMediaWikiのwikitextエディタにシンタックスハイライトを追加する拡張機能です。この拡張機能はシンタックスハイライトの切り替えを行うボタンを追加します。 2010 WikiEditor toolbar と VisualEditor 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).

Features

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

Bracket matching

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 by default (see roadmap and configuration).

Line numbering in 2010 wikitext editor
Line numbering in 2017 wikitext editor

ブラウザの対応状況

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

インストール方法

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

手動インストール

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

設定

配色と書式のカスタマイズ方法は 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 extension や PhpTags extension に従ってその拡張機能にCodeMirrorサポートを追加してください。

実装予定

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

Extension:CodeMirror

Contents