Read Me

=pod

README for DDC::Concordance (formerly known as ddc-perl)

=head1 ABSTRACT

DDC::Concordance - Query and wrapper utilities for the ddc-concordance search engine

=head1 REQUIREMENTS

=over 4

=item IO::Socket::INET

=item NetServer::Generic

(for server wrapping)

=item Text::Wrap

=item Lingua::LTS

(for LTS wrapping, see 'grimm/lts/Lingua-LTS' directory in the DWDS subversion repository)

=back

=head1 RECOMMENDATIONS

=over 4

=item DDC::XS

XS wrappers for the  libDDC* C++ libraries will be used if available.

=item a running DDC server

(for client connection)
Current sources for the DDC search engine should be available from
L<http://sourceforge.net/projects/ddc-concordance/>, and should be installable
for supported systems via the L<Alien::DDC::Concordance|Alien::DDC::Concordance>
module, available on CPAN.

=back



=head1 DESCRIPTION

The DDC::Concordance package (formerly known as F<ddc-perl>)
provides object-oriented wrappers for querying and/or wrapping
a DDC corpus index server.  Also included in the distribution are some example
scripts for querying a server, simple query expansion using an LTS transducer
and an indexed 'pho' field, as well as a drop-in wrapper for an underlying
DDC server which performs transparent query translation for an indexed
'pho' field.

=head2 Current Version

Current sources for this module should be available from CPAN (L<http://metacpan.org/release/DDC-Concordance>)
or via sourceforce (L<https://sourceforge.net/projects/ddc-concordance/files/ddc-perl/>).

=head1 KNOWN BUGS

=head2 Conflicting CPAN module names

Unforunately, the top-level C<DDC> namespace conflicts with another module on CPAN,
namely Torsten Raudssus' "DDC" from the "Data-Coloured" distribution (L<https://metacpan.org/pod/DDC>).
As a workaround to this problem, the top-level module for this package has been renamed
to C<DDC::Concordance> in ddc-perl v0.17.
New code should use the L<DDC::Concordance|DDC::Concordance>
module directly as a top-level entry point and dependency target.

For backwards-compatibility,
the F<ddc-perl-compat> distribution is provided to enable older code to run without explicit changes,
but note that its installation may cause unexpected results if you also use
the C<DDC> module from the "Data::Coloured" distribution.
If necessary, you can explicitly define a dependency on C<DDC::Compat> to ensure that
a backwards-compatible top-level C<use DDC;> will load the L<DDC::Concordance|DDC::Concordance>
module.
The F<ddc-perl-compat> distribution is available
via sourceforce (L<https://sourceforge.net/projects/ddc-concordance/files/ddc-perl/>).

=head1 AUTHOR

Bryan Jurish E<lt>moocow@cpan.orgE<gt>

=cut