Class ReferringPagesPlugin

  • All Implemented Interfaces:

    public class ReferringPagesPlugin
    extends AbstractReferralPlugin
    Displays the pages referring to the current page. Parameters:
    • max - How many items to show.
    • extras - How to announce extras.
    • page - Which page to get the table of contents from.
    From AbstractReferralPlugin:
    • separator - How to separate generated links; default is a wikitext line break, producing a vertical list.
    • maxwidth - maximum width, in chars, of generated links.
    • Field Detail

      • PARAM_MAX

        public static final java.lang.String PARAM_MAX
        Parameter name for setting the maximum items to show. Value is "max".
        See Also:
        Constant Field Values

        public static final java.lang.String PARAM_EXTRAS
        Parameter name for setting the text to show when the maximum items is overruled. Value is "extras".
        See Also:
        Constant Field Values
    • Method Detail

      • execute

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

        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.
        HTML, ready to be included into the rendered page.
        PluginException - In case anything goes wrong.