Search by

ucf / ucf-video-vtt

mcatech

There is no license information available for the latest version (v0.1.1) of this package.

Plugin that provides a series of tools for developers to properly enqueue descriptive text tracks for videos (vtt files) for their videos.

Package info

github.com/UCF/UCF-Video-VTT

Type:wordpress-plugin

pkg:composer/ucf/ucf-video-vtt

Security

Advisories: 0

Aikido package health analysis

Transparency log

Statistics

Installs: 1

Dependents: 0

Suggesters: 0

Stars: 1

Open Issues: 0

v0.1.1 2023-03-22 14:22 UTC

Requires

Requires (Dev)

None

Suggests

None

Provides

None

Conflicts

None

Replaces

None

Unknown License 2b8058d1f728cbeb2f14e26ea4d4a1ab08b51019

Published on Packagist.org on 2026-10-20 18:19 UTC

This package is auto-updated.

Last update: 2026-10-20 18:19:37 UTC

README

Plugin that provides a series of tools for developers to properly enqueue descriptive text tracks for videos (vtt files) for their videos.

Description

The primary goal of this project is to provide a series of tools for including

Documentation

Head over to the UCF Video VTT Tools wiki for detailed information about this plugin, installation instructions, and more.

Changelog

0.1.1

Enhancements:

  • Added composer file.

0.1.0

  • Initial release of the plugin.
  • Includes a field for setting a custom vtt file for a video.
  • Generates a vtt using the video description field if no custom file is provided.
  • Provides an API endpoint that delivers the vtt file.
  • Provides helper classes that will insert the appropriate markup to point to the vtt file.

Upgrade Notice

n/a

Development

Enabling debug mode in your wp-config.php file is recommended during development to help catch warnings and bugs.

Requirements

  • node v16+
  • gulp-cli

Instructions

  1. Clone the UCF-Video-VTT repo into your local development environment, within your WordPress installation's plugins/ directory: git clone https://github.com/UCF/UCF-Video-VTT.git

  2. cd into the new UCF-Video-VTT directory, and run npm install to install required packages for development into node_modules/ within the repo

  3. Optional: If you'd like to enable BrowserSync for local development, or make other changes to this project's default gulp configuration, copy gulp-config.template.json, make any desired changes, and save as gulp-config.json.

    To enable BrowserSync, set sync to true and assign syncTarget the base URL of a site on your local WordPress instance that will use this plugin, such as http://localhost/wordpress/my-site/. Your syncTarget value will vary depending on your local host setup.

    The full list of modifiable config values can be viewed in gulpfile.js (see config variable).

  4. Run gulp default to process front-end assets.

  5. If you haven't already done so, create a new WordPress site on your development environment to test this plugin against, and install and activate all plugin dependencies.

  6. Activate this plugin on your development WordPress site.

Other Notes

  • This plugin's README.md file is automatically generated. Please only make modifications to the README.txt file, and make sure the gulp readme command has been run before committing README changes. See the contributing guidelines for more information.

Contributing

Want to submit a bug report or feature request? Check out our contributing guidelines for more information. We'd love to hear from you!