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 2.2 kB 2 04-Oct-2006 16:25 Sothach
checker.bmp 5.8 kB 1 05-Oct-2006 10:30 Sothach
colorcode-plugin-src.jar 14.2 kB 5 05-Oct-2006 13:08 Sothach
colorcode-plugin.jar 13.2 kB 4 16-Jan-2007 10:51 Sothach
colorcode_eg.bmp 30.1 kB 1 29-Sep-2006 15:06 Sothach
colorcode_eg2.bmp 398.8 kB 1 29-Sep-2006 15:15 Sothach
properties 1.9 kB 2 04-Oct-2006 16:25 Sothach
project1.dtd 0.7 kB 1 09-Oct-2011 16:43
project1.xml 5.4 kB 1 09-Oct-2011 16:43
properties 2.2 kB 2 04-Oct-2006 16:25 Sothach
properties 1.9 kB 2 04-Oct-2006 16:25 Sothach

This page (revision-85) was last changed on 22-May-2012 17:56 by  

This page was created on 29-Sep-2006 14:22 by Sothach

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Difference between version and

At line 1 changed 4 lines
!!Color Code Plugin
By [RoyPhillips]
This plugin implements the {{[WikiPlugin|JSPWikiPlugin]}} interface,
This plugin implements the {{~WikiPlugin}} interface,
At line 19 changed one line
classpath, for example, a file {{[WEB-INF/classes/|ColorCodePluginExamplesSQL}}, and use the properties in it to format the text
classpath, for example, a [properties file|ColorCodePluginProperties], and use the properties in it to format the text.
At line 21 changed one line
Alternatively, the configuration can be specified as immeidate parameters to the Plugin, as in this cheap-and-cheerful XML example:
At line 21 added 13 lines
*Could someone write here a short example where to actually put .properties file. Can't get this working.
;:--Juhani, 26-Oct-2006
[Short Properties file example|ColorCodePlugin_egproperties] -- contents & location
These properties define how (color, bold, italic) each element, such as keywords will be rendered, as well as listing the keywords and optionally, 'special' patterns in the text (see XML example below). Using the settings distributed, the example renders:
[{Image src='colorcode_eg.bmp' width='99%;' }]
Alternatively, the configuration can be specified as immediate parameters to the Plugin, as in this cheap-and-cheerful XML example:
At line 26 changed one line
At line 30 changed one line
(xml document)
(...xml document here...)
At line 44 added one line
[{Image src='colorcode_eg2.bmp' width='99%;' }]
At line 46 added 23 lines
!The Specials
As well as the predefined categories of token, {{keyword, normal, string, number, symbol}}, the properties file may define any number of 'special' token classes. In the example above, the property {{colorcode.special.__tag__.pattern}} defined the pattern by which the special token class ''tag'' could be recognized. Otherwise 'normal' tokens that match this regular expression will be rendered according to the default special font properties, unless explictly specified by a matching {{colorcode.special.__tag__.font.color}} etc. definition.
See [] for an example of definining more than one class of special token. Notice that the ~StreamTokenizer has to be programmed to accept any non-alphabetic characters that form part of a special token, by including them in the {{tokenizer.ordinaryChar}} and {{tokenizer.wordChar}} properties.
(sorry, that should have read __Installing__)
*Download the [distribution jar|colorcode-plugin.jar] into the local {{JSPWiki/WEB-INF/lib}} directory.
*Either invoke with full package name, or add to {{JSPWiki/WEB-INF/}} plugin search path:
;:{{jspwiki.plugin.searchPath = ...,lu.intrasoft.jspwiki.plugin, ...}}
*Unpack the [source jar|colorcode-plugin-src.jar] into some convenient directory
*Edit the {{}} file to set the local webserver path
** E.g., {{webserver.dir=C:/Program Files/Apache Software Foundation/Tomcat 5.5}}
*Run the ant task {{deploy}}
|[|]|Simple {{[WikiPlugin|JSPWikiPlugin]}} implemenation
|[|]|Non-plugin specific code to render text as HTML (the guts of this thing)
|[|]|A {{~StreamTokenizer}} subclass that configures it's options from provided properties
At line 35 changed one line
[<< Back to Contributed Plugins|ContributedPlugins]
do NOT forget to include the blank line between the syntax and your code! (wont work without)\\
are there any pre-defined .properties for other languages?
--Max, 03-Oct-2006
Currently, the pre-defined .properties include:
|[SQL|]|SQL syntax highlighting (Oracle flavor)
|[C/C++|]|C & C++ -- full C++ '98 keyword set
|[Java|]|Works, but nowhere near as nice as [Java2HtmlPlugin]
|[Velocity|]|Velocity template file highlighing
The XML example above could easily be converted to a properties file, as well. It's easy enough to create one for a different syntax - I have used inline definitions for emails, bash scripts, etc., that don't occur often enough for a formal properties file.
--Roy, 03-Oct-2006
Fixed the special pattern matching to respect the '^' start-of-line anchor, making it easier to describe syntaxes such as Java {{.properties}} files:
__{{colorcode.special.variable.pattern='^~[a-zA-Z0-9 /~\~\.-~]+'}}__\\
{{colorcode.special.comment.pattern='^#~[ -~]+'}}\\
{{tokenizer.ordinaryChar: '#,/,.,},{,.,0x20,0x2C'}}\\
{{tokenizer.wordChar: '#,/,.,},{,.,0x20,0x2C'}}\\
--Roy, 05-Oct-2006
Hi Roy... nice. And a rather compact little beastie, for anyone who care to look at the code and design of the plugin -
One thing: some control over font-size would be nice... the HTML prologue/ epilogues currently come from hardcoded constants, and specify explicit sizes which would tend to override CSS?
We did manage to get past this - CSS style on 'code' tag, and use !important for the font-size specification. (thanks Phil Duhs for this tip)
My preference for code snippets, is definitely *smaller* rather than *large print*. We run a development shop here not a, ahem, remedial reading course :)
--Thomas Whitmore, 11-Jan-2007
Thanks for the comments, Thomas, I have added a new way of specifying markup styles in this plugin using spans/css classes (thanks to Damien French for the use case & testing). It works like this:
Set the parameter {{spans}} to 'true' ({{ColorCodePlugin spans='true'}}), and it will insert spans with class set to the 2nd part of the property for the type of token, so if it's a symbol (property 'colorcode.symbol') it'll get class='symbol'. An external css can then define the appearance of that element.
The built-in classes are : normal, keyword, symbol, string, number, comment, and 'specials' defined will get the user-defined part used as the class name, so "" will generate class="email"
Does that help in your case?
-- Roy, 16-Jan-2007
Has anyone done a properties file for python syntax? Thanks.
-- Mariano, 27-Aug-2010
[<< Back to Contributed Plugins|ContributedPlugins]
Version Date Modified Size Author Changes ... Change note
85 22-May-2012 17:56 6.691 kB to previous
84 22-May-2012 16:19 6.464 kB to previous | to last
83 05-Feb-2011 10:49 6.691 kB Harry Metske to previous | to last removed spam
82 04-Feb-2011 16:08 6.755 kB SamuelWilson to previous | to last
81 27-Aug-2010 16:46 6.691 kB AnonymousCoward to previous | to last
« This page (revision-85) was last changed on 22-May-2012 17:56 by