Extension:SyntaxHighlight

ソース エディターなどのウィキテキストエディター上で構文を強調表示して編集を補助したい場合は、CodeMirror 拡張機能または Remember the dot と Cacycle の利用者スクリプトを参照してください。

これまでは SyntaxHighlight_GeSHi として知られていた SyntaxHighlight(構文強調表示)拡張機能は、‎<syntaxhighlight> タグを使用してソースコードに豊富なフォーマットを提供します。 Pygments ライブラリを使用しており、数百の異なるプログラミング言語とファイル形式をサポートしています。

‎<pre> タグと <poem > タグと同様に、テキストは入力のとおりに正確にレンダリングされ、空白は保持されます。

The SyntaxHighlight extension does not work on wiki installations hardened using Hardened-PHP due to the lack of proc_open, shell_exec and other functions. T250763 を参照してください。

‎<syntaxhighlight>タグはウィキブックスなどの1ページに5,000個またはそれ以上の極端な数のsyntaxhighlightタグが含まれることがあり、1.39以降は高負荷としてマークされています。 極端な場合には、環境で ウェブサーバのタイムアウト値を増やします。 (T316858 を参照して下さい。)

インストール後はwikiページで 「syntaxhighlight」タグを使用できます。例えば次の表示の場合、

defquick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

上記は、以下のウィキ文マークアップの結果を表示しています。

<syntaxhighlightlang="python"line>
defquick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

モジュール呼び出しなどから参照読み込みされたソースコードで使用するには、#tag パーサーと safesubst: を使用します:^[1]

{{#tag:syntaxhighlight|{{safesubst:Module:Sandbox/userName/myModule}}|lang=lua}}

MediaWiki 1.16以前では、拡張機能は ‎<source> というタグを使用していました。 これは引き続きサポートされていますが、非推奨です。代わりに、‎<syntaxhighlight>を使うべきです。

表示されたコードが大きすぎる場合は、wikiのMediaWiki:Common.css ページに次のコードを入れて調整することができます(存在しない場合は作成してください):

/* ここに配置されたCSSはすべての外装に適用されます */
.mw-highlightpre{
font-size:90%;
/* ここに追加の CSS スタイルを挿入 */
}

コードブロックを境界線で囲むには、上のセクションでborder:1pxdashedblue;のような行を挿入します。 上記のセクションにfont-family:"Courier New",monospace;のような行を挿入することによって、使用される「フォントファミリ」の制御も行えます。

A practical method to generate CSS code in bulk that corresponds to one of the color schemes supported by Pygments is to run the following command from within the MediaWiki installation folder. This example is for the stata-dark color scheme:

./extensions/SyntaxHighlight_GeSHi/pygments/pygmentize-Sstata-dark-fhtml|sed's/^/.mw-highlight /'

This will output a large chunk of CSS that looks something like:

.mw-highlightpre{line-height:125%;}
.mw-highlighttd.linenos.normal{color:inherit;background-color:transparent;padding-left:5px;padding-right:5px;}
.mw-highlightspan.linenos{color:inherit;background-color:transparent;padding-left:5px;padding-right:5px;}
.mw-highlighttd.linenos.special{color:#000000;background-color:#ffffc0;padding-left:5px;padding-right:5px;}
.mw-highlightspan.linenos.special{color:#000000;background-color:#ffffc0;padding-left:5px;padding-right:5px;}
.mw-highlight.hll{background-color:#49483e}
.mw-highlight.c{color:#777;font-style:italic}/* Comment */
.mw-highlight.err{color:#A61717;background-color:#E3D2D2}/* Error */
.mw-highlight.esc{color:#CCC}/* Escape */
/* ... and so on ... */

この拡張機能は、‎<syntaxhighlight>タグのlang属性が正しく指定されていないページを追跡カテゴリに追加します。 メッセージキーのMediaWiki:syntaxhighlight-error-categoryによりカテゴリ名が決まります。このウィキではCategory:Pages with syntax highlighting errorsになります。

このカテゴリに誤って分類されるページは、‎<syntaxhighlight>タグにlang属性がない場合が多いです。エラーの原因は古いバージョンのこの拡張機能が$wgSyntaxHighlightDefaultLang の定義をサポートしていたからです。 修正するには‎<pre>に置き換えるか、タグにlang="text"を加えます。 例えば:

<syntaxhighlightlang="text">
...
</syntaxhighlight>

カテゴリはハイライトの対象が1000行以上だった場合や100キロバイト以上だった場合にも追加されます。^[2]

lang="name"属性により、対応するレクサー(語彙分析)が決まります。^[3] 拡張機能がソースコードを強調表示する方式は言語に影響を受けます。 サポートする言語の詳細は「言語のサポート」の節を参照してください。

defquick_sort(arr):
 less = []

<syntaxhighlightlang="python">
...
</syntaxhighlight>

無効あるいは未知の名前を指定すると、そのページをトラックするカテゴリが付与されます。 このページの「#構文強調エラーのカテゴリ」節で詳細を説明します。

line 属性で行番号が有効になります。

defquick_sort(arr):
	less = []

<syntaxhighlightlang="python"line>
...
</syntaxhighlight>

start属性(lineと併用)は、コードブロックの最初の行番号を定義します。 例えば、line start="55"と指定すると、行番号は55から始まります。

defquick_sort(arr):
 less = []

<syntaxhighlightlang="python"linestart="55">
...
</syntaxhighlight>

linelinks属性(lineと併用)は、コードブロックの各行にアンカーリンクを追加します。 行番号をクリックすると、選択した行を強調表示するためのリンクを取得でき、内部および外部リンクでの使用が可能になります。 また、⇧ Shiftを押しながら別の行番号をクリックすることで、選択した行の範囲を強調表示するためのリンクを取得することもできます(MediaWiki 1.42 • change 1007640 以降)。 When JavaScript is disabled, single-line highlights can be created and existing ones jump to the right location, but the highlight is missing; however, range highlights don’t work at all, so consider using single-line highlights only for accessibility if meaningfully possible. The value of the attribute is used as a prefix for the anchors, to distinguish multiple code blocks on one page.

 defquick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

ここをクリックすると、上記のコードブロックの3行目にジャンプして強調表示します。 ここをクリックすると、上記のコードブロックの2-4行目にジャンプして強調表示します。

<syntaxhighlightlang="python"linelinelinks="example">
...
</syntaxhighlight>
[[#example-3|...]]
[[#example-2--example-4|...]]

highlight属性は、(異なる背景色で強調表示して)マークする必要のある1つ以上の行を指定します。 カンマで区切って複数の行番号を指定したり(例: highlight="1,4,8")、2つの行番号とハイフンを使用して範囲を指定することができます(例: highlight="5-7")。

defquick_sort(arr):
 less = []
 pivot_list = []
 more = []
 if len(arr) <= 1:
 return arr

これは次の記述によるものです:

<syntaxhighlightlang="python"linestart="3"highlight="1,5-7">
...
</syntaxhighlight>

この属性は、(独自のブロックではなく)段落の一部としてインラインにソースコードを埋め込むことを示します。 (1.26 で導入)

例:

次のlambda x: x * 2はPythonにおけるラムダ式の例です。

これは次の記述によるものです:

次の<syntaxhighlightlang="python"inline>lambda x: x * 2</syntaxhighlight>はPythonにおける[[w:Lambda (programming)|ラムダ式]]の例です。

inline使用時、class="nowrap" (サポートされているウィキの場合のみ。MediaWikiでは未定義)を指定すると、コードブロック内で改行されないようになります。

例:

class="nowrap" なし:

style="white-space:nowrap" あり:

style属性でCSS属性を直接含めることができます。 これはブロックを(‎<span>ではなく)‎<div>タグで囲むことと同じです。 tab‐size属性はこの方法では指定できず、後の高度な設定で説明するとおり、別途‎<span>タグが必要になります。

例:

defquick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass

これは次の記述によるものです:

<syntaxhighlightlang="python"style="border: 3px dashed blue;">
defquick_sort(arr):
	less = []
	pivot_list = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

copy属性は、クリックすると内容をクリップボードにコピーするリンクボタンを追加します。

例:

defquick_sort(arr):
 less = []

これは次の記述によるものです:

<syntaxhighlightlang="python"copy>
defquick_sort(arr):
 less = []
</syntaxhighlight>

Pygments ライブラリは、内蔵のレクサー(lexers)と呼ばれる正規表現ベースの字句解析メカニズムを通じて、何百ものコンピューター言語とファイル形式の構文強調表示を提供します。

通常、lang は言語名を小文字化したものを使用しますが、大半の言語には Pygments ドキュメントで呼ばれている短い名称(エイリアス)が付いています。Pygments レクサーおよび SyntaxHighlight.lexers.php を参照してください。

以前 GeSHi でサポートされていた一部の言語は、同等の Pygments レクサーに関連付けられました。SyntaxHighlightGeSHiCompat.php を参照してください。

2020年1月現在、Pygmentsがサポートしているプログラミング言語は次のとおりです:

• ActionScript
• Ada
• Agda (literate を含む)
• Alloy
• AMPL
• ANTLR
• APL
• AppleScript
• Assembly (various)
• Asymptote
• Augeas
• AutoIt
• Awk
• BBC Basic
• Befunge
• BlitzBasic
• Boa
• Boo
• Boogie
• BrainFuck
• C, C++ (Arduino のような方言を含む)
• C#
• Chapel
• Charm++ CI
• Cirru
• Clay
• Clean
• Clojure
• CoffeeScript
• ColdFusion
• Common Lisp
• Component Pascal
• Coq
• Croc (MiniD)
• Cryptol (incl. Literate Cryptol)
• Crystal
• Cypher
• Cython
• D
• Dart
• DCPU-16
• Delphi
• Dylan (incl. console)
• Eiffel
• Elm
• Emacs Lisp
• Email
• Erlang (シェル セッションを含む)
• Ezhil
• Factor
• Fancy
• Fantom
• Fennel
• FloScript
• Forth
• Fortran
• FreeFEM++
• F#
• GAP
• Gherkin (Cucumber)
• GLSL shaders
• Golo
• Gosu
• Groovy
• Haskell (Literate Haskell を含む)
• HLSL
• HSpec
• Hy
• IDL
• Idris (incl. Literate Idris)
• Igor Pro
• Io
• Jags
• Java
• JavaScript
• Jasmin
• Jcl
• Julia
• Kotlin
• Lasso (incl. templating)
• Limbo
• LiveScript
• Logtalk
• Logos
• Lua
• Mathematica
• Matlab
• Modelica
• Modula-2
• Monkey
• Monte
• MoonScript
• Mosel
• MuPad
• NASM
• Nemerle
• NesC
• NewLISP
• Nimrod
• Nit
• Notmuch
• NuSMV
• Objective-C
• Objective-J
• Octave
• OCaml
• Opa
• OpenCOBOL
• ParaSail
• Pawn
• PHP
• Perl 5
• Pike
• Pony
• PovRay
• PostScript
• PowerShell
• Praat
• Prolog
• Python (incl. console sessions and tracebacks)
• QBasic
• Racket
• Raku a.k.a. Perl 6
• REBOL
• Red
• Redcode
• Rexx
• Ride
• Ruby (incl. irb sessions)
• Rust
• S, S-Plus, R
• Scala
• Scdoc
• Scheme
• Scilab
• SGF
• Shell scripts (Bash, Tcsh, Fish)
• Shen
• Silver
• Slash
• Slurm
• Smalltalk
• SNOBOL
• Snowball
• Solidity
• SourcePawn
• Stan
• Standard ML
• Stata
• Swift
• Swig
• SuperCollider
• Tcl
• Tera Term language
• TypeScript
• TypoScript
• USD
• Unicon
• Urbiscript
• Vala
• VBScript
• Verilog, SystemVerilog
• VHDL
• Visual Basic.NET
• Visual FoxPro
• Whiley
• Xtend
• XQuery
• Zeek
• Zephir
• Zig

• Angular テンプレート
• Cheetah テンプレート
• ColdFusion
• Django / Jinja テンプレート
• ERB (Ruby templating)
• Evoque
• Genshi (Trac テンプレート言語)
• Handlebars
• JSP (Java Server Pages)
• Liquid
• Myghty (the HTML::Mason based framework)
• Mako (Myghty の後継)
• Slim
• Smarty テンプレート (PHP テンプレート)
• Tea
• Twig

• Apache 設定ファイル
• Apache Pig
• BBCode
• CapDL
• Cap'n Proto
• CMake
• Csound 楽譜
• CSS
• Debian control files
• 差分ファイル
• Dockerfiles
• DTD
• EBNF
• メール ヘッダー
• Extempore
• Flatline
• Gettext カタログ
• Gnuplot スクリプト
• Groff マークアップ
• 16進ダンプ
• HTML
• HTTP セッション
• IDL
• Inform
• INI形式 設定ファイル
• IRC logs (irssi style)
• Isabelle
• JSGF notation
• JSON, JSON-LD
• リーンの定理の格言
• Lighttpd 設定ファイル
• Linux kernel log (dmesg)
• LLVM assembly
• LSL スクリプト
• Makefiles
• MoinMoin/Trac ウィキマークアップ
• MQL
• MySQL
• NCAR command language
• Nginx 設定ファイル
• Nix 言語
• NSIS スクリプト
• Notmuch
• POV-Ray scenes
• Puppet
• QML
• Ragel
• Redcode
• ReST
• Roboconf
• Robot Framework
• RPM spec files
• Rql
• RSL
• Scdoc
• SPARQL
• SQL, also MySQL, SQLite
• Squid configuration
• TADS 3
• Terraform
• TeX
• Thrift
• TOML
• Treetop grammars
• USD (Universal Scene Description)
• Varnish configs
• VGL
• Vim Script
• WDiff
• Windows バッチ ファイル
• XML
• XSLT
• YAML
• Windows レジストリ ファイル

以下は、GeSHiで強調表示できた言語の一部のリストです。Pygmentsへの切り替え後にサポートされなくなった言語には取り消し線が引かれています。

• ダウンロードして、ファイルをextensions/フォルダー内のSyntaxHighlight_GeSHiという名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:

  cdextensions/
  gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
  

• Gitでのインストールの場合のみ、PHPの依存関係をインストールするためComposerを実行します。 (合併症の可能性についてはT173141を参照。)
• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'SyntaxHighlight_GeSHi' );
  

• Linuxでは、pygmentizeバイナリに実行権限を設定します。 これを行うには、FTPクライアントまたは次のシェルコマンドを使用します:

chmoda+x/path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize

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

Vagrantでのインストール:

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

{
"extra":{
"merge-plugin":{
"include":[
"extensions/SyntaxHighlight_GeSHi/composer.json"
]
}
}
}

Linux

Windows

• MediaWiki を Windows で稼働させている場合は、Pygmentize.exe のパスを $wgPygmentizePath = "c:\\Python27\\Scripts\\pygmentize.exe"; のように設定する必要があります。
  • pygmentize.exe がない場合、Scriptsフォルダでコマンドラインを開きeasy_install Pygments を実行して、ファイルを作成。

同梱版のpygment バイナリファイル(extensions/SyntaxHighlight_GeSHi/pygments/pygmentize)を利用する場合は、ご利用のウェブサイトでバイナリの実行を許可しているかどうか確認してください。 ホストがウェブのディレクトリに実行可能ファイル追加を許可していない場合には、LocalSettings.php にpython-pygments をインストールして $wgPygmentizePath = pygmentize を追加します。

トラブルシューティング

MediaWiki v1.26以降に更新後、一部の利用者から拡張機能に関する問題が報告されています。 Luaなどの一部の言語が強調表示されず、デバッグを有効にするとMediaWikiが次のエラーを出力する場合があります: Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory

• LocalSettings.php の $wgPygmentizePath に外部のpygmentizeバイナリを指定してみてください。

• 「cPanel」を使用した共有ホスティング環境では、「Python アプリのセットアップメニューから新しい 「Python」アプリケーションをセットアップし、「SSH」(source /virtualenv/python/3.5/bin/activate) 経由でアプリの仮想環境をアクティブ化する事でこれを実行出来ます。 この後、「Pygments」モジュールを 「Python」 アプリに追加出来ます。そのためには、仮想環境パス (cd virtualenv/python/3.5/bin/) に移動し、「Pygments」(./pip install Pygments) をダウンロードしてインストールし、「Python アプリのセットアップ」メニューの「既存のアプリケーション」セクションで「Pygments」を追加してモジュールをアクティブ化します。 これにより、必要なファイルが次のパスに作成されます。 virtualenv/python/3.5/bin/pygmentize

• さらなる提案と情報については、これの phab:T128993 を参照して下さい。
• SELinuxでは、audit.logにtype=AVC msg=audit(1609598265.169:225924): avc: denied { execute } for pid=2360888 comm="bash" name="pygmentize" dev="dm-0" ino=50814399 scontext=system_u:system_r:httpd_t:s0 tcontext=unconfined_u:object_r:httpd_user_content_t:s0 tclass=file permissive=0のようなエラーを出力し、拡張機能の実行が妨げられる場合があります。 これはsetsebool -P httpd_unified 1で許可できます。
• この拡張機能の以前のバージョンでは、Windowsが_Py_HashRandomization_Initエラーで失敗することがあります。 これはWindows環境がpythonの実行に渡されないバグによるものでした。 1.40で修正版がリリースされ、1.38と1.39にバックポートされています。

このプラグインにより、ビジュアルエディターで直接編集できるようになります。 利用者がsyntaxhighlight部分を編集する場合にポップアップが開きます。 これを機能させるには、VisualEditorとParsoidをGitの最新バージョンからインストールして構成する必要があります。 この機能は古いParsoidのバージョンでは動作しない可能性があります。 詳細は Extension:SyntaxHighlight/VisualEditor を参照してください

SyntaxHighlight を使用、開発、テストするための MediaWiki-Docker 環境を構成するための手順については、MediaWiki-Docker/Extension/SyntaxHighlight を参照してください。

• ‎<pre>や‎<code>タグと異なり、   などのHTML文字エンティティにおいては、 & 文字を & としてエスケープする必要はありません(すべきではありません)。
• ‎<pre>のようなタグを挿入する場合も、‎<code>タグ内で使用する場合と異なり、範囲内のタグ(自身の終了タグを除く)の < 記号を < としてエスケープしたり、ウィキテキストを‎<nowiki>タグでエスケープする必要はありません。

• さらに、‎<pre> は 8 文字ごとのタブ ストップを前提としており、レンダリングされたテキストをコピーする際には実際のスペースでタブを表現します。一方、‎<syntaxhighlight> は 4 文字ごとのタブ ストップを使用し(Internet Explorer では 8)、レンダリングされたテキスト内のタブ文字を保持します。後者の挙動は、$style 属性を用いず $div でもない、囲みの $span タグを使って変更できます。
  • Tab stop length for ‎<syntaxhighlight> may be adjusted using a ‎<span style=""> tag nested inside it that specifies the tab-size (its own style attribute cannot be used to specify the tab stops, and ‎<div> cannot be used instead): ‎<span style="-moz-tab-size: nn; -o-tab-size: nn; tab-size: nn;">
  • 「Firefox」 (バージョン 4.0 からバージョン 90) では -moz- プレフィックスが必須であり、「Opera」 (バージョン 10.60 からバージョン 15) では -o- プレフィックスが必須です。^[4]

• Instructions on updating the pygments version used by SyntaxHighlight
• Instructions on setting up SyntaxHighlight in a MediaWiki-Docker development environment
• Pygments – Python syntax highlighter
• 依存する拡張機能:
  • Extension:SyntaxHighlightPages – タイトルの接尾辞に基づいてページを強調表示します。
• 代替の拡張機能:
  • Extension:Highlightjs Integration – HighlightJSライブラリを使用する構文強調機能(MaximaなどのPygmentsに含まれていない一部の言語もサポートされています)。
  • Extension:ExternalContent – Markdownファイルの自動レンダリングを使用して、GitHub、GitLab、Bitkeeperリポジトリのコードなどの外部コンテンツを埋め込みます。また、Prism.jsライブラリによって約300言語の構文強調に対応しています。コンテンツ内容はCirrusSearchによってインデックス付けされます。

• Extensions bundled with MediaWiki 1.21/ja
• Stable extensions/ja
• Tag extensions/ja
• GPL licensed extensions/ja
• Extensions in Wikimedia version control/ja
• ApiFormatHighlight extensions/ja
• ContentAlterParserOutput extensions/ja
• ParserFirstCallInit extensions/ja
• ResourceLoaderRegisterModules extensions/ja
• SoftwareInfo extensions/ja
• All extensions/ja
• Extensions requiring Composer with git/ja
• Extensions used on Wikimedia/ja
• Extensions included in BlueSpice/ja
• Extensions included in Canasta/ja
• Extensions available as Debian packages/ja
• Extensions included in Fandom/ja
• Extensions included in Miraheze/ja
• Extensions included in MyWikis/ja
• Extensions included in ProWiki/ja
• Extensions included in semantic::core/ja
• Extensions included in ShoutWiki/ja
• Extensions included in wiki.gg/ja
• Extensions included in WikiForge/ja
• Syntax highlighting extensions/ja
• GeSHi extensions/ja
• Extensions with VisualEditor support/ja

• Extensions with manual MediaWiki version/ja