Расширение:SyntaxHighlight

This page is a translated version of the page Extension:SyntaxHighlight and the translation is 85% complete.

Outdated translations are marked like this.

Other languages:

Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎magyar • ‎беларуская (тарашкевіца)‎ • ‎русский • ‎українська • ‎中文 • ‎日本語 • ‎한국어

This extension comes with MediaWiki 1.21 and above. Thus you do not have to download it again. However, you still need to follow the other instructions provided.

Для подсветки синтаксиса wikicode при использовании редактора кода см. расширение CodeMirror или скрипты пользователей of Remember the dot and Cacycle.

**Справка по расширениям MediaWiki**
SyntaxHighlight Статус релиза: стабильный

Реализация	Tag
Описание	Позволяет подсвечивать исходный код на вики-страницах
Автор(ы)	Brion Vibber, Tim Starling, Rob Church, Ori Livneh
Последняя версия	continuous updates
MediaWiki	1.25+
Изменения БД	Нет
Лицензия	GNU General Public License 2.0 or later
Загрузка	Загрузить snapshot Git ^[?]: Загрузить Git master browse repository (GitHub) commit history code review README
Параметры $wgPygmentizePath $wgSyntaxHighlightModels
Тэги <syntaxhighlight>
Использованные hook'и ContentGetParserOutput ParserFirstCallInit ApiFormatHighlight ResourceLoaderRegisterModules
Переведите расширение SyntaxHighlight если оно доступно на translatewiki.net
Проверьте использование и версию.
Проблемы	Открытые задачи · Сообщить об ошибке

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

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

Применение

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

1 def quickSort(arr):
2 	less = []
3 	pivotList = []
4 	more = []
5 	if len(arr) <= 1:
6 		return arr
7 	else:
8 		pass

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

<syntaxhighlight lang="Python" line='line'>
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

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

Стайлинг

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

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

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

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

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

Наиболее распространенная ошибка, которая приводит к тому, что страницы, помечаются этой категорией, представляет собой тег <syntaxhighlight> или тег <source> без атрибута lang.

These can typically either be replaced with <pre>, or lang="bash" or lang="text" can be added to the tag.

The category may also be added, and the content will not be highlighted, if there are more than 1000 lines or more than 100 kB text.^[1]

Параметры

lang

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

def quickSort(arr):
    less = []

<syntaxhighlight lang="Python">
..
</syntaxhighlight>

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

line

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

1 def quickSort(arr):
2 	less = []

<syntaxhighlight lang="Python" line>
..
</syntaxhighlight>

start

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

55 def quickSort(arr):
56     less = []

<syntaxhighlight lang="Python" line start="55">
..
</syntaxhighlight>

highlight

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

3 def quickSort(arr):
4     less = []
5     pivotList = []
6     more = []
7     if len(arr) <= 1:
8         return arr

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

<syntaxhighlight lang="Python" highlight="1,5-7" start='3' line>
..
</syntaxhighlight>

inline

Версия MediaWiki:

≥ 1.26

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

Обратите внимание, что разрывы строк могут возникать в любом пространстве между тегами открытия и закрытия, если исходный код не помечен как неклассируемый с помощью class="nowrap" (на тех вики, которые его поддерживают, см. Ниже) или style=white-space:nowrap.

Например:

lambda x: x * 2 - это lambda expression в Python.

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

<syntaxhighlight lang="Python" inline>lambda x: x * 2</syntaxhighlight> это [[w:Lambda (programming)|lambda expression]] в Python.

class

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

Например:

Без class="nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

With style="white-space:nowrap":

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxlambda x: x * 2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style

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

Например:

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

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

<syntaxhighlight lang="Python" style="border:3px dashed blue">
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

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

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

Programming languages

ActionScript

Ada

ANTLR

AppleScript

Assembly

Asymptote

Awk

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#

GAP

Gherkin (Cucumber)

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

REBOL

Red

Redcode

Ruby

Rust

S, S-Plus and R

Scala

Scheme

Scilab

Smalltalk

SNOBOL

Tcl

Vala

Verilog

VHDL

Visual Basic.NET

Visual FoxPro

XQuery

Zephir

Template languages

Cheetah templates

Django / Jinja templates

ERB

Genshi

JSP

Myghty

Mako

Smarty templates

Tea

Other markup

Apache config files

Bash shell scripts

BBCode

CMake

CSS

Debian control files

Diff files

DTD

Gettext catalogs

Gnuplot script

Groff markup

HTML

HTTP sessions

INI-style config files

IRC logs (irssi style)

JSON

Lighttpd config files

Makefiles

MoinMoin/Trac Wiki markup

MySQL

Nginx config files

POV-Ray scenes

Ragel

Redcode

ReST

Robot Framework

RPM spec files

SQL

Squid configuration

TeX

tcsh

Vim Script

Windows batch files

XML

XSLT

YAML

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

Pygments еще не поддерживает «wikitext» или «mediawiki» lexer (phab:T29828). Вместо этого используйте "html", "xml" или "moin".

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

Установка

The version of this extension bundled with MediaWiki 1.31 requires Python version 3 (python3) to be installed on the server. This is a change from the version bundled with MediaWiki 1.30, which used Python version 2 (python). Note that the python3 binary must be installed in the execution PATH of the PHP interpreter.

Несмотря на то, что расширение обновлено до Pygments (и ухода от GeSHi), и несмотря на его обновленное имя, это внутреннее расширение по-прежнему использует прежние имена файлов, как указано ниже.

Скачайте и распакуйте файл(ы) в папку с названием SyntaxHighlight_GeSHi в вашей папке extensions/.
Запустите Composer для установки зависимостей PHP, запустив composer install --no-dev в каталоге расширений. (Смотрите T173141 о возможных осложнениях.)
Добавьте следующий строки в конец файла LocalSettings.php:
```
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
```

В Linux, установите разрешения для выполнения "pygmentize":

You can use an FTP client or the following shell command to do so:

chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize

Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Для использующих MediaWiki 1.24 или более ранние:

В приведенных выше инструкциях описывается новый способ установки этого расширения с использованием wfLoadExtension()

Если вам нужно установить это расширение на более ранние версии (MediaWiki 1.24 и более ранние), вместо wfLoadExtension( 'SyntaxHighlight_GeSHi' );, вам необходимо использовать:

require_once "$IP/extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php";

При установке из Git обратите внимание, что начиная с MediaWiki 1.26 для этого расширения требуется 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.

Настройка

Linux

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

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 и выше некоторые пользователи начали сообщать о проблемах с расширением. 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, Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory.

Попробуйте указать в $wgPygmentizePath в 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 (source /virtualenv/python/3.5/bin/activate). After this, the Pygments module can be added to the Python app, for which navigate to the virtual environment path (cd virtualenv/python/3.5/bin/), download and install Pygments (./pip 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: virtualenv/python/3.5/bin/pygmentize

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

VisualEditor интеграция

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

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

Unlike the <pre> and <code> tags, HTML character entities such as   need not (and should not) have the & character escaped as &. Like the <pre> tag but unlike the <code> 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 <nowiki> tag.

Кроме того, в то время как <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), а префикс -o- требуется для Opera (от версии 10.60 до версии 15).^[2] (Обратите внимание, что в окне редактирования вики допускаются 8-пробельные табуляции.) Это относится только к актуальным сохраненным страницам; превью, сгенерированные в окне редактирования, или Special:ExpandTemplates имеют отличия.

См. также

Pygments – Python syntax highlighter
Extensions dependent on this one:
- Extension:SyntaxHighlightPages – highlights pages based on title suffixes.
- Extension:ViewFiles – makes files specified by the system administrator accessible via a special page.
Alternative extensions:
- Extension:GoogleCodePrettify – расширение синтаксической подсветки, которое использует Google Prettify library.
- Extension:SyntaxHighlighter – расширение синтаксической подсветки кода, которое использует библиотеку SyntaxHighlighter.

Footnotes

Это расширение используется на некоторых проектах Викимедиа Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki.

[5] :T104109#3879800

[6] ttp://developer.mozilla.org/en-US/docs/Web/CSS/tab-size

[1]

[2]

Расширение:SyntaxHighlight

Contents

Применение

Стайлинг

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

Параметры

lang

line

start

highlight

inline

class

style

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

Programming languages

Template languages

Other markup

Установка

Настройка

VisualEditor интеграция

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

См. также

Footnotes