.\" 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
.\" ========================================================================
.\"
.IX Title "Text::BibTeX::Validate 3pm"
.TH Text::BibTeX::Validate 3pm "2021-02-28" "perl v5.32.1" "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"
Text::BibTeX::Validate \- validator for BibTeX format
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Text::BibTeX;
\&    use Text::BibTeX::Validate qw( validate_BibTeX );
\&
\&    my $bibfile = Text::BibTeX::File\->new( \*(Aqbibliography.bib\*(Aq );
\&    while( my $entry = Text::BibTeX::Entry\->new( $bibfile ) ) {
\&        for my $warning (validate_BibTeX( $entry )) {
\&            print STDERR "$warning\en";
\&        }
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Text::BibTeX::Validate checks the standard fields of BibTeX entries for
their compliance with their format. In particular, value of \f(CW\*(C`email\*(C'\fR is
checked against \s-1RFC 822\s0 mandated email address syntax, value of \f(CW\*(C`doi\*(C'\fR
is checked to start with \f(CW10.\fR and contain at least one \f(CW\*(C`/\*(C'\fR and so on.
Some nonstandard fields as \f(CW\*(C`isbn\*(C'\fR, \f(CW\*(C`issn\*(C'\fR and \f(CW\*(C`url\*(C'\fR are also checked.
Failures of checks are returned as instances of
Text::BibTeX::Validate::Warning.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "validate_BibTeX( $what )"
.el .SS "validate_BibTeX( \f(CW$what\fP )"
.IX Subsection "validate_BibTeX( $what )"
Takes plain Perl hash reference containing BibTeX fields and their
values, as well as Text::BibTeX::Entry instances
and returns an array of validation messages as instances of
Text::BibTeX::Validate::Warning.
.ie n .SS "clean_BibTeX( $what )"
.el .SS "clean_BibTeX( \f(CW$what\fP )"
.IX Subsection "clean_BibTeX( $what )"
Takes the same input as \f(CW\*(C`validate_BibTeX\*(C'\fR and attempts to reconcile
trivial issues like dropping the resolver \s-1URL\s0 part of DOIs (see
\&\f(CW\*(C`shorten_DOI\*(C'\fR method) and converting month numbers into three-letter
abbreviations.
.ie n .SS "shorten_DOI( $doi )"
.el .SS "shorten_DOI( \f(CW$doi\fP )"
.IX Subsection "shorten_DOI( $doi )"
Remove the resolver \s-1URL\s0 part, as well as \f(CW\*(C`doi:\*(C'\fR prefixes, from DOIs.
.SH "AUTHORS"
.IX Header "AUTHORS"
Andrius Merkys, <merkys@cpan.org>