lang

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

def quick_sort(arr):
    less = []

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

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

line

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

def quick_sort(arr):
	less = []

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

start

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

def quick_sort(arr):
    less = []

<syntaxhighlight lang="python" line start="55">
...
</syntaxhighlight>

linelinks

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.

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

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

<syntaxhighlight lang="python" line linelinks="example">
...
</syntaxhighlight>

[[#example-3|...]]
[[#example-2--example-4|...]]

highlight

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

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

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

<syntaxhighlight lang="python" line start="3" highlight="1,5-7">
...
</syntaxhighlight>

inline

この属性は、(独自のブロックではなく)段落の一部としてインラインにソースコードを埋め込むことを示します。 このオプションは MediaWiki 1.26 以降で利用できます。

例:

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

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

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

class

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

例:

class="nowrap" なし:

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

style

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

例:

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

次の記述を使います：

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

copy

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

例:

def quick_sort(arr):
    less = []

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

<syntaxhighlight lang="python" copy>
def quick_sort(arr):
    less = []
</syntaxhighlight>

プログラミング言語

• 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がサポートしていたレクサー

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

設定

$wgSyntaxHighlightMaxLines and $wgSyntaxHighlightMaxBytes (optional): For performance reasons, blobs or pages (JS, Lua and CSS pages) larger than these values will not be highlighted. (since 1.40)

Linux

• $wgPygmentizePath （オプション）：Pygmentsパッケージを「ピグメント化する」（pygmentize）絶対パス。 この拡張機能は、Pygmentsパッケージを同梱しており、$wgPygmentizePathは既定では同梱されたバージョンが指定されていますが、必要に応じて別のバージョンを指定することもできます。 例: $wgPygmentizePath = "/usr/local/bin/pygmentize";。

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にバックポートされています。

VisualEditorとの連携

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