view release on metacpan or  search on metacpan

docs/ascii/citeparser.txt  view on Meta::CPAN

    The toolkit came about as a result of the ParaCite resource, a reference
    search engine located at http://paracite.eprints.org, which uses a
    template-based reference parser to extract metadata from provided
    references and then provides search results based on this metadata. The
    ParaCite parser is provided directly as the
    Biblio::Citation::Parser::Standard module, with a separate Templates
    module that can be replaced as new reference templates are located.

    As well as providing examples for the provided parsing modules, ParaTools
    also includes examples for using the ParaCite web service. This is an
    alternate interface which provides access to ParaCite's search and parsing
    functionality for any language that supports the Web Services Description
    Language (WSDL).

Who should use ParaTools?
    The ParaTools package has many applications, including:

    *       Converting reference lists into valid OpenURLs

    *       Converting existing metadata into valid OpenURLs

    *       Collecting metadata from references to carry out internal searches

    *       Extracting reference lists from documents

    *       Carrying out searches using ParaCite

    The modularity of ParaTools means that it is very easy to add new
    techniques (and we would be very pleased to hear of new ones!).

What will it run on?
    ParaTools should work on any platform that supports Perl 5.6.0 or higher,
    although testing was primarily carried out using Red Hat Linux 7.3 with
    Perl 5.6. Where possible platform-agnostic modules have been used for file
    functionality, so temporary files should be placed in the correct place
    for the operating system. Memory requirements for ParaTools are minimal,
    although the template parser and document parser will require more memory
    as the number of templates and sizes of documents increase.

This Documentation
    This documentation is written in perl POD format and converted into
    Postscript (which is 2 pages to a sheet for printing), ASCII, PDF, and
    HTML.

    The latest version of this documentation can be obtained from
    http://paracite.eprints.org/files/docs/


==============================================================================
Required Software
==============================================================================

What software does Biblio::Citation::Parser need?
  Perl Modules
    URI     URI is required for the OpenURL encoding functions in
            Biblio::Citation::Parser::Utils.

    Text::Unidecode
            Used by Biblio::Citation::Parser::Citebase to allow for matching
            on unicode strings.

    URI::OpenURL (Optional)
            If you wish to create valid OpenURLs, URI::OpenURL provides a set
            of functions for this purpose. The metadata produced by
            Biblio::Citation::Parser can be used with this module.

    SOAP::Lite (Optional)
            This module is required if you wish to use the ParaCite web
            services, but optional otherwise. This requires several other
            modules, which are available in the soap subdirectory of
            http://paracite.eprints.org/files/perlmods/.

    There are also some dependencies for the above modules, including
    MIME::Base64, HTML::TagSet, and Digest::MD5. The latest versions of these
    can be obtained from http://www.cpan.org/

  Installing Perl Modules
    This describes the way to install a simple perl module, some require a bit
    more effort. We will use the non-existent FOO module as an example.

    Unpack the archive:
             % tar xfvz FOO-5.2.34.tar.gz

    Enter the directory this creates:
             % cd FOO-5.2.34

    Run the following commands:
             % perl ./Build.PL
             % ./Build
             % ./Build test
             % ./Build install


==============================================================================
How to Install Biblio::Citation::Parser
==============================================================================

Installation
    First unpack the Biblio::Citation::Parser archive:

     % tar xfvz <packagename>.tar.gz

    Move into the unpacked folder, and then do the following:

     % perl Build.PL
     % ./Build

    You can optionally run

     % ./Build test

    which will carry out a few checks to ensure everything is working
    correctly.

    Finally, become root and do:

     % ./Build install

    This will install the modules and man pages into the correct locations.