Extension:SyntaxHighlight/ja

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

タグと タグのように、テキストは入力のとおりに正確にレンダリングされ、空白は保持されます.

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

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

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

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

コードブロックを境界線で囲むには、上のセクションでのような行を挿入します. 上記のセクションにのような行を挿入することによって、使用される「フォントファミリ」の制御も行えます.

Syntax 強調のエラーのカテゴリ
この拡張機能は、タグの 属性が悪いページを追跡カテゴリに追加します. The message key メッセージキーのMediaWiki:syntaxhighlight-error-categoryによりカテゴリ名が決まります. このウィキではCategory:になります.

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

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

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

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

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

start
The  attribute (in combination with  ) defines the first line number of the code block. For example,  will make line numbering start at 55.

highlight
The  attribute specifies one or more lines that should be marked (by highlighting those lines with a different background color). You can specify multiple line numbers separated by commas (for example, ) or ranges using two line numbers and a hyphen (for example,  ).

is the result of

inline
The attribute indicates that the source code should be inline as part of a paragraph (as opposed to being its own block). This option is available starting with MediaWiki 1.26. For backwards-compatibility, an  attribute results in the same behavior.

例:

次の はPythonにおけるラムダ式の例です.

Is the result of:

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

例:

なし:

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

With : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style
The  attribute allows CSS attributes to be included directly. This is equivalent to enclosing the block in a (not ) tag. The  attribute cannot be specified this way; it requires an enclosing  tag as described below under Advanced.

例えば下記を表示するには：

次の記述を使います：

言語のサポート
Pygmentsライブラリがサポートする言語やコンピュータ言語、ファイル形式は数百あります. As of January 2020 the full list is:

プログラミング言語
1=

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

テンプレート言語
1=

Angular テンプレート

Cheetah templates

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

その他のマークアップ
1=

Apache 設定ファイル

Apache Pig

BBCode

CapDL

Cap'n Proto

CMake

Csound 楽譜

CSS

Debian control files

差分ファイル

Dockerfiles

DTD

EBNF

メール ヘッダー

Extempore

Flatline

Gettext カタログ

Gnuplot script

Groff マークアップ

六角演算子

HTML

HTTP セッション

IDL

Inform

INI-style config files

IRC logs (irssi style)

Isabelle

JSGF notation

JSON, JSON-LD

リーンの定理の格言

Lighttpd config files

Linux kernel log (dmesg)

LLVM assembly

LSL スクリプト

Makefiles

MoinMoin/Trac Wiki markup

MQL

MySQL

NCAR command language

Nginx config files

Nix 言語

NSIS scripts

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 レジストリ ファイル

厳密な言語コードは詳細を網羅した Pygments 説明文書も提供. その他、GeSHi がサポートする言語名の一部について関数も提供しています (一覧表はこちら).

Lexers previously supported by GeSHi
GeSHi で強調表示できるコンピュータ言語の一部を紹介します. 取り消し線のある項目はPygmentshrの移行により非推奨になっています.



設定

 * Linux:


 * （オプション）：Pygmentsパッケージを「ピグメント化する」（pygmentize）絶対パス. The extension bundles the Pygments package and  points to the bundled version by default, but you can point to a different version, if you want to. 例:.
 * : Configure the default lexer for some wiki pages. By default this will highlight javascript and css pages. Additional content models can be configured by extensions (e.g. Lua, JSON, ..). 例:


 * Windows:


 * MediaWiki を Windows 機器でホスティングするには、Pygmentize.exe のパスは に設定します
 * がない場合、 フォルダでコマンドラインを開き を実行して、ファイルを作成.

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


 * トラブルシューティング:

After updating to MediaWiki v1.26 and above, some users started reporting problems with the extension. There could be cases, when some languages, such as Lua might not get highlighted and by turning on debugging, MediaWiki would throw out the error,.


 * Try pointing in LocalSettings.php towards an external pygmentize binary.
 * 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 . After this, the Pygments module can be added to the Python app, for which navigate to the virtual environment path, download and 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:


 * See the phabricator task on this for further suggestions and information.
 * SELinux can also prevent the extension from running with an error similar to  in your audit.log This can be allowed with

VisualEditor integration
The plugin enables direct editing with VisualEditor. A popup is opened when a user wants to edit  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. See for details

高度な設定
Unlike the and  tags, HTML character entities such as   need not (and should not) have the   character escaped as. Like the tag but unlike the  tag, tags within the range (other than its own closing tag) need not have the   symbol escaped as , nor does wikitext need to be escaped with a  tag.

Furthermore, while assumes tab stops every 8 characters and renders tabs using actual spaces when the rendered text is copied,  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  tag (not, and not using its own   attribute). The  prefix is required for Firefox (from version 4.0), and the   prefix is required for Opera (from version 10.60 to version 15). ( 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
 * Extensions dependent on this one:
 * — highlights pages based on title suffixes.
 * Alternative extensions:
 * — syntax highlighter that uses HighlightJS library (includes support for some languages that are missing from Pygments, such as Maxima).
 * — syntax highlighter that uses Google Code Prettify library.
 * — syntax highlighter that uses SyntaxHighlighter library.