Aard

 view release on metacpan or  search on metacpan

MANIFEST  view on Meta::CPAN

Changes
Makefile.PL
MANIFEST
README
t/Aard.t
t/jargon-4.4.7-1.aar
lib/Aard.pm
META.yml                                 Module YAML meta-data (added by MakeMaker)
META.json                                Module JSON meta-data (added by MakeMaker)
SIGNATURE                                Public-key signature (added by MakeMaker)

README  view on Meta::CPAN

Aard version 0.001
==================

Aard is a module for reading files in the Aard Dictionary format (.aar). A dictionary is an array of (key, article) pairs, with some associated metadata.

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

lib/Aard.pm  view on Meta::CPAN

=head1 SYNOPSIS

  use Aard;
  my $dict = Aard->new('something.aar');
  printf "This dictionary (volume %d of %d) has %d entries\n", $dict->volume, $dict->total_volumes, $dict->count;
  printf "The tenth entry's key: %s\n", $dict->key(9);
  printf "The tenth entry's value: %s\n", $dict->article(9);

=head1 DESCRIPTION

Aard is a module for reading files in the Aard Dictionary format (.aar). A dictionary is an array of I<(key, article)> pairs, with some associated metadata.

=over

=item B<new>(I<filename>)

Creates a new Aard object for the given file.

=item B<fh>

Returns the open filehandle to the dictionary.

lib/Aard.pm  view on Meta::CPAN

=item B<volume>

Returns the volume number of this file.

=item B<total_volumes>

Returns the total number of volumes for this dictionary.

=item B<meta>

Returns the raw metadata as a hashref.

=item B<article_count>

Returns the number of unique articles in this volume (if B<article_count_is_volume_total> is true) or in this dictionary (otherwise).

=item B<article_count_is_volume_total>

Returns true if B<article_count> means number of articles in this volume. This is always true since aardtools 0.9.0.

=item B<index_language>

lib/Aard.pm  view on Meta::CPAN

=item B<copyright>

Returns the copyright notice

=item B<license>

Returns the full license text

=item B<source>

Returns the dictionary data source

=back

=head1 SEE ALSO

L<http://aarddict.org>, L<http://aarddict.org/aardtools/doc/aardformat.html>

=head1 AUTHOR

Marius Gavrilescu, E<lt>marius@ieval.roE<gt>