| java.lang.Object
 com.ecyrd.jspwiki.plugin.WeblogPlugin
| WeblogPlugin | | public class WeblogPlugin implements WikiPlugin,ParserStagePlugin(Code) | | 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.
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 |
| DEFAULT_DATEFORMAT | | final public static String DEFAULT_DATEFORMAT(Code) | | |
| DEFAULT_DAYS | | final public static int DEFAULT_DAYS(Code) | | How many days are considered by default. Default value is
|
| DEFAULT_PAGEFORMAT | | final public static String DEFAULT_PAGEFORMAT(Code) | | |
| PARAM_ALLOWCOMMENTS | | final public static String PARAM_ALLOWCOMMENTS(Code) | | |
| PARAM_ENTRYFORMAT | | final public static String PARAM_ENTRYFORMAT(Code) | | |
| PARAM_MAXENTRIES | | final public static String PARAM_MAXENTRIES(Code) | | |
| PARAM_STARTDATE | | final public static String PARAM_STARTDATE(Code) | | |
| findBlogEntries | | public List findBlogEntries(PageManager mgr, String baseName, Date start, Date end) throws ProviderException(Code) | | 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.
Parameters:
mgr - A PageManager which is used to get the pages
Parameters:
baseName - The basename (e.g. "Main" if you want "Main_blogentry_xxxx")
Parameters:
start - The date which is the first to be considered
Parameters:
end - The end date which is the last to be considered a list of pages with their FIRST revisions.
throws:
ProviderException - If something goes wrong |
|
|