Introduction

TeX::Hyphen -- hyphenate words using TeX's patterns

Usage

  require 'tex/hyphen'
  hyp = TeX::Hyphen.new(:file => 'hyphen.tex', :style => 'czech',
                        :leftmin => 2, :rightmin => 2)
  hyp = TeX::Hyphen.new

  word = "representation"
  points = hyp.hyphenate(word)  #=> [3, 5, 8, 10]
  puts hyp.visualize(word)      #=> rep-re-sen-ta-tion

Description

Constructor new() creates a new Hyphen object and loads the file with patterns into memory. Then you can ask it for hyphenation of a word by calling a method of this object. If no file is specified, the default Donald E. Knuth's hyphen.tex, that is included in this module, is used instead.

A TeX hyphenation object can be constructed using a few different calling methods. Any method may also take a constructor block, allowing direct access to @file, @style, @min_left, and @min_right.

arg may be one of Array, Hash, String, or nil:

Array

A four-element array in the form of: [file, style, min_left, min_right]

Hash

A hash with the following keys:

:file (or: 'file')

:style (or: 'style')

:min_left (or: :leftmin, 'min_left', 'leftmin')

:min_right (or: :rightmin, 'min_right', 'rightmin')

String

This corresponds to @file.

The parameters are:

• file The name of the file with the hyphenation patterns. It

              will be loaded and the resulting object will be able to
              hyphenate according to patterns in that file. If the
              file is not specified or is +nil+, the default
              hyphen.tex will be used (and is included in the module
              definition).
  

• style Various language use special shortcuts to specify the

              patterns. Instead of doing the full TeX expansion, we
              use Ruby code to parse the patterns. The style options
              requires a module found at "tex/hyphen/#{@style}" and
              uses the parsing functions found in it.
  
              Currently, the default Czech (works for English as
              well) and German are available. See TeX::Hyphen::Czech
              for more information, especially if you want to support
              other languages and styles.
  

• min_left The minimum starting substring which will not be

              hyphenated. This overrides the default specified in the
              style file.
  

• min_right The minimum ending substrnig which will not be

              hyphenated. This overrides the default specified int he
              style file.
  

Returns a list of places where the word can be divided, as

  hyp.hyphenate('representation')

returns [3, 5, 8, 10].

Returns a visualization of the hyphenation points, so:

  hyp.visualize('representation')

should return rep-re-sen-ta-tion, at elast for English patterns.

This function will hyphenate a word