A VexTab Parser for VexFlow
JavaScript CoffeeScript Other

README.md

VexTab 2.0

A VexTab Parser for VexFlow. Copyright (c) 2012 Mohit Muthanna Cheppudira.

What is VexTab?

VexTab is a language that allows you to easily create, edit, and share music notation and guitar tablature. Unlike ASCII tab, which is designed for readability, VexTab is designed for writeability.

Go try it out at The VexTab Tutorial.

If you want to save and share your VexTab, try out My Vexflow.

To see what VexTab can do, take a look at the list of features.

Quick Start

Simply include releases/vextab-div.js into your HTML document via a script tag. The contents of all div elements with the class vex-tabdiv are parsed as VexTab and automatically rendered in-place as music notation.

<div class="vex-tabdiv"
    width=680 scale=1.0 editor="true"
    editor_width=680 editor_height=330>options space=20
    tabstave
    notation=true
    key=A time=4/4

    notes :q =|: (5/2.5/3.7/4) :8 7-5h6/3 ^3^ 5h6-7/5 ^3^ :q 7V/4 |
    notes :8 t12p7/4 s5s3/4 :8 3s:16:5-7/5 :h p5/4
    text :w, |#segno, ,|, :hd, , #tr


    options space=25
</div>

VexTab defaults to HTML5 canvas; for SVG define VEXTAB_USE_SVG before including vextab-div.js. See the .html files in doc/ for examples of vextab-div in use.

Some of the available div attributes are:

  • editor: true|false -- Enable/disable live editor. Default false.
  • scale: 0.5 -> 3.0 -- Scale factor for rendering. Default 1.0.
  • editor_width, editor_height: pixels -- Dimensions of editor.

You can use the CSS file in releases/vextab.css for basic styling of the interface. You can also set the clear background color via div.vex-canvas. E.g.:

div.vex-canvas {
  background-color: white;
}

Note that the provided vextab-div.js bundle is unminified, and includes all necessary dependencies such as jQuery, lodash, and VexFlow. You can get access to some of these classes, and the VexTab API (see below) via the VexTabDiv global.

  • VexTabDiv.Div: The TabDiv class used to implement the auto-render functionality for div elements.
  • VexTabDiv.VexTab: The parser. See API below.
  • VexTabDiv.Artist: The renderer. See API below.
  • VexTabDiv.Flow: The Vex.Flow namespace from the VexFlow library.

VexTab API

If you want to do more interesting things with VexTab, you can use the API directly.

$ npm install vextab

Basic usage:

// Load VexTab module.
vextab = require("vextab");

VexTab = vextab.VexTab;
Artist = vextab.Artist;
Renderer = vextab.Vex.Flow.Renderer;

// Create VexFlow Renderer from canvas element with id #boo.
renderer = new Renderer($('#boo')[0], Renderer.Backends.CANVAS);

// For SVG, you can use the following line (make sure #boo is a div element)
// renderer = new Renderer($('#boo')[0], Renderer.Backends.SVG);

// Initialize VexTab artist and parser.
artist = new Artist(10, 10, 600, {scale: 0.8});
vextab = new VexTab(artist);

try {
    // Parse VexTab music notation passed in as a string.
    vextab.parse("tabstave notation=true\n notes :q 4/4\n")

    // Render notation onto canvas.
    artist.render(renderer);
} catch (e) {
    console.log(e);
}

See tests/playground.js for a working example of the VexTab API in use.

You can also also use the API in standalone mode, i.e., without a loader, by including releases/vextab-div.js in a script tag. See tests/vextab-standalone.js for an example of this.

Developers

Clone this repository. Then run the following commands to setup a basic build and run tests:

$ npm install
$ npm link
$ npm link vextab
$ npm start

If you have the grunt-cli NPM package installed, you can manually run the various build steps:

$ npm install -g grunt-cli
$ grunt (lint|build|test|stage|publish)

Before sending in a pull request, make sure that the tests pass a visual inspection. Open tests/runtests.html in your browser and verify that the notation examples at the bottom of the page render correctly. Also open tests/playground.html and verify that your new feature/bug fix, etc. works correctly.

Please add new tests for whatever you're working on. Don't send PRs without tests. Thanks!

Dependencies

This rewrite of VexTab has three key dependencies:

  • CoffeeScript - A nicer JavaScript.
  • Jison - An LALR(1) parser modeled on Bison.
  • lodash - A utility-belt library for JavaScript.

For the audio player feature, you need:

  • MIDI.js - A soundfont renderer for the web.
  • Soundfonts for various instruments - See MIDI.js for more information.

Help

Questions? Ask the VexFlow Google Group.

License

VexTab is an open specification and the reference implementation (this repository) is open source. It is freely available complete and uncrippled for non-commercial use.

If you would like to use this code on commercial websites, products, blogs, plugins, or tools, please get in touch with me. (I'm very reasonable.)

Copyright (c) 2012 Mohit Muthanna Cheppudira

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

The above copyright notice shall be included in all copies or substantial portions of the Software.

Note: The underlying library, VexFlow, is completely open source and distributed under the MIT license. See the VexFlow GitHub Page for details.

Links