A long, long time ago I wrote a small extension to JSPWiki (which is still my favourite Wiki, by the way). It happened in 2009, and I even mentioned it it here on my blog! Contrary to what I promised, I never wrote any instructions. Luckily, there isn’t much to say in terms of instructions: the plugin just gives you a bit of control over how to display the list of Wiki-wide InterWikiLinks.
- A JSPWiki plugin is just a Java class that implements the com.ecyrd.jspwiki.plugin.WikiPlugin interface and can be found through your class path. That makes adding a plugin pretty simple, if you are somewhat familiar with Java. And remember that the InterWikiLinks plugin has been integrated in the standard JSPWiki distributions starting with 2.8.4.
- Using the InterWikiLinks plugin in a Wikipage is simple as well. Adding the following text to the source of your Wikipage explains the full syntax of the plugin:
[{INSERT InterWikiLinksPlugin WHERE type='text', tabletitle='Your preferred title', separator=', ' }]
This will render all your InterWiki links as a simple list of links, separated by commas, and preceded by a title. The ‘type’ parameter can take four values: ‘text‘ is the default; ‘ulist‘ creates an unordered (bulleted) list; ‘olist‘ will render the links as an ordered (numbered) list; and ‘table‘ will create an HTML table. The ‘separator’ parameter can take any HTML markup you want – as long as it makes sense in the context of the display of a list of items, of course.
Just know that I have only used and tested it with the 2.8 releases of JSPWiki. Here’s a simple example of how to use it: In the SystemInfo page, replace the default overview (using a WikiVariable) with
| __Available InterWiki links__ | [{ InterWikiLinksPlugin }]
Anyway, what I wanted to note here today is that I have finally uploaded my original version of the source code to a public repository: https://www.pikacode.com/nukleos/InterWikiLinks/. So if you want to use this plugin with a JSPWiki instance that does not have it included, you know where to find the source code.
Advertisements
