Title: Highlight Source Pro
Author: kno
Published: <strong>April 7, 2008</strong>
Last modified: April 10, 2008

---

Search plugins

This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.

![](https://s.w.org/plugins/geopattern-icon/highlight-source-pro.svg)

# Highlight Source Pro

 By [kno](https://profiles.wordpress.org/kno/)

[Download](https://downloads.wordpress.org/plugin/highlight-source-pro.1.3.zip)

 * [Details](https://pcd.wordpress.org/plugins/highlight-source-pro/#description)
 * [Reviews](https://pcd.wordpress.org/plugins/highlight-source-pro/#reviews)
 *  [Installation](https://pcd.wordpress.org/plugins/highlight-source-pro/#installation)
 * [Development](https://pcd.wordpress.org/plugins/highlight-source-pro/#developers)

 [Support](https://wordpress.org/support/plugin/highlight-source-pro/)

## Description

Powerful, flexible, XHTML-compliant, server-side code highlighting, credits for 
everything
 but ‘making it a plugin’ go to [Jay Pipes](http://jpipes.com/index.php?/archives/216-Syntax-Highlighting-and-Allowing-HTML-in-Comments.html)
and [GeSHi](http://geshi.org/).

#### Features

 * Highlight sources of any language
 * automatically, server-side (no javascripts)
 * XHTML-Compliant, `<div>`, `<ul>`, `<span>` with class-attributes and a css-file
   are used for styling
 * optionally add a heading for every code-block
 * optionally specify line-number offset (BREAKS XHTML COMPLIANCE)
 * optionally don’t display line-numbers
 * set per-codeblock if the code is html_entity_encoded or not
 * only parses `<pre>`-tags with the `lang=`-attribute, thus does not interfere 
   with any regular preformatted contents you might have
 * degrades beautifully through `<pre>`-tags (if you keep the sources clean, that
   is)
 * all settings through logical, valid arguments for the main container
 * comes with generic cross-browser CSS (tested: IE5.5+, FF, Safari, Opera)

#### Version History

 * 1.3: Thanks to a tipp now the link-path to the stylesheets is correct, sorry 
   for the inconvenience
 * 1.2: Leading whitespace isn’t stripped anymore (indents as well as newlines),
   when there’s no title the title-div is not being generated anymore
 * 1.1: Solved the issue with single-quotes being changed to typographical quotes

#### Known Issues

While the plugin is basically XHTML 1.0 Strict compliant there’s just no way of 
getting the offset-based line-numbering to display without inadequate (ab)use of
javascript and css hacks, so be warned that _IF you use the line-number offset, 
your documents will **NOT** validate_ because of the forbidden `start=`-attribute
for the `<ol>`!

### Documentation

More on the [Highlight Source Pro Page](http://blog.kno.at/tools/highlight-source-pro/)

## Screenshots

 * [[
 * All-In-One Preview

## Installation

The plugin is simple to install:

 1. Upload the `highlight_source_pro` folder to your `/wp-content/plugins` directory
 2. Enable via Admin-Interface

#### How to Use

Set your code-blocks as `<pre>`-tags. If the language is supported by GeSHi (see
file list in the `/geshi-directory`) use the filename (without extension) as language-
attribute. If your code is encoded (html-entities; e.g. `<` is displayed as `&lt;`–
most likely the case if you write in the visual editor) add the `enc__`-prefix. 
For example for a php-codeblock you would start as follows:

    ```
    <pre lang="php">
    ```

You can control various things:
 * Start of Line-Offset, e.g. for #17: `<pre class
="17">` * define entity-encoded blocks, e.g. for php: `<pre lang="enc__php">` * 
Define a title for your code-block that appears inside the block, but above the 
code lines. Everything in the same line as the opening `<pre>` tag will be considered
the title, including HTML works fine:

    ```
            <pre lang="php"><strong>This is</strong> an <em>example</em> with a <h3>headline</h3>
    ```

* disable line numbers by not specifying an offset
 * combine all those things as
long as you stick to the right order:

## FAQ

  I use Self-Formatted Markup in older posts, what’s gonna happen?

As long as they aren’t wrapped in `<pre>`-tags _with a `lang=`-attribute_ nothing
is going to happen – your markup will stay untouched. Highlight Source Pro only 
hooks in for those `<pre>`-tags having a `lang=`-attribute.

  What about that class-abuse for line numbering???

The line-numbering is the one problem here, because – currently – it requires to
break with the XHTML-Standard. Because the `<ol>` is always and guaranteed inside
a `<div>` with the `.geshi`-class there is no need for the `class`-attribute on 
the list element. Also due to the fact that a CSS-classname is not allowed to start
with a number, this solution is valid XHTML for downgrading and _can never interfere
with existing CSS-rules_.

  I can use all HTML for the title-line?

Yep. The basic idea is, once again, backwards compatibility. If you consider your
code-blocks being important you’ll most likely want to add a heading instead of 
just a line, on the other hand you can simply use the title-feature to show which
file is being talked about. Since the title-string will be placed inside a `<div
>` you’ll be fine as long as there’s no line-break (and your markup is valid)

  What about that html_entity_decode thing and the enc__ – prefix??

There’s two ways of handling code-listing in your original post source. You can 
either use the HTML-input and hardcode PHP, C or whatever you think about, statements
in there, Highlight Source Pro will handle those listings without any problems (
in fact, it’s the safer version to use for Highlighting as all characters are present
in their original form).

On the other hand this will get problematic if – for any reason – you stop using
Highlight Source Pro, because WordPress (and every other serious software) will 
strip lots of those listings for security and compatibility reasons. If you want
to be sure that your listings don’t break when moving to another platform you should
consider using htmlentities() on your listings, or writing them with the Visual 
Editor in the first place, so when falling back everything will be displayed as 
you want.

In this case you’ll have to use the `enc__`-prefix to tell Highlight Source Pro 
to apply `html_entity_decode()` before the actual syntax-highlighting. While this
might be the more _default_ case it’s still the one requiring the alteration with
the prefix, for compatibility reasons. If encoded scripts would be marked with the
original language-signature and the source would later on be used in another GeSHi-
environment things would get very, very complicated and confusing.

## Reviews

There are no reviews for this plugin.

## Contributors & Developers

“Highlight Source Pro” is open source software. The following people have contributed
to this plugin.

Contributors

 *   [ kno ](https://profiles.wordpress.org/kno/)

[Translate “Highlight Source Pro” into your language.](https://translate.wordpress.org/projects/wp-plugins/highlight-source-pro)

### Interested in development?

[Browse the code](https://plugins.trac.wordpress.org/browser/highlight-source-pro/),
check out the [SVN repository](https://plugins.svn.wordpress.org/highlight-source-pro/),
or subscribe to the [development log](https://plugins.trac.wordpress.org/log/highlight-source-pro/)
by [RSS](https://plugins.trac.wordpress.org/log/highlight-source-pro/?limit=100&mode=stop_on_copy&format=rss).

## Meta

 *  Version **1.3**
 *  Last updated **18 years ago**
 *  Active installations **30+**
 *  WordPress version ** 2.3 or higher **
 *  Tested up to **2.5**
 *  Language
 * [English (US)](https://wordpress.org/plugins/highlight-source-pro/)
 * Tags
 * [code](https://pcd.wordpress.org/plugins/tags/code/)[Highlight](https://pcd.wordpress.org/plugins/tags/highlight/)
   [markup](https://pcd.wordpress.org/plugins/tags/markup/)[source](https://pcd.wordpress.org/plugins/tags/source/)
   [syntax](https://pcd.wordpress.org/plugins/tags/syntax/)
 *  [Advanced View](https://pcd.wordpress.org/plugins/highlight-source-pro/advanced/)

## Ratings

No reviews have been submitted yet.

[Add my review](https://wordpress.org/support/plugin/highlight-source-pro/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/highlight-source-pro/reviews/)

## Contributors

 *   [ kno ](https://profiles.wordpress.org/kno/)

## Support

Got something to say? Need help?

 [View support forum](https://wordpress.org/support/plugin/highlight-source-pro/)

## Donate

Would you like to support the advancement of this plugin?

 [ Donate to this plugin ](http://tinyurl.com/3mjxz2)