view release on metacpan or  search on metacpan

README.rpod  view on Meta::CPAN

=pod

README for DiaColloDB::WWW

=head1 ABSTRACT

DiaColloDB::WWW - www wrapper scripts and utitilties for DiaColloDB diachronic collocation database


=head1 REQUIREMENTS


=head2 Perl Modules

The following non-core perl modules are required,
and should be available from L<CPAN|http://www.cpan.org>.

=over 4

=item DiaColloDB

=item File::Copy::Recursive

=item File::ShareDir

=item File::ShareDir::Install

=item File::chmod::Recursive

=item HTTP::Daemon

=item HTTP::Message

=item MIME::Types

=item Template

=item URI

=item URI::Escape

=back

=head2 Additional Requirements

In order to make use of this module,
you will also need
an existing DiaCollo index to query.
See L<dcdb-create.perl(1)|dcdb-create.perl>
from the L<DiaColloDB|DiaColloDB> distribution
for details.



=head1 DESCRIPTION

The DiaColloDB::WWW package provides a set of Perl modules
and wrapper scripts implementing a simple webservice API
for L<DiaColloDB|DiaColloDB> indices, including a simple
user interface and online visualization.

=head1 INSTALLATION

Issue the following commands to the shell:

 bash$ cd DiaColloDB-WWW-0.01 # (or wherever you unpacked this distribution)
 bash$ perl Makefile.PL       # check requirements, etc.
 bash$ make                   # build the module
 bash$ make test              # (optional): test module before installing
 bash$ make install           # install the module on your system

See L<perlmodinstall> for details.

=head1 USAGE

Assuming you have a raw text corpus you would like to access via this module,
the following steps will be required:

=head2 Corpus Annotation and Conversion

Your corpus must be tokenized and annotated with whatever word-level attributes and/or
document-level metadata you wish to be able to query; in particular document date is
required. See L<DiaColloDB::Document/SUBCLASSES> for a list of currently supported
corpus formats.

=head2 DiaCollo Index Creation

You will need to compile a L<DiaColloDB|DiaColloDB> index for your corpus.