org.daisy.dotify.translator.package-info Maven / Gradle / Ivy
/**
* Provides braille transformation classes. This package contains everything
* needed to transform text into braille. Hyphenation is handled
* internally by the translator. This design allows
* for non-standard hyphenation as well as line break dependent braille
* markers, such as continuation signs etc.
*
* The entry point for translating braille is the BrailleTranslatorFactoryMaker
* where an instance of a BrailleTranslator can be obtained.
*
* To add a translator for another language:
*
* - Implement BrailleTranslator for your locale and place it the
* org.daisy.dotify.translator.impl package or in a sub package thereof.
* - Add the name of your implementation to the org.daisy.dotify.translator.BrailleFilter
* file in META-INF/services
* - If your implementation uses a grade not defined in
* {@link org.daisy.dotify.api.translator.BrailleTranslatorFactory},
* please add it to the API so that others may know about it.
*
*
* @author Joel Håkansson
*/
package org.daisy.dotify.translator;