Extension:SyntaxHighlight GeSHi

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

SyntaxHighlight_GeSHi Release status: stable
Implementation	Tag
Description	Allows source code to be syntax highlighted on the wiki pages.
Author(s)	Brion Vibber, Tim Starling and Rob Church
Version	r24298 (July 21, 2007)
MediaWiki	1.10.0+
Download	Download snapshot Subversion [Help] Browse source code README
Hooks used	ShowRawCssJs ParserFirstCallInit

This extension adds the <source> tag to present formatted source code.

[edit] Installation

• Step 1:

Download the extension from the Subversion repository and save it into the extensions/SyntaxHighlight_GeSHi directory of your wiki. If you have shell access to your server, you may do the following to download the extension:

cd extensions
svn co http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/SyntaxHighlight_GeSHi

• Step 2:

(Recommended) Download 1.0.X stable release of Subversion repository in SourceForge.net:

# change to the directory of the SyntaxHighlight_GeSHi extension
cd SyntaxHighlight_GeSHi
# check out a current version of GeSHi into a directory called geshi
svn co http://geshi.svn.sourceforge.net/svnroot/geshi/branches/RELEASE_1_0_X_STABLE/geshi-1.0.X/src/ geshi

The geshi.php file can also be downloaded from GeSHi, and unzip it inside the extensions/SyntaxHighlight_GeSHi directory. (Note: the zip file creates a sub-directory called geshi/, and places the file geshi.php there - Also note that GeSHi 1.1.2alpha3 does not work with this extension!)

(Note: You need both - the mediawiki plugin files and the geshi files from sourceforge to make it work!)

• Step 3.

Add this line to your LocalSettings.php:

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

• step 4. (Optional)

If needed, change the following line in SyntaxHighlight_GeSHi.class.php to suit the path of your geshi.php file

require( 'geshi/geshi.php' );

Sometimes you'll need to add the absolute path to geshi (/var/www/html/.../geshi/geshi.php)

[edit] Usage

On the wiki page, you can now use "source" elements:

<source lang="php">
<?php
    $v = "string";    // sample initialization
?>
html text
<?
    echo $v;         // end of php code
?>
</source>

[edit] Parameters

• lang: Defines the language
• line: Corresponds to enable_line_numbers method on GeSHi
• start: Corresponds to start_line_numbers_at method on GeSHi
• enclose: Corresponds to set_header_type method on GeSHi
• strict: Corresponds to enable_strict_mode method on GeSHi

The effect and usage of these parameters can be consulted in GeSHi's documentation.

Since r22246, you can override the colors using [[MediaWiki:GeSHi.css]].

[edit] Examples

[edit] C#

<source lang="csharp">
// Hello World in Microsoft C# ("C-Sharp").

using System;

class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}
</source>

Results in:

// Hello World in Microsoft C# ("C-Sharp").
 
using System;
 
class HelloWorld
{
    public static int Main(String[] args)
    {
        Console.WriteLine("Hello, World!");
        return 0;
    }
}

[edit] PHP

<source lang="php">
<?php
  // Hello World in PHP
  echo 'Hello World!';
?>
</source>

Results in:

<?php
  // Hello World in PHP
  echo 'Hello World!';
?>

[edit] Python

<source lang="python">
# Hello World in Python

def main():
    print "Hello World!"

if __name__ == '__main__':
    main()
</source>

Results in:

# Hello World in Python
 
def main():
    print "Hello World!"
 
if __name__ == '__main__':
    main()

[edit] Fortran

bugs:

• comments for fortran77 do not work (line starts with C)

<source lang="fortran">
C *
C *testing this srcipt
C *
c * comments for fortran77 do not work!

hello = "Hello World!"

if hello .eq. 'test' then
 !do nothing
else
 !do something
 x = 1
endif
</source>

Results in:

C *
C *testing this srcipt
C *
c * comments for fortran77 do not work!
 
hello = "Hello World!"
 
if hello .eq. 'test' then
 !do nothing
else
 !do something
 x = 1
endif

[edit] Supported languages

These are the languages known by GeSHi that can be used in the lang parameter:

[edit] See also

• GeSHiCodeTag - A working alternative extension that also uses Geshi
• GeSHi - Generic Syntax Highlighter
• ASHighlight (MediaWiki support for Andre Simon's highlight utility)
• Extension:SyntaxHighlight GeSHi extension - An extension to SyntaxHighlight_GeSHi. Enables external file inclusion.
• Extension:Geshi includes every component - no additional downloads

Languages:

English  • Deutsch  • 日本語