Syntax Highlighting Plugin

Page contents

• Introduction
• Supported languages
• Syntax Rules
  • CODE Parameters
• Examples
• Plugin Installation & Configuration
• Plugin Info

Introduction

The Syntax Highlighting Plugin is used to emphasize the rendering of your wiki text according to several languages. It currently uses enscript to render its output.

Supported languages

Recent versions of enscript support highlighting of the following languages:

ada, asm, awk, bash, c, changelog, cpp, csh, delphi, diff, diffs, diffu, dylan, eiffel, elisp, forth, fortran, fortran_pp, haskell, html, icon, idl, inf, java, javascript, ksh, lua, m4, mail, makefile, matlab, nroff, oberon2, objc, outline, oz, pascal, perl, php, postscript, pyrex, python, rfc, ruby, scheme, sh, skill, smalltalk, sml, sql, states, synopsys, tcl, tcsh, tex, vba, verilog, vhdl, vrml, wmlscript, zsh

You need to installed and enabled the SyntaxHighlightingPlugin to see the actual languages that are available.

Additional languages can be added, see genscript documentation.

Syntax Rules

To use this plugin, use the following syntax:

<sticky>
%CODE{ lang="cpp" num="10" numstep="2" }% 
...code...
%ENDCODE%
</sticky>

The <sticky> tags are required to prevent TWiki's WYSIWYG editor from removing line breaks inside the code block.

In addition, %SYNTAXHIGHLIGHTING{supported}% returns the list of currently supported languages as indicated above.

CODE Parameters

Parameter	Description	Default
step="..."	Increment line numbers with the given step. Negative numbers will decrement.	"1"
num="..."	Show line numbers next to the source code. An integer indicates the start number. Also "on" and "off"	"off"
"..." or lang="..."	Source language. Supported languages: ada, asm, awk, bash, changelog, cpp, csh, c, delphi, diffs, diff, diffu, dylan, eiffel, elisp, Name:, forth, fortran_pp, fortran, haskell, html, icon, idl, inf, javascript, java, ksh, lua, m4, mail, makefile, matlab, nroff, oberon2, objc, outline, oz, pascal, perl, php, postscript, pyrex, python, rfc, ruby, scheme, sh, skill, Smalltalk, sml, sql, states, synopsys, tcl, tcsh, tex, vba, verilog, vhdl, vrml, wmlscript, zsh	(none, required)
numstyle="..."	Style of line number column	light brown box
style="..."	Style of box around the source code	light gray box

Note: The default can be set in configure

Examples

The following text:

 
<sticky>
%CODE{"c++"}%
#include <iostream>
int main()
{
  // Hello world example
  std::cout << "Hello, world." << std::endl;
}
%ENDCODE%
</sticky>

gives (if installed):

BeautifierPlugin Error: Unable to handle "c++" language.

#include 
int main()
{
  // Hello world example
  std::cout << "Hello, world." << std::endl;
}

You can also output numbered lines starting at 10 with this text:

<sticky>
%CODE{"sh" num="10"}% 
#!/bin/sh
languages=`enscript --help-highlight | grep 'Name:' | cut -d ' ' -f 2`
for l in $languages; do
    cat << EOF
   * $l
EOF
done
%ENDCODE% 
</sticky>

gives (if installed):

BeautifierPlugin Error: Unable to handle "sh" language.

#!/bin/sh
languages=`enscript --help-highlight | grep 'Name:' | cut -d ' ' -f 2`
for l in $languages; do
    cat << EOF
   * $l
EOF
done

Plugin Installation & Configuration

Show details Hide details

Plugin Info

Plugin Author:	TWiki:Main.AndrewRJones
Previous Authors:	TWiki:Main.NicolasTisserand, TWiki:Main.NicolasBurrus, Perceval Anichini
Copyright:	© 2002-2016 Peter Thoeny, TWiki.org © 2002-2016 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2016-01-22

Show Change History Hide Change History

2019-12-04:	TWikibug:Item7873: unescaped braces in regex are escaped.
2016-01-22:	TWikibug:Item7708: Switch to GPL 3; copyright update to 2016
2014-03-26:	TWikibug:Item7470: SyntaxHighlightingPlugin may fail to recognize enscript supporting languages
2013-12-11:	TWikibug:Item7399: Auto-detect supported languages -- TWiki:Main.PeterThoeny
2013-04-04:	TWikibug:Item7211: Add Scala support -- TWiki:Main.HideyoImazu
2013-02-14:	TWikibug:Item7091: Show source code of undefined or unsupported language, but warn user; use configure settings for defaults; rename numstep parameter to step & make numstep undocumented; add VarCODE variable documentation -- TWiki:Main.PeterThoeny
2013-02-13:	TWikibug:Item7091: Add style and numstyle parameters -- TWiki:Main.PeterThoeny
2013-02-13:	TWikibug:Item7123: Use TWISTY in installation instructions and change history
2012-11-15:	TWikibug:Item7035: Number step support -- TWiki:Main.YaojunFei
2011-05-14:	TWikibug:Item6701: Small fix in Config.spec -- TWiki:Main.PeterThoeny
2010-10-23:	TWikibug:Item6530: Doc improvements - TWiki:Main.PeterThoeny, TWiki:Main.AndreasKeil
2008-09-11:	TWikibug:Item5995: Rewritten to work on TWiki 4.2
2002-07-12:	Initial version

TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
Dependencies:	enscript >= 1.6.3, CPAN:IPC::Run
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/SyntaxHighlightingPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/SyntaxHighlightingPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/SyntaxHighlightingPluginAppraisal

Related Topics: VarCODE, TWikiPreferences, TWikiPlugins