<html><head><metahttp-equiv="content-type"content="text/html; charset=utf-8"/><title>Hyphenate</title><linkrel="stylesheet"type="text/css"href="scribble.css"title="default"/><linkrel="stylesheet"type="text/css"href="racket.css"title="default"/><linkrel="stylesheet"type="text/css"href="manual-style.css"title="default"/><linkrel="stylesheet"type="text/css"href="manual-racket.css"title="default"/><scripttype="text/javascript"src="scribble-common.js"></script><scripttype="text/javascript"src="manual-racket.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><bodyid="scribble-racket-lang-org"><divclass="tocset"><divclass="tocview"><divclass="tocviewlist tocviewlisttopspace"><divclass="tocviewtitle"><tablecellspacing="0"cellpadding="0"><tr><tdstyle="width: 1em;"><ahref="javascript:void(0);"title="Expand/Collapse"class="tocviewtoggle"onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><ahref="index.html"class="tocviewselflink"data-pltdoc="x">Hyphenate</a></td></tr></table></div><divclass="tocviewsublistonly"style="display: none;"id="tocview_0"><tablecellspacing="0"cellpadding="0"><tr><tdalign="right">1 </td><td><ahref="index.html#%28part._.Installation%29"class="tocviewlink"data-pltdoc="x">Installation</a></td></tr><tr><tdalign="right">2 </td><td><ahref="index.html#%28part._.Importing_the_module%29"class="tocviewlink"data-pltdoc="x">Importing the module</a></td></tr><tr><tdalign="right">3 </td><td><ahref="index.html#%28part._.Interface%29"class="tocviewlink"data-pltdoc="x">Interface</a></td></tr><tr><tdalign="right">4 </td><td><ahref="index.html#%28part._.License___source_code%29"class="tocviewlink"data-pltdoc="x">License & source code</a></td></tr></table></div></div></div><divclass="tocsub"><tableclass="tocsublist"cellspacing="0"><tr><td><spanclass="tocsublinknumber"></span><ahref="#%28part._.Hyphenate%29"class="tocsubseclink"data-pltdoc="x">Hyphenate</a></td></tr><tr><td><spanclass="tocsublinknumber">1<tt> </tt></span><ahref="#%28part._.Installation%29"class="tocsubseclink"data-pltdoc="x">Installation</a></td></tr><tr><td><spanclass="tocsublinknumber">2<tt> </tt></span><ahref="#%28part._.Importing_the_module%29"class="tocsubseclink"data-pltdoc="x">Importing the module</a></td></tr><tr><td><spanclass="tocsublinknumber">3<tt> </tt></span><ahref="#%28part._.Interface%29"class="tocsubseclink"data-pltdoc="x">Interface</a></td></tr><tr><td><ahref="#%28def._%28%28lib._hyphenate%2Fmain..rkt%29._hyphenate%29%29"class="tocsubnonseclink"data-pltdoc="x"><spanclass="RktSym"><spanclass="RktValLink">hyphenate</span></span></a></td></tr><tr><td><ahref="#%28def._%28%28lib._hyphenate%2Fmain..rkt%29._unhyphenate%29%29"class="tocsubnonseclink"data-pltdoc="x"><spanclass="RktSym"><spanclass="RktValLink">unhyphenate</span></span></a></td></tr><tr><td><spanclass="tocsublinknumber">4<tt> </tt></span><ahref="#%28part._.License___source_code%29"class="tocsubseclink"data-pltdoc="x">License & source code</a></td></tr></table></div></div><divclass="maincolumn"><divclass="main"><divclass="versionbox"><spanclass="versionNoNav">6.0.1.13</span></div><h2><aname="(part._.Hyphenate)"></a><aname="(mod-path._hyphenate)"></a><aname="(mod-path._(submod._hyphenate._safe))"></a>Hyphenate</h2><divclass="SAuthorListBox"><spanclass="SAuthorList"><pclass="author">Matthew Butterick <<ahref="mailto:mb@mbtype.com">mb@mbtype.com</a>></p></span></div><p><tablecellspacing="0"cellpadding="0"class="defmodule"><tr><tdalign="left"><spanclass="hspace"> </span><spanclass="RktPn">(</span><spanclass="RktSym"><ahref="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29"class="RktStxLink"data-pltdoc="x">require</a></span><spanclass="stt"></span><ahref="index.html"class="RktModLink"data-pltdoc="x"><spanclass="RktSym">hyphenate</span></a><spanclass="RktPn">)</span
</div><divclass="SIntrapara"><tablecellspacing="0"cellpadding="0"><tr><td><p><spanclass="stt">raco pkg install hyphenate</span></p></td></tr></table></div></p><p><divclass="SIntrapara">After that, you can update the package like so:
</div><divclass="SIntrapara"><tablecellspacing="0"cellpadding="0"><tr><td><p><spanclass="stt">raco pkg update hyphenate</span></p></td></tr></table></div></p><h3>2<tt> </tt><aname="(part._.Importing_the_module)"></a>Importing the module</h3><p>The module operates in two modes: fast and safe. Fast mode is the default, which you get by importing the module in the usual way: <spanclass="RktPn">(</span><spanclass="RktSym"><ahref="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29"class="RktStxLink"data-pltdoc="x">require</a></span><spanclass="RktMeta"></span><spanclass="hspace"> </span><spanclass="RktMeta"></span><spanclass="RktSym"><ahref="index.html#%28def._%28%28lib._hyphenate%2Fmain..rkt%29._hyphenate%29%29"class="RktValLink"data-pltdoc="x">hyphenate</a></span><spanclass="RktPn">)</span><spanclass="RktMeta"></span>.</p><p>Safe mode enables the function contracts documented below. Use safe mode by importing the module as <spanclass="RktPn">(</span><spanclass="RktSym"><ahref="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._require%29%29"class="RktStxLink"data-pltdoc="x">require</a></span><spanclass="RktMeta"></span><spanclass="hspace"> </span><spanclass="RktMeta"></span><spanclass="RktPn">(</span><spanclass="RktSym"><ahref="http://docs.racket-lang.org/reference/require.html#%28form._%28%28lib._racket%2Fprivate%2Fbase..rkt%29._submod%29%29"class="RktStxLink"data-pltdoc="x">submod</a></span><spanclass="RktMeta"></span><spanclass="hspace"> </span><spanclass="RktMeta"></span><spanclass="RktSym"><ahref="index.html#%28def._%28%28lib._hyphenate%2Fmain..rkt%29._hyphenate%29%29"class="RktValLink"data-pltdoc="x">hyphenate</a></span><spanclass="RktMeta"></span><spanclass="hspace"> </span><spanclass="RktMeta"></span><spanclass="RktSym">safe</span><spanclass="RktPn">)</span><spanclass="RktPn">)</span><spanclass="RktMeta"></span>.</p><h3>3<tt> </tt><aname="(part._.Interface)"></a>Interface</h3><p><divclass="SIntrapara"><blockquoteclass="SVInsetFlow"><tablecellspacing="0"cellpadding="0"class="boxed RBoxed"><tr><td><blockquoteclass="SubFlow"><divclass="RBackgroundLabel SIEHidden"><divclass="RBackgroundLabelInner"><p>procedure</p></div></div><tablecellspacing="0"cellpadding="0"class="prototype RForeground"><tr><td><spanclass="RktPn">(</span><aname="(def._((lib._hyphenate/main..rkt)._hyphenate))"></a><spantitle="Provided from: hyphenate, (submod hyphenate safe) | Package: hyphenate"><spanclass="RktSym"><ahref="index.html#%28def._%28%28lib._hyphenate%2Fmain..rkt%29._hyphenate%29%29"class="RktValDef RktValLink"data-pltdoc="x">hyphenate</a></span></span></td><td><spanclass="hspace"> </span></td><td><spanclass="RktVar">xexpr</span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td></tr><tr><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span>[</td><td><spanclass="RktVar">joiner</span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td></tr><tr><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="RktPn">#:exceptions</span><spanclass="hspace"> </span><spanclass="RktVar">exceptions</span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td></tr><tr><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="RktPn">#:min-length</span><spanclass="hspace"> </span><spanclass="RktVar">length</span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td><td><spanclass="hspace"> </span></td>