This page (revision-1) was last changed on 29-Nov-2024 16:16 by UnknownAuthor

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Page revision history

Version Date Modified Size Author Changes ... Change note

Page References

Incoming links Outgoing links

Version management

Difference between version and

At line 1 added 33 lines
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:
[{ReferringPagesPlugin before='*' after='\n' }]
----
[Category.Documentation]