The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Text::Tradition::Parser::CollateX

SYNOPSIS

  use Text::Tradition;
  
  my $t_from_file = Text::Tradition->new( 
    'name' => 'my text',
    'input' => 'CollateX',
    'file' => '/path/to/collation.xml'
    );
    
  my $t_from_string = Text::Tradition->new( 
    'name' => 'my text',
    'input' => 'CollateX',
    'string' => $collation_xml,
    );

DESCRIPTION

Parser module for Text::Tradition, given a GraphML file from the CollateX program that describes a collation graph. For further information on the GraphML format for text collation, see http://gregor.middell.net/collatex/

METHODS

parse

parse( $tradition, $init_options );

Takes an initialized Text::Tradition object and a set of options; creates the appropriate nodes and edges on the graph. The options hash should include either a 'file' argument or a 'string' argument, depending on the source of the XML to be parsed.

BUGS / TODO

  • Make this into a stream parser with GraphML

  • Use CollateX-calculated ranks instead of recalculating our own

LICENSE

This package is free software and is provided "as is" without express or implied warranty. You can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Tara L Andrews, aurum@cpan.org