.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "ISSN 3pm"
.TH ISSN 3pm "2008-08-06" "perl v5.14.2" "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"
Business::ISSN \- Perl extension for International Standard Serial Numbers
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use Business::ISSN;
\&        $issn_object = Business::ISSN\->new(\*(Aq1456\-5935\*(Aq);
\&        
\&        $issn_object = Business::ISSN\->new(\*(Aq14565935\*(Aq);
\&        
\&        # print the ISSN (with hyphen)
\&        print $issn_object\->as_string;
\&        
\&        # check to see if the ISSN is valid
\&        $issn_object\->is_valid;
\&        
\&        #fix the ISSN checksum.  BEWARE:  the error might not be
\&        #in the checksum!
\&        $issn_object\->fix_checksum;
\&        
\&        #EXPORTABLE FUNCTIONS
\&                
\&        use Business::ISSN qw( is_valid_checksum );
\&                
\&        #verify the checksum
\&        if( is_valid_checksum(\*(Aq01234567\*(Aq) ) { ... }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.IP "new($issn)" 4
.IX Item "new($issn)"
The constructor accepts a scalar representing the \s-1ISSN\s0.
.Sp
The string representing the \s-1ISSN\s0 may contain characters
other than [0\-9xX], although these will be removed in the
internal representation.  The resulting string must look
like an \s-1ISSN\s0 \- the first seven characters must be digits and
the eighth character must be a digit, 'x', or 'X'.
.Sp
The string passed as the \s-1ISSN\s0 need not be a valid \s-1ISSN\s0 as
long as it superficially looks like one.  This allows one to
use the \f(CW\*(C`fix_checksum\*(C'\fR method.
.Sp
One should check the validity of the \s-1ISSN\s0 with \f(CW\*(C`is_valid()\*(C'\fR
rather than relying on the return value of the constructor.
.Sp
If all one wants to do is check the validity of an \s-1ISSN\s0, 
one can skip the object-oriented  interface and use the
c<\fIis_valid_checksum()\fR> function which is exportable on demand.
.Sp
If the constructor decides it can't create an object, it
returns undef.  It may do this if the string passed as the
\&\s-1ISSN\s0 can't be munged to the internal format.
.ie n .IP "$obj\->checksum" 4
.el .IP "\f(CW$obj\fR\->checksum" 4
.IX Item "$obj->checksum"
Return the \s-1ISSN\s0 checksum.
.ie n .IP "$obj\->as_string" 4
.el .IP "\f(CW$obj\fR\->as_string" 4
.IX Item "$obj->as_string"
Return the \s-1ISSN\s0 as a string.
.Sp
A terminating 'x' is changed to 'X'.
.ie n .IP "$obj\->is_valid" 4
.el .IP "\f(CW$obj\fR\->is_valid" 4
.IX Item "$obj->is_valid"
Returns 1 if the checksum is valid.
.Sp
Returns 0 if the \s-1ISSN\s0 does not pass the checksum test.  
The constructor accepts invalid \s-1ISSN\s0's so that
they might be fixed with \f(CW\*(C`fix_checksum\*(C'\fR.
.ie n .IP "$obj\->fix_checksum" 4
.el .IP "\f(CW$obj\fR\->fix_checksum" 4
.IX Item "$obj->fix_checksum"
Replace the eighth character with the checksum the
corresponds to the previous seven digits.  This does not
guarantee that the \s-1ISSN\s0 corresponds to the product one
thinks it does, or that the \s-1ISSN\s0 corresponds to any product
at all.  It only produces a string that passes the checksum
routine.  If the \s-1ISSN\s0 passed to the constructor was invalid,
the error might have been in any of the other nine positions.
.SS "\s-1EXPORTABLE\s0 \s-1FUNCTIONS\s0"
.IX Subsection "EXPORTABLE FUNCTIONS"
Some functions can be used without the object interface.  These
do not use object technology behind the scenes.
.IP "is_valid_checksum('01234567')" 4
.IX Item "is_valid_checksum('01234567')"
Takes the \s-1ISSN\s0 string and runs it through the checksum
comparison routine.  Returns 1 if the \s-1ISSN\s0 is valid, 0 otherwise.
.SH "AUTHOR"
.IX Header "AUTHOR"
Currently maintained by brian d foy \f(CW\*(C`<brian.d.foy@gmail.com>\*(C'\fR.
Sami Poikonen <sp@iki.fi>
.PP
Original module by Sami Poikonen, based on Business::ISBN by brian d foy.
.PP
This module is released under the terms of the Perl Artistic License.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 1999\-2008, brian d foy, All Rights Reserved.
.PP
You may redistribute this under the same terms as Perl itself.