Package org.apache.wiki.plugin

Class RecentChangesPlugin

java.lang.Object

org.apache.wiki.plugin.AbstractReferralPlugin

org.apache.wiki.plugin.RecentChangesPlugin

All Implemented Interfaces:

Plugin

public class RecentChangesPlugin
extends AbstractReferralPlugin
implements Plugin

Returns the Recent Changes in the wiki being a date-sorted list of page names.

Parameters:

• since - show changes from the last n days, for example since=5 shows only the pages that were changed in the last five days
• format - (full|compact) : if "full", then display a long version with all possible info. If "compact", then be as compact as possible.
• timeFormat - the time format to use, the default is "HH:mm:ss"
• dateFormat - the date format to use, the default is "dd.MM.yyyy"

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_DATE_FORMAT
static java.lang.String	DEFAULT_TIME_FORMAT
static java.lang.String	PARAM_DATE_FORMAT	Parameter name for the separator dateFormat.
static java.lang.String	PARAM_FORMAT	Parameter name for the separator format.
static java.lang.String	PARAM_TIME_FORMAT	Parameter name for the separator timeFormat.

Fields inherited from class org.apache.wiki.plugin.AbstractReferralPlugin

ALL_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_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
RecentChangesPlugin()

Method Summary

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

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 Details

PARAM_FORMAT

public static final java.lang.String PARAM_FORMAT

Parameter name for the separator format. Value is "format".

See Also:

Constant Field Values

PARAM_TIME_FORMAT

public static final java.lang.String PARAM_TIME_FORMAT

Parameter name for the separator timeFormat. Value is "timeFormat".

See Also:

Constant Field Values

PARAM_DATE_FORMAT

public static final java.lang.String PARAM_DATE_FORMAT

Parameter name for the separator dateFormat. Value is "dateFormat".

See Also:

Constant Field Values

DEFAULT_TIME_FORMAT

public static final java.lang.String DEFAULT_TIME_FORMAT

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final java.lang.String DEFAULT_DATE_FORMAT

See Also:

Constant Field Values

Constructor Details

RecentChangesPlugin

public RecentChangesPlugin()

Method Details

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.

Specified by:

execute in interface Plugin

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.