Extension:SyntaxHighlight/cs

Rozšíření SyntaxHighlight, dříve známé jako SyntaxHighlight_GeSHi, poskytuje bohaté formátování zdrojového kódu pomocí tagu. Je spuštěn knihovnou Pygments a podporuje stovky různých programovacích jazyků a formátů souborů.

Stejně jako značky a   se text vykresluje přesně tak, jak byl napsán, a zachovává veškeré prázdné místo.

The SyntaxHighlight extension does not work on hardened wiki installations due to lack of,   and friends. See.

Tag se od 1.39 stal mocným. (Podívejte se na stránku .)

Použití
Po instalaci můžete na wiki stránkách používat značky "syntaxhighlight". Například,

je výsledkem následujícího označení wikitextu:

Ve starších verzích (před MediaWiki 1.16) rozšíření používalo značku. Toto je stále podporováno, ale je zastaralé. Místo toho by měl být použit.

Styl
Pokud je zobrazený kód příliš velký, můžete jej upravit vložením následujícího do stránky MediaWiki:Common.css ve vaší wiki (vytvořte ji, pokud neexistuje):

Zapouzdření bloků kódu do ohraničení lze provést vložením řádku jako v sekci výše. Kontrolu nad rodinou písem lze také uplatnit vložením řádku jako do sekce výše.



Kategorie chyb zvýraznění syntaxe
Rozšíření přidává stránky, které mají špatný atribut  ve značce  do kategorie sledování. Klíč zprávy MediaWiki:syntaxhighlight-error-category určuje název kategorie. Na této wiki je to Category:.

Nejčastější chybou, která vede k tomu, že stránky jsou označeny touto kategorií, je značka bez atributu , protože starší verze tohoto rozšíření podporovaly definici. Ty mohou být obvykle buď nahrazeny, nebo  nebo   mohou být přidány ke značce.

Kategorie může být také přidána a obsah nebude zvýrazněn, pokud je více než 1000 řádků nebo více než 100 kB textu.

lang
Atribut  definuje, jaký lexer by měl být použit. Jazyk ovlivňuje, jak rozšíření zvýrazní zdrojový kód. Podrobnosti o podporovaných jazycích najdete v sekci #Supported languages.

Zadáním neplatného nebo neznámého názvu označíte stránku kategorií sledování. Podrobnosti naleznete v části #Syntax highlighting error category na této stránce.

line
Atribut  umožňuje čísla řádků.

start
Atribut  (v kombinaci s  ) definuje číslo prvního řádku bloku kódu. Například  způsobí, že číslování řádků začne na 55.

highlight
Atribut  určuje jeden nebo více řádků, které by měly být označeny (zvýrazněním těchto řádků jinou barvou pozadí). Můžete zadat více čísel řádků oddělených čárkami (například ) nebo rozsahy pomocí dvou čísel řádků a pomlčky (například  ).

je výsledkem

inline
Atribut označuje, že zdrojový kód by měl být vložen jako součást odstavce (na rozdíl od vlastního bloku). Tato možnost je k dispozici od MediaWiki 1.26.

Například:

Následující  je výraz lambda v Pythonu.

Je výsledkem:

class
Když je použit,   (na těch wiki, které to podporují; ne na MediaWiki samotné) určuje, že zalomení řádků by se nemělo vyskytovat v mezerách v bloku kódu.

Například:

Bez :

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

S :

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style
Atribut  umožňuje přímé zahrnutí atributů CSS. To je ekvivalentní uzavření bloku do tagu (nikoli ). Atribut  nelze zadat tímto způsobem. Vyžaduje to uzavírací značku, jak je popsáno níže v části Advanced.

Například:

Je výsledkem:



Podporované jazyky
Pygments poskytuje podporu pro zvýrazňování syntaxe stovek počítačových jazyků a formátů souborů prostřednictvím různých "lexerů", které jsou součástí knihovny.

Ve většině případů je atribut, který se má použít s tímto rozšířením, tvořen malými písmeny v názvu jazyka. Mnohé však mají aliasy nebo "krátká jména", jak se jim říká v dokumentaci Pygments; úplné podrobnosti viz "Available lexers".

Některé jazyky dříve podporované GeSHi byly namapovány na lexery Pygments. Podrobnosti viz.

Od ledna 2020 je úplný seznam jazyků podporovaných Pygments:

Programovací jazyky
1=

ActionScript

Ada

Agda (včetně gramotných)

Alloy

AMPL

ANTLR

APL

AppleScript

Assembly (různé)

Asymptote

Augeas

AutoIt

Awk

BBC Basic

Befunge

BlitzBasic

Boa

Boo

Boogie

BrainFuck

C, C++ (vč. dialekty jako Arduino)

C#

Chapel

Charm++ CI

Cirru

Clay

Clean

Clojure

CoffeeScript

ColdFusion

Common Lisp

Component Pascal

Coq

Croc (MiniD)

Cryptol (včetně Literate Cryptol)

Crystal

Cypher

Cython

D

Dart

DCPU-16

Delphi

Dylan (včetně řídicího panelu)

Eiffel

Elm

Emacs Lisp

Email

Erlang (včetně shellové relace)

Ezhil

Factor

Fancy

Fantom

Fennel

FloScript

Forth

Fortran

FreeFEM++

F#

GAP

Gherkin (Cucumber)

GLSL shadery

Golo

Gosu

Groovy

Haskell (včetně Literate Haskell)

HLSL

HSpec

Hy

IDL

Idris (včetně Literate Idris)

Igor Pro

Io

Jags

Java

JavaScript

Jasmin

Jcl

Julia

Kotlin

Lasso (včetně šablonování)

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 (včetně konzolové relace a zpětného sledování)

QBasic

Racket

Raku a.k.a. Perl 6

REBOL

Red

Redcode

Rexx

Ride

Ruby (včetně irb relace)

Rust

S, S-Plus, R

Scala

Scdoc

Scheme

Scilab

SGF

Shell skripty (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

Jazyky šablon
1=

Angular šablony

Cheetah šablony

ColdFusion

Django / Jinja šablony

ERB (Ruby šablony)

Evoque

Genshi (jazyk šablon Trac)

Handlebars

JSP (Java Server Pages)

Liquid

Myghty (the HTML::Mason základní rámec)

Mako (nástupce Myghty)

Slim

Smarty šablony (šablony PHP)

Tea

Twig

Jiné označení
1=

Konfigurační soubory Apache

Apache Pig

BBCode

CapDL

Cap'n Proto

CMake

Csound scores

CSS

Řídicí soubory Debianu

Soubory Diff

Dockerfiles

DTD

EBNF

Záhlaví e-mailů

Extempore

Flatline

Gettext katalogy

Gnuplot skripty

Groff označení

Hexdumps

HTML

HTTP relace

IDL

Inform

INI-style config files

IRC logs (irssi style)

Isabelle

JSGF notation

JSON, JSON-LD

Lean theorem prover

Lighttpd config files

Linux kernel log (dmesg)

LLVM assembly

LSL scripts

Makefiles

MoinMoin/Trac Wiki markup

MQL

MySQL

NCAR command language

Nginx config files

Nix language

NSIS scripts

Notmuch

POV-Ray scenes

Puppet

QML

Ragel

Redcode

ReST

Roboconf

Robot Framework

RPM spec files

Rql

RSL

Scdoc

SPARQL

SQL, also MySQL, SQLite

Squid configuration

TADS 3

Terraform

TeX

Thrift

TOML

Treetop grammars

USD (Universal Scene Description)

Varnish configs

VGL

Vim Script

WDiff

Windows batch files

XML

XSLT

YAML

Windows Registry files

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

Configuration
and (optional): For performance reasons, blobs or pages (JS, Lua and CSS pages) larger than these values will not be highlighted. (since 1.40)


 * 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:.


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


 * 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 T128993 on this for further suggestions and information.
 * SELinux can also prevent the extension from running with an error similar to  in your audit.log. This can be allowed with
 * In earlier versions of this extension, Windows would sometimes fail with an _Py_HashRandomization_Init error. This was a bug with the Windows environment not being passed to python executions. A fix was released in 1.40, with backports to 1.38 and 1.39.

VisualEditor integration
The plugin enables direct editing with VisualEditor. A popup is opened when a user wants to edit  sections. For this to work, VisualEditor must be installed and configured from the latest Git version, same for Parsoid. The feature may not work with older Parsoid versions. See for details

Advanced
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 to version 90), 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.