Go to file
Timo Tijhof 8c3a3ffda0 Update highlight() to use getWithSetCallback() idiom
* Use backend-specific makeGlobalKey() method instead of
  deprecated wfGlobalCacheKey().

* Call makeCacheKey() inline and reduce to only producing
  part of the key (makeCacheKeyHash).

* Add a $ttl (1 month), instead of the previously unspecified
  expiry (default: indefinite).

Change-Id: I913a768a3b61cc31ce14fa086a563ceecca7c603
2018-02-22 23:53:56 +00:00
i18n Localisation updates from https://translatewiki.net. 2018-02-10 09:15:29 +01:00
includes Update highlight() to use getWithSetCallback() idiom 2018-02-22 23:53:56 +00:00
maintenance Update Maintenance scripts in extensions to use $this->requireExtension() 2018-01-28 16:42:01 +00:00
modules Document monospace hack 2018-01-11 14:45:39 +01:00
pygments Run Pygments using Python 3 2017-12-27 18:51:19 -08:00
tests If there is no input, don't try and shell out to pygments 2018-02-22 13:29:58 -08:00
.eslintrc.json build: Replace jshint/jscs with eslint 2016-11-19 13:56:05 +00:00
.gitignore Add phan configuration for static analysis and fix phan warnings 2017-12-25 11:16:49 +07:00
.gitreview Whoops, track not trace 2016-10-24 17:03:53 -07:00
.phpcs.xml Move classes into includes/ 2018-02-15 14:29:07 -08:00
.stylelintrc.json Use json extension for .stylelintrc 2017-08-19 10:30:45 +02:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT.md 2017-06-07 16:14:47 +04:30
composer.json build: Updating mediawiki/minus-x to 0.3.1 2018-02-18 09:46:21 +00:00
COPYING
extension.json Move classes into includes/ 2018-02-15 14:29:07 -08:00
Gruntfile.js Mark es6 file as such 2018-01-11 14:46:17 +01:00
package.json build: Update linters 2017-11-30 21:55:54 +00:00
README Drop symfony/process dependency, use Shell\Command instead 2018-01-04 13:07:35 -08: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 ==

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.