UnusedPagesPlugin (Apache JSPWiki 2.11.2 API)

java.lang.Object
- org.apache.wiki.plugin.AbstractReferralPlugin
- - org.apache.wiki.plugin.UnusedPagesPlugin

All Implemented Interfaces:

Plugin
```
public class UnusedPagesPlugin
extends AbstractReferralPlugin
```
Plugin for displaying pages that are not linked to in other pages. Uses the ReferenceManager.
Parameters (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 Summary

Fields
Modifier and Type Field Description

static java.lang.String PARAM_EXCLUDEATTS
If set to "true", attachments are excluded from display.
- Fields inherited from class org.apache.wiki.plugin.AbstractReferralPlugin
  ALL_ITEMS, items, m_after, m_before, m_dateFormat, m_dateLastModified, m_engine, m_exclude, m_include, m_lastModified, m_maxwidth, m_separator, m_show, m_sorter, PARAM_AFTER, PARAM_BEFORE, PARAM_COLUMNS, PARAM_EXCLUDE, PARAM_INCLUDE, PARAM_LASTMODIFIED, PARAM_MAXWIDTH, PARAM_SEPARATOR, PARAM_SHOW, PARAM_SHOW_VALUE_COUNT, PARAM_SHOW_VALUE_PAGES, PARAM_SORTORDER, PARAM_SORTORDER_HUMAN, PARAM_SORTORDER_JAVA, PARAM_SORTORDER_LOCALE
- Fields inherited from interface org.apache.wiki.api.plugin.Plugin
  CORE_PLUGINS_RESOURCEBUNDLE

Constructor Summary

Constructors
Constructor Description

UnusedPagesPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`execute(Context context, java.util.Map<java.lang.String,java.lang.String> params)`	This is the main entry point for any plugin.

Methods inherited from class org.apache.wiki.plugin.AbstractReferralPlugin
applyColumnsStyle, filterAndSortCollection, filterCollection, filterWikiPageCollection, initialize, makeHTML, wikitizeCollection

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_EXCLUDEATTS
```
public static final java.lang.String PARAM_EXCLUDEATTS
```
    If set to "true", attachments are excluded from display. Value is "excludeattachments".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UnusedPagesPlugin
```
public UnusedPagesPlugin()
```
- 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    HTML, ready to be included into the rendered page.
    
    Throws:
    
    PluginException - In case anything goes wrong.