.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.37 .\" .\" 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. | will give a .\" real vertical bar. \*(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-|\(bv\*(Tr .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 "Geography::States 3" .TH Geography::States 3 "2009-04-09" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Geography::States \- Map states and provinces to their codes, and vica versa. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Geography::States; .Ve .PP .Vb 1 \& my $obj = Geography::States -> new (COUNTRY [, STRICT]); .Ve .SH "EXAMPLES" .IX Header "EXAMPLES" .Vb 1 \& my $canada = Geography::States -> new ('Canada'); .Ve .PP .Vb 4 \& my $name = $canada -> state ('NF'); # Newfoundland. \& my $code = $canada -> state ('Ontario'); # ON. \& my ($code, $name) = $canada -> state ('BC'); # BC, British Columbia. \& my @all_states = $canada -> state; # List code/name pairs. .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module lets you map states and provinces to their codes, and codes to names of provinces and states. .PP The \f(CW\*(C`Geography::States \-\*(C'\fR new ()> call takes 1 or 2 arguments. The first, required, argument is the country we are interested in. Current supported countries are \fI\s-1USA\s0\fR, \fIBrazil\fR, \fICanada\fR, \fIThe Netherlands\fR, and \fIAustralia\fR. If a second non-false argument is given, we use \fIstrict mode\fR. In non-strict mode, we will map territories and alternative codes as well, while we do not do that in strict mode. For example, if the country is \fB\s-1USA\s0\fR, in non-strict mode, we will map \fB\s-1GU\s0\fR to \fBGuam\fR, while in strict mode, neither \fB\s-1GU\s0\fR and \fBGuam\fR will be found. .Sh "The \fIstate()\fP method" .IX Subsection "The state() method" All queries are done by calling the \f(CW\*(C`state\*(C'\fR method in the object. This method takes an optional argument. If an argument is given, then in scalar context, it will return the name of the state if a code of a state is given, and the code of a state, if the argument of the method is a name of a state. In list context, both the code and the state will be returned. .PP If no argument is given, then the \f(CW\*(C`state\*(C'\fR method in list context will return a list of all code/name pairs for that country. In scalar context, it will return the number of code/name pairs. Each code/name pair is a 2 element anonymous array. .PP Arguments can be given in a case insensitive way; if a name consists of multiple parts, the number of spaces does not matter, as long as there is some whitespace. (That is \*(L"NewYork\*(R" is wrong, but \*(L"new\ \s-1YORK\s0\*(R" is fine.) .SH "ODDITIES AND OPEN QUESTIONS" .IX Header "ODDITIES AND OPEN QUESTIONS" I found conflicting abbreviations for the \s-1US\s0 \fINorthern Mariana Islands\fR, listed as \fI\s-1NI\s0\fR and \fI\s-1MP\s0\fR. I picked \fI\s-1MP\s0\fR from the \s-1USPS\s0 site. .PP One site listed \fIMidway Islands\fR as having code \fI\s-1MD\s0\fR. It is not listed by the \s-1USPS\s0 site, and because it conflicts with \fIMaryland\fR, it is not put in this listing. .PP The \s-1USPS\s0 also has so-called \fIMilitary \*(L"States\*(R"\fR, with non-unique codes. Those are not listed here. .PP Canada's \fIQuebec\fR has two codes, the older \fI\s-1PQ\s0\fR and the modern \fI\s-1QC\s0\fR. Both \&\fI\s-1PQ\s0\fR and \fI\s-1QC\s0\fR will map to \fIQuebec\fR, but \fIQuebec\fR will only map to \fI\s-1QC\s0\fR. With strict mode, \fI\s-1PQ\s0\fR will not be listed. Similary, Newfoundland has an old code \fI\s-1NF\s0\fR, and a new code \fI\s-1NL\s0\fR (the province is now called \&\fINewfoundland and Labrador\fR). .SH "DEVELOPMENT" .IX Header "DEVELOPMENT" The current sources of this module are found on github, . .SH "AUTHOR" .IX Header "AUTHOR" Abigail . .SH "COPYRIGHT and LICENSE" .IX Header "COPYRIGHT and LICENSE" Copyright (C) 1999 \- 2001, 2009 by Abigail. .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE\s0 \s-1SOFTWARE\s0 \s-1IS\s0 \s-1PROVIDED\s0 \*(L"\s-1AS\s0 \s-1IS\s0\*(R", \s-1WITHOUT\s0 \s-1WARRANTY\s0 \s-1OF\s0 \s-1ANY\s0 \s-1KIND\s0, \s-1EXPRESS\s0 \s-1OR\s0 \&\s-1IMPLIED\s0, \s-1INCLUDING\s0 \s-1BUT\s0 \s-1NOT\s0 \s-1LIMITED\s0 \s-1TO\s0 \s-1THE\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0, \&\s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0 \s-1AND\s0 \s-1NONINFRINGEMENT\s0. \s-1IN\s0 \s-1NO\s0 \s-1EVENT\s0 \s-1SHALL\s0 \&\s-1THE\s0 \s-1AUTHOR\s0 \s-1BE\s0 \s-1LIABLE\s0 \s-1FOR\s0 \s-1ANY\s0 \s-1CLAIM\s0, \s-1DAMAGES\s0 \s-1OR\s0 \s-1OTHER\s0 \s-1LIABILITY\s0, \&\s-1WHETHER\s0 \s-1IN\s0 \s-1AN\s0 \s-1ACTION\s0 \s-1OF\s0 \s-1CONTRACT\s0, \s-1TORT\s0 \s-1OR\s0 \s-1OTHERWISE\s0, \s-1ARISING\s0 \s-1FROM\s0, \s-1OUT\s0 \&\s-1OF\s0 \s-1OR\s0 \s-1IN\s0 \s-1CONNECTION\s0 \s-1WITH\s0 \s-1THE\s0 \s-1SOFTWARE\s0 \s-1OR\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0 \s-1OTHER\s0 \s-1DEALINGS\s0 \s-1IN\s0 \&\s-1THE\s0 \s-1SOFTWARE\s0.