.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 "EBook::Tools::BISG 3pm" .TH EBook::Tools::BISG 3pm "2019-08-08" "perl v5.28.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" EBook::Tools::BISG \- Class for downloading information from the Book Industry Study Group webpages .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 6 \& use EBook::Tools::BISG; \& my $bisg = EBook::Tools::BISG\->new(); \& $bisg\->download_bisac; \& $bisg\->save_bisac; \& say $bisg\->bisac(\*(Aqfic000000\*(Aq); \& %bisac_codes = $bisg\->bisac(); .Ve .SH "DEPENDENCIES" .IX Header "DEPENDENCIES" .IP "\(bu" 4 \&\f(CW\*(C`DBI\*(C'\fR .Sp This will also require a \s-1DBD\s0 of your choice. The default is to use a local SQLite store. .IP "\(bu" 4 \&\f(CW\*(C`LWP\*(C'\fR .IP "\(bu" 4 \&\f(CW\*(C`Mojo::DOM\*(C'\fR .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .ie n .SS """new(%args)""" .el .SS "\f(CWnew(%args)\fP" .IX Subsection "new(%args)" Instantiates a new Ebook::Tools::BISG object. .PP \fIArguments\fR .IX Subsection "Arguments" .IP "\(bu" 4 \&\f(CW\*(C`baseurl\*(C'\fR .Sp The base url of the bisg.org website or mirror to use. .IP "\(bu" 4 \&\f(CW\*(C`dsn\*(C'\fR .Sp The Perl::DBI Data Source Name. Defaults to a sqlite store named bisac.sqlite in the user config directory. .SH "ACCESSOR METHODS" .IX Header "ACCESSOR METHODS" .ie n .SS """bisac($code)""" .el .SS "\f(CWbisac($code)\fP" .IX Subsection "bisac($code)" Returns either the name matching a particular code (case-insensitive), or the hash of all \s-1BISAC\s0 codes and references with the keys in lower-case if no argument is provided. .ie n .SS """find($regexp)""" .el .SS "\f(CWfind($regexp)\fP" .IX Subsection "find($regexp)" Returns a list of all \s-1BISAC\s0 values (names) where either the key or the value for that entry matches a case-insensitive regular expression. If no argument is specified, or it is just '.', then the entire list is returned. .SH "MODIFIER METHODS" .IX Header "MODIFIER METHODS" .ie n .SS """download_bisac()""" .el .SS "\f(CWdownload_bisac()\fP" .IX Subsection "download_bisac()" Downloads the \s-1BISAC\s0 codes from the \s-1BISG\s0 website and converts them into a hash. Codes and obsolete entries are lowercased and made the keys, the values will be the official names they map to. .ie n .SS """load_bisac()""" .el .SS "\f(CWload_bisac()\fP" .IX Subsection "load_bisac()" Load the \s-1BISAC\s0 codes from the specified database into the hash. This is called automatically by \fBnew()\fR. .PP If the load fails, nothing will happen (silently!), so the only way to tell is to check to see if you have a populated hash afterwards. .ie n .SS """save_bisac()""" .el .SS "\f(CWsave_bisac()\fP" .IX Subsection "save_bisac()" Save the \s-1BISAC\s0 codes in the hash to the database. This will destroy any existing table named bisac_codes. .PP Croaks on failure.