Go to file
Ori Livneh f36b6c66d3 If unable to shell out to Pygments, emit a warning and fall back to plain text.
Change-Id: I8beb0367405e8ea70385134e03302e8bd3ab91ff
2015-06-22 16:19:25 -07:00
i18n Localisation updates from https://translatewiki.net. 2015-06-21 20:05:35 +02:00
maintenance Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
modules Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
pygments Bundle Pygments 2.0.2 2015-06-22 22:54:42 +00:00
.gitignore Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
.gitreview Adding .gitreview 2012-03-23 10:35:01 -07:00
.jscsrc build: Use npm for repo testing (jshint, jsonlint, jscs, banana) 2015-05-29 17:21:59 +00:00
.jshintrc build: Use npm for repo testing (jshint, jsonlint, jscs, banana) 2015-05-29 17:21:59 +00:00
composer.json Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
extension.json Bundle Pygments 2.0.2 2015-06-22 22:54:42 +00:00
Gruntfile.js build: Use npm for repo testing (jshint, jsonlint, jscs, banana) 2015-05-29 17:21:59 +00:00
package.json build: Updating development dependencies 2015-06-05 17:14:21 -07:00
README Bundle Pygments 2.0.2 2015-06-22 22:54:42 +00:00
SyntaxHighlight_GeSHi.class.php If unable to shell out to Pygments, emit a warning and fall back to plain text. 2015-06-22 16:19:25 -07:00
SyntaxHighlight_GeSHi.compat.php Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
SyntaxHighlight_GeSHi.lexers.php Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
SyntaxHighlight_GeSHi.php Revert "Revert "Add extension.json, empty PHP entry point"" 2015-05-20 14:36:46 -07: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 your root MediaWiki directory, create a
composer.local.json file with the following contents:

    {
        "extra": {
            "merge-plugin": {
                "include": [
                    "extensions/SyntaxHighlight_GeSHi/composer.json"
                ]
            }
        }
    }

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