mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/SyntaxHighlight_GeSHi
synced 2024-11-15 18:49:22 +00:00
6ba411fe2f
Until and unless there is an explicit need (and intent to support) a public interface to use this data elsewhere, there is no need for it to be a separate module. It can be its own class, but at the resource level this data should be considered a JavaScript file. And we don't create separate modules for each file. They are in the same module unless they should be semantically loaded in unrelated page contexts. The module registery is not a javascript class autoloader. There is a global cost to adding more modules to this registry. Change-Id: Ifeddef8cfe00b6c115734f92eceab251a0b75bdb |
||
---|---|---|
i18n | ||
maintenance | ||
modules | ||
pygments | ||
tests | ||
.csslintrc | ||
.gitignore | ||
.gitreview | ||
.jscsrc | ||
.jshintrc | ||
composer.json | ||
COPYING | ||
extension.json | ||
Gruntfile.js | ||
package.json | ||
README | ||
ResourceLoaderGeSHiVisualEditorModule.php | ||
SyntaxHighlight_GeSHi.class.php | ||
SyntaxHighlight_GeSHi.compat.php | ||
SyntaxHighlight_GeSHi.lexers.php | ||
SyntaxHighlight_GeSHi.php |
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 your root MediaWiki directory, create a composer.local.json file with the following contents: { "extra": { "merge-plugin": { "include": [ "extensions/SyntaxHighlight_GeSHi/composer.json" ] } } } Then 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. * 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.