Go to file
Kunal Mehta 987187935c Make sure $wgPygmentizePath is sane only when we need it
This avoids having an extension function, which runs on every request,
regardless of whether it uses syntax highlighting or not.

Change-Id: I890348b73af956819300cce64d0672dcdb209c19
2017-07-06 00:57:40 -07:00
i18n Localisation updates from https://translatewiki.net. 2017-06-28 23:13:15 +02:00
maintenance Make sure $wgPygmentizePath is sane only when we need it 2017-07-06 00:57:40 -07:00
modules Pass dataElement type to parent's toDataElement 2017-05-19 16:06:44 +02:00
pygments Update pygments to 2.2 2017-04-27 15:10:16 +02:00
tests Update pygments to 2.2 2017-04-27 15:10:16 +02:00
.eslintrc.json build: Replace jshint/jscs with eslint 2016-11-19 13:56:05 +00:00
.gitignore Support local composer setup 2015-06-25 22:49:53 +00:00
.gitreview Whoops, track not trace 2016-10-24 17:03:53 -07:00
.stylelintrc Introduce stylelint 2016-05-19 17:44:00 +01:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2017-06-07 16:14:47 +04:30
composer.json Update mediawiki/codesniffer to 0.7.2 2017-06-13 12:22:06 +02:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
extension.json Make sure $wgPygmentizePath is sane only when we need it 2017-07-06 00:57:40 -07:00
Gruntfile.js build: Re-use MessageDirs in banana conf 2017-01-23 14:10:18 +00:00
package.json Remove 'GeSHi' name from composer and npm manifests 2017-05-21 13:26:40 +00:00
phpcs.xml Use short array syntax 2017-06-15 18:16:11 +02:00
README Support local composer setup 2015-06-25 22:49:53 +00:00
ResourceLoaderSyntaxHighlightVisualEditorModule.php Use short array syntax 2017-06-15 18:16:11 +02:00
SyntaxHighlight.ace.php Update mediawiki/codesniffer to 0.7.2 2017-06-13 12:22:06 +02:00
SyntaxHighlight.class.php Make sure $wgPygmentizePath is sane only when we need it 2017-07-06 00:57:40 -07:00
SyntaxHighlight.GeSHi.compat.php Use short array syntax 2017-06-15 18:16:11 +02:00
SyntaxHighlight.GeSHi.php Remove GeSHi from class and filenames 2017-05-20 14:47:23 +00:00
SyntaxHighlight.lexers.php Use short array syntax 2017-06-15 18:16:11 +02:00
SyntaxHighlight_GeSHi.php Add php code sniffer to SyntaxHighlight_GeSHi 2015-09-27 21:16:58 +02:00

This extension allows source code to be syntax highlighted on the wiki pages.
This README file might be out of date, have a look at the extension page
for updated informations:

    https://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi

== Requirements ==

This version of the extension has been tested with Pygments 1.6, 2.0.2 and
MediaWiki 1.25 as of 2015-06-19. To get releases of this extension compatible
with earlier versions of MediaWiki, visit:

    https://www.mediawiki.org/wiki/Special:ExtensionDistributor/SyntaxHighlight_GeSHi

== Installation ==

First, you will need to ensure that this extension's Composer-managed
dependencies are available. In the extension directory, run 'composer update'.

Next, Add this line to your LocalSettings.php:

    wfLoadExtension( 'SyntaxHighlight_GeSHi' );

By default, this extension will use a bundled copy of Pygments 2.0.2. If you
would like to use a different copy of the library, you can set
$wgPygmentizePath to point to the path to the 'pygmentize' binary.

== Usage ==

On the wiki page, you can now use "source" elements:

<source lang="php">
<?php
    v = "string";    // sample initialization
?>
html text
<?php
    echo v;         // end of php code
?>
</source>

== Parameters ==

For details information of these parameters, see the documentation of Pygments'
HtmlFormatter at <http://pygments.org/docs/formatters/#HtmlFormatter>.

* lang;		Defines the language.
* line;		Corresponds to linenos="inline" option.
* start;	Corresponds to linenostart opion.
* enclose;  If set to "none", corresponds to the nowrap=1 option.
* inline;   Corresponds to the nowrap=1 option.
* highlight;    Corresponds to hl_lines option (comma separated).

== Note ==

Pygments is generous about creating HTML elements: highlighting large blocks of
code can easily generate enough of them to crash a browser. As a guard, syntax
highlighting is turned off for code fragments larger than 100 kB.