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

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Extension:SyntaxHighlight and the translation is 96% complete.

Other languages:
Deutsch • ‎English • ‎日本語 • ‎русский • ‎Türkçe • ‎中文
Для подсветки синтаксиса wikicode при использовании редактора кода см. расширение CodeMirrorExtension:CodeMirror или скрипты пользователей of Remember the dot and Cacycle.
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.
Это расширение ранее называлось SyntaxHighlight_GeSHi, поскольку оно использовало GeSHi для подсветки синтаксиса. Начиная с June 2015 оно использует Pygments.
Справка по расширениям MediaWikiManual:Extensions
Crystal Clear action run.svg
SyntaxHighlight

Статус релиза:Extension status стабильный

SyntaxHighlighting with Pygments.png
РеализацияTemplate:Extension#type Tag
ОписаниеTemplate:Extension#description Позволяет подсвечивать исходный код на вики-страницах
Автор(ы)Template:Extension#username Brion Vibber, Tim Starling, Rob Church, and Ori Livneh
Последняя версияTemplate:Extension#version continuous updates
MediaWikiTemplate:Extension#mediawiki 1.25+
Изменения БДTemplate:Extension#needs-updatephp Нет
ЛицензияTemplate:Extension#license GNU General Public License 2.0 or later
Загрузка
README
ПараметрыTemplate:Extension#parameters
  • $wgPygmentizePath
  • $wgSyntaxHighlightModels
ТэгиTemplate:Extension#tags
<syntaxhighlight>
Использованные hook'иTemplate:Extension#hook
ContentGetParserOutputManual:Hooks/ContentGetParserOutput
ParserFirstCallInitManual:Hooks/ParserFirstCallInit
ApiFormatHighlightManual:Hooks/ApiFormatHighlight
ResourceLoaderRegisterModulesManual:Hooks/ResourceLoaderRegisterModules

Переведите расширение SyntaxHighlight если оно доступно на translatewiki.net

Проверьте использование и версию.

ПроблемыPhabricator

Открытые задачи · Сообщить об ошибке

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

Подобно тегам <pre> и <poemExtension: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.

Второй наиболее распространенной ошибкой является использование lang="sh" или lang="shell", которые не поддерживаются. Обычно их можно заменить на lang="bash" или lang="shell-session".

Параметры

lang

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

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

Подробнее о поддерживаемых языках см. В разделе Supported languages. Подробнее см. в разделе Syntax highlighting error category на этой странице.

line

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

1 int x = 0;
2 Console.WriteLine("结果是:"+ x);
<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.

Например:

#include <stdio.h>
int main()
{
	printf ("Hello world!");
	return 0;
}

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

<syntaxhighlight lang=c style="border:3px dashed blue">
#include <stdio.h>
int main()
{
	printf ("Hello world!");
	return 0;
}
</syntaxhighlight>

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

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

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

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

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


Установка

gotcha
  • Скачайте и распакуйте файл(ы) в папку с названием SyntaxHighlight_GeSHi в вашу папку extensions/.
  • Добавьте следующий код в файл LocalSettings.php (в самый конец):
    wfLoadExtension( 'SyntaxHighlight_GeSHi' );
    
  • В Linux ', установите разрешения для выполнения "pygmentize" библиотеки:
chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
  • YesY Готово - Перейдите на страницу «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 и выше некоторые пользователи начали сообщать о проблемах с расширением.

  • Попробуйте указать в $wgPygmentizePath в LocalSettings.php на внешний двоичный файл pygmentize.
  • См. phabricator task для этого для дальнейших предложений и информации.

VisualEditor интеграция

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

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

Unlike the <pre> and <code> tags, HTML character entities such as   need 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 &lt;, 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).[1] (Обратите внимание, что в окне редактирования вики допускаются 8-пробельные табуляции.) Это относится только к актуальным сохраненным страницам; превью, сгенерированные в окне редактирования, или Special:ExpandTemplates имеют отличия.

См. также

Footnotes