NAME
Bible::OBML::Reference - Simple Bible reference parser
VERSION
version 1.06
SYNOPSIS
use Bible::OBML::Reference;
my $self = Bible::OBML::Reference->new;
my $ref = $self->parse('Text that includes Romans 2:2-14 and other words');
my @books = $self->books;
my @acronyms = $self->acronyms;DESCRIPTION
This module primarily provides a method to parse text to pull out canonical Bible references. These are "address references" only, such as "James 1:5". There are supporting methods that may also be useful such as returning a list of books and acronyms.
METHODS
parse
This method expects to receive a text string and will return a list of canonical Bible references that it was able to derive from the string. The method will parse the string looking for what appear to be references. If any are found, they are canonicalized and returned.
my @ref = $self->parse('Text that includes Romans 2:2-14 and other words');
# $ref[0] now contains "Romans 2:2-14"You can also provide an optional second parameter, and if it is positive, the method will return acronyms instead of full book names. Also note that the method will return an arrayref insteaf an array if in scalar context.
my $ref = $self->parse('Text that includes Romans 2:2-14 and other words');
# $ref->[0] now contains "Ro 2:2-14"books
my @books = $self->books;
my $book = $self->books('Genesis');Returns either a list of all books of the Bible or a single book title that matches the acronym provided.
acronyms
my @acronyms = $self->acronyms;
my $acronym = $self->acronyms('Genesis');Returns either a list of all short acronyms or a single short acronym that matches the book full title provided.
ATTRIBUTES
bible
This is a read-only attribute that contains an arrayref of arrayrefs, each containing 3 text strings. The first string is the full name of a book of the Bible, followed by a very short acronym, followed by a more common and slightly longer acronym. The books (as arrayrefs) are listed in Bible order. For example:
[ 'Genesis', 'Ge', 'Gen' ],
[ 'Exodus', 'Ex', 'Exo' ],
[ 'Leviticus', 'Le', 'Lev' ],SEE ALSO
You can also look for additional information at:
AUTHOR
Gryphon Shafer <gryphon@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Gryphon Shafer.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.