Taxi::Mysql::Format::TextBibl - hit list formatter: single text attribute, indented metadata


NAME

Taxi::Mysql::Format::TextBibl - hit list formatter: single text attribute, indented metadata

(Back to Top)


SYNOPSIS

 ##========================================================================
 ## PRELIMINARIES
 use Taxi::Mysql::Format::TextBibl;
 ##========================================================================
 ## Constructors etc.
 $q = $CLASS_OR_OBJ->new(%args);
 ##========================================================================
 ## API
 $str = $fmt->toString($hl);

(Back to Top)


DESCRIPTION

Taxi::Mysql::Format::Text is a class for formatting HitList objects to human-readable wrapped and indented text.

Globals etc.

Variable: @ISA

Taxi::Mysql::Format::Text inherits from and implements the API specified by Taxi::Mysql::Format::Text1.

Constructors etc.

new
 $q = $CLASS_OR_OBJ->new(%args);

Object structure, known %args:

   {
    ##-- bibl formatting
    prepend    => $prepend_str,       ##-- defulat: ''
    append     => $append_str,        ##-- default: "\n"
    prependHit => $prepend_hit,       ##-- default: ''
    appendHit  => $append_hit,        ##-- default: ''
    indentAll  => $global_indent_str, ##-- default: ''
    indentBibl => $bibl_indent_str,   ##-- default: "\t"
    pagewidth  => $ncols,             ##-- default=80
    ##-- target column selection (from ../Text1)
    textCol   => $col, ##-- sets $fmt->{textCols}; default='text'
    ##-- Text formatting (from ../Text)
    biblCols  => \@biblCols,   ##-- key pseudo-set: bibliographic columns from hit (default=all but 'text')
    mark      => [$pre,$post], ##-- match highlighting strings
    ##-- Source data (from ../Format)
    index  => $index,     ##-- underlying Taxi::Mysql object
   }

API

toString
 $str = $fmt->toString($hl);

(undocumented)

(Back to Top)


ACKNOWLEDGEMENTS

Perl by Larry Wall.

(Back to Top)


AUTHOR

Bryan Jurish <moocow@ling.uni-potsdam.de>

(Back to Top)


COPYRIGHT AND LICENSE

Copyright (C) 2006 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.8.7 or, at your option, any later version of Perl 5 you may have available.

(Back to Top)


SEE ALSO

perl(1), Taxi::Mysql(3perl), Taxi::Mysql::Format(3perl), Taxi::Mysql::Format::Text1(3perl).

(Back to Top)

 Taxi::Mysql::Format::TextBibl - hit list formatter: single text attribute, indented metadata