blib/man3/Reference::Field::Author.3pm

   1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "Reference::Field::Author 3pm"
 127 .TH Reference::Field::Author 3pm "2009-03-23" "perl v5.14.2" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 Reference::Field::Author \-\-
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .SH "DESCRIPTION"
 137 .IX Header "DESCRIPTION"
 138 .SH "TODO"
 139 .IX Header "TODO"
 140 \&\s-1XXX\s0 Allow the corresponding author to be set explicitely
 141 .PP
 142 \&\s-1XXX\s0 To do this, we need to break away from using the author field as
 143 an arrayref, and instead use a hashref with the author fields, and a
 144 specific corresponding author setting. [This should probaly be de
 145 riguer for other fields as well.]
 146 .SH "BUGS"
 147 .IX Header "BUGS"
 148 None known.
 149 .SS "author"
 150 .IX Subsection "author"
 151 \fIUsage\fR
 152 .IX Subsection "Usage"
 153 .PP
 154 \fIFunction\fR
 155 .IX Subsection "Function"
 156 .PP
 157 \fIReturns\fR
 158 .IX Subsection "Returns"
 159 .PP
 160 \fIArgs\fR
 161 .IX Subsection "Args"
 162 .SS "corresponding_author"
 163 .IX Subsection "corresponding_author"
 164 .Vb 1
 165 \&     my $corresponding_author = $ref\->corresponding_author;
 166 .Ve
 167 .PP
 168 Returns the corresponding author (the last author listed.)
 169 .SS "first_author"
 170 .IX Subsection "first_author"
 171 .Vb 1
 172 \&     my $first_author = $ref\->first_author;
 173 .Ve
 174 .PP
 175 Returns the first author (primary author.)
 176 .SS "_parse_author"
 177 .IX Subsection "_parse_author"
 178 .Vb 1
 179 \&     my $author_info = _parse_author($author);
 180 .Ve
 181 .PP
 182 Parses the author and returns an author record.
 183 .PP
 184 Author record
 185 .PP
 186 The author can be specified in a few different ways:
 187 .IP "\s-1SCALAR\s0 Author Name" 4
 188 .IX Item "SCALAR Author Name"
 189 .RS 4
 190 .PD 0
 191 .IP "\s-1SMITH\s0 John W." 4
 192 .IX Item "SMITH John W."
 193 .IP "Smith \s-1JW\s0" 4
 194 .IX Item "Smith JW"
 195 .IP "John W. Smith" 4
 196 .IX Item "John W. Smith"
 197 .IP "John Wilkenson Smith" 4
 198 .IX Item "John Wilkenson Smith"
 199 .IP "\s-1HASHREF\s0 Author structure" 4
 200 .IX Item "HASHREF Author structure"
 201 .IP "\s-1ARRAYREF\s0 Author Name" 4
 202 .IX Item "ARRAYREF Author Name"
 203 .RE
 204 .RS 4
 205 .PD
 206 .Sp
 207 In these cases, the author's name should be parsed appropriately. [\s-1XXX\s0
 208 Needs to be extended to handle Smith, John W. appropriately.]
 209 .RE
 210 .SS "_delete_author"
 211 .IX Subsection "_delete_author"
 212 \&\s-1XXX\s0 \s-1NOT\s0 \s-1IMPLEMENTED\s0
 213 .SS "_init"
 214 .IX Subsection "_init"
 215 Called by Reference's new function
 216 .PP
 217 Call superclass's _init function [\f(CW\*(C`$self\-\*(C'\fRNEXT::_init>], sets up the
 218 author list reference.
 219 .SH "POD ERRORS"
 220 .IX Header "POD ERRORS"
 221 Hey! \fBThe above document had some coding errors, which are explained below:\fR
 222 .IP "Around line 282:" 4
 223 .IX Item "Around line 282:"
 224 You forgot a '=back' before '=head2'