.\" 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::JSON 3pm"
.TH OpenGuides::JSON 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 "\fBemit_json\fR" 4
.IX Item "emit_json"
Renders the given node as \s-1JSON\s0
.IP "\fBoutput_as_json\fR" 4
.IX Item "output_as_json"
Renders the given arbitary data as \s-1JSON\s0
.SH "NAME"
OpenGuides::JSON \- An OpenGuides plugin to output JSON.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Does all the \s-1JSON\s0 stuff 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::JSON;
\&
\&    my $wiki = Wiki::Toolkit\->new( ... );
\&    my $config = OpenGuides::Config\->new( file => "wiki.conf" );
\&    my $json_writer = OpenGuides::JSON\->new( wiki   => $wiki,
\&                                         config => $config );
\&
\&    # JSON version of a node.
\&    print "Content\-Type: application/javascript\en\en";
\&    print $json_writer\->emit_json( node => "Masala Zone, N1 0NU" );
\&
\&    # Ten most recent changes.
\&    print "Content\-Type: application/javascript\en";
\&    print "Last\-Modified: " . $self\->json_timestamp( items => 10 ) . "\en\en";
\&    print $json_writer\->make_recentchanges_json( items => 10 );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.Vb 2
\&    my $json_writer = OpenGuides::JSON\->new( wiki   => $wiki,
\&                                           config => $config );
.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 arguments mandatory.
.IP "\fBemit_json\fR" 4
.IX Item "emit_json"
.Vb 7
\&    $wiki\->write_node( "Masala Zone, N1 0NU",
\&                     "Quick and tasty Indian food",
\&                     $checksum,
\&                     { comment  => "New page",
\&                       username => "Kake",
\&                       locale   => "Islington" }
\&    );
\&
\&    print "Content\-Type: application/javascript\en\en";
\&    print $json_writer\->emit_json( node => "Masala Zone, N1 0NU" );
.Ve
.Sp
\&\fBNote:\fR Some 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:
.RS 4
.IP "\fBpostcode\fR \- The postcode or zip code of the place discussed by the node.  Defaults to the empty string." 4
.IX Item "postcode - The postcode or zip code of the place discussed by the node. Defaults to the empty string."
.PD 0
.ie n .IP "\fBcity\fR \- The name of the city that the node is in.  If not supplied, then the value of ""default_city"" in the config object supplied to ""new"", if available, otherwise the empty string." 4
.el .IP "\fBcity\fR \- The name of the city that the node is in.  If not supplied, then the value of \f(CWdefault_city\fR in the config object supplied to \f(CWnew\fR, if available, otherwise the empty string." 4
.IX Item "city - The name of the city that the node is in. If not supplied, then the value of default_city in the config object supplied to new, if available, otherwise the empty string."
.ie n .IP "\fBcountry\fR \- The name of the country that the node is in.  If not supplied, then the value of ""default_country"" in the config object supplied to ""new"" will be used, if available, otherwise the empty string." 4
.el .IP "\fBcountry\fR \- The name of the country that the node is in.  If not supplied, then the value of \f(CWdefault_country\fR in the config object supplied to \f(CWnew\fR will be used, if available, otherwise the empty string." 4
.IX Item "country - The name of the country that the node is in. If not supplied, then the value of default_country in the config object supplied to new will be used, if available, otherwise the empty string."
.IP "\fBusername\fR \- An identifier for the person who made the latest edit to the node.  This person will be listed as a contributor (Dublin Core).  Defaults to empty string." 4
.IX Item "username - An identifier for the person who made the latest edit to the node. This person will be listed as a contributor (Dublin Core). Defaults to empty string."
.ie n .IP "\fBlocale\fR \- The value of this can be a scalar or an arrayref, since some places have a plausible claim to being in more than one locale.  Each of these is put in as a ""Neighbourhood"" attribute." 4
.el .IP "\fBlocale\fR \- The value of this can be a scalar or an arrayref, since some places have a plausible claim to being in more than one locale.  Each of these is put in as a \f(CWNeighbourhood\fR attribute." 4
.IX Item "locale - The value of this can be a scalar or an arrayref, since some places have a plausible claim to being in more than one locale. Each of these is put in as a Neighbourhood attribute."
.IP "\fBphone\fR \- Only one number supported at the moment.  No validation." 4
.IX Item "phone - Only one number supported at the moment. No validation."
.IP "\fBwebsite\fR \- No validation." 4
.IX Item "website - No validation."
.IP "\fBopening_hours_text\fR \- A freeform text field." 4
.IX Item "opening_hours_text - A freeform text field."
.RE
.RS 4
.RE
.IP "\fBjson_maker\fR" 4
.IX Item "json_maker"
.PD
Returns a raw Wiki::Toolkit::Plugin::JSON object created with the values you
invoked this module with.
.IP "\fBmake_prefs_json\fR" 4
.IX Item "make_prefs_json"
.Vb 3
\&    my $json_writer = OpenGuides::JSON\->new( wiki   => $wiki,
\&                                             config => $config );
\&    print $json_writer\->make_prefs_json();
.Ve
.Sp
Retrieves the preferences from any stored preferences cookie, supplies
defaults for any preferences not set, returns the result as \s-1JSON.\s0
.IP "\fBmake_recentchanges_json\fR" 4
.IX Item "make_recentchanges_json"
.Vb 4
\&    # Ten most recent changes.
\&    print "Content\-Type: application/javascript\en";
\&    print "Last\-Modified: " . $json_writer\->json_timestamp( items => 10 ) . "\en\en";
\&    print $json_writer\->make_recentchanges_json( items => 10 );
\&
\&    # All the changes made by bob in the past week, ignoring minor edits.
\&
\&    my %args = (
\&                 days               => 7,
\&                 ignore_minor_edits => 1,
\&                 filter_on_metadata => { username => "bob" },
\&               );
\&
\&    print "Content\-Type: application/javascript\en";
\&    print "Last\-Modified: " . $json_writer\->json_timestamp( %args ) . "\en\en";
\&    print $json_writer\->make_recentchanges_json( %args );
.Ve
.IP "\fBjson_timestamp\fR" 4
.IX Item "json_timestamp"
.Vb 1
\&    print "Last\-Modified: " . $json_writer\->json_timestamp( %args ) . "\en\en";
.Ve
.Sp
Returns the timestamp of the \s-1RSS\s0 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 \fBmake_recentchanges_json()\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
<http://openguides.org/>
.IP "\(bu" 4
<http://chefmoz.org/>
.SH "AUTHOR"
.IX Header "AUTHOR"
The OpenGuides Project (openguides\-dev@openguides.org)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 2003\-2013 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"
Code in this module is mostly pirated from OpenGuides::RDF, those authors deserve all the credit. Chris Prather
did the pirating.