Extension:Geshi

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

geshi Release status: stable
Implementation	Tag
Description
Author(s)	Jean-Lou Dupont
Last Version	1.0.0
MediaWiki	1.10, 1.11
License	No license specified
Download	SVN See SVN ($Id: geshi.doc.wikitext 491 2007-10-10 15:34:11Z jeanlou.dupont $)

See also: Extension:SyntaxHighlight GeSHi.

[edit] Purpose

Syntax highlight text snippets, whole pages or whole files. The extension also provides a new 'hook' for other extensions to leverage as well as providing syntax highlighting for text blocks, whole pages or whole files. Line numbers can optionally be included or omitted.

[edit] Usage

• LINES parameter
  • 0 -> no line numbers
  • 1 -> include line numbers
• LANG parameter: language
• SOURCE parameter
  • source=page where page is a valid page
  • source=file where file is a valid file of the Mediawiki installation accessible through the root of the installation.

[edit] Example 1

<geshi lang=LANG lines=LINES source=SOURCE> code OR page title OR filename </geshi>

[edit] Example 2

<php lines=LINES source=SOURCE> php code OR page title OR filename </php>

This usage is especially useful to integrate with other extensions (such as Form Processor).

[edit] Extensibility

This extension provides a new hook SyntaxHighlight that can be leveraged by other extensions.

public function handler( &$text, $lang, $lines, &$result )

[edit] History

• Added 'source' tag for aligning with some similar extensions.
• Added 'js' tag for highlighting 'Javascript'
• Added 'css' tag for highlighting 'CSS'
• Added parser function '{{#source ...}}'

[edit] 1.0.0

• Moved to PEAR distribution channel

[edit] Dependancy

• StubManager extension

[edit] Installation

See the Mediawiki Extension table entry "download" above.^[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote^[2]

• Add the following to LocalSettings.php if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above)^[2]:

require_once( "$IP/extensions/geshi/geshi.php" );

pear channel-discover mediawiki.googlecode.com/svn

pear install mediawiki/geshi

require 'MediaWiki/geshi/geshi.php';

pear upgrade pear

pear clear-cache

pear upgrade --force mediawiki/geshi

[edit] RSS feed

To keep kept up-to-date with this channel, use the following RSS feed.

[edit] Notes

[edit] Sandbox

You are invited in the author's sandbox to try-out some of his extensions.

[edit] Other Extensions From the same author

Consult User Jldupont's page.

1. ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
2. ↑ ^{2.0 2.1 2.2} Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
   Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
3. ↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] External Links

• GeSHi main page