Extension:SyntaxHighlight/uk

Розширення SyntaxHighlight, раніше відоме як SyntaxHighlight_GeSHi, надає багате форматування початкового коду за допомогою тегу. Воно працює на бібліотеці Pygments і підтримує сотні різних мов програмування та форматів файлів.

Як і з тегами  і , текст відображається точнісінько так, як був набраний, зберігаючи будь-які пропуски.

Використання
Раз установивши, можна використовувати теги «syntaxhighlight» на вікі-сторінках. Наприклад,

є результатом наступної розмітки вікітексту:

У старіших версіях (до MediaWiki 1.16) розширення використовувало тег. Він досі підтримується, але застарів. Замість нього треба використовувати.

Стилізація
Якщо відображуваний код завеликий, можна підігнати його, помістивши наступне на сторінку MediaWiki:Common.css у вашій Вікіпедії (створіть її за відсутності):

Оболонкування блоків коду в межі можна зробити шляхом вставки рядка на кшталт  у розділі вище. Контроль над використовуваною родиною шрифтів також може здійснюватися вставкою рядка на кшталт  у розділі вище.

Категорія помилок підсвічування синтаксису
Розширення додає сторінки, що мають поганий атрибут  у тегах $source або , до категорії відстеження. Ключ повідомлення MediaWiki:syntaxhighlight-error-category визначає назву категорії; у цій Вікіпедії це Category:.

Найпоширенішою помилкою, що призводить до позначення сторінок даною категорією, є повна відсутність атрибуту  у тегах   або $source, оскільки старіші версії даного розширення підтримуювали визначення «$wgSyntaxHighlightDefaultLang». Як правило, можна або замінити на  чи , або додати   до тегу.

Категорія також може додаватися, а вміст не підсвічуватися, якщо текст перевищує 1000 рядків або 100 кБ.

lang
Атрибут  визначає, який лексичний аналізатор слід використати. Мова впливає на підсвічування розширенням початкового коду. Див. розділ Підтримувані мови для подробиць підтримуваних мов.

Вказання недійсної чи невідомої назви помітить сторінку категорією відстеження. Детальніше див. у розділі Категорія помилок підсвічування синтаксису на цій сторінці.

line
Атрибут  вмикає номери рядків.

start
Атрибут  (у поєднанні з  ) визначає номер першого рядка блоку коду. Наприклад,  пронумерує рядки, починаючи з 55.

highlight
Атрибут  визначає один чи більше рядків, які слід маркувати (підсвічуванням цих рядків іншим кольором тла). Можна вказати багато номерів рядків, розділених комами (наприклад, ), чи діапазони за допомогою двох номерів рядків і дефісу (наприклад,  ). Зауважте, що специфікація номерів рядків ігнорує будь-яке перенумерування відображених номерів рядків атрибутом.

є результатом

inline
Атрибут позначає, що початковий код слід вбудувати як частину абзацу (на відміну від власного блоку). Ця опція доступна, починаючи з MediaWiki 1.26. Для зворотної сумісності атрибут  має наслідок ту саму поведінку.

Note that using the "enclose" parameter is deprecated; if set to "none", it should be replaced with inline; otherwise, it can be removed entirely.

Зауважте, що розриви рядків можуть відбуватися в будь-якому місці між відкривальним і закривальним тегами, якщо початковий код не марковано нерозривним за допомогою  (на тих Вікіпедіях, що підтримують його; див. нижче) чи.

Наприклад:

Наступний  є лямбда-виразом у мові Python.

є результатом:

Наступний  є лямбда-виразом у мові Python.

class
При використанні,   (не тих Вікіпедіях, що підтримують його; не на самій MediaWiki) вказує, що рядки не слід розривати на пропусках у блоці коду.

Наприклад:

Без :

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx With : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style
Атрибут  дозволяє пряме включення атрибутів CSS. Це еквівалентно оточуванню блоку в тег  (не  ). Атрибут  не можна вказувати таким чином; він вимагає оточування тегом , як описано нижче в Розширений.

Наприклад:

є результатом:

Підтримувані мови
Бібліотека Pygments надає підтримку сотень комп'ютерних мов і форматів файлів. Станом на січень 2020 року, повний список:

Мови програмування
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 (включно з сеансами оболонки)

Ezhil

Factor

Fancy

Fantom

Fennel

FloScript

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 (almost good enough for MediaWiki)

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 scores

CSS

Debian control files

Файли Diff

Dockerfiles

DTD

EBNF

Заголовки електронної пошти

Extempore

Flatline

Каталоги Gettext

Сценарій Gnuplot

Розмітка Groff

Шістнадцяткові дампи

HTML

Сеанси HTTP

IDL

Inform

Конфігураційні файли у стилі INI

Журнали IRC (стиль irssi)

Isabelle

Нотація JSGF

JSON, JSON-LD

Lean theorem prover

Конфігураційні файли Lighttpd

Журнал ядра Linux (dmesg)

LLVM assembly

Сценарії LSL

Makefiles

MoinMoin/Trac Wiki markup

MQL

MySQL

Командна мова NCAR

Конфігураційні файли Nginx

Мова Nix

Сценарії NSIS

Notmuch

Сцени POV-Ray

Puppet

QML

Ragel

Redcode

ReST

Roboconf

Robot Framework

RPM spec files

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

Точні коди мов див. у повних деталях у документі Pygments, і деякі відображення для деяких назв мов, які підтримує GeSHi (повний список).

Нижче частковий список мов, які GeSHi може підсвітити, закреслені мови більше не підтримуються після перемикання на Pygments.

Конфігурація

 * Linux:


 * (опційна): Абсолютний шлях до pygmentize з пакету Pygments. Розширення за замовчуванням збирає пакет Pygments і точки  у комплектну версію, але можна вказати на іншу версію, якщо хочете. Наприклад:.
 * : Налаштовує лексичний аналізатор за замовчуванням для деяких вікі-сторінок. За замовчування це підсвічуватиме сторінки javascript і css. Додаткові моделі вмісту можуть налаштовуватися розширеннями (наприклад, Lua, JSON, …). Приклад:


 * Windows:


 * Якщо ви розміщуєте свою MediaWiki на машині Windows, ви маєте встановити шлях для Pygmentize.exe
 * За відсутності  запустіть   з командного рядка всередині папки   для генерування файлу.

При використанні комплектного двійкового файлу pygmentize (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize) впевніться, що веб-сервер має дозвіл виконувати його. Якщо ваш хост не дозволяє вам додавати виконавчі файли до веб-директорії, встановіть python-pygments і додайте  до LocalSettings.php.


 * Вирішення проблем:

Після оновлення до MediaWiki v1.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:


 * Див. завдання на Фабрикаторі щодо цього для подальших пропозицій та інформації.

Інтеграція з Візуальним редактором
Плагін дозволяє пряме редагування з Візуальним редактором. Спливне вікно відкривається, коли користувач хоче редагувати розділи $source або. Аби це працювало, Візуальний редактор повинен бути встановлений і налаштований з останньої версії на git, так само для Parsoid. Можливість довільно не працює зі старішими версіями Parsoid. Детальніше див. Extension:SyntaxHighlight/VisualEditor

Розширено
На відміну від тегів  та , символьні сутності HTML на кшталт   не вимагають (і не повинні) екранування символу   як. Як тег, але на відміну від тегу  , теги всередині діапазону (іншого, ніж власний закривальний тег) не вимагає екранування символу   як  , а вікітекст не вимагає екранування тегом.

Більше того, хоча  припускає табуляції щовісім символів і відображає їх за допомогою дійсних пропусків при копіюванні відображеного тексту,   використовує чотири-пропускні табуляції (за винятком Internet Explorer, який використовує 8) і зберігає символи табуляції у відображеному тексті; останнє може бути змінено за допомогою огородження тегом   (не   і не використовуючи власний атрибут  ). Префікс  вимагається для Firefox (з версії 4.0), а префікс   вимагається для Opera (з версії 10.60 до 15). (Зауважте, що вікно редагування вікі припускає восьми-пропускні табуляції.) Це застосовується лише для дійсних збережених сторінок, попередні перегляди, згенеровані через вікна редагування чи Special:ExpandTemplates можуть відрізнятися.

Див. також

 * Pygments – Python syntax highlighter
 * Розширення, залежні від цього:
 * – підсвічує сторінки на основі суфіксів заголовків.
 * Альтернативні розширення:
 * – підсвічувальник синтаксису, що використовує бібліотеку Google Code Prettify.
 * – підсвічувальник синтаксису, що використовує бібліотеку SyntaxHighlighter.