wiki:WikiStart
Last modified 6 years ago Last modified on 08/23/08 10:08:19

sfSyntaxHighlighter plugin

The sfSyntaxHighlighterPlugin adds automatically the javascript code needed to use the SyntaxHighlighter javascript library.

After installation, you will only need to enable the sfSyntaxHighlighterFilter in the applications you want.

Installation

1. Install the plugin

    symfony plugin-install http://plugins.symfony-project.com/sfSyntaxHighlighterPlugin

2. Modify the filters.yml file of the application to enable the filter so that the plugin can add the Javascript code at the bottom of every page.

    # generally, you will want to insert your own filters here
    sf_syntax_highlighter_plugin:
        class: sfSyntaxHighlighterFilter

3. Clear the cache

    symfony cc

SyntaxHighlighter?'s basic usage

You can find the official documentation of the SyntaxHighlighter library in "usage" section of their wiki.

Highlighting code

Place your code on the page and surround it with <pre> tag. Set name attribute to code and class attribute to one of the language aliases you wish to use.

    &lt;pre name=&quot;code&quot; class=&quot;c-sharp&quot;&gt;
        ... some code here ...
    &lt;/pre&gt;

SyntaxHighlighter? version

This plugin uses version 1.5.1 of SyntaxHighlighter.

Supported Highlighting Brushes

These are the currently supported highlighting brushes. The different aliases for every brush are between parenthesis.

  • ActionScript? 3.0 ('as','actionscript','ActionScript?','as3','AS3')
  • C++ ('cpp','c','c++')
  • C# ('c#','c-sharp','csharp')
  • CSS ('css')
  • Delphi ('delphi','pascal')
  • Java ('java')
  • JavaScript? ('js','jscript','javascript')
  • PHP ('php')
  • Python ('py','python')
  • Ruby ('ruby','rails','ror')
  • SQL ('sql')
  • Visual Basic ('vb','vb.net')
  • XML ('xml','xhtml','xslt','html','xhtml')