This is a base class for all plugins using referral things. As such it is not capable of being invoked directly, but all plugins that extend this plugin inherit its parameters and their functionality.

The direct known subclasses include ReferringPagesPlugin, UndefinedPagesPlugin, and UnusedPagesPlugin.

Parameters#

All parameters are optional:

  • include='pattern' : a specification of wiki pages to include. See the note below on pattern syntax.
  • exclude='pattern' : a specification of wiki pages to exclude. See the note below on pattern syntax.
  • maxwidth='n' : maximum width of generated links.
  • separator='c' : separator between generated links (wikitext).
  • before='string' : output the content of this parameter before the link.
  • after='string' : output the content of this parameter after the link.

Pattern Syntax#

For include and exclude you can list page names (separated by commas or whitespace) and/or supply a pattern (using a regular expression syntax) in the exclude parameter to filter out the pages you don't want, or in the include parameter to include those you do. Absent either the entire wiki is queried.

Example#

There are no examples of this abstract plugin since it cannot be invoked directly.

Back to JSPWikiPlugins.

More Information#

There might be more information for this subject on one of the following:
Category.Documentation

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-4) was last changed on 27-Jul-2014 11:14 by jim