Shlomi Fish > File-Format-CRD > File::Format::CRD::Reader

Download:
File-Format-CRD-0.0.4.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: v0.0.4   Source  

NAME ^

File::Format::CRD::Reader - read Windows .CRD files.

VERSION ^

version 0.0.4

SYNOPSIS ^

    use File::Format::CRD::Reader;

    my $reader = File::Format::CRD::Reader->new({ filename => $filename});

    while (my $card = $reader->get_next_card({encoding => "windows-1255"}))
    {
        print "Title = " , $card->{'title'}, "\nBody = <<<\n",
            $card->{'body'}, "\n>>>\n\n";
    }

VERSION ^

Version 0.0.4

METHODS ^

File::Format::CRD::Reader->new({filename => $filename});

Open CRD file $filename for reading.

$self->get_num_cards()

Get the number of cards.

$self->finish()

Clean up and finish. Can no longer read cards after that.

$self->get_next_card({encoding => "windows-1255"})

Get the next card. Returns undef or the empty list at the end of the file, and a hash-ref like that upon success:

    {
        'title' => "My Card",
        'body' => "Body of card\nHello",
    }

The encoding parameter 'encoding' can be used to decode the card using a certain encoding.

AUTHOR ^

Shlomi Fish, http://www.shlomifish.org/

BUGS ^

Please report any bugs or feature requests to bug-file-format-crd at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Format-CRD. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc File::Format::CRD::Reader

You can also look for information at:

ACKNOWLEDGEMENTS ^

This module is based on http://ihaa.com/english/crd2html.html by ihaa.com.

COPYRIGHT & LICENSE ^

Copyright 2010 Shlomi Fish.

This program is distributed under the MIT (X11) License: http://www.opensource.org/licenses/mit-license.php

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

AUTHOR ^

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE ^

This software is Copyright (c) 2010 by Shlomi Fish.

This is free software, licensed under:

  The MIT (X11) License

BUGS ^

Please report any bugs or feature requests on the bugtracker website http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-Format-CRD or by email to bug-file-format-crd@rt.cpan.org.

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT ^

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc File::Format::CRD

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-file-format-crd at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Format-CRD. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

http://bitbucket.org/shlomif/perl-file-format-crd

  hg clone ssh://hg@bitbucket.org/shlomif/perl-file-format-crd
syntax highlighting: