This is version . It is not the current version, and thus it cannot be edited.
[Back to current version]   [Restore this version]

Color Code Plugin#

By RoyPhillips

Overview#

This plugin implements the WikiPlugin interface, providing an execute implemenation that renders the body text as colorized source code, according to either a named syntax parameter, and/or parameter values provided at the plugin's point of invocation. Example:
[{ColorCodePlugin syntax='sql'
 
select count(*) from dual
}]

Renders as:

The above example will attempt to load a resource named 'sql' from the webapps classpath, for example, a properties file, and use the properties in it to format the text. These properties define how (color, bold, italic) each element, such as keywords will be rendered, as well as listing the keywords and optional, 'special' patterns in the text (see XML example below).

Alternatively, the configuration can be specified as immediate parameters to the Plugin, as in this cheap-and-cheerful XML example:

[{ColorCodePlugin 
                  colorcode.keywords='version,encoding,!doctype,public,xml'
                  colorcode.special.pattern='<[/]?[a-z_-]+>'
                  tokenizer.wordChar: '.,-,/,!,<,>'
                  tokenizer.ordinaryChar: '<,>'

(...xml document here...)
}]

Installing#

  • Download the distribution jar into the local JSPWiki/WEB-INF/lib directory.
  • Either invoke with full package name, or add to JSPWiki/WEB-INF/jspwiki.properties plugin search path:
jspwiki.plugin.searchPath = ...,lu.intrasoft.jspwiki.plugin, ...

Implementation#

ColorCodePlugin.javaSimple WikiPlugin implemenation
ColorCodeHTML.javaNon-plugin specific code to render text as HTML (the guts of this thing)
SyntaxTokenizer.javaA StreamTokenizer subclass that configures it's options from provided properties

Back

Add new attachment

Only authorized users are allowed to upload new attachments.

List of attachments

Kind Attachment Name Size Version Date Modified Author Change note
properties
c.properties 2.2 kB 2 04-Oct-2006 16:25 Sothach
bmp
checker.bmp 5.8 kB 1 05-Oct-2006 10:30 Sothach
jar
colorcode-plugin-src.jar 14.2 kB 5 05-Oct-2006 13:08 Sothach
jar
colorcode-plugin.jar 13.2 kB 4 16-Jan-2007 10:51 Sothach
bmp
colorcode_eg.bmp 30.1 kB 1 29-Sep-2006 15:06 Sothach
bmp
colorcode_eg2.bmp 398.8 kB 1 29-Sep-2006 15:15 Sothach
properties
java.properties 1.9 kB 2 04-Oct-2006 16:25 Sothach
dtd
project1.dtd 0.7 kB 1 09-Oct-2011 16:43 71.178.151.165
xml
project1.xml 5.4 kB 1 09-Oct-2011 16:43 71.178.151.165
properties
sql.properties 2.2 kB 2 04-Oct-2006 16:25 Sothach
properties
vm.properties 1.9 kB 2 04-Oct-2006 16:25 Sothach
« This particular version was published on 29-Sep-2006 15:09 by Sothach.