NAME
HTML::Timeline - Convert a Gedcom file into a Timeline file
Synopsis
shell> bin/timeline.pl -hDescription
HTML::Timeline is a pure Perl module.
Distributions
This module is available as a Unix-style distro (*.tgz).
See http://savage.net.au/Perl-modules.html for details.
See http://savage.net.au/Perl-modules/html/installing-a-module.html for help on unpacking and installing.
Constructor and initialization
new(...) returns an object of type HTML::Timeline.
This is the class's contructor.
Usage: HTML::Timeline -> new().
This method takes a hashref of options.
Call new() as new({option_1 => value_1, option_2 => value_2, ...}).
Available options:
- ancestors
-
If this option is 1, the ancestors of the root_person (see below) are processed.
If this option is 0, their descendents are processed.
The default is 0.
- everyone
-
If this option is 1, everyone is processed, and the root_person (see below) is ignored.
If this option is 0, the root_person is processed.
The default is 0.
- gedcom_file
-
This takes the name of your input Gedcom file.
The default is bach.ged.
- include_spouses
-
If this option is 1, and descendents are processed, spouses are included.
If this option is 0, spouses are ignored.
The default is 0.
- root_person
-
The name of the person on which to base the timeline.
The default is 'Johann Sebastian Bach'.
- verbose
-
This takes either a 0 or a 1.
Write more or less progress messages to STDERR.
The default value is 0.
- xml_file
-
The name of your XML output file.
The default value is 'timeline.xml'.
Note: The name of the XML file is embedded in timeline.html, at line 28. You will need to edit the latter file if you use a different name for your XML output file.
Method: log($message)
If new() was called as new({verbose => 1}), write the message to STDERR.
If new() was called as new({verbose => 0}) (the default), do nothing.
Method: run()
Do everything.
See examples/timeline.pl for an example of how to call run().
Required Modules
Some of these are only used by bin/timeline.pl.
See also
The Gedcom module.
Support
Support is via the Gedcom mailing list.
Subscribe via perl-gedcom-subscribe@perl.org.
Credits
The MIT Simile Timeline project, and others, are at http://code.google.com/p/simile-widgets/.
Its original home is at http://simile.mit.edu/timeline.
Philip Durbin write the program examples/ged2xml.pl, which Ron Savage converted into a module.
Philip also supplied the files examples/bach.* and examples/timeline.html.
Ron Savage wrote bin/timeline.pl.
examples/timeline.xml is the output of this program, using the default options.
Author
HTML::Timeline was written by Ron Savage in 2008. [ron@savage.net.au]
Home page: http://savage.net.au/index.html
Copyright
Australian copyright (c) 2008, 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