Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.39 KB

readme.md

File metadata and controls

45 lines (34 loc) · 2.39 KB
Raw

Powered by Virginia Commonwealth University

T4Utils 2

A Javascript library of utility classes and extensions for TerminalFour Programmable Layouts. This repo is a port/continuation of Ben Margevicius' unmaintained T4Utils library.

Latest Version

v1.7.0_2017.06.01 - Ordinal Indicators Enhancement

This update enhances the structure, performance, and extensiveness of the ordinalIndicators module; Here's how:

  • Both the pageInfo and groupInfo methods have been merged into one self-executing function: info
    • Now you can grab all page/group information via ordinalIndicators.info
  • More information about groups is available
    • ordinalIndicators.groupAmount - The total amount of groups on the page
    • ordinalIndicators.groupCount - The total amount of content within the current group
    • ordinalIndicators.groupID - The ID of the current group (zero-based)
    • ordinalIndicators.groupIndex - The index of the current piece of content within the group (zero-based)

Check out the changelog for previous release information.

Table of contents

Quick start

There's a couple different ways you can get your hands on the T4Utils 2 library:

  1. Download one of the latest releases
  2. Clone the repo, npm install, and gulp (Requires Node)

Documentation

The T4Utils 2 build environment comes with a JSDoc3 Gulp task. To build out the HTML documentation, run $ gulp docs and look in the docs directory within the project. This documentation can then be previewed within a web browser or uploaded to server.

Contributing

Please read through the contribution guidelines before opening issues or contributing code.

Contributors

Joel Eisner

Sam Yerkes