Go to file
James D. Forrester 4a22815562 build: Upgrade eslint-config-wikimedia from 0.10.1 to 0.11.0
Change-Id: I691326c8fc35e0ccc7b7d0b19b586e68611baf88
2019-04-03 16:26:40 -07:00
.phan Migrate to new Phan 2019-03-02 13:43:16 +01:00
i18n Localisation updates from https://translatewiki.net. 2019-03-08 22:29:32 +01:00
includes build: Updating mediawiki/mediawiki-phan-config to 0.5.0 2019-03-10 22:30:03 -07:00
maintenance Use ::class for class name resolution 2019-03-03 02:22:47 +01:00
modules Update eslint-config-wikimedia to 0.9.0 2018-11-27 21:59:16 +00:00
pygments Fix create_pygmentize_bundle 2019-01-09 14:43:22 -08:00
tests/parser Update tests to match parser changes 2019-03-19 13:38:21 -04:00
.eslintrc.json build: Set "root": true, in .eslintrc.json 2018-12-17 18:58:34 -08:00
.gitignore build: Upgrade eslint-config-wikimedia from 0.10.1 to 0.11.0 2019-04-03 16:26:40 -07:00
.gitreview Whoops, track not trace 2016-10-24 17:03:53 -07:00
.phpcs.xml Removed unused function lang_filter 2018-08-06 17:26:34 +02:00
.stylelintrc.json Use json extension for .stylelintrc 2017-08-19 10:30:45 +02:00
CODE_OF_CONDUCT.md build: Updating mediawiki/phan-taint-check-plugin to 1.3.0 2018-08-19 16:54:29 +00:00
composer.json build: Updating mediawiki/mediawiki-phan-config to 0.5.0 2019-03-10 22:30:03 -07:00
COPYING Add COPYING 2014-01-22 19:44:32 +00:00
extension.json Use wfMakeStaticArrayFile() 2018-07-28 21:29:57 -07:00
Gruntfile.js build: Upgrade eslint-config-wikimedia from 0.10.1 to 0.11.0 2019-04-03 16:26:40 -07:00
package.json build: Upgrade eslint-config-wikimedia from 0.10.1 to 0.11.0 2019-04-03 16:26:40 -07:00
README Drop symfony/process dependency, use Shell\Command instead 2018-01-04 13:07:35 -08:00
SyntaxHighlight.lexers.php Use wfMakeStaticArrayFile() 2018-07-28 21:29:57 -07:00
SyntaxHighlight_GeSHi.php Start showing warning for deprecated PHP entry point 2018-10-26 22:23:56 +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 ==

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.