.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Wiki::Toolkit::Feed::Listing 3pm"
.TH Wiki::Toolkit::Feed::Listing 3pm "2016-12-31" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Wiki::Toolkit::Feed::Listing \- parent class for Feeds from Wiki::Toolkit.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Handles common data fetching tasks, so that child classes need only
worry about formatting the feeds.
.PP
Also enforces some common methods that must be implemented.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """fetch_recently_changed_nodes"""
.el .SS "\f(CWfetch_recently_changed_nodes\fP"
.IX Subsection "fetch_recently_changed_nodes"
Based on the supplied criteria, fetch a list of the recently changed nodes
.ie n .SS """fetch_newest_for_recently_changed"""
.el .SS "\f(CWfetch_newest_for_recently_changed\fP"
.IX Subsection "fetch_newest_for_recently_changed"
Based on the supplied criteria (but not using all of those used by
\&\fBfetch_recently_changed_nodes\fR), find the newest node from the recently
changed nodes set. Normally used for dating the whole of a Feed.
.ie n .SS """fetch_node_all_versions"""
.el .SS "\f(CWfetch_node_all_versions\fP"
.IX Subsection "fetch_node_all_versions"
For a given node (name or \s-1ID\s0), return all the versions there have been,
including all metadata required for it to go into a \*(L"recent changes\*(R"
style listing.
.ie n .SS """recent_changes"""
.el .SS "\f(CWrecent_changes\fP"
.IX Subsection "recent_changes"
Build an Atom Feed of the recent changes to the Wiki::Toolkit instance,
using any supplied parameters to narrow the results.
.PP
If the argument \*(L"also_return_timestamp\*(R" is supplied, it will return an
array of the feed, and the feed timestamp. Otherwise it just returns the feed.
.ie n .SS """node_all_versions"""
.el .SS "\f(CWnode_all_versions\fP"
.IX Subsection "node_all_versions"
Build an Atom Feed of all the different versions of a given node.
.PP
If the argument \*(L"also_return_timestamp\*(R" is supplied, it will return an
array of the feed, and the feed timestamp. Otherwise it just returns the feed.
.ie n .SS """format_geo"""
.el .SS "\f(CWformat_geo\fP"
.IX Subsection "format_geo"
Using the geo and space xml namespaces, format the supplied node metadata
into geo: and space: tags, suitable for inclusion in a feed with those
namespaces imported.
.PP
The following are methods that any feed renderer must provide:
.ie n .SS """feed_timestamp"""
.el .SS "\f(CWfeed_timestamp\fP"
.IX Subsection "feed_timestamp"
All implementing feed renderers must implement a method to produce a
feed specific timestamp, based on the supplied node
.ie n .SS """generate_node_list_feed"""
.el .SS "\f(CWgenerate_node_list_feed\fP"
.IX Subsection "generate_node_list_feed"
All implementing feed renderers must implement a method to produce a
feed from the supplied list of nodes
.ie n .SS """generate_node_name_distance_feed"""
.el .SS "\f(CWgenerate_node_name_distance_feed\fP"
.IX Subsection "generate_node_name_distance_feed"
All implementing feed renderers must implement a method to produce a
stripped down feed from the supplied list of node names, and optionally
locations and distance from a reference point.
.ie n .SS """parse_feed_timestamp"""
.el .SS "\f(CWparse_feed_timestamp\fP"
.IX Subsection "parse_feed_timestamp"
Take a feed_timestamp and return a Time::Piece object.
.SH "MAINTAINER"
.IX Header "MAINTAINER"
The Wiki::Toolkit team, http://www.wiki\-toolkit.org/.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2006\-2009 the Wiki::Toolkit team.
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.