Go to file
Translation updater bot 1380a20c78 Localisation updates from https://translatewiki.net.
Change-Id: I2a607150ce6812f1a5420e46b4da259d323227c2
2017-02-16 23:05:33 +01:00
i18n Localisation updates from https://translatewiki.net. 2017-02-16 23:05:33 +01:00
maintenance Remove duplicate values from the lexer list 2016-02-03 17:30:01 -08:00
modules build: Replace jshint/jscs with eslint 2016-11-19 13:56:05 +00:00
pygments Update create_pygmentize_bundle for package changes 2017-01-29 01:38:57 -08:00
tests SECURITY: Replace strip markers before syntax highlighting 2016-05-20 10:21:06 -07: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
composer.json Update symfony/process to ~3.0 2016-04-02 20:57:52 +00:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
extension.json Merge "Skip registering RL modules depending on VisualEditor" 2017-02-13 10:53:30 +00:00
Gruntfile.js build: Re-use MessageDirs in banana conf 2017-01-23 14:10:18 +00:00
package.json build: Replace jshint/jscs with eslint 2016-11-19 13:56:05 +00:00
phpcs.xml Update mediawiki-codesniffer and parallel-lint settings 2015-09-29 01:45:26 +02:00
README Support local composer setup 2015-06-25 22:49:53 +00:00
ResourceLoaderGeSHiVisualEditorModule.php Convert SyntaxHighlight names to Ace names 2016-10-31 14:13:36 +01:00
SyntaxHighlight_GeSHi.ace.php Convert SyntaxHighlight names to Ace names 2016-10-31 14:13:36 +01:00
SyntaxHighlight_GeSHi.class.php Fix logic in RL module conditional registration 2017-02-13 17:18:44 +01:00
SyntaxHighlight_GeSHi.compat.php Add language mapping for geshi apt_sources to debsources 2016-04-11 13:30:17 +02:00
SyntaxHighlight_GeSHi.lexers.php Remove non-existent ipython lexers 2017-01-29 01:37:54 -08: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.