syntaxhighlighter Follow @yiiframework

SyntaxHighlighter component for Yii framework.

This application component wraps SyntaxHighlighter by Alex Gorbatchev

Install ¶

Unpack extension into a directory of your choice, the extensions directory would be a good choice.

Add to config/main.php:

'components' => array(
            'syntaxhighlighter' => array(
                'class' => 'ext.JMSyntaxHighlighter.JMSyntaxHighlighter',
            ),
            ...
    ),

If you want a theme other than the default:

'components' => array(
            'syntaxhighlighter' => array(
                'class' => 'ext.JMSyntaxHighlighter.JMSyntaxHighlighter',
                'theme' => 'Django',
            ),
            ...
    ),

You can choose from the following themes:

Default (the default if none provided)
Django
Eclipse
Emacs
FadeToGrey
MDUltra
Midnight
RDark

Usage ¶

Insert this code where you want the syntaxhighlighter script to be:

<?php Yii::app()->syntaxhighlighter->addHighlighter(); ?>

This could be in your main layout, but it's up to you.

The script will highlight any pre tag having the "brush" class:

<pre class="brush : php">
function Hello($world) {
    echo 'Hello ' . $world;
}
</pre>

Available brushes are:

    _Brush_                 :   _Language_
    applescript             :   AppleScript
    actionscript3 as3       :   AS3
    bash shell              :   Bash
    coldfusion cf           :   ColdFusion
    cpp c                   :   Cpp
    c# c-sharp csharp       :   CSharp
    css                     :   Css
    delphi pascal           :   Delphi
    diff patch pas          :   Diff
    erl erlang              :   Erlang
    groovy                  :   Groovy
    java                    :   Java
    jfx javafx              :   JavaFX
    js jscript javascript   :   JScript
    perl pl                 :   Perl
    php                     :   Php
    text plain              :   Plain
    py python               :   Python
    ruby rails ror rb       :   Ruby
    sass scss               :   Sass
    scala                   :   Scala
    sql                     :   Sql
    vb vbnet                :   Vb
    xml xhtml xslt html     :   Xml

For example, to highlight a bash script, you can use either bash or shell:

<pre class="brush : shell">...</pre>

This component makes use of the SyntaxHighlighter autoload feature, so that only the brushes used are actually loaded into the page.

Tricks ¶

TinyMCE is great, but it does not want to leave the <pre> tags alone! Don't worry, there's a solution to this problem: Grab and install the Wysiwyg Pre Element Fix and enjoy! :) Just in case: the Pre Element Fix has been attached to this page as well.

Resources ¶

• Forum Topic
• SyntaxHighlighter