.\" 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 "Wiki::Toolkit::Plugin::JSON 3pm" .TH Wiki::Toolkit::Plugin::JSON 3pm "2021-01-08" "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::Plugin::JSON \- A Wiki::Toolkit plugin to output RecentChanges JSON. .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This is an alternative access to the recent changes of a Wiki::Toolkit wiki. It outputs \s-1JSON.\s0 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Wiki::Toolkit; \& use Wiki::Toolkit::Plugin::JSON; \& \& my $wiki = Wiki::Toolkit\->new( ... ); # See perldoc Wiki::Toolkit \& \& # Set up the JSON feeder with the mandatory arguments \- see \& # C below for more, optional, arguments. \& my $json = Wiki::Toolkit::Plugin::JSON\->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); \& }, \& recent_changes_link => \*(Aqhttp://example.com/?RecentChanges\*(Aq, \& ); \& \& print "Content\-type: application/xml\en\en"; \& print $json\->recent_changes; .Ve .SH "METHODS" .IX Header "METHODS" .ie n .SS """new()""" .el .SS "\f(CWnew()\fP" .IX Subsection "new()" .Vb 11 \& my $json = Wiki::Toolkit::Plugin::JSON\->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); \& }, \& recent_changes_link => \*(Aqhttp://example.com/?RecentChanges\*(Aq, \& \& # Optional arguments: \& site_description => \*(AqMy wiki about my stuff\*(Aq, \& interwiki_identifier => \*(AqMyWiki\*(Aq, \& make_diff_url => sub \& { \& my $node_name = shift; \& return \*(Aqhttp://example.com/?diff=\*(Aq . uri_escape($node_name) \& }, \& make_history_url => sub \& { \& my $node_name = shift; \& return \*(Aqhttp://example.com/?hist=\*(Aq . uri_escape($node_name) \& }, \& ); .Ve .PP \&\f(CW\*(C`wiki\*(C'\fR must be a Wiki::Toolkit object. \f(CW\*(C`make_node_url\*(C'\fR, and \&\f(CW\*(C`make_diff_url\*(C'\fR and \f(CW\*(C`make_history_url\*(C'\fR, if supplied, must be coderefs. .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 recent_changes_link .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/xml\en\en"; \& print $json\->recent_changes; \& \& # Or get something other than the default of the latest 15 changes. \& print $json\->recent_changes( items => 50 ); \& print $json\->recent_changes( days => 7 ); \& \& # Or ignore minor edits. \& print $json\->recent_changes( ignore_minor_edits => 1 ); \& \& # Personalise your feed further \- consider only changes \& # made by Fred to pages about bookshops. \& print $json\->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 \s-1JSON\s0 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. Defaults to the empty string." 4 .IX Item "comment - a brief comment summarising the edit that has just been made. 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. Defaults to the empty string." 4 .IX Item "username - an identifier for the person who made the edit; will be used as the Dublin Core contributor for this item. Defaults to the empty string." .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 Dublin Core contributor for this item. Defaults to the empty string." 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 Dublin Core contributor for this item. Defaults to the empty string." .ie n .IP "\fBmajor_change\fR \- true if the edit was a major edit and false if it was a minor edit; used for the importance of the item. Defaults to true (ie if ""major_change"" was not defined or was explicitly stored as ""undef"")." 4 .el .IP "\fBmajor_change\fR \- true if the edit was a major edit and false if it was a minor edit; used for the importance of the item. Defaults to true (ie if \f(CWmajor_change\fR was not defined or was explicitly stored as \f(CWundef\fR)." 4 .IX Item "major_change - true if the edit was a major edit and false if it was a minor edit; used for the importance of the item. Defaults to true (ie if major_change was not defined or was explicitly stored as undef)." .PD .ie n .SS """rss_timestamp()""" .el .SS "\f(CWrss_timestamp()\fP" .IX Subsection "rss_timestamp()" .Vb 1 \& print $json\->rss_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. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 Wiki::Toolkit .IP "\(bu" 4 .IP "\(bu" 4 .SH "MAINTAINER" .IX Header "MAINTAINER" Earle Martin . Originally by Kake Pugh . .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2003\-4 Kake Pugh. Subsequent modifications copyright 2005 Earle Martin. .PP Copyright 2008 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" The members of the Semantic Web Interest Group channel on irc.freenode.net, #swig, were very useful in the development of this module.