Documentation
¶
Overview ¶
Package hyphenation is a quick and dirty implementation of a hyphenation algorithm.
(TODO: make more time and space efficient).
Package for an algorithm to hyphenate words. It is based on an algorithm described by Frank Liang (F.M.Liang http://www.tug.org/docs/liang/). It loads a pattern file (available with the TeX distribution) and builds a trie structure, carrying an array of positions at every 'leaf'.
The trie package I'm using here is a very naive implementation and should be replaced by a more sophisticated one (e.g., https://github.com/siongui/go-succinct-data-structure-trie). Resulting from the API of the trie, the implementation of the pattern application algorithm is bad. TODO: improve time complexity of pattern application.
Further Reading
https://www.microsoft.com/en-us/Typography/OpenTypeSpecification.aspx https://nedbatchelder.com/code/modules/hyphenate.html (Python implementation) http://www.mnn.ch/hyph/hyphenation2.html / https://github.com/mnater/hyphenator
----------------------------------------------------------------------
BSD License ¶
Copyright (c) 2017-20, Norbert Pillmayer ¶
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of this software nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Dictionary ¶
type Dictionary struct {
Identifier string // Identifies the dictionary
// contains filtered or unexported fields
}
Dictionary is a type representing a hyphenation dictionary. A hyphenation dictionary consists of hyphenation patterns and a list of exceptions
func LoadPatterns ¶
func LoadPatterns(patternfile string) *Dictionary
LoadPatterns loads a pattern file. Returns the identifier of the pattern file and a trie.
Patterns are enclosed in between
\patterns{ % some comment
...
.wil5i
.ye4
4ab.
a5bal
a5ban
abe2
...
}
Odd numbers stand for possible discretionnaries, even numbers forbid hyphenation. Digits belong to the character immediately after them, i.e.,
"a5ban" => (a)(5b)(a)(n) => positions["aban"] = [0,5,0,0].
func (*Dictionary) Hyphenate ¶
func (dict *Dictionary) Hyphenate(word string) []string
Hyphenate returns a word split up at legal hyphenation positions.
Example:
"table" => [ "ta", "ble" ].
func (*Dictionary) HyphenationString ¶
func (dict *Dictionary) HyphenationString(word string) string
HyphenationString return a word with possible hyphens inserted. Example:
"table" => "ta-ble".
Source Files