GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  TEXT::HYPHEN (3)

.ds Aq ’

NAME

Text::Hyphen - determine positions for hyphens inside words

CONTENTS

VERSION

Version 0.1

SYNOPSIS

This module implements Knuth-Liang algorithm to find positions inside words where it is possible to insert hyphens to break a line.



    use Text::Hyphen;

    my $hyphenator = new Text::Hyphen;

    print $hyphenator->hyphenate(representation);
    # prints rep-re-sen-ta-tion



EXPORT

This version does not export anything and uses OOP interface. This will probably change.

XXX employ a singleton to provide functional interface

FUNCTIONS

    new(%options)

Creates the hyphenator object.

You can pass several options:
min_word Minimum length of word to be hyphenated. Shorter words are returned right away. Defaults to 5 for English.
min_prefix Minimal prefix to leave without any hyphens. Defaults to 2 for English.
min_suffix Minimal suffix to leave wothout any hyphens. Defaults to 2 for English.

    hyphenate($word, [$delim])

Hyphenates the $word by inserting $delim into hyphen positions. $delim defaults to dash (-).

AUTHOR

Alex Kapranoff, <kappa at cpan.org>

BUGS

Please report any bugs or feature requests to bug-text-hyphen at rt.cpan.org, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-Hyphen>. I will be notified, and then you’ll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.



    perldoc Text::Hyphen



You can also look for information at:
o RT: CPAN’s request tracker

<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Text-Hyphen>

o AnnoCPAN: Annotated CPAN documentation

<http://annocpan.org/dist/Text-Hyphen>

o CPAN Ratings

<http://cpanratings.perl.org/d/Text-Hyphen>

o Search CPAN

<http://search.cpan.org/dist/Text-Hyphen>

ACKNOWLEDGEMENTS

Donald Knuth and Frank Liang for the algorithm.

Alexander Lebedev for all his valuable work on russian ispell dictionaries and russian hyphenation patterns. See his archive at <ftp://scon155.phys.msu.ru/pub/russian/>.

Mark-Jason Dominus and Jan Pazdziora for Text::Hyphenate and TeX::Hyphenate modules on CPAN both of which are hopefully obsoleted by Text::Hyphen :)

Ned Batchelder for his public domain Python implementation of Knuth-Liang algorithm available at <http://nedbatchelder.com/code/modules/hyphenate.html>.

COPYRIGHT & LICENSE

Copyright 2008 Alex Kapranoff.

This program is released under the following license: BSD.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 TEXT::HYPHEN (3) 2008-12-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.