Extension:SyntaxHighlight/zh

SyntaxHighlight（语法高亮）扩展，早先被称为SyntaxHighlight_GeSHi，使用扩展标签对源代码提供富文本格式. 它由Pygments库提供支持，并支持数百种编程语言和文件格式.

如同和 标签，文本将按照输入的内容准确呈现且保留所有空格.

The SyntaxHighlight extension does not work on hardened wiki installations due to lack of,   and friends. 参见.

自1.39版本起，标签被视为高开销. （参见. ）

用法
当您安装本扩展后，您就可以在你的wiki使用“syntaxhighlight”标签. 举个例子，

这是实现上面内容的维基代码：

在MediaWiki 1.16之前，这个扩展使用的是标签. 它现在仍然可以使用，但已棄用，應使用.

样式
如果您觉得标签里面的预览文字太大，您可以调整它通过把下面的代码拷贝到您wiki的 MediaWiki:Common.css 中 （创建它如果不存在的话）：

代码块的外框可以通过在上方代码中插入一行实现. 控制使用的字体也可以通过添加到上面的代码中.



语法高亮错误分类
该扩展将添加在标签中有错误 属性的页面到一个追踪分类. 消息文字MediaWiki:syntaxhighlight-error-category决定了分类的名字，在本维基上为Category:.

导致页面被此类别标记的最常见错误是标记，根本没有 属性，因为此扩展的旧版本支持的定义. 这些通常既可以替换为，也可以将 或 添加到标签.

如果内容超过1000行或者超过100jB文本，分类也可能被添加，内容不会被高亮.

lang
属性定义了应使用什么词法分析器. 该语言会影响扩展如何高亮显示源代码. 参阅支持的语言这一章节获得关于受支持语言的详细内容.

指定了一个无效的或未知的语言名称，则该页面会被加入跟踪分类. 参阅语法高亮错误分类章节获取详细信息.

line
属性启用行号.

start
属性（与 相配合）定义了代码块的第一行行号. 例如， 将会使行号从55开始.

highlight
属性将指定一行或多行将被标记（通过对指定的行显示不同的背景色）. 您可以指定多个行的数字通过逗号分隔（例如， ）或使用一个连字符和两个数字表示范围（例如， ）.

上面为下方代码的输出结果：

inline
该属性表示源代码将作为段落的一部分内联（而不是自己的块）. 该选项在MediaWiki 1.26版本开始可用.

例如：

以下 是在Python的Lambda表达式.

是下方的结果：

class
当使用了 时，指定 （在那些受到支持的维基上，而不是MediaWiki本身）不应在代码块内的空格处出现换行符.

例如：

没有 ：

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

使用 ：

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style
属性允许CSS属性被直接包含. 这相当于将块封装在标签（不是标签）中. 属性不能够通过这种方式指定. 它需要标签封装，像下方高级段落中描述的样子.

例如：

是下方的结果：



支持的语言
Pygments通过库中包含的各种“语法分析器”支持语法突出显示数百种计算机语言和文件格式.

在大多数情况下，要与此扩展一起使用的 属性是语言名称的小写版本. However, many have aliases, or "short names" as they're called in the Pygments documentation; see "Available lexers" for full details.

Some languages previously supported by GeSHi have been mapped to Pygments lexers; see for details.

截至2020年1月，Pygments支持的完整语言列表为：

编程语言
1=

ActionScript

Ada

Agda（包括literate）

Alloy

AMPL

ANTLR

APL

AppleScript

组装（各种）

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（包括Literate Cryptol）

Crystal

Cypher

Cython

D

Dart

DCPU-16

Delphi

Dylan（包括控制台）

Eiffel

Elm

Emacs Lisp

Email

Erlang（包括shell session）

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（包括Literate Idris）

Igor Pro

Io

Jags

Java

JavaScript

Jasmin

Jcl

Julia

Kotlin

Lasso（包括模板）

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（包括控制台会话和回溯）

QBasic

Racket

Raku a.k.a. Perl 6

REBOL

Red

Redcode

Rexx

Ride

Ruby（包括irb会话）

Rust

S, S-Plus, R

Scala

Scdoc

Scheme

Scilab

SGF

Shell脚本（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 templates

Cheetah templates

ColdFusion

Django / Jinja模板

ERB（Ruby模板）

Evoque

Genshi（Trac模板语言）

Handlebars

JSP (Java Server Pages)

Liquid

Myghty（基于HTML::Mason的框架）

Mako (the Myghty successor)

Slim

Smarty templates (PHP templating)

Tea

Twig

其他标记
1=

Apache配置文件

Apache Pig

BBCode

CapDL

Cap'n Proto

CMake

Csound代码

CSS

Debian控制文件

Diff files

Dockerfiles

DTD

EBNF

E-mail headers

Extempore

Flatline

Gettext catalogs

Gnuplot script

Groff markup

Hexdumps

HTML

HTTP会话

IDL

Inform

INI风格的配置文件

IRC日志（irssi风格）

Isabelle

JSGF notation

JSON, JSON-LD

Lean theorem prover

Lighttpd config files

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 batch files

XML

XSLT

YAML

Windows Registry files

Lexers previously supported by GeSHi
以下是GeSHi可以高亮显示的部分语言清单，在切换到Pygments之后不再支持语言的被用横线删去.

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


 * Linux:


 * （可选）：Pygments包中pygmentize的绝对路径. 默认情况下，扩展中附带了Pygments包，指向默认了Pygments包，但如果需要，您可以指向不同的版本.  例如：.


 * Windows:


 * 若您在一台Windows主机上运行MediaWiki，您需要设置Pygmentize.exe的位置.
 * 若没有 ，从命令行运行在 目录中的 来生成文件.

若您在使用附带的pygmentize二进制文件（extensions/SyntaxHighlight_GeSHi/pygments/pygmentize），确保您的网络服务器允许执行它. 若您的主机商不允许添加可执行文件到站点目录，安装python-pygments并添加到LocalSettings.php中.


 * 问题排除:

找升级到MediaWiki 1.26 版本及其以后，一些用户开始报告与这个扩展的问题. 有些情况下，当某些语言（如Lua）可能无法突出显示并打开调试中时，MediaWiki会抛出错误.


 * 尝试在LocalSettings.php指定为外部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 . 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:


 * 获取更多建议和信息，请参见T128993.
 * SELinux can also prevent the extension from running with an error similar to  in your audit.log. This can be allowed with
 * 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.



可视化编辑器集成
该插件可以使用可视化编辑器直接编辑. 一个对话框会被打开，当一个用户想要编辑 段落. 要使其工作，可视化编辑器必须被安装且从最新git版本被配置，与Parsoid相同. 该功能在较老的Parsoid版本中随机地无法使用. 参见获取更多细节

高级
与和标记不同，HTML代码实体（例如 ）不需要（也不应该）将  字符转义为. 与标签一样，但与标签不同，范围内的标签（除了自己的结束标签）不需要将 符号转义为 ，也不需要使用标签转义wikitext.

此外，虽然假定制表符每8个字符停止并在复制渲染文本时使用实际空格渲染制表符，使用4空格制表位（Internet Explorer使用8除外）并保留渲染文本中的制表符，后者可以使用封闭的标记（不是，而不是使用自己的 属性）进行更改. Firefox 4.0到90需要 前缀，Opera需要 前缀（从10.60到15）. (请注意，wiki编辑框采用8空格缩进. ) 这仅适用于实际保存的页面，通过编辑框或Special:ExpandTemplates生成的预览可能会有所不同.



參見

 * Pygments — Python syntax highlighter
 * 基于此的扩展：
 * — 基于标题后缀的高亮.
 * 可选扩展：
 * — syntax highlighter that uses HighlightJS library (includes support for some languages that are missing from Pygments, such as Maxima).
 * — 使用谷歌代码美化库的语法高亮扩展.