This is a base class for all JSPWikiPlugins that refer to 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 IndexPlugin, PageViewPlugin, ReferringPagesPlugin, UndefinedPagesPlugin, and UnusedPagesPlugin.
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.
- columns='int' : number of columns used to display the plugin results. As the PageViewPlugin renders its output using a table, this parameter has no effect on that plugin.
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.
There are no examples of this abstract plugin since it cannot be invoked directly!