Funnelback logo

Documentation

Rss.cgi

Introduction

The rss.cgi script is used to generate an RSS feed from a Funnelback query in the 'Classic UI. The Modern UI'' equivalent is called rss.ftl.

The script

The script will generate an RSS (2.0) XML file for the supplied Funnelback query, sorted by document dates. Each RSS item will use the document's title and live URL.

Synopsis

rss.cgi?collection=COLLECTION&query=QUERY&items=MAX

If you create an rss.cfg configuration file:

rss.cgi
rss.cgi?name=value

Parameters

collection
The collection to search.
query
The query term to search for.
items
The maximum number of items to return in the feed (there is also a hard-coded default, and a maximum of 100 items).
name
is the name of a pseudo-query (see below).

rss.cfg

If the file $SEARCH_HOME/conf/rss.cfg exists, then it can supply default values for the CGI parameters and more.

The standard format for the file is:

collection=tempest
query=prospero
items=42

which would run the query prospero on collection tempest and return the top 42 results (sorted by date).

You can also use the config file to define pseudo-queries. If the file contains an item such as:

query.name=sprintf-string

then a CGI parameter called name will build a query from the sprintf-string and the value of the CGI parameter. For example, if rss.cfg contained:

query.author=a:%s

and you ran:

rss.cgi?author=fred

the query executed will be "a:fred". Note that the first pseudo-query found is used.

rss.xsl

This file is an XSLT stylesheet that is used to convert the Funnelback XML results into RSS XML. It can be accessed and edited via the administration interface file-manager.

See also

top ⇑