linebreak-1.0.0.1: breaks strings to fit width

Copyright(C) 2014 Francesco Ariis
LicenseBSD3 (see LICENSE file)
MaintainerFrancesco Ariis <fa-ml@ariis.it>
Stabilityprovisional
Portabilityportable
Safe HaskellSafe-Inferred
LanguageHaskell98

Text.LineBreak

Description

Simple functions to break a String to fit a maximum text width, using Knuth-Liang hyphenation algorithm.

Example:

import Text.Hyphenation
import Text.LineBreak

hyp = Just english_US
bf = BreakFormat 25 4 '-' hyp
cs = "Using hyphenation with gruesomely non parsimonious wording."
main = putStr $ breakString bf cs

will output:

Using hyphenation with
gruesomely non parsimo-
nious wording.

Synopsis

Documentation

breakString :: BreakFormat -> String -> String Source

Breaks some text (String) to make it fit in a certain width. The output is a String, suitable for writing to screen or file.

breakStringLn :: BreakFormat -> String -> [String] Source

Convenience for lines $ breakString bf cs

data BreakFormat Source

How to break the strings: maximum width of the lines, number of spaces to replace tabs with (dumb replacement), symbol to use to hyphenate words, hypenator to use (language, exceptions, etc.; refer to Text.Hyphenation for usage instructions). To break lines without hyphenating, put Nothing in bfHyphenator.