Extension:SyntaxHighlight

This page is a translated version of the page Extension:SyntaxHighlight and the translation is 72% complete.
この拡張機能は MediaWiki 1.21 以降に同梱されています。 そのため再度ダウンロードする必要はありません。 しかし、提供されているその他の手順に従う必要はあります。
ソース エディターを使用するときのウィキテキストの構文強調表示については、CodeMirror 拡張機能または Remember the dotCacycle の利用者スクリプトを参照してください。
MediaWiki 拡張機能マニュアル
SyntaxHighlight
リリースの状態: 安定
実装 タグ
説明 ウィキページ内でソースコードの構文を強調できるようにする
作者
最新バージョン 継続的な更新
互換性の方針 master は後方互換性を維持しています。
MediaWiki 1.25+
データベースの変更 いいえ
Composer mediawiki/syntax-highlight
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
README
  • $wgPygmentizePath
  • $wgSyntaxHighlightMaxLines
  • $wgSyntaxHighlightMaxBytes
‎<syntaxhighlight>
使用中の公開ウィキ 11,760 (Ranked 8th)
SyntaxHighlight 拡張機能の翻訳にご協力ください
問題点 未解決のタスク · バグを報告

これまでは 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以降は高負荷としてマークされています。 Increase webserver timeout value in environments in extreme cases. (See タスク T316858.)

使用法

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

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

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

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

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

スタイル

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

/* ここに配置されたCSSはすべての外装に適用されます */
.mw-highlight pre {
	font-size: 90%;
}

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

構文強調エラーのカテゴリ

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

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

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

パラメーター

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>

highlight

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

ここで指定する行番号は、start属性によって変更される行番号を無視します。
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

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

「enclose」引数の使用は非推奨となりました。「none」に設定されている場合は、inlineに置き換える必要があります。それ以外の場合は当該箇所を除去してください。
Line breaks can occur at any space between the opening and closing tags unless the source code is marked non-breakable with class="nowrap" (on those wikis that support it; see below) or style="white-space:nowrap".

例:

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

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

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

class

When inline is used, class="nowrap" (on those wikis that support it; not on MediaWiki itself) specifies that line breaks should not occur at spaces within the code block.

例:

class="nowrap" なし:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

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>

言語のサポート

Pygments は、ライブラリに含まれるさまざまな「レキサー」(lexers) を通じて、何百ものコンピューター言語とファイル形式の構文強調のサポートを提供します。

この拡張機能のlang=属性に使用する名前は、ほとんどの場合は言語名を小文字にしたものです。 ただし、大半はPygmentsドキュメントで呼ばれている短い名称(エイリアス)が付いています。詳細は"利用可能なレクサー"を参照してください。

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

2023年4月以降、Pygmentsは「wikitext」レクサーを提供しています。 古いバージョンでは、代わりに「html+handlebars」または「moin」を使用してください。

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 (the Trac template language)
  • Handlebars
  • JSP (Java Server Pages)
  • Liquid
  • Myghty (the HTML::Mason based framework)
  • Mako (the Myghty successor)
  • Slim
  • Smarty templates (PHP templating)
  • 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 Wiki markup
  • 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 レジストリ ファイル
Since MediaWiki 1.37 more lexers were added with the update of pygments to version 2.10.0 as detailed with タスク T280117.
  • ansys
  • apdl
  • asc
  • gcode
  • golang === go
  • gsql
  • jslt
  • julia-repl
  • kuin
  • meson
  • nestedtext
  • nodejsrepl
  • nt
  • omg-idl
  • output
  • pem
  • procfile
  • pwsh
  • smithy
  • teal
  • thingsdb
  • ti
  • wast
  • wat

GeSHiがサポートしていたレクサー

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

GeSHiがサポートしていたレクサー
コード 言語
4cs GADV 4CS
6502acme MOS 6502 (6510) ACME Cross Assembler
6502kickass MOS 6502 (6510) Kick Assembler
6502tasm MOS 6502 (6510) TASM/64TASS
68000devpac Motorola 68000 - HiSoft Devpac ST 2 Assembler
abap ABAP
actionscript ActionScript
actionscript3 ActionScript3
ada Ada
algol68 ALGOL 68
apache Apache Configuration
applescript AppleScript
apt_sources Apt sources
arm ARM Assembler
asm Assembly
asp Active Server Pages (ASP)
asymptote Asymptote
autoconf Autoconf
autohotkey AutoHotkey
autoit AutoIt
avisynth AviSynth
awk AWK
bascomavr BASCOM AVR
bash Bash
basic4gl Basic4GL
bf Brainfuck
bibtex BibTeX
blitzbasic Blitz BASIC
bnf Backus–Naur Form
boo Boo
c C
c_loadrunner C Loadrunner
c_mac C (Mac)
caddcl AutoCAD DCL
cadlisp AutoLISP
cfdg CFDG
cfm ColdFusion Markup Language
chaiscript ChaiScript
cil Common Intermediate Language (CIL)
clojure Clojure
cmake CMake
cobol COBOL
coffeescript CoffeeScript
cpp C++
cpp-qt C++ (Qt toolkit)
csh C shell
csharp C#
css Cascading Style Sheets (CSS)
cuesheet Cue sheet
d D
dart Dart
dcl Data Control Language
dcpu16 DCPU-16
dcs Data Conversion System
delphi Delphi
diff Diff
div DIV
dosbatch DOS batch file
dot DOT
e E
ebnf Extended Backus–Naur Form
ecmascript ECMAScript
eiffel Eiffel
email Email (mbox \ eml \ RFC format)
epc Enerscript
erlang Erlang
euphoria Euphoria
f1 Formula One
falcon Falcon
fo FO
fortran Fortran
freebasic FreeBASIC
freeswitch FreeSWITCH
fsharp Fsharp
gambas Gambas
gdb GDB
genero Genero
genie Genie
gettext gettext
glsl OpenGL Shading Language (GLSL)
gml Game Maker Language (GML)
gnuplot gnuplot
go Go
groovy Groovy
gwbasic GW-BASIC
haskell Haskell
haxe Haxe
hicest HicEst
hq9plus HQ9+
html4strict HTML (use "html" instead)
html5 HTML5 (use "html" instead)
icon Icon
idl Uno IDL
ini INI
inno Inno
intercal INTERCAL
io Io
j J
java Java
java5 Java(TM) 2 Platform Standard Edition 5.0
javascript JavaScript
jquery jQuery
kixtart KiXtart
klonec Klone C
klonecpp Klone C++
kotlin Kotlin
ksh Korn shell
latex LaTeX
lb Liberty BASIC
ldif LDAP Data Interchange Format
lisp Lisp
llvm LLVM
locobasic Locomotive BASIC
logtalk Logtalk
lolcode LOLCODE
lotusformulas Formula language
lotusscript LotusScript
lscript LightWave 3D
lsl2 Linden Scripting Language
lua Lua
magiksf Magik
m68k Motorola 68000 Assembler
make make
mapbasic MapBasic
matlab MATLAB M
mirc mIRC scripting language
mmix MMIX
modula2 Modula-2
modula3 Modula-3
mpasm Microchip Assembler
mxml MXML
mysql MySQL
nagios Nagios
netrexx NetRexx
newlisp NewLISP
nsis Nullsoft Scriptable Install System (NSIS)
oberon2 Oberon-2
objc Objective-C
objeck Objeck
ocaml OCaml
ocaml-brief OCaml
octave Octave
oobas LibreOffice/OpenOffice.org Basic
oorexx Object REXX
oracle11 Oracle 11 SQL
oracle8 Oracle 8 SQL
oxygene Oxygene
oz Oz
parasail ParaSail
parigp PARI/GP
pascal Pascal
pcre Perl Compatible Regular Expressions
per per
perlpl
Perl
perl6
pl6
raku
Perl 6
pf PF
php PHP
php-brief PHP (deprecated – no colors, odd framing)
pic16 PIC assembly language
pike Pike
pixelbender Pixel Bender
pli PL/I
plsql PL/SQL
postgresql PostgreSQL
postscript PostScript
povray Persistence of Vision Raytracer
powerbuilder PowerBuilder
powershell Windows PowerShell
proftpd ProFTPD
progress OpenEdge Advanced Business Language
prolog Prolog
properties Properties file
providex ProvideX
purebasic PureBasic
pycon Python
pys60 PyS60
python
py
python3
py3
Python
python2
py2
Python 2
q Q
qbasic QBasic/QuickBASIC
rails Rails
rebol Rebol
reg Windows Registry
rexx Rexx
robots robots.txt
rpmspec RPM Spec files
rsplus R
ruby Ruby
sas SAS
scala Scala
scheme Scheme
sh
shell
shell-session
Shell Script (POSIX)
scilab Scilab
sdlbasic SdlBasic
smalltalk Smalltalk
smarty Smarty
spark SPARK
sparql SPARQL
sql SQL
stonescript StoneScript (Scripting language for ShiVa3D)
systemverilog SystemVerilog
tcsh Tcsh
tcl Tcl
teraterm Tera Term
text Plain text
thinbasic thinBasic
ts TypeScript
tsql Transact-SQL
typoscript TypoScript
unicon Unicon
upc Unified Parallel C
urbi URBI
uscript UnrealScript
vala Vala
vb Visual Basic
vbnet Visual Basic .NET
vedit VEDIT
verilog Verilog
vhdl VHDL
vim Vim script
visualfoxpro Visual FoxPro
visualprolog Visual Prolog
whitespace Whitespace
whois Whois
winbatch Winbatch
xml XML
xorg_conf Xorg.conf
yaml YAML
xpp Microsoft Dynamics AX
z80 ZiLOG Z80 Assembler
zxbasic ZXBasic


インストール

この拡張機能のMediaWiki 1.31同梱版をサーバにインストールするにはPythonバージョン3(python3)が必要です。同バージョン2(python)を使ったMediaWiki 1.30同梱版からの変更です。python3バイナリファイルのインストール先は必ずPHPインタープリターの実行PATHにする点に留意してください。
Pygmentsへのアップデート(ならびにGeSHiからの移行)および新しい名前に変わっても、内部では下記のとおり、旧来のファイル名をそのまま使い続けています。
  • ダウンロードして、ファイルをextensions/フォルダー内のSyntaxHighlight_GeSHiという名前のディレクトリ内に配置します。
    開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
  • Gitでのインストールの場合のみ、PHPの依存関係をインストールするためComposerを実行します。 (合併症の可能性についてはタスク T173141を参照。)
  • 以下のコードを LocalSettings.php ファイルの末尾に追加します:
    wfLoadExtension( 'SyntaxHighlight_GeSHi' );
    
  • Linuxでは、pygmentizeバイナリに実行権限を設定します。 これを行うには、FTPクライアントまたは次のシェルコマンドを使用します:
chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
  •   完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。


Vagrantでのインストール:

  • Vagrant を使用している場合は、vagrant roles enable syntaxhighlight --provisionでインストールしてください。
インストールにGitを利用する場合、MediaWiki 1.26 から 1.31 まで、この拡張機能にはComposer (コンポーザー) が必須です。

これを受け、Gitからインストール後は拡張機能を保存したディレクトリ、例えば"../extensions/SyntaxHighlight_GeSHi/"に移動し、インストールにはcomposer install --no-dev、また更新するにはcomposer update --no-devを実行します。

お勧めの代替の手順として、ご利用のwikiのルートディレクトリの「composer.local.json」内に、下記の例のような"extensions/SyntaxHighlight_GeSHi/composer.json"という行を追加します。
{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/SyntaxHighlight_GeSHi/composer.json"
			]
		}
	}
}
次にcomposer update --no-devを実行します。 Voilà!
  警告: 拡張機能をFTP経由でアップロードする場合は、 pygments/pygmentizeファイルの転送タイプ(transfer type)をbinaryにしてあるか確認します。

設定

$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バイナリを指定してみてください。
  • In shared hosting environments with cPanel, this can be done by setting up a new Python application through the "Setup Python App" menu, and activating the virtual environment for the app through SSH (source /virtualenv/python/3.5/bin/activate). After this, the Pygments module can be added to the Python app, for which navigate to the virtual environment path (cd virtualenv/python/3.5/bin/), download and install Pygments (./pip install Pygments) and then activate the module by adding "Pygments" under the "Existing applications" section of the "Setup Python App" menu. This will create the required file at path: virtualenv/python/3.5/bin/pygmentize
  • See phab:T128993 on this for further suggestions and information.
  • 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で許可できます。
  • In earlier versions of this extension, Windows would sometimes fail with an _Py_HashRandomization_Init error. This was a bug with the Windows environment not being passed to python executions. A fix was released in 1.40, with backports to 1.38 and 1.39.

VisualEditorとの連携

The plugin enables direct editing with VisualEditor. A popup is opened when a user wants to edit syntaxhighlight sections. For this to work, VisualEditor must be installed and configured from the latest Git version, same for Parsoid. The feature may not work with older Parsoid versions. 詳細は Extension:SyntaxHighlight/VisualEditor を参照してください

高度な設定

Unlike the ‎<pre> and ‎<code> tags, HTML character entities such as &nbsp; need not (and should not) have the & character escaped as &amp;. Like the ‎<pre> tag but unlike the ‎<code> tag, tags within the range (other than its own closing tag) need not have the < symbol escaped as &lt;, nor does wikitext need to be escaped with a ‎<nowiki> tag.

Furthermore, while ‎<pre> assumes tab stops every 8 characters and renders tabs using actual spaces when the rendered text is copied, ‎<syntaxhighlight> uses 4-space tab stops (except Internet Explorer, which uses 8) and preserves the tab characters in the rendered text; the latter may be changed using an enclosing ‎<span style="-moz-tab-size: nn; -o-tab-size: nn; tab-size: nn;"> tag (not ‎<div>, and not using its own style attribute). The -moz- prefix is required for Firefox (from version 4.0 to version 90), and the -o- prefix is required for Opera (from version 10.60 to version 15).[2] (Note that the wiki editing box assumes 8-space tabs.) This applies only to actual saved pages; previews generated through an edit box or Special:ExpandTemplates may differ.

関連項目

  • Pygments — Python syntax highlighter
  • 依存する拡張機能:
  • 代替の拡張機能:
    • Extension:Highlightjs Integration — HighlightJSライブラリを使用する構文強調機能(MaximaなどのPygmentsに含まれていない一部の言語もサポートされています)。
    • Extension:GoogleCodePrettify — Google Code Prettifyライブラリを使用する構文強調機能。
    • Extension:ExternalContent — Markdownファイルの自動レンダリングを使用して、GitHub、GitLab、Bitkeeperリポジトリのコードなどの外部コンテンツを埋め込みます。また、Prism.jsライブラリによって約300言語の構文強調に対応しています。コンテンツ内容はCirrusSearchによってインデックス付けされます。


脚注