Go to file
Ed Sanders 532fb50436 build: Update CSSLint from 0.4.0 to 0.5.0
Change-Id: I8f9458b3ed01ef1676cb5064d71138d30fe3d215
2015-09-18 16:03:22 +00:00
i18n build: Update grunt-banana-checker from 0.2.0 to 0.3.0 and make pass 2015-09-18 16:02:41 +00:00
maintenance Highlight using Pygments rather than Geshi 2015-06-22 23:37:15 +01:00
modules build: Update JSCS from 1.8.0 to 2.1.0 and make pass 2015-09-18 16:01:40 +00:00
pygments Revert "Add Pyglet, a web micro-service for highlighting using Pygments" 2015-06-25 01:11:54 +00:00
tests Fix "MWException: Unexpected output from Pygments" in highlight fallback 2015-07-07 22:12:53 +01:00
.csslintrc Add VisualEditor support 2015-06-24 22:43:42 +01:00
.gitignore Support local composer setup 2015-06-25 22:49:53 +00:00
.gitreview Adding .gitreview 2012-03-23 10:35:01 -07:00
.jscsrc build: Update JSCS from 1.8.0 to 2.1.0 and make pass 2015-09-18 16:01:40 +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 Rename modules/VisualEditor to modules/ve-syntaxhighlight 2015-09-18 12:14:39 +01:00
Gruntfile.js build: Update grunt-banana-checker from 0.2.0 to 0.3.0 and make pass 2015-09-18 16:02:41 +00:00
package.json build: Update CSSLint from 0.4.0 to 0.5.0 2015-09-18 16:03:22 +00:00
README Support local composer setup 2015-06-25 22:49:53 +00:00
ResourceLoaderGeSHiVisualEditorModule.php Unbreak VE integration in debug mode 2015-07-28 23:59:07 +01:00
SyntaxHighlight_GeSHi.class.php Use $parser->mUniqPrefix instead of $parser::MARKER_PREFIX for MW 1.25 compatibility 2015-07-15 12:44:17 +00:00
SyntaxHighlight_GeSHi.compat.php Merge "Map 'gettext' to 'pot'" 2015-07-24 12:07:40 +00: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 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.