The HelloWorldPlugin (or just "HelloWorld" in use) is a CeryleWikiPlugin that provides a bit more than a minimal 'Hello World' plugin, providing a core set of features (such as parameter handling and authentication checking) as a demo and beginning point for plugin development.

Parameters#

  • debug = 'true' | 'false' . When true, displays debugging level information. Defaults to false.
  • text = 'content' . An optional parameter to provide alternate "Hello World" text to the plugin.
No external dependencies (other than JSPWiki).


Tests#

(NOTE: these tests may fail if the plugin has not been installed.)

[{HelloWorld}]

Plugin insertion failed: Could not find plugin HelloWorldPlugin insertion failed: Could not find plugin HelloWorld

[{HelloWorld debug='true' text='Bonjour tout le monde!' 

this content is in the body. }]

Plugin insertion failed: Could not find plugin HelloWorldPlugin insertion failed: Could not find plugin HelloWorld


Notes#

  • Note that plugin invocation occurs more than once per page view, as plugins get parsed and invoked during permission checks and other calls for the page's HTML content. This in itself isn't a problem, but you should know that the plugin's execute() method gets called multiple times per page view, which whatever impact that may have.
  • The plugin body is returned as a null unless it is separated from the first (parameter) line by at least one line of whitespace. This is a bug I thought fixed; apparently not.

Comments#

  • Could not get this plugin to work. Try the SayHello plugin.

Well, that's not particularly helpful. You've not provided any reason or description of the problem. It's literally just about the easiest plugin there can be, so if you can't get it to work it's not been installed correctly — this has nothing to do with a problem with the plugin. The plugin needs to be compiled correctly and its jar file put in the correct place ($WIKI_HOME/WEB-INF/lib/), and the searchPath property of the jspwiki.properties file must be modified to include the package designation (i.e., org.ceryle.wiki.plugin). This is the same as with any plugin. Also note that the HelloWorldPlugin is not installed on jspwiki.org. -- MurrayAltheim, 14 Aug 2007

Ben O'Regan I managed to get this plugin to work on my Windows Vista PC using the following installation procedure:

  • 1. Install and test JSPWiki application in the usual way.
  • 2. Download the source files for JSPWiki application & unpack.
  • 3. In the source files there is a directory 'JSPWiki-2.8.4\src\org\'. In this directory, create the subdirectory 'ceryle\wiki\plugin'
  • 4. Copy the HelloWorld.java file into the new above directory.
  • 5. Built the complete JSPWiki application with Ant (refer to http://www.jspwiki.org/wiki/BuildingJSPWiki to tell you how to do this step).
  • 6. All the executable code for the new plugin seems to be included in 'JSPWiki-2.8.4\build\JSPWiki\WEB-INF\lib\JSPWiki.jar'. Copy this new JSPWiki.jar file over the existing file of the same name in the pre-existing functining JSPWiki application.
  • 7. Edit the search path by inserting the line 'jspwiki.plugin.searchPath = org.ceryle.wiki.plugin' into the JSPWiki.properties file in my pre-existing functioning JSPWiki application. I also commented out the searchpath that was already there.
  • 8. Stop the Apache Tomcat service then restarted it again (you have to do this).
  • 9. Test the plugin.

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
java
HelloWorld.java 5.9 kB 2 06-Jun-2012 14:39 149.77.162.163
« This page (revision-7) was last changed on 24-Aug-2011 22:23 by Ben