Extension:SyntaxHighlightPages

From mediawiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
SyntaxHighlightPages
Release status: beta
Implementation ContentHandler
Description Syntax highlight pages based on title suffixes.
Author(s) (Gittenburgtalk)
Latest version 0.1.0 (2019-07-13)
Compatibility policy Master maintains backwards compatibility.
MediaWiki 1.31+
MediaWiki 1.36 Not formally tested
MediaWiki 1.34 Not formally tested
MediaWiki 1.32 Not formally tested
License MIT License
Download
$wgSyntaxHighlightPagesSuffixes

Check usage and version matrix.

The SyntaxHighlightPages extension highlights pages based on title suffixes; it depends on Extension:SyntaxHighlight.

Additionally the extension adds a Download link to the toolbox on highlighted pages.

Installation[edit]

  • Download and place the file(s) in a directory called SyntaxHighlightPages in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'SyntaxHighlightPages' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

$wgSyntaxHighlightPagesSuffixes
The enabled suffixes.

For example:

$wgSyntaxHighlightPagesSuffixes = ['txt', 'html', 'css', 'xml', 'js', 'php'];

Note that the suffix needs to be a short name listed under https://pygments.org/docs/lexers/.

Unfortunately using the file extensions known to Pygments does not work since Extension:SyntaxHighlight provides no PHP wrapper for pygments.lexers.find_lexer_class_for_filename.

This does mean that adding e.g. 'htm' will not work because it is not a lexer name.