Source Highlighting Plugin

Syntax Rules

• lang - Specify the code language to highlight; use the language's extension (defaults to r).
• bgcolor - Specify the backround color (defaults to light blue).
• keywords - Specify additional keywords (quoted and semicolon delimited) to highlight. (ex: keywords="upData;radFunction")

Available Languages

Example

<highlight>
a<-function(data) {
   plot(data)
}
</highlight>

a<-function(data) {
   plot(data)
}

<highlight bgcolor=#cccccc lang=py keywords="write;xreadlines">
#!/usr/bin/python
# this script replaces all occurrences of char old with char new
import os, sys
old='\n'
new=' '
file='~/names.txt'
input=open(file)
output=open(file+'.new','w')
for s in input.xreadlines():
    output.write(s.replace(old,new))
output.close()
input.close()
</highlight>

SourceHighlightingPlugin Global Settings

• One line description, shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = This plugin highlights source code.

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

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip SourceHighlightingPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/SourceHighlightingPlugin.txt	Plugin topic
  data/TWiki/SourceHighlightingPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/SourceHighlightingPlugin.pm	Plugin Perl module

• Test if the plugin is correctly installed:
  • (describe tests here)

Plugin Info