SyntaxHighlightingPlugin

Description

The Syntax Highlighting Plugin is used to emphasize the rendering of your wiki text according to several languages.

It uses enscript to render its output.

It supports the following languages :

• ada
• asm
• awk
• bash
• c
• changelog
• c++
• csh
• delphi
• diff
• diffs
• diffu
• elisp
• fortran
• fortran_pp
• haskell
• html
• idl
• inf
• java
• javascript
• ksh
• m4
• mail
• makefile
• maple
• matlab
• modula_2
• nested
• nroff
• objc
• outline
• pascal
• perl
• postscript
• python
• rfc
• scheme
• sh
• skill
• sql
• states
• synopsys
• tcl
• tcsh
• tex
• vba
• verilog
• vhdl
• vrml
• wmlscript
• zsh

Syntax Rules

To use this plugin, use the following syntax:

%CODE{lang="..." [num="10"]}% 
...code...
%ENDCODE%

The language can be any from the above list. The num setting is optional and will set the starting line number.

Using SyntaxHighlightingPlugin With Other Syntax Highlighters

Currently all the Foswiki syntax highlighting plugins use the same %CODE% syntax. This allows you to switch the highlighter you use without having to update all your topics to the new syntax. However, it also means that if you have two or more highlighting plugins installed on your system, the plugin that is first in $Foswiki::cfg{PluginsOrder} (or by default, first alphabetically) will consume all the %CODE% blocks.

Version 1.2 of this plugin added support for using the %CODE_ENSCRIPT% syntax, which allows you to explicitly which plugin you want to highlight your code.

Clearly this is not the best solution to the problem of using more than one highlighting plugin. You can read the background on why this approach was taken in the [Foswikitask:Item1353][task report]].

Examples

The following text :

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

gives (if installed):

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

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

%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% 

gives (if installed):

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

Change of Syntax

This plugin used to use the following syntax (pre September 2008):

%begin sh%
...code...
%end%

This has been changed to be more consistent with other Foswiki variables. There is a script included which will replace the old syntax with the new. To use it, copy it from the tools directory and into your data directory. When you run it, it will look through your webs and replace the syntax. Note that its not the best script in the world, so always test it on a copy of your data first!

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

You should ensure the path to enscript is correctly set in configure before enabling the plugin.

Plugin Files

Plugin Info

Related Topics: DefaultPreferences, SitePreferences, Plugins