Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.62 KB

readme.md

File metadata and controls

57 lines (38 loc) · 2.62 KB

Build Status Type License: LGPL v2.1

dotify.devtools

In addition to the Dotify project, there is a DotifyDevtools project in the code repository. DotifyDevtools contains tools that are useful when developing for Dotify, but are not needed when running the final software.

Main Features

Tools included in devtools:

  • GenerateTableEntries
  • SchematronRulesGenerator
  • PefFileCompareUI
  • Unbrailler
  • and more

GenerateTableEntries

This tool allows a user to generate braille table entries for a span of unicode characters that are to be added to a braille table. Currently, the parameters are embedded in the code, and need to be recompiled if modified.

SchematronRulesGenerator

This tool can be used to build schematron files using a compact java notation.

PefFileCompareUI

This tool can be used for regression testing. It allows detailed comparing between two folders of pef-files, ignoring meta data.

Environment variables

org.daisy.dotify.devtools.regression.baseline specifies whether the baseline should be updated or just used for comparison.

values: update or compare (default)

org.daisy.dotify.devtools.regression.mode specifies whether the Dotify CLI should be called with the convert command or not.

values: convert or legacy (default)

Unbrailler

This tool can be used to compare text differences in an xml-editor. A folder is scanned for PEF-files and the braille in each file is replaced by ascii characters for easier debugging.

Using

To use the bundle, download the latest release from maven central install it in your local maven cache with:

gradlew install (Windows) or ./gradlew install (Mac/Linux)

Building

Build with gradlew build (Windows) or ./gradlew build (Mac/Linux)

Testing

Tests are run with gradlew test (Windows) or ./gradlew test (Mac/Linux)

Javadoc

Javadoc for the latest Dotify Devtools is available here.

Requirements & Compatibility

  • Requires Java 8

More information

See the common wiki for more information.