Extension:SyntaxHighlight

The Extension:SyntaxHighlight GeSHi tag displays formatted source code with the   tag.

This extension also adds coloring according to the code language settings. Like the  tags and the   tags, the tags shows the coding exactly as it was typed, preserving white space.

This extension also can create line numbers.

source tag replaced
Before 50696, the  tag was used. It is still supported, but  is recommended to avoid possible conflicts. The original syntax is used in some other languages, e.g. XML.

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

shows:

Alternative Tag
is also used in some other languages (for example XML). If your source code contains is provided. is recommended to avoid the conflicts mentioned above.

Parameters

 * Defines what programming language the source code is using. This affects how the extension highlights the source code. See the section "Supported languages" in this page for details of supported languages.
 * Defines what programming language the source code is using. This affects how the extension highlights the source code. See the section "Supported languages" in this page for details of supported languages.


 * Type of line numbering to use (default is no line numbering). Corresponds to enable_line_numbers the flag in GeSHi.
 * Type of line numbering to use (default is no line numbering). Corresponds to enable_line_numbers the flag in GeSHi.


 * Use together with the parameter "line". Define the start number of the line. If you type line start="55", it will start counting at 55, then 56,57,58... and so on. Corresponds to start_line_numbers_at method on GeSHi
 * Use together with the parameter "line". Define the start number of the line. If you type line start="55", it will start counting at 55, then 56,57,58... and so on. Corresponds to start_line_numbers_at method on GeSHi


 * Specifies which line is highlighted. Note that the parameter line start="??" doesn't affect how it counts the lines.
 * Specifies which line is highlighted. Note that the parameter line start="??" doesn't affect how it counts the lines.


 * Specifies what container is used to enclose the source code. Takes values "pre" (default value), "div", "none". Corresponds to set_header_type method on GeSHi. Choosing "div" will cause text to wrap, which is helpful if text is extending off the edge of the screen, causing horizontal scrolling.
 * Specifies what container is used to enclose the source code. Takes values "pre" (default value), "div", "none". Corresponds to set_header_type method on GeSHi. Choosing "div" will cause text to wrap, which is helpful if text is extending off the edge of the screen, causing horizontal scrolling.


 * Type the name of the parameter to enable the strict mode. Corresponds to enable_strict_mode method on GeSHi.
 * Type the name of the parameter to enable the strict mode. 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.

More Usage
When line numbering is added with line, long code lines will be wrapped. See the example below. When text is the selected language, and numbering is used, the behaviour resembles the use of pre tags with numbering and long-line wrapping.

The following example shows how to color an HTML code listing: A typical result is just:

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

Note that installed GeSHi version (can be revealed by previewing e.g. ) might not be the most recent version;  see 10967 for Wikimedia sites.

Default Source Language
Added in 50693.

If the site mainly quotes the source code of a specific programming language, it would be helpful to set a default language.

To do so, add a new variable to LocalSettings.php, just after the require_once line. We set C programming language as an example:

Step 1: downloading

 * Method 1: Manual downloading with snapshot

Click on the snapshot link, also above

Alternatively, click on the extension's Subversion repository. Open each of the 4 file's pages, and download the files by opening and saving the pages behind the download link. Save (or upload) these files into the extensions/SyntaxHighlight_GeSHi directory of your wiki.
 * Method 2: Manual downloading with subversion

Next, go to the GeSHi project site and download the latest stable release. Unpack (and upload) these files into the extensions/SyntaxHighlight_GeSHi/geshi directory of your wiki.

Notes:
 * GeSHi 1.1.2alpha3 does not work with the MediaWiki extension.
 * You need both the MediaWiki extension files and the GeSHi project files from SourceForge to make it work!
 * You can delete the extensions/SyntaxHighlight_GeSHi/geshi/docs directory to save a few megabytes.


 * Method 3: Already bundled with subversion (SVN)

Since r46666, we bundle Geshi into subversion. When downloading via the ExtensionDistributor or directly from SVN, there should already be a "geshi" directory inside your SyntaxHighlight_GeSHi directory. If this is the case then GeSHi is already installed.


 * Method 4: Using an SVN tool

Use an SVN tool to checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/SyntaxHighlight_GeSHi/.

For example using the SVN command-line tool:

This will automatically also download the latest stable version of GeSHi.

Save (or upload) everything into the extensions/SyntaxHighlight_GeSHi directory of your wiki.

Note: You can delete the extensions/SyntaxHighlight_GeSHi/geshi/docs directory and the various .svn directories to save a few megabytes.

You can also use the SVN command-line tool to download the latest stable version without all the .svn directories. This will save you having to find and remove each of them.

Step 2: Installation
Add this line to the end of your LocalSettings.php:


 * GeSHi installation (optional)

If you didn't put GeSHi in the extensions/SyntaxHighlight_GeSHi/geshi directory, then change the following line in SyntaxHighlight_GeSHi.class.php</tt> to suit the path of your geshi.php file

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

Here's a shortcut using the PHP dirname function with the magic __FILE__ constant:

Configuration
If you want the dashed border like for   </tt> tags you have to add them again.

Method 1: CSS file

 * This method requires r52346 or higher of this extension.

Add to MediaWiki:Geshi.css, MediaWiki:Monobook.css or MediaWiki:Common.css pages:

This will give all GeSHi output (except for enclose="none"</tt>) a dashed border almost identical to &lt;pre&gt; in monobook/main.css

Method 2: Inline CSS
You can also edit the SyntaxHighlight_GeSHi.class.php around line 215 (Line 264 in SVN trunk 82481). Look for this: and change it to: On a Unix-like system simply type this command in the directory containing "SyntaxHighlight_GeSHi.class.php": Link to Extension Talk (2008): Extension talk:SyntaxHighlight GeSHi/Archive 2008
 * See also 52346.


 * If you already add the extension to LocalSettings.php before changing this, comment it out via "#" and refresh the page, then remove the # and refresh one more time.

Default DIV Based Rendering
Long strings will cause the page width to blow up when rendered on a web page. The solution to this is to use the enclose="div" tag, this can be enabled by default by editing SyntaxHighlight_GeSHi.class.php near line 156. Look for the following: and append a else case to the if statement:

Bugs and Limitations
You may report bugs by clicking here.