By default, this plugin tries to obtain an RSS feed every time the page is accessed. If you place the showrss plugin in a frequently accessed page, use the cache functionality. The value of the cache timeout should be set properly depending on how frequently the target site is updated.

Parameters

RSS_location - the file path or the URL of the RSS feed

The template parameter determines the display format of the RSS. The default value is 'default'.

default - simple list of pages

menubar － display a bullet before the page name (useful in a page like MenuBar, which has a limit in page width)

recent － display the timestamp of the pages name like the recent plugin

cache_timeout - the cache expiration time (in hours). The default is to disable caches.

The last parameter determines whether the plugin displays the timestamp of the RSS feed. The timestamp is displayed if 1 is set. The default is not to display the RSS timestamp.

This is similar to the function of 'creating a new page' using a skeleton page, but while 'create new' always reads the entire page, thie plugin can specify which part of the existing page should be used as a template.

Parameters

TemplatePage - The page used as a template. It must be URL-encoded.

Constants

MAX_LEN - The maximum length of the templated (displayed on the form to specify the location of the tamplate page.)

Unlike the bugtrack plugin, in which the items are fixed, the tracker plugin can create arbitrary input fields on the stylized page. The potential use of this plugin is to create FAQ，BBS，book reviews，TODO list, etc.

The input fields can be defined by creating a template page under :config/plugin/tracker/ according to specific formats. For a reference, the template equivalent to the bugtrack pluging is placed at :config/plugin/tracker/default.

Parameters

TemplateName - the template template name (e.g., #tracker(hoge)). If omitted, :config/plugin/tracker/default is used.

It is possible to specify the form name or the list name after the template name. This is useful when you want to use multiple form/list formats for the same template. For example, #tracker(foo/form_alternative) uses :config/plugin/tracker/foo/form_alternative, and #tracker_list(foo/list_alternative) uses :config/plugin/tracker/foo/list_alternative for layout.

'''BasePageName' - the top-level page created by the plugin. The default is the current page.

Constants

TRACKER_LIST_EXCLUDE_PATTERN - the regular expression that defines the pages excluded from the pages shown by the tracker_list plugin

TRACKER_LIST_SHOW_ERROR_PAGE - whether to display the pages in the list if the items couldn't be extracted from them

Templates syntax

For each tracker, the following 4 pages should be created as a template.

:config/plugin/tracker/foo

the descreiption of the foo template

:config/plugin/tracker/foo/form

definitions of input fields and layouts

:config/plugin/tracker/foo/page

format of the page to be created

:config/plugin/tracker/foo/list

layout of the list displayed by the tracker_list plugin. Special rules apply to the format definition (c), header(h), and footer(f) are a table (|...|)

Keywords

The keywords that can be used in forms

[_name] : display a field to enter the page name to store an entry (optional)

[_submit] : display the [Add] button

The keywords that can be used in pages and lists

[_date] : submission timestamp

[_page] : the page name (with brackets) created

[_refer] : the page in which #tracker was placed

[_base] : the page prefix. If the second parameter of tracker()/tracker_list() is omitted, the value of [_refer] is used.

[_name] : the value of the [_name] in the form. This is used as part of the page name in which the entry is stored.

[_real] : The generated page name exluding [_refer] + '/'. By default, this is the same value as [_name]. If one of the following conditions hold, the tracker plugin creates the page name by adding serial numbers to [_real].
(1) the form does not contain a [_name] field
(2) [_name] is empty, or it contains an invalid character for a page name
(2) the page named [_refer] / [_name] already exists

TemplateName - the template name used in the tracker plugin. The default is :config/plugin/tracker/default.

BasePageName - the base page name used in the tracker plugin. If the base page name was not specified by the tracker plugin, this should be the page in which the tracker plugin is placed. The default is the current page.

The third parameter specifies the key item for sorting and the sort order. sort_item should be selected from the fields defined in :config/plugin/tracker/TemplateName. The default is PageName. sort_order is either ASC*1, DESC*2, SORT_ASC*3, or SORT_DESC*4, and it should be written after the colon (:). Use semicolons (;) to specify multiple sort keys (and orders). For example, #tracker_list(,,state:SORT_ASC;priority:SORT_ASC;_real:SORT_DESC) display the items sorted by (1) [state] in the ascending order, (2) [priority] in the ascending order, and (3) [_real] in the descending order with the priority of this order.

max_pages - maximum number of pages displayed on the list. The default is to display all pages.