Class TableOfContents

java.lang.Object
org.apache.wiki.plugin.TableOfContents
All Implemented Interfaces:
Plugin, HeadingListener

public class TableOfContents extends Object implements Plugin, HeadingListener
Provides a table of contents.

Parameters :

  • title - The title of the table of contents.
  • numbered - if true, generates automatically numbers for the headings.
  • start - If using a numbered list, sets the start number.
  • prefix - If using a numbered list, sets the prefix used for the list.
Since:
2.2
  • Field Details

  • Constructor Details

  • Method Details

    • getDisplayName

      public String getDisplayName(Locale locale)
      Description copied from interface: Plugin
      Provides the ability for a plugin to provide it's display name that is visible via the [{}] autocomplete/suggestion mechanism within the editor.Example: Calls My Custom plugin
      Specified by:
      getDisplayName in interface Plugin
      Returns:
      String
    • getSnipExample

      Description copied from interface: Plugin
      Provides the ability for a plugin to provide a suggestion or template for execution within a wiki page. Default returns just the FQCN of the plugin, which should enable it to fire off, however no parameters are provided in this case. Override it to provide example inputs to aid users with configuring your plugin. Example: com.company.Plugin inputParamter='test'
      Specified by:
      getSnipExample in interface Plugin
      Returns:
      String
    • headingAdded

      public void headingAdded(Context context, Heading hd)
      Is called whenever a heading is encountered in the stream.
      Specified by:
      headingAdded in interface HeadingListener
      Parameters:
      context - The WikiContext
      hd - The heading which was just encountered.
    • execute

      public String execute(Context context, Map<String,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.