.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "OpenGuides::Feed 3pm"
.TH OpenGuides::Feed 3pm "2021-01-30" "perl v5.32.0" "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
.IP "\fBset_feed_name_and_url_params\fR Overrides the default feed name and default feed http equivalent url. Useful on custom feeds, where the defaults are incorrect." 4
.IX Item "set_feed_name_and_url_params Overrides the default feed name and default feed http equivalent url. Useful on custom feeds, where the defaults are incorrect."
.Vb 2
\&   $feed\->set_feed_name_and_url("Search Results", "search=pub");
\&   $feed\->build_mini_feed_for_nodes("rss", @search_results);
.Ve
.IP "\fBmake_feed\fR" 4
.IX Item "make_feed"
Produce one of the standard feeds, in the requested format.
.Sp
my \f(CW$feed_contents\fR = feeds\->make_feed(
                                feed_type => 'rss',
                                feed_listing => 'recent_changes'
                    );
.Sp
Passes additional arguments through to the underlying Wiki::Toolkit::Feed
.IP "\fBbuild_feed_for_nodes\fR" 4
.IX Item "build_feed_for_nodes"
For the given feed type, build a feed from the supplied list of nodes.
Will figure out the feed timestamp from the newest node, and output a
 last modified header based on this.
.Sp
my \f(CW@nodes\fR = \f(CW$wiki\fR\->\fBfetch_me_nodes_I_like()\fR;
my \f(CW$feed_contents\fR = \f(CW$feed\fR\->build_feed_for_nodes(\*(L"rss\*(R", \f(CW@nodes\fR);
.IP "\fBbuild_mini_feed_for_nodes\fR" 4
.IX Item "build_mini_feed_for_nodes"
For the given feed type, build a mini feed (name and distance) from the
 supplied list of nodes.
Will figure out the feed timestamp from the newest node, and output a
 last modified header based on this.
.Sp
my \f(CW@nodes\fR = \f(CW$wiki\fR\->\fBsearch_near_here()\fR;
my \f(CW$feed_contents\fR = \f(CW$feed\fR\->build_mini_feed_for_nodes(\*(L"rss\*(R", \f(CW@nodes\fR);
.IP "\fBrender_feed_for_nodes\fR" 4
.IX Item "render_feed_for_nodes"
Normally internal method to perform the appropriate building of a feed
based on a list of nodes.
.IP "\fBdefault_content_type\fR" 4
.IX Item "default_content_type"
For the given feed type, return the default content type for that feed.
.Sp
my \f(CW$content_type\fR = \f(CW$feed\fR\->default_content_type(\*(L"rss\*(R");
.IP "\fBfetch_maker\fR" 4
.IX Item "fetch_maker"
For the given feed type, identify and return the maker routine for feeds
of that type.
.Sp
my \f(CW$maker\fR = \f(CW$feed\fR\->fetch_maker(\*(L"rss\*(R");
my \f(CW$feed_contents\fR = maker\->node_all_versions(%options);
.Sp
Will always return something of type Wiki::Toolkit::Feed::Listing
.SH "NAME"
OpenGuides::Feed \- generate data feeds for OpenGuides in various formats.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Produces \s-1RSS 1.0\s0 and Atom 1.0 feeds for OpenGuides.  Distributed and
installed as part of the OpenGuides project, not intended for independent
installation.  This documentation is probably only useful to OpenGuides
developers.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use Wiki::Toolkit;
\&    use OpenGuides::Config;
\&    use OpenGuides::Feed;
\&
\&    my $wiki = Wiki::Toolkit\->new( ... );
\&    my $config = OpenGuides::Config\->new( file => "wiki.conf" );
\&    my $feed = OpenGuides::Feed\->new( wiki       => $wiki,
\&                                      config     => $config,
\&                                      og_version => \*(Aq1.0\*(Aq, );
\&
\&    # Ten most recent changes in RSS format.
\&    my %args = ( items     => 10,
\&                 feed_type => \*(Aqrss\*(Aq,
\&                 also_return_timestamp => 1 );
\&    my ($feed_output,$feed_timestamp) = $feed\->make_feed( %args );
\&
\&    print "Content\-Type: application/rdf+xml\en";
\&    print "Last\-Modified: " . $feed_timestamp . "\en\en";
\&    print $feed_output;
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.Vb 3
\&    my $feed = OpenGuides::Feed\->new( wiki       => $wiki,
\&                                      config     => $config,
\&                                      og_version => \*(Aq1.0\*(Aq, );
.Ve
.Sp
\&\f(CW\*(C`wiki\*(C'\fR must be a Wiki::Toolkit object and \f(CW\*(C`config\*(C'\fR must be an
OpenGuides::Config object.  Both of these arguments are mandatory.
\&\f(CW\*(C`og_version\*(C'\fR is an optional argument specifying the version of
OpenGuides for inclusion in the feed.
.IP "\fBrss_maker\fR" 4
.IX Item "rss_maker"
Returns a raw Wiki::Toolkit::Feed::RSS object created with the values you
invoked this module with.
.IP "\fBatom_maker\fR" 4
.IX Item "atom_maker"
Returns a raw Wiki::Toolkit::Feed::Atom object created with the values you
invoked this module with.
.IP "\fBmake_feed\fR" 4
.IX Item "make_feed"
.Vb 5
\&    # Ten most recent changes in RSS format.
\&    my %args = ( items     => 10,
\&                 feed_type => \*(Aqrss\*(Aq,
\&                 also_return_timestamp => 1 );
\&    my ($feed_output,$feed_timestamp) = $rdf_writer\->make_feed( %args );
\&
\&    print "Content\-Type: application/rdf+xml\en";
\&    print "Last\-Modified: " . $feed_timestamp . "\en\en";
\&    print $feed_output;
\&    print $rdf_writer\->make_feed( %args );
\&
\&
\&    # All the changes made by bob in the past week, ignoring minor edits, in Atom.
\&    $args{days}               = 7;
\&    $args{ignore_minor_edits  = 1;
\&    $args{filter_on_metadata} => { username => "bob" };
\&    $args{also_return_timestamp} => 1;
\&
\&    my ($feed_output,$feed_timestamp) = $rdf_writer\->make_feed( %args );
\&    print "Content\-Type: application/atom+xml\en";
\&    print "Last\-Modified: " . $feed_timestamp . "\en\en";
\&    print $feed_output;
.Ve
.IP "\fBfeed_timestamp\fR" 4
.IX Item "feed_timestamp"
Instead of calling this, you should instead pass in the 'also_return_timestamp'
option. You will then get back the feed timestamp, along with the feed output.
.Sp
This method will be removed in future, and currently will only return
meaningful values if your arguments relate to recent changes.
.Sp
.Vb 1
\&    print "Last\-Modified: " . $feed\->feed_timestamp( %args ) . "\en\en";
.Ve
.Sp
Returns the timestamp of something in POSIX::strftime style (\*(L"Tue, 29 Feb 2000
12:34:56 \s-1GMT\*(R"\s0). Takes the same arguments as \fBmake_recentchanges_rss()\fR.
You will most likely need this to print a Last-Modified \s-1HTTP\s0 header so
user-agents can determine whether they need to reload the feed or not.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Wiki::Toolkit, Wiki::Toolkit::Feed::RSS and Wiki::Toolkit::Feed::Atom
.IP "\(bu" 4
<http://openguides.org/>
.SH "AUTHOR"
.IX Header "AUTHOR"
The OpenGuides Project (openguides\-dev@lists.openguides.org)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2012 The OpenGuides Project.  All Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "CREDITS"
.IX Header "CREDITS"
Written by Earle Martin, based on the original OpenGuides::RDF by Kake Pugh.