.\" 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
.\" ========================================================================
.\"
.IX Title "Biblio::SICI::ContributionSegment 3pm"
.TH Biblio::SICI::ContributionSegment 3pm "2023-02-06" "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"
Biblio::SICI::ContributionSegment \- The contribution segment of a SICI
.SH "VERSION"
.IX Header "VERSION"
version 0.04
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $sici = Biblio::SICI\->new();
\&
\&  $sici\->contribution\->location(\*(Aq6\-21\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fIPlease note:\fR You are expected to not directly instantiate objects of this class!
.PP
The contribution segment of a \s-1SICI\s0 contains information about a contribution 
to an item, e.g. about an article published in a journal issue.
A \s-1SICI\s0 can be valid without containing data on a contribution so this segment may
be empty / unused.
.PP
For further information please have a look at the standard.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
For each attribute, clearer (\*(L"clear_\*(R") and predicate (\*(L"has_\*(R") methods
are provided.
.ie n .IP """location""" 4
.el .IP "\f(CWlocation\fR" 4
.IX Item "location"
The location of the contribution within the item. A typical example
would be the range of pages an article was printed on.
.ie n .IP """titleCode""" 4
.el .IP "\f(CWtitleCode\fR" 4
.IX Item "titleCode"
A special code of no more than 6 characters, derived from the title 
of the contribution.
Rules for the construction of the code are provided in the standard.
.ie n .IP """localNumber""" 4
.el .IP "\f(CWlocalNumber\fR" 4
.IX Item "localNumber"
An opaque number that somehow describes the contribution
in the context of its item.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "\s-1STRING\s0 ""to_string""()" 4
.el .IP "\s-1STRING\s0 \f(CWto_string\fR()" 4
.IX Item "STRING to_string()"
Returns a stringified representation of the data in the
contribution segment.
.ie n .IP """reset""()" 4
.el .IP "\f(CWreset\fR()" 4
.IX Item "reset()"
Resets all attributes to their default values.
.Sp
Resetting the contribution segment also resets the value of the
\&\f(CW\*(C`csi\*(C'\fR attribute in the control segment!
.ie n .IP "\s-1BOOL\s0 ""is_valid""()" 4
.el .IP "\s-1BOOL\s0 \f(CWis_valid\fR()" 4
.IX Item "BOOL is_valid()"
Checks if the data for the contribution segment conforms
to the standard.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Biblio::SICI::Role::ValidSegment
.SH "AUTHOR"
.IX Header "AUTHOR"
Heiko Jansen <hjansen@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2014 by Heiko Jansen.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.