##========================================================================
## POD DOCUMENTATION, auto-generated by podextract.perl

##========================================================================
## NAME
=pod

=head1 NAME

DiaColloDB::Document::DDCTabs - diachronic collocation db, source document, DDC tab-dump

=cut

##========================================================================
## SYNOPSIS
=pod

=head1 SYNOPSIS

 ##========================================================================
 ## PRELIMINARIES
 
 use DiaColloDB::Document::DDCTabs;
 
 ##========================================================================
 ## Constructors etc.
 
 $doc = CLASS_OR_OBJECT->new(%args);
 
 ##========================================================================
 ## API: I/O: parse
 
 $bool = $doc->fromFile($filename_or_fh, %opts);
 

=cut

##========================================================================
## DESCRIPTION
=pod

=head1 DESCRIPTION

DiaColloDB::Document::DDCTabs
provides a L<DiaColloDB::Document|DiaColloDB::Document>-compliant API
for parsing DDC tab-dump files as produced by C<ddc_dump --full --tabs>;
see L<http://odo.dwds.de/~moocow/software/ddc/ddc_tabs.html> for details.

=cut

##----------------------------------------------------------------
## DESCRIPTION: DiaColloDB::Document::DDCTabs: Globals & Constants
=pod

=head2 Globals & Constants

=over 4

=item Variable: @ISA

DiaColloDB::Document::DDCTabs inherits from L<DiaColloDB::Document|DiaColloDB::Document>
and supports the L<DiaColloDB::Document|DiaColloDB::Document> API.

=back

=cut

##----------------------------------------------------------------
## DESCRIPTION: DiaColloDB::Document::DDCTabs: Constructors etc.
=pod

=head2 Constructors etc.

=over 4

=item new

 $doc = CLASS_OR_OBJECT->new(%args);

%args, object structure:

 ##-- parsing options
 eosre => $re,        ##-- EOS regex (empty or undef for file-breaks only; default='^$')
 utf8  => $bool,      ##-- enable utf8 parsing? (default=1)
 trimAuthor => $bool, ##-- trim "author" meta-attribute (eliminate DTA PNDs)? (default=1)
 trimGenre  => $bool, ##-- create trimmed "genre" meta-attribute? (default=1)
 trimPND    => $bool, ##-- create trimmed "pnd" meta-attribute? (default=1)
 ##
 ##-- document data
 date   =>$date,     ##-- year
 wf     =>$iw,       ##-- index-field for $word attribute (default=0)
 pf     =>$ip,       ##-- index-field for $pos attribute (default=1)
 lf     =>$il,       ##-- index-field for $lemma attribute (default=2)
 tokens =>\@tokens,  ##-- tokens, including undef for EOS
 meta   =>\%meta,    ##-- document metadata (e.g. author, title, collection, ...)

Each token in @tokens is a HASH-ref {w=E<gt>$word,p=E<gt>$pos,l=E<gt>$lemma,...}, or undef for EOS.

=back

=cut

##----------------------------------------------------------------
## DESCRIPTION: DiaColloDB::Document::DDCTabs: API: I/O: parse
=pod

=head2 API: I/O: parse

=over 4

=item fromFile

 $bool = $doc->fromFile($filename_or_fh, %opts);

parse tokens from $filename_or_fh.
%opts: clobbers %$doc

=back

=cut

##========================================================================
## END POD DOCUMENTATION, auto-generated by podextract.perl

##========================================================================
## Example
=pod

=head1 EXAMPLE

The following is an example file in the format accepted by this module:

 %%$DDC:meta.date_=2016-02-25
 %%$DDC:meta.author=Jurish, Bryan
 %%$DDC:meta.collection=tiny
 %%$DDC:meta.textClass=dummy:test-data
 %%$DDC:meta.title=test document
 %%$DDC:BREAK.s=5
 %%$DDC:BREAK.p=11
 %%$DDC:BREAK.file=17
 %%$DDC:BREAK.textarea=17
 %%$DDC:index[0]=Token w
 %%$DDC:index[1]=Pos p
 %%$DDC:index[2]=Lemma l
 This	DT	this
 is	VBZ	be
 a	DT	a
 test	NN	test
 .	SENT	.
 
 %%$DDC:BREAK.s=5
 This	DT	this
 is	VBZ	be
 only	RB	only
 a	DT	a
 test	NN	test
 .	SENT	.
 
 %%$DDC:BREAK.s=11
 %%$DDC:BREAK.p=11
 This	DT	this
 is	VBZ	be
 still	RB	still
 a	DT	a
 test	NN	test
 .	SENT	.
 

=cut

##======================================================================
## Footer
##======================================================================
=pod

=head1 AUTHOR

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

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2015-2016 by Bryan Jurish

This package is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.

=head1 SEE ALSO

L<http://odo.dwds.de/~moocow/software/ddc/ddc_tabs.html>,
L<DiaColloDB::Document(3pm)|DiaColloDB::Document>,
L<DiaColloDB(3pm)|DiaColloDB>,
L<perl(1)|perl>,
...



=cut
