NAME

Genealogy::Gedcom::Reader - An OS-independent reader for GEDCOM data

Synopsis

See Genealogy::Gedcom::Reader::Lexer.

Description

Genealogy::Gedcom::Reader provides a reader for GEDCOM data.

See The GEDCOM Specification Ged551-5.pdf.

Distributions

This module is available as a Unix-style distro (*.tgz).

See http://savage.net.au/Perl-modules/html/installing-a-module.html for help on unpacking and installing distros.

Installation

Install Genealogy::Gedcom as you would for any Perl module:

Run:

        cpanm Genealogy::Gedcom

or run:

        sudo cpan Genealogy::Gedcom

or unpack the distro, and then either:

        perl Build.PL
        ./Build
        ./Build test
        sudo ./Build install

or:

        perl Makefile.PL
        make (or dmake or nmake)
        make test
        make install

Constructor and Initialization

See Genealogy::Gedcom::Reader::Lexer.

FAQ

o What is the purpose of this set of modules?

It's the basis of a long-term project to write a new interface to GEDCOM files.

How are the modules related?

o Genealogy::Gedcom

This is a dummy module at the moment, which just occupies the namespace.

o Genealogy::Gedcom::Reader

This employs the lexer to do the work. It may one day use a (non-existent) parser too.

Run scripts/read.pl -help.

read.pl is currenly a copy of lex.pl. The latter is recommended.

o Genealogy::Gedcom::Reader::Lexer

This does the real work for finding tokens within GEDCOM files.

Run scripts/lex.pl -help.

See Genealogy::Gedcom::Reader::Lexer for details.

Why did you choose Hash::FieldHash over Moose?

My policy is to use the light-weight Hash::FieldHash for stand-alone modules and Moose for applications.

Machine-Readable Change Log

The file CHANGES was converted into Changelog.ini by Module::Metadata::Changes.

Version Numbers

Version numbers < 1.00 represent development versions. From 1.00 up, they are production versions.

Thanks

Many thanks are due to the people who worked on Gedcom.

Support

Email the author, or log a bug on RT:

https://rt.cpan.org/Public/Dist/Display.html?Name=Genealogy::Gedcom.

Author

Genealogy::Gedcom was written by Ron Savage <ron@savage.net.au> in 2011.

Home page: http://savage.net.au/index.html.

Copyright

Australian copyright (c) 2011, Ron Savage.

        All Programs of mine are 'OSI Certified Open Source Software';
        you can redistribute them and/or modify them under the terms of
        The Artistic License, a copy of which is available at:
        http://www.opensource.org/licenses/index.html

cpanm Genealogy::Gedcom

perl -MCPAN -e shell
install Genealogy::Gedcom