Go to file
Translation updater bot 2abcdb3b56 Localisation updates from https://translatewiki.net.
Change-Id: I23b9f7ffec95d8ecf6590b3142d2cb9ae24f5425
2017-12-18 23:07:11 +01:00
i18n Localisation updates from https://translatewiki.net. 2017-12-18 23:07:11 +01:00
maintenance Rename files to match classes 2017-12-10 01:32:49 +01:00
modules Add new (unprefixed) CSS modifier user-select 2017-11-07 19:36:32 +01: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
.phpcs.xml Rename files to match classes 2017-12-10 01:32:49 +01: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.2.1 2017-12-11 09:02:46 +00:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
extension.json Rename files to match classes 2017-12-10 01:32:49 +01:00
GeSHi.php Rename files to match classes 2017-12-10 01:32:49 +01:00
Gruntfile.js Use json extension for .stylelintrc 2017-08-19 10:30:45 +02:00
package.json build: Update linters 2017-11-30 21:55:54 +00:00
README Support local composer setup 2015-06-25 22:49:53 +00:00
ResourceLoaderSyntaxHighlightVisualEditorModule.php Improve some parameter docs 2017-10-07 17:16:00 +02:00
SyntaxHighlight.lexers.php Use short array syntax 2017-06-15 18:16:11 +02:00
SyntaxHighlight.php Rename files to match classes 2017-12-10 01:32:49 +01:00
SyntaxHighlight_GeSHi.php Add php code sniffer to SyntaxHighlight_GeSHi 2015-09-27 21:16:58 +02:00
SyntaxHighlightAce.php Rename files to match classes 2017-12-10 01:32:49 +01:00
SyntaxHighlightGeSHiCompat.php Rename files to match classes 2017-12-10 01:32:49 +01: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.