Giter Club home page Giter Club logo

dotify.devtools's Introduction

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.

dotify.devtools's People

Contributors

joeha480 avatar fredrikschill avatar kalaspuffar avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.