.\" 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 .\" .\" 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 "Biblio::Citation::Parser::Utils 3pm" .TH Biblio::Citation::Parser::Utils 3pm "2021-01-09" "perl v5.32.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::Citation::Parser::Utils \- OpenURL utility functions .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module contains methods for the parsing of reference metadata into OpenURLs. Although we have aimed to make it 1.0 compliant, there may well be errors (please let us know if there are!). .SH "METHODS" .IX Header "METHODS" .ie n .IP "$openurl_hash = Biblio::Citation::Parser::Utils::trim_openurl($openurl)" 4 .el .IP "\f(CW$openurl_hash\fR = Biblio::Citation::Parser::Utils::trim_openurl($openurl)" 4 .IX Item "$openurl_hash = Biblio::Citation::Parser::Utils::trim_openurl($openurl)" This method takes a hash of metadata, and returns a hash that contains only valid OpenURL fields. .ie n .IP "$openurl_hash = Biblio::Citation::Parser::Utils::decompose_openurl($openurl)" 4 .el .IP "\f(CW$openurl_hash\fR = Biblio::Citation::Parser::Utils::decompose_openurl($openurl)" 4 .IX Item "$openurl_hash = Biblio::Citation::Parser::Utils::decompose_openurl($openurl)" This method aims to enrich an OpenURL metadata hash by applying various parsing techniques to the fields. It decomposes dates into years, months, and days if possible, fills in the appropriate fields if SICIs are present, and ensures URLs, ISBNs, etc, are valid. It returns a pointer to a hash containing the modified metadata, and an array of errors (if any). .ie n .IP "$openurl = Biblio::Citation::Parser::create_openurl($metadata)" 4 .el .IP "\f(CW$openurl\fR = Biblio::Citation::Parser::create_openurl($metadata)" 4 .IX Item "$openurl = Biblio::Citation::Parser::create_openurl($metadata)" This method creates and returns an OpenURL from a metadata hash. No base URLs are prepended to this, so this should be done before using it as a link. URI::OpenURL should be used to generate OpenURLs in place of this function. .ie n .IP "$valid_isbn = Biblio::Citation::Parser::Utils::isbn_check(@isbn_chars)" 4 .el .IP "\f(CW$valid_isbn\fR = Biblio::Citation::Parser::Utils::isbn_check(@isbn_chars)" 4 .IX Item "$valid_isbn = Biblio::Citation::Parser::Utils::isbn_check(@isbn_chars)" This is a simple function that takes an array of \s-1ISBN\s0 characters, and returns true if it is a valid \s-1ISBN.\s0 .ie n .IP "$sici_hash = Biblio::Citation::Parser::Utils::parse_sici($sici)" 4 .el .IP "\f(CW$sici_hash\fR = Biblio::Citation::Parser::Utils::parse_sici($sici)" 4 .IX Item "$sici_hash = Biblio::Citation::Parser::Utils::parse_sici($sici)" This function takes a \s-1SICI\s0 string, and returns a hash of information parsed from it, including date information, issn numbers, etc. .ie n .IP "$bici_hash = Biblio::Citation::Parser::Utils::parse_bici($bici)" 4 .el .IP "\f(CW$bici_hash\fR = Biblio::Citation::Parser::Utils::parse_bici($bici)" 4 .IX Item "$bici_hash = Biblio::Citation::Parser::Utils::parse_bici($bici)" This is not yet implemented, but will eventually be the \s-1BICI\s0 alternative for parse_sici. .ie n .IP "$escaped_url = ParaTools::Utils::url_escape($string)" 4 .el .IP "\f(CW$escaped_url\fR = ParaTools::Utils::url_escape($string)" 4 .IX Item "$escaped_url = ParaTools::Utils::url_escape($string)" Simple function to convert a string into an encoded \&\s-1URL\s0 (i.e. spaces to \f(CW%20\fR, etc). Takes the unencoded \&\s-1URL\s0 as a parameter, and returns the encoded version. .SH "AUTHOR" .IX Header "AUTHOR" Mike Jewell