Extension:SyntaxHighlight/ru

Расширение SyntaxHighlight, ранее известное как SyntaxHighlight_GeSHi обеспечивает огромное количество подсветок синтаксиса source code используя тег Расширение работает от библиотеки Pygments и поддерживает сотни различных языков программирования и форматов файлов.

Подобно тегам  и , текст отображается точно так же, как и набранный, сохраняя любое пустое пространство.

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

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

В старых версиях (до MediaWiki 1.16) расширение использовало тег. Этот вариант по-прежнему поддерживается, но  может помочь избежать конфликтов, если сам исходный код содержит   теги (например, XML).

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

Выделение рамкой кодовых блоков в границах можно сделать, вставив строку, подобную, в секции выше. Контроль над «семейством используемых шрифтов» также может быть осуществлен путем вставки строки, такой как, в секции выше.

Категория подсветки ошибок синтаксиса
Расширение добавляет страницы, которые имеют атрибут испорченный  в теге   или   в категорию tracking category. Ключ сообщения MediaWiki:syntaxhighlight-error-category определяет имя категории; на этой вики это Category:.

Наиболее распространенная ошибка, которая приводит к тому, что страницы, помечаются этой категорией, представляет собой тег  или тег   без атрибута. These can typically either be replaced with, or   or   can be added to the tag.

Второй наиболее распространенной ошибкой является использование  или , которые не поддерживаются. Обычно их можно заменить на  или.

lang
Атрибут  определяет, какой lexer следует использовать. Язык влияет на то, как расширение подсвечивает исходный код. Pygments парсер синтаксиса чувствителен к регистру, и все языки имеют как минимум одну заглавную букву (языки с именами в нижнем регистре - reserved for gtags). Подробнее о поддерживаемых языках см. В разделе Поддерживаемые языки.

Указание недопустимого или неизвестного имени пометит страницу, что поместит её в категорию отслеживания. Подробнее см. в разделе Категория подсветки ошибок синтаксиса на этой странице.

line
Атрибут  активирует нумерацию строк.

start
Атрибут  (в сочетании с  ) определяет первый номер строк кода. Например,  начнет нумерацию строк с числа 55.

highlight
Атрибут  указывает одну или несколько строк, которые должны быть отмечены (путем выделения этих строк другим цветом фона). Вы можете указать несколько номеров строк, разделенных запятыми (например, ) или диапазоны, используя два номера строк и дефис (например,  ). Обратите внимание, что характеристика номера строки игнорирует любую перенумерацию отображаемых номеров строк с атрибутом.

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

inline
Атрибут указывает, что исходный код должен быть встроенным как часть абзаца (в отличие от отдельного блока). Эта опция доступна начиная с MediaWiki 1.26. Для обратной совместимости атрибут  приводит к такому же поведению.

Обратите внимание, что разрывы строк могут возникать в любом пространстве между тегами открытия и закрытия, если исходный код не помечен как неклассируемый с помощью  (на тех вики, которые его поддерживают, см. Ниже) или.

Например:

- это lambda expression в Python.

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

это lambda expression в Python.

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

Например:

Без :

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx With : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style
Атрибут  позволяет напрямую использовать атрибуты CSS. Это эквивалентно включению блока в тег  (не  ). Атрибут  не может быть указан таким образом; для этого требуется заключение в тег , как описано ниже в Advanced.

Например:

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

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

AppleScript, Assembly, Asymptote, Awk, bash, Befunge, Boo, BrainFuck, C, C++, C#, Clojure, CoffeeScript, ColdFusion, Common Lisp, Coq, Cryptol, Crystal, Cython, D, Dart, Delphi, Dylan, Elm, Erlang, Ezhil, Factor, Fancy, Fortran, F#, Gambas, GAP, Gherkin, GL shaders, Groovy, Haskell, IDL, Io, Java, JavaScript, Lasso, LLVM, Logtalk, Lua, Matlab, MiniD, Modelica, Modula-2, MuPad, Nemerle, Nimrod, Objective-C, Objective-J, Octave, OCaml, PHP, Perl, PovRay, PostScript, PowerShell, Prolog, Python 2.x and 3.x (incl. console sessions and tracebacks), R, REBOL, Red, Redcode, Ruby, Rust, S, S-Plus, Scala, Scheme, Scilab, Smalltalk, SNOBOL, Tcl, Vala, Verilog, VHDL, Visual Basic.NET, Visual FoxPro, XQuery, Zephir

(full list и complete details in the Pygments document), и здесь некоторые сопоставления для некоторых языков, которые поддерживались GeSHi (full list).

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

Настройка

 * Linux:


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


 * Windows:


 * Если вы размещаете свою Mediawiki на компьютере с Windows, вам необходимо установить путь для Pygmentize.exe в
 * Если в директории нет  запустите   из командной строки внутри папки , чтобы сгенерировать файл.

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


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

После обновления до MediaWiki v1.26 и выше некоторые пользователи начали сообщать о проблемах с расширением. 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,.


 * Попробуйте указать в  в 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:


 * См. phabricator task для этого для дальнейших предложений и информации.

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

Дополнительно
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.

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

См. также

 * Pygments – Python syntax highlighter
 * Родственные расширения:
 * – расширение синтаксической подсветки, которое использует Google Prettify library.
 * – расширение синтаксической подсветки кода, которое использует библиотеку SyntaxHighlighter.
 * – расширение, зависящее от этого, для поддержки выделения текста из файлов, просматриваемых с помощью специальной страницы.