Timed Text Toolkit
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Timed Text Toolkit (ttt)

A collection of related tools that provide support for or make use of the W3C Timed Text Markup Language (TTML).

Core Tools

  • Timed Text Verifier (ttv)
  • Timed Text Transformer (ttx)
  • Timed Text Transforming Verifier (ttxv)
  • Timed Text Presentation Engine (ttpe)

Conversion Tools

  • Lambda CAP to TTML Converter (cap2tt)

Build Requirements

Prior to performing a build, the following requirements must be met:

  • Install Java JDK 7 or 8.
  • Install maven 3.1 (or greater).
  • Perform one-time installation of third party library dependencies as follows, where $TTT_HOME is set to the directory where the ttt repository is cloned:
    $ cd $TTT_HOME
    $ mvn -f ttt-deps/pom.xml install

This last step installs snapshot copies of batik, fontbox, and xmlunit dependencies that contain modifications specific to ttt.

Build and Install

In order to build and install ttt in the local maven repository, run mvn (maven) as follows:

mvn clean install

Site Construction

In order to build the ttt site content, including checkstyle and findbugs reports, run mvn (maven) as follows after performing the above build and install step:

mvn site site:stage

The resulting staged site data can be accessed at target/staging/index.html. The findbugs reports can be found under the Project Reports link for each module.

Tool Dependencies

At present, ttt is being developed using the following versions of tools:

    $ java -version
    java version "1.8.0_152"
    Java(TM) SE Runtime Environment (build 1.8.0_152-b16)
    Java HotSpot(TM) 64-Bit Server VM (build 25.152-b16, mixed mode)

    $ mvn -version
    Apache Maven 3.5.3 (3383c37e1f9e9b3bc3df5050c29c8aff9f295297; 2018-02-24T12:49:05-07:00)
    Maven home: /opt/local/share/java/maven3
    Java version: 1.8.0_152, vendor: Oracle Corporation
    Java home: /Library/Java/JavaVirtualMachines/jdk1.8.0_152.jdk/Contents/Home/jre
    Default locale: en_US, platform encoding: UTF-8
    OS name: "mac os x", version: "10.13.6", arch: "x86_64", family: "mac"

Additional dependencies are managed by maven.

Maven Coordinates

  <groupId>com.skynav.ttt</groupId>
  <artifactId>ttt</artifactId>