Extension:SyntaxHighlight/be-tarask

The SyntaxHighlight extension, formerly known as SyntaxHighlight_GeSHi, provides rich formatting of source code using the  tag. It is powered by the Pygments library and supports hundreds of different programming languages and file formats.

Like the  and   tags, the text is rendered exactly as it was typed, preserving any white space.

Выкарыстаньне
Once installed, you can use "syntaxhighlight" tags on wiki pages. For example,

is the result of the following wikitext markup:

In older versions (before MediaWiki 1.16), the extension used the tag. This is still supported, but  may help avoid conflicts if your source code itself contains   tags (for example XML).

Стыляваньне
If the displayed code is too big, you can adjust it by putting the following into the MediaWiki:Common.css page in your wiki (create it if it does not exist):

Encasing code blocks in borders can be done by inserting a line like  in the section above. Control over font family used can also be exercised by inserting a line like  into the section above.

Катэгорыя памылковых падсьветак сынтаксу
The extension adds pages that have a bad  attribute in a   or   tag to a tracking category. The message key MediaWiki:syntaxhighlight-error-category determines the category name; on this wiki it is Category:.

The most common error that leads to pages being tagged with this category is a  or   tag with no   attribute at all, because older versions of this extension supported the definition of "$wgSyntaxHighlightDefaultLang". These can typically either be replaced with, or   or   can be added to the tag.

мова
The  attribute defines what lexer should be used. The language affects how the extension highlights the source code. The pygments parser is case sensitive and all languages have at least one capital letter (lower case language names are reserved for gtags). See the section Supported languages for details of supported languages.

Specifying an invalid or unknown name will tag the page with a tracking category. Падрабязнасьці глядзіце ў сэкцыі Катэгорыя старонак з памылкамі падсьветкі сынтаксісу гэтай старонкі.

рыса
The  attribute enables line numbers.

старт
The  attribute (in combination with  ) defines the first line number of the code block. For example,  will make line numbering start at 55.

падсьветка
The  attribute specifies one or more lines that should be marked (by highlighting those lines with a different background color). You can specify multiple line numbers separated by commas (for example, ) or ranges using two line numbers and a hyphen (for example,  ). Note that the line number specification ignores any renumbering of the displayed line numbers with the  attribute.

is the result of

у радку
The attribute indicates that the source code should be inline as part of a paragraph (as opposed to being its own block). This option is available starting with MediaWiki 1.26. For backwards-compatibility, an  attribute results in the same behavior.

Note that line breaks can occur at any space between the opening and closing tags unless the source code is marked non-breakable with  (on those wikis that support it; see below) or.

For example:

is a lambda expression in Python.

Is the result of:

is a lambda expression in Python.

кляса
When  is used,   (on those wikis that support it; not on MediaWiki itself) specifies that line breaks should not occur at spaces within the code block.

For example:

Without :

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx With : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

стыль
The  attribute allows CSS attributes to be included directly. This is equivalent to enclosing the block in a  (not  ) tag. The  attribute cannot be specified this way; it requires an enclosing   tag as described below under Advanced.

For example:

Is the result of:

Падтрымка моваў
The Pygments library provides support for hundreds of computer languages and file formats. 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)

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

For accurate language codes, see complete details in the Pygments document and there are some mappings for some language names which were supported by GeSHi (full list).

Below is a partial list of languages that GeSHi could highlight, with strike-through for languages no longer supported after the switch to Pygments.

Наладжваньне

 * Linux:


 * (optional): Absolute path to pygmentize of the Pygments package. The extension bundles the Pygments package and  points to the bundled version by default, but you can point to a different version, if you want to. For example:.
 * : Configure the default lexer for some wiki pages. By default this will highlight javascript and css pages. Additional content models can be configured by extensions (e.g. Lua, JSON, ..).


 * Windows:


 * If you are hosting your MediaWiki on a Windows machine, you have to set the path for the Pygmentize.exe
 * If there is no  run   from command line inside the   folder to generate the file.

If you are using the bundled pygmentize binary (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize), make sure your webserver is permitted to execute it. If your host does not allow you to add executables to your web directory, install python-pygments and add  to LocalSettings.php.


 * Troubleshooting:

After updating to MediaWiki v1.26 and above, some users started reporting problems with the extension. Могуць быць выпадкі, калі асобныя мовы, напрыклад Lua, не падсьвечваюцца, а пры ўключэньні адладкі MediaWiki выдае памылку.


 * Try pointing  in LocalSettings.php towards an external pygmentize binary.
 * 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:


 * See the phabricator task on this for further suggestions and information.

Інтэграцыя зь Візуальным рэдактарам
The plugin enables direct editing with VisualEditor. A popup is opened when a user wants to edit  or   sections. For this to work, VisualEditor must be installed and configured from the latest git version, same for Parsoid. The feature randomly does not work with older Parsoid versions. Падрабязнасьці глядзіце ў 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.

Furthermore, while  assumes tab stops every 8 characters and renders tabs using actual spaces when the rendered text is copied,   uses 4-space tab stops (except Internet Explorer, which uses 8) and preserves the tab characters in the rendered text; the latter may be changed using an enclosing   tag (not , and not using its own   attribute). The  prefix is required for Firefox (from version 4.0), and the   prefix is required for Opera (from version 10.60 to version 15). (Note that the wiki editing box assumes 8-space tabs.) This applies only to actual saved pages; previews generated through an edit box or Special:ExpandTemplates may differ.

Глядзіце таксама

 * Pygments – Python syntax highlighter
 * Зьвязаныя пашырэньні:
 * – syntax highlighter that uses Google Code Prettify library.
 * – syntax highlighter that uses SyntaxHighlighter library.
 * – an extension, dependent on this one, to support highlighting text from files viewed via a special page.