Syntax Highlighting TWiki Plugin

The Syntax Highlighting Twiki Plugin is used to emphasize the rendering of your twiki text according to several types of source code languages.

It currently uses enscript to render its output. enscript could handle and render a lot of languages. For a detailed information please read the manual of enscript. You can add your personal code templates by extending the enscript styles. As default there are files like style_xyz.st (e.g. styles_emacs.st). Make a copy and rewrite the output formatting. You can use this later on as the style parameter when calling SyntaxHighlightingPlugin.

To make it easy for people who are using TWiki:Plugins.BeautifierPlugin or TWiki:Plugins.SourceHighlightPlugin there is an option set so that this plugin could also handle %CODE{}% blocks.

Normally enscript will support at least following languages : show listhide list

Syntax Rules

To enable syntax highlighting on some text, just type :

%SYNTAX{ [syntax=]"syntax type" numbered="bool|start with line number" numstep="inc line number" color="bool" style="enscript style"}% 
    some text belonging to the source code
%ENDSYNTAX%

If running this plugin in EXTENDED_MODE it is compatible to TWiki:Plugins.Beautifierplugin, TWiki:Plugins.SourceHighlightPlugin:

%CODE{ "syntax type" }% 
    some text belonging to the source code
%ENDCODE%

The additional option parameters are also available in this mode.

Example

The following text :

%SYNTAX{ syntax="cpp" }% 
#include <iostream>
int main()
{
  std::cout << "Hello, world." << std::endl;
}
%ENDSYNTAX%

gives :

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

If you do not see a nice colorized piece of code above this, you should check if the plugin is well installed.

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

%SYNTAX{ syntax="sh" numbered="1000" numstep="10" }%
#!/bin/sh
list_syntax=`enscript --help-highlight | grep 'Name:' | cut -d ' ' -f 2`
for l in $list_syntax; do
    cat << EOF
   * $l
EOF
done
%ENDSYNTAX%

which outputs:

01000	#!/bin/sh
01010	list_syntax=`enscript --help-highlight | grep 'Name:' | cut -d ' ' -f 2`
01020	for l in $list_syntax; do
01030	    cat << EOF
01040	   * $l
01050	EOF
01060	done

SyntaxHighlightingPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %DEFAULTPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This Plugin is used to emphasize the rendering of your twiki text according to several types of source code languages.

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• Extended Mode to be compatible to other plugins
  • Set EXTENDED_MODE = 1

• Enscript settings
  • Set ENSCRIPT_COLOR = 1
  • Set ENSCRIPT_STYLE = emacs

• Format settings

        * Set FORMAT_LINENUMBERS = <font color="#555555">%05d</font>&#9;
        * Set FORMAT_PREPEND = <table width="100%" border="0" cellpadding="" cellspacing="0"><tr><td bgcolor="#FFFFFF"><pre><font color="#000000">
        * Set FORMAT_APPEND = </font></pre></td></tr></table>
        

Plugin Installation Instructions

• Make sure you have GNU enscript 1.6.3 or above installed.

• Unzip the SyntaxHighlighting.zip package in your TWiki installation directory.

• If the installation is correct, you should see some highlighted text in this page.

• If you want support for additional languages you only have to take care, that your local enscript will support them.

Things to do

• Plugin should use lib/TWiki/Sandbox.pm sysCommand than IPC:Open2

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins, EmptyPlugin

-- TWiki:Main.ThomasFreudenberg - 24 Nov 2006