org.ceryle.wiki.plugin.about
Class AboutPlugin

java.lang.Object
  extended by org.ceryle.wiki.plugin.about.AboutPlugin
All Implemented Interfaces:
WikiPlugin
Direct Known Subclasses:
About

public class AboutPlugin
extends Object
implements WikiPlugin

A query plugin that provides a standard query for its parent wiki page.

Parameters:

page='pagename'
The optional wiki page name to query. When absent uses the current page.

This provides a query on assertions containing the specified page name in the page name, subject and/or object parts of an assertion, as well as a display of its tree if it is part of one.

Author:
Murray Altheim

Field Summary
static String CLASS_ABOUT
          View anchor class attribute value for the 'about' output message.
static String CLASS_TREE
          View anchor class attribute value for the 'tree' output message.
static String PARAM_PAGE
           
 
Fields inherited from interface com.ecyrd.jspwiki.plugin.WikiPlugin
CORE_PLUGINS_RESOURCEBUNDLE
 
Constructor Summary
AboutPlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_ABOUT

public static String CLASS_ABOUT
View anchor class attribute value for the 'about' output message. The default value is "about".


CLASS_TREE

public static String CLASS_TREE
View anchor class attribute value for the 'tree' output message. The default value is "tree".


PARAM_PAGE

public static final String PARAM_PAGE
See Also:
Constant Field Values
Constructor Detail

AboutPlugin

public AboutPlugin()
Method Detail

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException
Specified by:
execute in interface WikiPlugin
Throws:
PluginException


The Ceryle Project. Copyright ©2001-2007 Murray Altheim, All Rights Reserved. See LICENSE included with distribution.