com.ecyrd.jspwiki.plugin
Class WeblogPlugin

java.lang.Object
  extended by com.ecyrd.jspwiki.plugin.WeblogPlugin
All Implemented Interfaces:
InitializablePlugin, WikiPlugin

public class WeblogPlugin
extends Object
implements WikiPlugin, InitializablePlugin

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

%p - Page name

Parameters:

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

Field Summary
static String ATTR_ISWEBLOG
           
static String DEFAULT_DATEFORMAT
           
static int DEFAULT_DAYS
           
static String DEFAULT_PAGEFORMAT
           
static String PARAM_ALLOWCOMMENTS
           
static String PARAM_DAYS
           
static String PARAM_ENTRYFORMAT
           
static String PARAM_MAXENTRIES
           
static String PARAM_PAGE
           
static String PARAM_STARTDATE
           
 
Constructor Summary
WeblogPlugin()
           
 
Method Summary
 String execute(WikiContext context, Map params)
          This is the main entry point for any plugin.
 List findBlogEntries(PageManager mgr, String baseName, Date start, Date end)
          Attempts to locate all pages that correspond to the blog entry pattern.
 void initialize(WikiContext context, Map params)
          Just sets the "I am a weblog" mark.
static String makeEntryPage(String pageName)
           
static String makeEntryPage(String pageName, String date)
           
static String makeEntryPage(String pageName, String date, String entryNum)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_DAYS

public static final int DEFAULT_DAYS
See Also:
Constant Field Values

DEFAULT_PAGEFORMAT

public static final String DEFAULT_PAGEFORMAT
See Also:
Constant Field Values

DEFAULT_DATEFORMAT

public static final String DEFAULT_DATEFORMAT
See Also:
Constant Field Values

PARAM_STARTDATE

public static final String PARAM_STARTDATE
See Also:
Constant Field Values

PARAM_ENTRYFORMAT

public static final String PARAM_ENTRYFORMAT
See Also:
Constant Field Values

PARAM_DAYS

public static final String PARAM_DAYS
See Also:
Constant Field Values

PARAM_ALLOWCOMMENTS

public static final String PARAM_ALLOWCOMMENTS
See Also:
Constant Field Values

PARAM_MAXENTRIES

public static final String PARAM_MAXENTRIES
See Also:
Constant Field Values

PARAM_PAGE

public static final String PARAM_PAGE
See Also:
Constant Field Values

ATTR_ISWEBLOG

public static final String ATTR_ISWEBLOG
See Also:
Constant Field Values
Constructor Detail

WeblogPlugin

public WeblogPlugin()
Method Detail

makeEntryPage

public static String makeEntryPage(String pageName,
                                   String date,
                                   String entryNum)

makeEntryPage

public static String makeEntryPage(String pageName)

makeEntryPage

public static String makeEntryPage(String pageName,
                                   String date)

initialize

public void initialize(WikiContext context,
                       Map params)
Just sets the "I am a weblog" mark.

Specified by:
initialize in interface InitializablePlugin

execute

public String execute(WikiContext context,
                      Map params)
               throws PluginException
Description copied from interface: WikiPlugin
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 WikiPlugin
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.

findBlogEntries

public List findBlogEntries(PageManager mgr,
                            String baseName,
                            Date start,
                            Date end)
                     throws ProviderException
Attempts to locate all pages that correspond to the blog entry pattern. Will only consider the days on the dates; not the hours and minutes. Returns a list of pages with their FIRST revisions.

Throws:
ProviderException