Go to file
Brad Jorsch 8dde10991c Implement 'ApiFormatHighlight' hook
Core change I04b1a3842 adds a hook to allow extensions to
syntax-highlight the pretty-printed output from the API.

Change-Id: If0413a1d922ff8a47afc355e0a2cc276cf54b400
2014-10-13 16:22:59 -07:00
geshi Haskell syntax: omit single quotes from QUOTEMARKS 2013-10-09 02:48:51 -07:00
i18n Localisation updates from https://translatewiki.net. 2014-09-02 22:17:59 +02:00
.gitignore Maintenance for extension SyntaxHighlight_GeSHi. 2012-08-26 11:24:29 +02:00
.gitreview Adding .gitreview 2012-03-23 10:35:01 -07:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
README Remove out of date information from README 2014-07-30 20:25:55 +01:00
ResourceLoaderGeSHiLocalModule.php Update comments 2014-06-15 17:22:00 -07:00
ResourceLoaderGeSHiModule.php Update comments 2014-06-15 17:22:00 -07:00
SyntaxHighlight_GeSHi.class.php Implement 'ApiFormatHighlight' hook 2014-10-13 16:22:59 -07:00
SyntaxHighlight_GeSHi.i18n.php Update i18n shim 2014-04-22 13:47:29 +00:00
SyntaxHighlight_GeSHi.php Implement 'ApiFormatHighlight' hook 2014-10-13 16:22:59 -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:

    http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi

== Requirements ==

This version of the extension has been tested with GeSHi 1.0.8.11 and MediaWiki 1.24
as of 2014-05-10. It may or may not work with earlier versions of the aforementioned
software. To get releases of this extension compatible with earlier versions of
MediaWiki, visit: 

    http://www.mediawiki.org/wiki/Special:ExtensionDistributor/SyntaxHighlight_GeSHi


== Installation ==

Add this line to your LocalSettings.php:

	require_once("extensions/SyntaxHighlight_GeSHi/SyntaxHighlight_GeSHi.php");

== 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 ==

Please see the documentation of GeSHi on http://qbnz.com/highlighter/geshi-doc.html
for detailed information to use some of the parameters.

* lang;		Defines the language 
* line;		Corresponds to enable_line_numbers method on GeSHi
* start;	Corresponds to start_line_numbers_at method on GeSHi
* strict;	Corresponds to enable_strict_mode method on GeSHi

== Note ==

GeSHi is generous about creating HTML elements: highlighting large blocks of
code can easily generate enough of them to crash a browser. As a guard, symbol
highlighting is turned off for code fragments larger than 100 kB. For fragments
larger than 200 kB, string highlighting is turned off as well.