koRpus (version 0.10-2)

read.hyph.pat: Reading patgen-compatible hyphenation pattern files

Description

This function reads hyphenation pattern files, to be used with hyphen.

Usage

read.hyph.pat(file, lang, fileEncoding = "UTF-8")

Arguments

file

A character string with a valid path to a file with hyphenation patterns (one pattern per line).

lang

A character string, usually two letters short, naming the language the patterns are meant to be used with (e.g. "es" for Spanish).

fileEncoding

A character string defining the character encoding of the file to be read. Unless you have a really good reason to do otherwise, your pattern files should all be UTF-8 encoded.

Value

An object of class kRp.hyph.pat-class.

Details

Hyphenation patterns that can be used are available from CTAN[1]. But actually any file with only the patterns themselves, one per line, should work.

The language designation is of no direct consequence here, but if the resulting pattern object is to be used by other functions in this package, it should resamble the designation that's used for the same language there.

References

[1] http://tug.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/txt/

See Also

hyphen, manage.hyph.pat

Examples

# NOT RUN {
read.hyph.pat("~/patterns/hyph-en-us.pat.txt", lang="en_us")
# }