Extension:SyntaxHighlight/ru

This extension comes with MediaWiki 1.21 and above. Таким образом, вам не нужно загружать его снова. Тем не менее, вы всё равно должны следовать другим инструкциям.
Category:Extensions bundled with MediaWiki 1.21/ru
Для подсветки синтаксиса викитекста при использовании редактора кода см. расширение CodeMirror или скрипты пользователей Remember the dot and Cacycle.
Category:GPL licensed extensions/ru
Справка по расширениям MediaWiki
SyntaxHighlight
Статус релиза: стабильноCategory:Stable extensions/ru
Реализация Тег Category:Tag extensions/ru
Описание Позволяет подсвечивать исходный код на вики-страницах
Автор(ы)
Последняя версия постоянное обновление
Политика совместимости Мастер поддерживает обратную совместимость.
MediaWiki 1.25+Category:Extensions with manual MediaWiki version
Изменения в БД Нет
Лицензия GNU General Public License 2.0 или позднее
Скачать Category:Extensions in Wikimedia version control/ru
README
  • $wgPygmentizePath
  • $wgSyntaxHighlightMaxLines
  • $wgSyntaxHighlightMaxBytes
<syntaxhighlight>
Использование общедоступными вики 11,760 (Ranked 8th)
Переведите расширение SyntaxHighlight
Проблемы Открытые задачи · Сообщить об ошибке
Category:All extensions/ru

Расширение SyntaxHighlight, ранее известное как SyntaxHighlight_GeSHi обеспечивает огромное количество подсветок синтаксиса кода используя тег <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.39. для 5000 или какого-то другого экстремального количества тегов синтаксиса на одной странице, например, для Викиучебника. Increase webserver timeout value in environments in extreme cases. (См. T316858.)

Применение

После установки вы можете использовать теги «syntaxhighlight» на страницах вики. Например,

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

является результатом следующей разметки wikitext:

<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>.

Стайлинг

Если отображаемый код слишком велик, вы можете настроить его, поместив следующее на страницу MediaWiki:Common.css в своей вики (создайте её, если она не существует):

/* CSS, размещённый здесь, будет применяться ко всем скинам */
.mw-highlight pre {
	font-size: 90%;
}

Выделение рамкой кодовых блоков в границах можно сделать, вставив строку, подобную border: 1px dashed blue;, в секции выше. Контроль над «семейством используемых шрифтов» также может быть осуществлен путем вставки строки, такой как font-family: "Courier New", monospace;, в секции выше.

Категория подсветки ошибок синтаксиса

Расширение добавляет страницы, которые имеют неверный атрибут lang в теге <syntaxhighlight>, в отслеживающую категорию. Ключ сообщения MediaWiki:syntaxhighlight-error-category определяет имя категории; на этой вики это Category:Pages with syntax highlighting errors.

Наиболее распространённой ошибкой, которая приводит к тому, что страницы помечаются этой категорией, является тег <syntaxhighlight> вообще без атрибута lang, поскольку более старые версии этого расширения поддерживали определение $wgSyntaxHighlightDefaultLang. Обычно их можно заменить на <pre>, или к тегу можно добавить $bash или lang="text".

Категория также может быть добавлена, и её содержимое не будет выделено, если в тексте более 1000 строк или текст более 100 КБ.[1]

Параметры

lang

Атрибут lang="name" определяет, какой lexer следует использовать. Язык влияет на то, как расширение подсвечивает исходный код. Подробнее о поддерживаемых языках см. в разделе Поддерживаемые языки.

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>
Версия MediaWiki:
1.36
Gerrit change 653142

The linelinks attribute (in combination with line) adds link anchors to each line of the code block. You can click on the line numbers to get a link that highlights the selected line, and use them in internal and external links. You can also hold ⇧ Shift and click on another line number to get a link that highlights the selected range of lines (Since 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

Click here to jump to and highlight line 3 in the code block above. Click here to jump to and highlight lines 2-4 in the code block above.

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

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

highlight

Атрибут highlight указывает одну или несколько строк, которые должны быть отмечены (путем выделения этих строк другим цветом фона). Вы можете указать несколько номеров строк, разделенных запятыми (например, highlight="1,4,8") или диапазоны, используя два номера строк и дефис (например, 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; в любом другом случае его можно полностью удалить.
Разрывы строк могут возникать в любом месте между тегами открытия и закрытия, если исходный код не помечен как неразрывный с помощью class="nowrap" (на тех вики, которые это поддерживают, см. ниже) или style="white-space:nowrap".

Например:

Следующий код lambda x: x * 2 - это aнонимная функция в Python.

Является результатом:

Следующий код <syntaxhighlight lang="python" inline>lambda x: x * 2</syntaxhighlight> - это [[w:ru:Анонимная функция|aнонимная функция]] в Python.

class

Использование inline, class="nowrap" (на тех вики, которые его поддерживают, а не на самой MediaWiki) указывает, что разрывы строк не должны возникать в пробелах внутри блока кода.

Например:

Без class="nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

С style="white-space:nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style

Атрибут style позволяет напрямую использовать атрибуты CSS. Это эквивалентно включению блока в тег <div> (не <span>). Атрибут 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

Версия MediaWiki:
1.43

The copy attribute adds a button link that copies the content to the clipboard when clicked.

This attribute cannot be used together with the inline attribute. If both are specified, copy will be ignored.

For example:

def quick_sort(arr):
    less = []

Is the result of:

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

Поддерживаемые языки

Библиотека Pygments обеспечивает поддержку для подсветки синтаксиса сотен компьютерных языков и форматированных файлов посредством различных "lexers", включённых в библиотеку.

В большинстве случаев атрибут lang=, используемый с этим расширением, представляет собой версию имени языка в нижнем регистре. Однако у многих есть псевдонимы или "короткие имена", как они называются в документации Pygments; см. "Доступные лексеры" для получения полной информации.

Некоторые языки, ранее поддерживаемые GeSHi, были сопоставлены с лексерами Pygments; подробности см. в SyntaxHighlightGeSHiCompat.php.

Pygments предоставляет лексер "wikitext" с апреля 2023 года. Вместо этого используйте "html+handlebars" или "moin".

Полный список поддерживаемых Pygments языков по состоянию на январь 2020 года:

Языки программирования

  • ActionScript
  • Ada
  • Agda (включая Literate Agda)
  • 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 (включая сессии в командной строке)
  • Ezhil
  • Factor
  • Fancy
  • Fantom
  • Fennel
  • FloScript
  • Forth
  • Fortran
  • FreeFEM++
  • F#
  • GAP
  • Gherkin (Cucumber)
  • Шейдеры GLSL
  • 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
  • Сценарии командной строки (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)
  • Evoque
  • Genshi (шаблонизатор проекта Trac)
  • Handlebars
  • JSP (Java Server Pages)
  • Liquid
  • Myghty (фреймворк на основе HTML::Mason)
  • Mako (преемник Myghty)
  • Slim
  • Smarty (шаблонизация для языка PHP)
  • Tea
  • Twig

Другая разметка

  • Конфигурационные файлы Apache
  • Apache Pig
  • BBCode
  • CapDL
  • Cap'n Proto
  • CMake
  • Партитуры Csound
  • CSS
  • Управляющие (control) файлы Debianа
  • Diff файлы
  • Dockerfiles
  • DTD
  • EBNF
  • Заголовки электронной почты
  • Extempore
  • Flatline
  • Каталоги gettext
  • Скрипт Gnuplot
  • Groff разметка
  • Hexdumps
  • HTML
  • HTTP сессии
  • IDL
  • Inform
  • Конфигурационные файлы в стиле .ini
  • Логи IRC (в стили irssi)
  • Isabelle
  • Нотация JSGF
  • JSON, JSON-LD
  • Доказатель теорем Lean
  • Конфигурационные файлы lighttpd
  • Сообщения ядра Linux (dmesg)
  • Сборка LLVM
  • Скрипты LSL
  • Makefiles
  • Вики-разметка MoinMoin/Trac
  • MQL
  • MySQL
  • NCAR command language
  • Конфигурационные файлы nginx
  • Язык Nix
  • Скрипты NSIS
  • Notmuch
  • сцены POV-Ray
  • Puppet
  • QML
  • Ragel
  • Redcode
  • ReST
  • Roboconf
  • Robot Framework
  • файлы спецификации RPM
  • Rql
  • RSL
  • Scdoc
  • SPARQL
  • SQL, а также MySQL, SQLite
  • Конфигурационные файлы Squidа
  • TADS 3
  • Terraform
  • TeX
  • Thrift
  • TOML
  • Спецификации грамматик на Treetop
  • USD (Universal Scene Description)
  • Конфигурационные файлы Varnish
  • VGL
  • Vim Script
  • WDiff
  • Пакетный файл Windows
  • XML
  • XSLT
  • YAML
  • Файлы реестра Windows
Начиная с MediaWiki 1.37, с обновлением pygments до версии 2.10.0 было добавлено больше лексеров, как описано в 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
Код Язык
4csGADV 4CS
6502acmeMOS 6502 (6510) ACME Cross Assembler
6502kickassMOS 6502 (6510) Kick Assembler
6502tasmMOS 6502 (6510) TASM/64TASS
68000devpacMotorola 68000 - HiSoft Devpac ST 2 Assembler
abapABAP
actionscriptActionScript
actionscript3ActionScript3
adaAda
algol68ALGOL 68
apacheApache Configuration
applescriptAppleScript
apt_sourcesApt sources
armARM Assembler
asmAssembly
aspActive Server Pages (ASP)
asymptoteAsymptote
autoconfAutoconf
autohotkeyAutoHotkey
autoitAutoIt
avisynthAviSynth
awkAWK
bascomavrBASCOM AVR
bashBash
basic4glBasic4GL
bfBrainfuck
bibtexBibTeX
blitzbasicBlitz BASIC
bnfBackus–Naur Form
booBoo
cC
c_loadrunnerC Loadrunner
c_macC (Mac)
caddclAutoCAD DCL
cadlispAutoLISP
cfdgCFDG
cfmColdFusion Markup Language
chaiscriptChaiScript
cilCommon Intermediate Language (CIL)
clojureClojure
cmakeCMake
cobolCOBOL
coffeescriptCoffeeScript
cppC++
cpp-qtC++ (Qt toolkit)
cshC shell
csharpC#
cssCascading Style Sheets (CSS)
cuesheetCue sheet
dD
dartDart
dclData Control Language
dcpu16DCPU-16
dcsData Conversion System
delphiDelphi
diffDiff
divDIV
dosbatchDOS batch file
dotDOT
eE
ebnfExtended Backus–Naur Form
ecmascriptECMAScript
eiffelEiffel
emailEmail (mbox \ eml \ RFC format)
epcEnerscript
erlangErlang
euphoriaEuphoria
f1Formula One
falconFalcon
foFO
fortranFortran
freebasicFreeBASIC
freeswitchFreeSWITCH
fsharpFsharp
gambasGambas
gdbGDB
generoGenero
genieGenie
gettextgettext
glslOpenGL Shading Language (GLSL)
gmlGame Maker Language (GML)
gnuplotgnuplot
goGo
groovyGroovy
gwbasicGW-BASIC
haskellHaskell
haxeHaxe
hicestHicEst
hq9plusHQ9+
html4strictHTML (use "html" instead)
html5HTML5 (use "html" instead)
iconIcon
idlUno IDL
iniINI
innoInno
intercalINTERCAL
ioIo
jJ
javaJava
java5Java(TM) 2 Platform Standard Edition 5.0
javascriptJavaScript
jqueryjQuery
kixtartKiXtart
klonecKlone C
klonecppKlone C++
kotlinKotlin
kshKorn shell
latexLaTeX
lbLiberty BASIC
ldifLDAP Data Interchange Format
lispLisp
llvmLLVM
locobasicLocomotive BASIC
logtalkLogtalk
lolcodeLOLCODE
lotusformulasFormula language
lotusscriptLotusScript
lscriptLightWave 3D
lsl2Linden Scripting Language
luaLua
magiksfMagik
m68kMotorola 68000 Assembler
makemake
mapbasicMapBasic
matlabMATLAB M
mircmIRC scripting language
mmixMMIX
modula2Modula-2
modula3Modula-3
mpasmMicrochip Assembler
mxmlMXML
mysqlMySQL
nagiosNagios
netrexxNetRexx
newlispNewLISP
nsisNullsoft Scriptable Install System (NSIS)
oberon2Oberon-2
objcObjective-C
objeckObjeck
ocamlOCaml
ocaml-briefOCaml
octaveOctave
oobasLibreOffice/OpenOffice.org Basic
oorexxObject REXX
oracle11Oracle 11 SQL
oracle8Oracle 8 SQL
oxygeneOxygene
ozOz
parasailParaSail
parigpPARI/GP
pascalPascal
pcrePerl Compatible Regular Expressions
perper
perlpl
Perl
perl6
pl6
raku
Perl 6
pfPF
phpPHP
php-briefPHP (deprecated no colors, odd framing)
pic16PIC assembly language
pikePike
pixelbenderPixel Bender
pliPL/I
plsqlPL/SQL
postgresqlPostgreSQL
postscriptPostScript
povrayPersistence of Vision Raytracer
powerbuilderPowerBuilder
powershellWindows PowerShell
proftpdProFTPD
progressOpenEdge Advanced Business Language
prologProlog
propertiesProperties file
providexProvideX
purebasicPureBasic
pyconPython
pys60PyS60
python
py
python3
py3
Python
python2
py2
Python 2
qQ
qbasicQBasic/QuickBASIC
railsRails
rebolRebol
regWindows Registry
rexxRexx
robotsrobots.txt
rpmspecRPM Spec files
rsplusR
rubyRuby
sasSAS
scalaScala
schemeScheme
sh
shell
shell-session
Shell Script (POSIX)
scilabScilab
sdlbasicSdlBasic
smalltalkSmalltalk
smartySmarty
sparkSPARK
sparqlSPARQL
sqlSQL
stonescriptStoneScript (Scripting language for ShiVa3D)
systemverilogSystemVerilog
tcshTcsh
tclTcl
teratermTera Term
textPlain text
thinbasicthinBasic
tsTypeScript
tsqlTransact-SQL
typoscriptTypoScript
uniconUnicon
upcUnified Parallel C
urbiURBI
uscriptUnrealScript
valaVala
vbVisual Basic
vbnetVisual Basic .NET
veditVEDIT
verilogVerilog
vhdlVHDL
vimVim script
visualfoxproVisual FoxPro
visualprologVisual Prolog
whitespaceWhitespace
whoisWhois
winbatchWinbatch
xmlXML
xorg_confXorg.conf
yamlYAML
xppMicrosoft Dynamics AX
z80ZiLOG Z80 Assembler
zxbasicZXBasic

Установка

Версия этого расширения в комплекте с MediaWiki 1.31 требует установки Python версии 3 (python3) на сервере. Это изменение по сравнению с версией в комплекте с MediaWiki 1.30, в которой использовалась версия Python 2 (python).
Несмотря на то, что расширение обновлено до Pygments (и ухода от GeSHi), и несмотря на его обновленное имя, это внутреннее расширение по-прежнему использует прежние имена файлов, как указано ниже.
  • Скачайте и распакуйте файл(ы) в папку с названием SyntaxHighlight_GeSHi в вашей папке extensions/.
    Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
  • Если и только если устанавливаете из git, запустите Composer для установки зависимостей PHP, запустив composer install --no-dev в каталоге расширений. (Смотрите T173141 о возможных осложнениях.)Category:Extensions requiring Composer with git/ru
  • Добавьте следующий код в конце вашего файла LocalSettings.php :
    wfLoadExtension( 'SyntaxHighlight_GeSHi' );
    
  • В Linux, установите разрешения для выполнения "pygmentize". Для этого вы можете использовать FTP-клиент или следующую команду:
chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
  • Yes Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.


Установка Vagrant:

  • Если вы используете Vagrant , установите с помощью vagrant roles enable syntaxhighlight --provision
При установке из Git обратите внимание, что начиная с MediaWiki 1.26 и кончая MediaWiki 1.31, для этого расширения требуется Composer.

Итак, после установки из Git измените на каталог, содержащий расширение, например. "../extensions/SyntaxHighlight_GeSHi/" и запустите composer install --no-dev или при обновлении: composer update --no-dev.

Альтернативно, а также предпочтительно добавить строку "extensions/SyntaxHighlight_GeSHi/composer.json" в файл "composer.local.json" в корневой каталог вашей вики, например:
{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/SyntaxHighlight_GeSHi/composer.json"
			]
		}
	}
}
Теперь запустите composer update --no-dev. Voilà!
Внимание Внимание: При загрузке расширения через FTP обязательно загрузите файл pygments/pygmentize с типом передачи 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 (необязательно): Абсолютный путь к pygmentize пакета Pygments. Расширение связывает пакет Pygments и $wgPygmentizePath с установленной версией по умолчанию, но вы можете указать другую версию, если хотите. Например: $wgPygmentizePath = "/usr/local/bin/pygmentize";.
Windows
  • Если вы размещаете свою Mediawiki на компьютере с Windows, вам необходимо установить путь для Pygmentize.exe в $wgPygmentizePath = "c:\\Python27\\Scripts\\pygmentize.exe";
    • Если в директории нет pygmentize.exe запустите easy_install Pygments из командной строки внутри папки Scripts, чтобы сгенерировать файл.

Если вы используете бинарный пакет pygmentize (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize), убедитесь, что вашему веб-серверу разрешено его выполнение. Если ваш хост не позволяет добавлять исполняемые файлы в ваш веб-каталог, установите python-pygments и добавьте $wgPygmentizePath = pygmentize в LocalSettings.php.

Поиск и устранение неисправностей

После обновления до MediaWiki v1.26 и выше некоторые пользователи начали сообщать о проблемах с расширением. Могут быть случаи, когда некоторые языки (например «Luа») могут не подсвечиваться, и при включении режима отладки MediaWiki выдает ошибку, Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory.

  • Попробуйте указать в $wgPygmentizePath в LocalSettings.php на внешний двоичный файл pygmentize.
  • В средах общего хостинга с cPanel это можно сделать, настроив новое приложение Python через меню "Настройка приложения Python" и активировав виртуальную среду для приложения через SSH (source /virtualenv/python/3.5/bin/activate). После этого Pygments модуль можно добавить в приложение Python, для чего перейдите по пути к виртуальной среде (cd virtualenv/python/3.5/bin/), загрузите и установите Pygments (./pip install Pygments), а затем активируйте модуль, добавив "Pygments" в раздел "Существующие приложения" меню "Настройка приложения Python". Это создаст требуемый файл по адресу: virtualenv/python/3.5/bin/pygmentize
  • См. phab:T128993 для этого для дальнейших предложений и информации.
  • SELinux также может предотвратить запуск расширения с ошибкой, аналогичной 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 в вашем audit.log. Это может быть разрешено с setsebool -P httpd_unified 1
  • В более ранних версиях этого расширения Windows иногда выдавал ошибку _Py_HashRandomization_Init. Это была ошибка, когда среда Windows не передавалась в выполнение Python. Исправление было выпущено в версии 1.40 с бэкпортами на версии 1.38 и 1.39.

Интеграция с VisualEditor

Плагин позволяет прямое редактирование с помощью VisualEditor. Всплывающее окно открывается, когда пользователь хочет редактировать syntaxhighlight секции. Чтобы это работало, VisualEditor должен быть установлен и настроен с последней версии git, такой же для Parsoid. Функция случайным образом не работает со старыми версиями Parsoid. Для более подробной информации смотрите Extension:SyntaxHighlight/VisualEditor

Дополнительно

В отличие от тегов <pre> и <code>, символьные сущности HTML, такие как &nbsp;, не имеют (и не должны) экранироваться символом & как &amp;. Подобно тегу <pre>, но, в отличие от тега <code>, теги в пределах диапазона (кроме собственного закрывающего тега) не должны иметь экранированный символ < как &lt;, а также не нужно экранировать викитекст тегом <nowiki>.

Кроме того, в то время как <pre> предполагает, что табуляция останавливается каждые 8 символов и отображает вкладки с использованием фактических пробелов при копировании текста, <syntaxhighlight> использует четырехпозиционные табуляции (кроме Internet Explorer, который использует 8) и сохраняет символы табуляции в визуализированном тексте ; последний может быть изменен с помощью охватывающего тега <span style="-moz-tab-size: nn; -o-tab-size: nn; tab-size: nn;"> (не <div>, и не используя собственный атрибут style). Префикс -moz- требуется для Firefox (для версий с 4.0 по 90), а префикс -o- требуется для Opera (для версий с 10.60 по 15).[2] (Обратите внимание, что в окне редактирования вики предполагаются 8-пробельные табуляции.) Это относится только к сохранённым страницам; превью, сгенерированные в окне редактирования, или Special:ExpandTemplates имеют отличия.

См. также

  • Pygments — Python syntax highlighter
  • Расширения, зависящие от этого:
  • Альтернативные расширения:
    • Extension:Highlightjs Integration — расширение синтаксической подсветки, которое использует библиотеку HighlightJS (поддерживает некоторые языки которые Pygments не поддерживает, например Maxima)
    • Extension:GoogleCodePrettify — расширение синтаксической подсветки, которое использует библиотеку Google Prettify.
    • Extension:ExternalContentembed external content, such as code from GitHub, GitLab, and Bitkeeper repos with automatic rendering of Markdown files; and using syntax highlighting via the Prism.js library for nearly 300 supported languages. Content indexed by CirrusSearch

Примечания

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