Class WeblogPlugin

java.lang.Object
org.apache.wiki.plugin.WeblogPlugin
All Implemented Interfaces:
ParserStagePlugin, Plugin

public class WeblogPlugin extends Object implements Plugin, ParserStagePlugin

Builds a simple weblog. The pageformat can use the following params:

%p - Page name

Parameters:

  • page - which page is used to do the blog; default is the current page.
  • entryFormat - how to display the date on pages, using the J2SE SimpleDateFormat syntax. Defaults to the current locale's DateFormat.LONG format for the date, and current locale's DateFormat.SHORT for the time. Thus, for the US locale this will print dates similar to this: September 4, 2005 11:54 PM
  • days - how many days the weblog aggregator should show. If set to "all", shows all pages.
  • pageformat - What the entry pages should look like.
  • startDate - Date when to start. Format is "ddMMyy."
  • maxEntries - How many entries to show at most.
  • preview - How many characters of the text to show on the preview page.

The "days" and "startDate" can also be sent in HTTP parameters, and the names are "weblog.days" and "weblog.startDate", respectively.

The weblog plugin also adds an attribute to each page it is on: "weblogplugin.isweblog" is set to "true". This can be used to quickly peruse pages which have weblogs.

Since:
1.9.21