.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "MARC::Schema 3pm"
.TH MARC::Schema 3pm "2023-03-12" "perl v5.36.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
.SH "NAME"
MARC::Schema \- Specification of the MARC21 format
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # in Perl
\& use MARC::Schema;
\&
\& my $record = {
\& _id => \*(Aqfol05865967\*(Aq,
\& record => [
\& [ \*(AqLDR\*(Aq, undef, undef, \*(Aq_\*(Aq, \*(Aq00661nam 22002538a 4500\*(Aq ],
\& [ \*(Aq001\*(Aq, undef, undef, \*(Aq_\*(Aq, \*(Aqfol05865967\*(Aq ],
\& [ \*(Aq001\*(Aq, undef, undef, \*(Aq_\*(Aq, \*(Aqfield is not repeatable\*(Aq ],
\& [ \*(Aq245\*(Aq, \*(Aq1\*(Aq, \*(Aq0\*(Aq, \*(Aqa\*(Aq, \*(AqProgramming Perl /\*(Aq,
\& \*(Aqc\*(Aq, \*(AqLarry Wall, Tom Christiansen & Jon Orwant.\*(Aq,
\& \*(Aqa\*(Aq, \*(Aqsubfield is not repeatable\*(Aq,
\& \*(Aqx\*(Aq, \*(Aqunknown subfield\*(Aq,
\& ],
\& [ \*(Aq999\*(Aq, undef, undef, \*(Aq_\*(Aq, \*(Aqnot a standard field\*(Aq]
\& ]
\& };
\&
\& # load default schema
\& my $schema = MARC::Schema\->new();
\&
\& # load custom schema from file
\& my $schema = MARC::Schema\->new({ file => share/marc\-schema.json });
\&
\&
\& # load custom schema
\& my $schema = MARC::Schema\->new(
\& { fields => {
\& \*(Aq001\*(Aq => { label => \*(AqControl Number\*(Aq, repetable => 0 }
\& }
\& }
\& );
\& my @check = $schema\->check($record);
\&
\& # via the command line
\& $ marcvalidate t/camel.mrc
\& $ marcvalidate \-\-schema marc_schema.json t/camel.mrc
\& $ marcvalidate \-\-type XML marc.xml
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
MARC::Schema defines a set of \s-1MARC21\s0 fields and subfields to validate Catmandu::MARC records. A schema is given as hash reference such as:
.PP
.Vb 9
\& { fields => {
\& LDR => {
\& positions =>
\& [ { position => \*(Aq00\-04\*(Aq, label => \*(AqRecord length\*(Aq } ],
\& repeatable => 0,
\& },
\& \*(Aq001\*(Aq => { label => \*(AqControl Number\*(Aq, repeatable => 0 }
\& }
\& }
.Ve
.PP
For a more detailed description of the (default) schema see \s-1MARC21\s0 structure in \s-1JSON\s0 .
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "check( $record [, %options ] )"
.el .SS "check( \f(CW$record\fP [, \f(CW%options\fP ] )"
.IX Subsection "check( $record [, %options ] )"
Check whether a given \*(L"Catmandu::Importer::MARC\*(R" or \*(L"MARC::Parser::*\*(R" record confirms to the schema and return a list of detected violations. Possible options include:
.IP "ignore_unknown_fields" 4
.IX Item "ignore_unknown_fields"
Don't report fields not included in the schema.
.IP "ignore_unknown_subfields" 4
.IX Item "ignore_unknown_subfields"
Don't report subfields not included in the schema.
.PP
Errors are given as list of hash references with keys \f(CW\*(C`error\*(C'\fR, \f(CW\*(C`tag\*(C'\fR,
\&\f(CW\*(C`type\*(C'\fR and \f(CW\*(C`value\*(C'\fR of the violated field. \f(CW\*(C`error\*(C'\fR contains a
human-readable error message for each violated field and/or subfield.
.ie n .SS "check_field( $field [, %options ] )"
.el .SS "check_field( \f(CW$field\fP [, \f(CW%options\fP ] )"
.IX Subsection "check_field( $field [, %options ] )"
Check whether a \s-1MARC21\s0 field confirms to the schema. Use same options as method \f(CW\*(C`check\*(C'\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Johann Rolschewski
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Patrick Hochstenbach
.PP
Steve Rogerson
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2018\- Johann Rolschewski
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catmandu::Validator
.PP
JSON::Schema
.PP
PICA::Schema
.PP
MARC::Lint
.SH "ACKNOWLEDGEMENT"
.IX Header "ACKNOWLEDGEMENT"
MARC::Schema uses the \s-1MARC21\s0 schema developed by Pe\*'ter Kira\*'ly as default. For more information see \*(L"Metadata assessment for \s-1MARC\s0 records\*(R" and \*(L"\s-1MARC21\s0 structure in \s-1JSON\*(R"\s0 .