.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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::Locator::Grid 3pm"
.TH Wiki::Toolkit::Plugin::Locator::Grid 3pm "2007-10-23" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Wiki::Toolkit::Plugin::Locator::Grid \- A Wiki::Toolkit plugin to manage co\-ordinate data.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Access to and calculations using co-ordinate metadata supplied to a
Wiki::Toolkit wiki when writing a node.
.PP
\&\fBNote:\fR This is \fIread-only\fR access. If you want to write to a node's
metadata, you need to do it using the \f(CW\*(C`write_node\*(C'\fR method of
Wiki::Toolkit.
.PP
We assume that the points are located on a flat, square grid with unit
squares of side 1 metre.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Wiki::Toolkit;
\&  use Wiki::Toolkit::Plugin::Locator::Grid;
.Ve
.PP
.Vb 3
\&  my $wiki = Wiki::Toolkit\->new( ... );
\&  my $locator = Wiki::Toolkit::Plugin::Locator::Grid\->new;
\&  $wiki\->register_plugin( plugin => $locator );
.Ve
.PP
.Vb 2
\&  $wiki\->write_node( "Jerusalem Tavern", "A good pub", $checksum,
\&                     { x => 531674, y => 181950 } ) or die "argh";
.Ve
.PP
.Vb 2
\&  # Just retrieve the co\-ordinates.
\&  my ( $x, $y ) = $locator\->coordinates( node => "Jerusalem Tavern" );
.Ve
.PP
.Vb 3
\&  # Find the straight\-line distance between two nodes, in metres.
\&  my $distance = $locator\->distance( from_node => "Jerusalem Tavern",
\&                                     to_node   => "Calthorpe Arms" );
.Ve
.PP
.Vb 3
\&  # Find all the things within 200 metres of a given place.
\&  my @others = $locator\->find_within_distance( node   => "Albion",
\&                                               metres => 200 );
.Ve
.PP
.Vb 5
\&  # Maybe our wiki calls the x and y co\-ordinates something else.
\&  my $locator = Wiki::Toolkit::Plugin::Locator::Grid\->new(
\&                                                       x => "os_x",
\&                                                       y => "os_y",
\&                                                     );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "\fBnew\fR" 4
.IX Item "new"
.Vb 3
\&  # By default we assume that x and y co\-ordinates are stored in
\&  # metadata called "x" and "y".
\&  my $locator = Wiki::Toolkit::Plugin::Locator::Grid\->new;
.Ve
.Sp
.Vb 5
\&  # But maybe our wiki calls the x and y co\-ordinates something else.
\&  my $locator = Wiki::Toolkit::Plugin::Locator::Grid\->new(
\&                                                       x => "os_x",
\&                                                       y => "os_y",
\&                                                     );
.Ve
.IP "\fBx_field\fR" 4
.IX Item "x_field"
.Vb 1
\&  my $x_field = $locator\->x_field;
.Ve
.Sp
An accessor, returns the name of the metadata field used to store the
x\-coordinate.
.IP "\fBy_field\fR" 4
.IX Item "y_field"
.Vb 1
\&  my $y_field = $locator\->y_field;
.Ve
.Sp
An accessor, returns the name of the metadata field used to store the
y\-coordinate.
.IP "\fBcoordinates\fR" 4
.IX Item "coordinates"
.Vb 1
\&  my ($x, $y) = $locator\->coordinates( node => "Jerusalem Tavern" );
.Ve
.Sp
Returns the x and y co-ordinates stored as metadata last time the node
was written.
.IP "\fBdistance\fR" 4
.IX Item "distance"
.Vb 3
\&  # Find the straight\-line distance between two nodes, in metres.
\&  my $distance = $locator\->distance( from_node => "Jerusalem Tavern",
\&                                     to_node   => "Calthorpe Arms" );
.Ve
.Sp
.Vb 5
\&  # Or in kilometres, and between a node and a point.
\&  my $distance = $locator\->distance( from_x  => 531467,
\&                                     from_y  => 183246,
\&                                     to_node => "Duke of Cambridge",
\&                                     unit    => "kilometres" );
.Ve
.Sp
Defaults to metres if \f(CW\*(C`unit\*(C'\fR is not supplied or is not recognised.
Recognised units at the moment: \f(CW\*(C`metres\*(C'\fR, \f(CW\*(C`kilometres\*(C'\fR.
.Sp
Returns \f(CW\*(C`undef\*(C'\fR if one of the endpoints does not exist, or does not
have both co-ordinates defined. The \f(CW\*(C`node\*(C'\fR specification of an
endpoint overrides the x/y co-ords if both specified (but don't do
that).
.Sp
\&\fBNote:\fR Works to the nearest metre. Well, actually, calls \f(CW\*(C`int\*(C'\fR and
rounds down, but if anyone cares about that they can send a patch.
.IP "\fBfind_within_distance\fR" 4
.IX Item "find_within_distance"
.Vb 3
\&  # Find all the things within 200 metres of a given place.
\&  my @others = $locator\->find_within_distance( node   => "Albion",
\&                                               metres => 200 );
.Ve
.Sp
.Vb 4
\&  # Or within 200 metres of a given location.
\&  my @things = $locator\->find_within_distance( x      => 530774,
\&                                               y      => 182260,
\&                                               metres => 200 );
.Ve
.Sp
Units currently understood: \f(CW\*(C`metres\*(C'\fR, \f(CW\*(C`kilometres\*(C'\fR. If both \f(CW\*(C`node\*(C'\fR
and \f(CW\*(C`x\*(C'\fR/\f(CW\*(C`y\*(C'\fR are supplied then \f(CW\*(C`node\*(C'\fR takes precedence. Croaks if
insufficient start point data supplied.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.RS 4
.IP "* Wiki::Toolkit" 4
.IX Item "Wiki::Toolkit"
.PD 0
.IP "* OpenGuides \- an application that uses this plugin." 4
.IX Item "OpenGuides - an application that uses this plugin."
.RE
.RS 4
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Kake Pugh (kake@earth.li).
The Wiki::Toolkit team (http://www.wiki\-toolkit.org/)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 2
\&     Copyright (C) 2004 Kake L Pugh.  All Rights Reserved.
\&     Copyright (C) 2006 the Wiki::Toolkit Team. All Rights Reserved.
.Ve
.Sp
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"
This module is based heavily on (and is the replacement for)
Wiki::Toolkit::Plugin::Locator::UK.
.Sp
The following thanks are due to people who helped with
Wiki::Toolkit::Plugin::Locator::UK: Nicholas Clark found a very silly
bug in a pre-release version, oops :) Stephen White got me thinking in
the right way to implement \f(CW\*(C`find_within_distance\*(C'\fR. Marcel Gruenauer
helped me make \f(CW\*(C`find_within_distance\*(C'\fR work properly with postgres.