Andrew Sterling Hanenkamp > Sword-0.102800 > Sword::Manager

Download:
Sword-0.102800.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.102800   Source  

NAME ^

Sword::Manager - Sword library manager

VERSION ^

version 0.102800

SYNOPSIS ^

  use Sword;

  my $library = Sword::Manager->new;

  # List available modules (Bibles, commentaries, dictionaries, books, etc.)
  my $modules = $library->modules;

  # Get a specific module by it's short name
  my $module = $library->get_module('KJV');

DESCRIPTION ^

This Perl module provides access to the SWMgr class from the Sword Engine API.

This documentation should cover everything that you can do with it. If something is wrong or missing, please report a bug.

METHODS ^

new

  my $library = Sword::Manager->new;

This constructs a new Sword Engine manager. This object will automatically load the module configuration from the system, user, and working directory module configuration files. If you have GNOME Sword installed or another Sword-based application, this should load all the library files available to that application.

This constructor configures the library for plain text markup.

Someday, this construction will take options to allow you to customize how the library is constructed, but today is not that day.

modules

  my $modules = $library->modules;

Returns an array reference containing the Sword::Module objects for all the installed modules found in the configuration.

get_module

  my $module = $library->get_module($name);

Returns the named Sword::Module object or undef if that module is not found.

SEE ALSO ^

Sword::Module

AUTHOR ^

Andrew Sterling Hanenkamp <hanenkamp@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2010 by Qubling Software LLC.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: