org.daisy.dotify.package-info Maven / Gradle / Ivy
/**
*
* Provides a braille translation system. The system can convert XML documents
* into braille or other text-oriented display formats.
*
*
*
* This package contains the application runnable (the command line ui), a
* component for UI embedding of Dotify and system keys and properties.
*
*
* The key packages for extending locale support in the application are:
*
*
* - org.daisy.dotify.config
* - org.daisy.dotify.setups
* - org.daisy.dotify.translator
* - org.daisy.dotify.hyphenator
*
* Extending Dotify
* The entry point to extending Dotify is to implement a task system
* and add to it the tasks that your locale needs. The task system is
* responsible for the entire conversion chain - from the input format
* to the output format. A TaskSystem implementation should contain at least
* two steps in order to fulfill the general contract of Dotify:
*
*
* - An input format detection and conversion to OBFL
*
* Since the Dotify formatter only understands OBFL markup, the first step in a task system
* is typically a translation between the grammar in the input document and OBFL.
* In many cases, this can be achieved by applying an XSLT tailored for the task.
* Page layout, such as headers and footers, as well as the interpretation of all
* elements in the input document should be handled by this XSLT. See
* http://code.google.com/p/obfl/ for a description of this format.
*
* - An OBFL format to a PagedMedia conversion.
*
The LayoutEngineTask is specifically designed for handling OBFL input and
* converting it into braille. For example:
* setup.add(new LayoutEngineTask("OBFL to PEF converter", flow,
paginator, paged));
*
*
*
*
* Note that the translator and hyphenator packages are located in a separate
* project, see the repository layout for more information.
*
* @author Joel Håkansson
*/
package org.daisy.dotify;