Package org.apache.wiki.plugin
Class ReferredPagesPlugin
java.lang.Object
org.apache.wiki.plugin.ReferredPagesPlugin
- All Implemented Interfaces:
Plugin
Displays the pages referring to the current page.
Parameters
- name - Name of the root page. Default name of calling page
- type - local|externalattachment
- depth - How many levels of pages to be parsed.
- include - Include only these pages. (eg. include='UC.*|BP.*' )
- exclude - Exclude with this pattern. (eg. exclude='LeftMenu' )
- format - full|compact, FULL now expands all levels correctly
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The maximum depth.static final int
The minimum depth.static final String
Parameter name for setting the number of columns that will be displayed by the plugin.static final String
The parameter name for the depth.static final String
The parameter name for the excluded pages.static final String
The parameter name for the format.static final String
The parameter name for the included pages.static final String
The parameter name for the root page to start from.static final String
The parameter name for the type of the references.Fields inherited from interface org.apache.wiki.api.plugin.Plugin
CORE_PLUGINS_RESOURCEBUNDLE
-
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
PARAM_ROOT
The parameter name for the root page to start from. Value is "page".- See Also:
-
PARAM_DEPTH
The parameter name for the depth. Value is "depth".- See Also:
-
PARAM_TYPE
The parameter name for the type of the references. Value is "type".- See Also:
-
PARAM_INCLUDE
The parameter name for the included pages. Value is "include".- See Also:
-
PARAM_EXCLUDE
The parameter name for the excluded pages. Value is "exclude".- See Also:
-
PARAM_FORMAT
The parameter name for the format. Value is "format".- See Also:
-
PARAM_COLUMNS
Parameter name for setting the number of columns that will be displayed by the plugin. Value is "columns". Available since 2.11.0.- See Also:
-
MIN_DEPTH
The minimum depth. Value is 1.- See Also:
-
MAX_DEPTH
The maximum depth. Value is 8.- See Also:
-
-
Constructor Details
-
ReferredPagesPlugin
public ReferredPagesPlugin()
-
-
Method Details
-
execute
- Specified by:
execute
in interfacePlugin
- Throws:
PluginException
-