Class IndexPlugin

java.lang.Object
org.apache.wiki.plugin.AbstractReferralPlugin
org.apache.wiki.plugin.IndexPlugin
All Implemented Interfaces:
Plugin

public class IndexPlugin
extends AbstractReferralPlugin
implements Plugin
A Plugin that creates an index of pages according to a certain pattern.
The default is to include all pages.

This is a rewrite of the earlier JSPWiki IndexPlugin using JDOM2. 8

Parameters (from AbstractReferralPlugin):

  • include - A regexp pattern for marking which pages should be included.
  • exclude - A regexp pattern for marking which pages should be excluded.
  • Constructor Details

  • Method Details

    • execute

      public java.lang.String execute​(Context context, java.util.Map<java.lang.String,​java.lang.String> params) throws PluginException
      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.

      Specified by:
      execute in interface Plugin
      Parameters:
      context - The current WikiContext.
      params - A Map which contains key-value pairs. Any parameter that the user has specified on the wiki page will contain String-String parameters, but it is possible that at some future date, JSPWiki will give you other things that are not Strings.
      Returns:
      HTML, ready to be included into the rendered page.
      Throws:
      PluginException - In case anything goes wrong.