The ReferringPagesPlugin is a JSPWikiPlugin that finds and lists all pages that refer to the current page. This is the twin sister of the ReferredPagesPlugin.

Table of Contents

Parameters #

  • max=n : How many pages to list. Default is 10. Some pages might create very long lists, so it's a good idea to limit the list size.
  • maxwidth=n : Limits the length of the generated links to at most n characters. This should used to keep the LeftMenu or LeftMenuFooter at a manageable width. Default is to not limit the length at all.
  • separator=<markup> : What should be put between the different items. It's WikiMarkup, and by default it's two backslashes (meaning a carriage return, or <br />). JesseWilbur: If you want to use something like a "|", you have to put it in single quotes. separator='|'
  • page=<page name>
  • before=<markup>
  • after=<markup>
  • show=pages|count : This parameter can have two values, "pages" (the default), and "count". The value "pages" will give you the list containing the pages, the value "count" will give you just the number of pages, not the whole list.
  • showLastModified=true|false : The showLastModified parameter gives you the last modified date/time of the most recently changed page. It is only valid if show="count", otherwise a PluginException is thrown.

This plugin extends AbstractReferralPlugin and therefore inherits its parameters.

Example#

[{ReferringPagesPlugin}]

See LeftMenuFooter.

Display options#

You can use the "separator" parameter to define any WikiMarkup you want to insert between the items. By default, it's \\.

For example, if you want a numbered list, use the following syntax:

[{ReferringPagesPlugin WHERE max='10' maxwidth='250' before='#' after='\n'}]
  1. AbstractReferralPlugin
  2. JSPWikiCorePlugins
  3. JavaRegularExpressions
  4. ReferredPagesPlugin
  5. WikiCategory


See: JSPWikiCorePlugin


Category.Plugins