.\" 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
.\" ========================================================================
.\"
.IX Title "Wiki::Toolkit::Feed::Atom 3pm"
.TH Wiki::Toolkit::Feed::Atom 3pm "2021-01-04" "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
.SH "NAME"
.Vb 1
\&  Wiki::Toolkit::Feed::Atom \- A Wiki::Toolkit plugin to output RecentChanges Atom.
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is an alternative access to the recent changes of a Wiki::Toolkit
wiki. It outputs the Atom Syndication Format as described at
<http://www.atomenabled.org/developers/syndication/>.
.PP
This module is a straight port of Wiki::Toolkit::Feed::RSS.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Wiki::Toolkit;
\&  use Wiki::Toolkit::Feed::Atom;
\&
\&  my $wiki = Wiki::Toolkit\->new( ... );  # See perldoc Wiki::Toolkit
\&
\&  # Set up the RSS feeder with the mandatory arguments \- see
\&  # C<new()> below for more, optional, arguments.
\&  my $atom = Wiki::Toolkit::Feed::Atom\->new(
\&    wiki                => $wiki,
\&    site_name           => \*(AqMy Wiki\*(Aq,
\&    site_url            => \*(Aqhttp://example.com/\*(Aq,
\&    make_node_url       => sub
\&                           {
\&                             my ($node_name, $version) = @_;
\&                             return \*(Aqhttp://example.com/?id=\*(Aq . uri_escape($node_name) . \*(Aq;version=\*(Aq . uri_escape($version);
\&                           },
\&    html_equiv_link => \*(Aqhttp://example.com/?RecentChanges\*(Aq,
\&    atom_link => \*(Aqhttp://example.com/?action=rc;format=atom\*(Aq,
\&  );
\&
\&  print "Content\-type: application/atom+xml\en\en";
\&  print $atom\->recent_changes;
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new()"""
.el .SS "\f(CWnew()\fP"
.IX Subsection "new()"
.Vb 12
\&  my $atom = Wiki::Toolkit::Feed::Atom\->new(
\&    # Mandatory arguments:
\&    wiki                 => $wiki,
\&    site_name            => \*(AqMy Wiki\*(Aq,
\&    site_url             => \*(Aqhttp://example.com/\*(Aq,
\&    make_node_url        => sub
\&                            {
\&                              my ($node_name, $version) = @_;
\&                              return \*(Aqhttp://example.com/?id=\*(Aq . uri_escape($node_name) . \*(Aq;version=\*(Aq . uri_escape($version);
\&                            },
\&    html_equiv_link  => \*(Aqhttp://example.com/?RecentChanges\*(Aq,,
\&    atom_link => \*(Aqhttp://example.com/?action=rc;format=atom\*(Aq,
\&
\&    # Optional arguments:
\&    site_description     => \*(AqMy wiki about my stuff\*(Aq,
\&    software_name        => $your_software_name,     # e.g. "Wiki::Toolkit"
\&    software_version     => $your_software_version,  # e.g. "0.73"
\&    software_homepage    => $your_software_homepage, # e.g. "http://search.cpan.org/dist/CGI\-Wiki/"
\&    encoding             => \*(AqUTF\-8\*(Aq
\&  );
.Ve
.PP
\&\f(CW\*(C`wiki\*(C'\fR must be a Wiki::Toolkit object. \f(CW\*(C`make_node_url\*(C'\fR, if supplied, must 
be a coderef.
.PP
The mandatory arguments are:
.IP "\(bu" 4
wiki
.IP "\(bu" 4
site_name
.IP "\(bu" 4
site_url
.IP "\(bu" 4
make_node_url
.IP "\(bu" 4
html_equiv_link or recent_changes_link
.IP "\(bu" 4
atom_link
.PP
The three optional arguments
.IP "\(bu" 4
software_name
.IP "\(bu" 4
software_version
.IP "\(bu" 4
software_homepage
.PP
are used to generate the \f(CW\*(C`generator\*(C'\fR part of the feed.
.PP
The optional argument
.IP "\(bu" 4
encoding
.PP
will be used to specify the character encoding in the feed. If not set,
will default to the wiki store's encoding.
.ie n .SS """recent_changes()"""
.el .SS "\f(CWrecent_changes()\fP"
.IX Subsection "recent_changes()"
.Vb 9
\&  $wiki\->write_node(
\&                     \*(AqAbout This Wiki\*(Aq,
\&                     \*(Aqblah blah blah\*(Aq,
\&                         $checksum,
\&                         {
\&                           comment  => \*(AqStub page, please update!\*(Aq,
\&                           username => \*(AqFred\*(Aq,
\&                         }
\&  );
\&
\&  print "Content\-type: application/atom+xml\en\en";
\&  print $atom\->recent_changes;
\&
\&  # Or get something other than the default of the latest 15 changes.
\&  print $atom\->recent_changes( items => 50 );
\&  print $atom\->recent_changes( days => 7 );
\&
\&  # Or ignore minor edits.
\&  print $atom\->recent_changes( ignore_minor_edits => 1 );
\&
\&  # Personalise your feed further \- consider only changes
\&  # made by Fred to pages about bookshops.
\&  print $atom\->recent_changes(
\&             filter_on_metadata => {
\&                         username => \*(AqFred\*(Aq,
\&                         category => \*(AqBookshops\*(Aq,
\&                       },
\&              );
.Ve
.PP
If using \f(CW\*(C`filter_on_metadata\*(C'\fR, note that only changes satisfying
\&\fIall\fR criteria will be returned.
.PP
\&\fBNote:\fR Many of the fields emitted by the Atom generator are taken
from the node metadata. The form of this metadata is \fInot\fR mandated
by Wiki::Toolkit. Your wiki application should make sure to store some or
all of the following metadata when calling \f(CW\*(C`write_node\*(C'\fR:
.IP "\fBcomment\fR \- a brief comment summarising the edit that has just been made; will be used in the summary for this item.  Defaults to the empty string." 4
.IX Item "comment - a brief comment summarising the edit that has just been made; will be used in the summary for this item. Defaults to the empty string."
.PD 0
.IP "\fBusername\fR \- an identifier for the person who made the edit; will be used as the Dublin Core contributor for this item, and also in the \s-1RDF\s0 description.  Defaults to 'No description given for change'." 4
.IX Item "username - an identifier for the person who made the edit; will be used as the Dublin Core contributor for this item, and also in the RDF description. Defaults to 'No description given for change'."
.IP "\fBhost\fR \- the hostname or \s-1IP\s0 address of the computer used to make the edit; if no username is supplied then this will be used as the author for this item.  Defaults to 'Anonymous'." 4
.IX Item "host - the hostname or IP address of the computer used to make the edit; if no username is supplied then this will be used as the author for this item. Defaults to 'Anonymous'."
.PD
.ie n .SS """generate_node_list_feed"""
.el .SS "\f(CWgenerate_node_list_feed\fP"
.IX Subsection "generate_node_list_feed"
Generate and return an Atom feed for a 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"
Generate a very cut down atom feed, based just on the nodes, their locations
(if given), and their distance from a reference location (if given).
.PP
Typically used on search feeds.
.ie n .SS """feed_timestamp()"""
.el .SS "\f(CWfeed_timestamp()\fP"
.IX Subsection "feed_timestamp()"
.Vb 1
\&  print $atom\->feed_timestamp();
.Ve
.PP
Returns the timestamp of the feed in POSIX::strftime style (\*(L"Tue, 29 Feb 2000 
12:34:56 \s-1GMT\*(R"\s0), which is equivalent to the timestamp of the most recent item 
in the feed. Takes the same arguments as \fBrecent_changes()\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.
.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 "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Wiki::Toolkit
.IP "\(bu" 4
<http://www.atomenabled.org/developers/syndication/>
.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 Earle Martin and the Wiki::Toolkit team.
Copyright 2012 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.
.SH "THANKS"
.IX Header "THANKS"
Kake Pugh for originally writing Wiki::Toolkit::Feed::RSS and indeed 
Wiki::Toolkit itself.