| com.ecyrd.jspwiki.plugin.WikiPlugin
All known Subclasses: com.ecyrd.jspwiki.plugin.IndexPlugin, com.ecyrd.jspwiki.plugin.Denounce, com.ecyrd.jspwiki.plugin.Note, com.ecyrd.jspwiki.plugin.RPCSamplePlugin, com.ecyrd.jspwiki.plugin.TableOfContents, com.ecyrd.jspwiki.plugin.Counter, com.ecyrd.jspwiki.plugin.InsertPage, com.ecyrd.jspwiki.forms.FormElement, com.ecyrd.jspwiki.plugin.ListLocksPlugin, com.ecyrd.jspwiki.plugin.VotePlugin, com.ecyrd.jspwiki.plugin.CurrentTimePlugin, com.ecyrd.jspwiki.plugin.BugReportHandler, com.ecyrd.jspwiki.plugin.AbstractReferralPlugin, com.ecyrd.jspwiki.plugin.RecentChangesPlugin, com.foo.SamplePlugin3, com.ecyrd.jspwiki.plugin.SessionsPlugin, com.ecyrd.jspwiki.plugin.WeblogPlugin, com.ecyrd.jspwiki.plugin.IfPlugin, com.ecyrd.jspwiki.forms.FormSet, com.ecyrd.jspwiki.plugin.ReferredPagesPlugin, com.ecyrd.jspwiki.plugin.Search, com.ecyrd.jspwiki.plugin.Image, com.ecyrd.jspwiki.plugin.Groups, com.ecyrd.jspwiki.plugin.WeblogEntryPlugin, com.ecyrd.jspwiki.plugin.WeblogArchivePlugin, com.ecyrd.jspwiki.plugin.JavaScriptPlugin, com.ecyrd.jspwiki.plugin.SamplePlugin,
| WikiPlugin | | public interface WikiPlugin (Code) | | Defines an interface for plugins. Any instance of a wiki plugin
should implement this interface.
author:
Janne Jalkanen |
| CORE_PLUGINS_RESOURCEBUNDLE | | final static String CORE_PLUGINS_RESOURCEBUNDLE(Code) | | |
| execute | | public String execute(WikiContext context, Map params) throws PluginException(Code) | | This is the main entry point for any plugin. The parameters are parsed,
and a special parameter called "_body" signifies the name of the plugin
body, i.e. the part of the plugin that is not a parameter of
the form "key=value". This has been separated using an empty
line.
Note that it is preferred that the plugin returns
XHTML-compliant HTML (i.e. close all tags, use <br />
instead of <br>, etc.
Parameters:
context - The current WikiContext.
Parameters:
params - A Map which contains key-value pairs. Anyparameter that the user has specified on thewiki page will contain String-Stringparameters, but it is possible that at some future date,JSPWiki will give you other things that are not Strings. HTML, ready to be included into the rendered page.
throws:
PluginException - In case anything goes wrong. |
|
|