MediaWiki Custom Pygments

From Leo's Notes
Revision as of 01:16, 6 March 2017 by Leo (talk | contribs) (handle newline commands)
This page was last edited on 6 March 2017, at 01:16.

To create a custom Pygments lexer for MediaWiki, do the following:

  1. Clone the Pygments project in the extensions/SyntaxHighlight_GeSHi/pygments directory. This should replace the pygmentize binary with the python script.
  2. Create your lexer in the extensions/SyntaxHighlight_GeSHi/pygments/pygments/lexers directory.
  3. Update the map by running make mapfiles in extensions/SyntaxHighlight_GeSHi/pygments
  4. Update the SyntaxHighlight_GeSHi.lexers.php file to contain the new lexer alias.

A simple lexer used on this wiki is for the Terminal output. It has the following lexer code which is just a couple regexes.

# -*- coding: utf-8 -*-
"""
    pygments.lexers.terminal
    ------------------------

    Lexers for terminal output

    :copyright:  Leo's stuff
    :license:  Leo's stuff
"""

import re

from pygments.lexer import RegexLexer, bygroups
from pygments.token import Text, Comment, Operator, Keyword, Name, String, \
    Number, Punctuation, Error

__all__ = ['TerminalLexer']

class TerminalLexer(RegexLexer):
    """
    For terminal output

    .. versionadded:: 0.1
    """

    name = 'terminal'
    aliases = ['terminal']

    tokens = {
        'root': [
            (r'^(\[*[a-zA-Z0-9\@:~\/\s\]]*[\$#]{1})(\s*[^#\n]*)(#*.*)', bygroups(Name, String, Comment )),
            (r'.*\\\n', String, 'newline'),
            (r'.*\n', Text)
        ],

        'newline': [
                (r'([^#\n]*)(#*.*)', bygroups(String, Comment), '#pop'),
                (r'.*$', String, '#pop'),
                (r'.*\\', String)
        ]
    }