Skip to content

Commit b54c1e2

Browse files
authored
jQuery and Raphael dependency update (#54)
* tidy and fix references and doc * update jquery and raphael dependencies * step to 1.4.0
1 parent d3149b6 commit b54c1e2

File tree

8 files changed

+68
-100
lines changed

8 files changed

+68
-100
lines changed

README.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,15 @@
22

33
this is the source repository for the jTab Javascript library.
44

5-
See [jTab](http://jtab.tardate.com/) for more info..
6-
5+
See [jTab](https://jtab.tardate.com/) for more info..
76

87
## Hosting
98

10-
I'm using GitHub Pages to host [jtab.tardate.com](http://jtab.tardate.com) directly from the GitHub repository.
11-
12-
How does that work? GitHub Pages basically serves whatever you commit to the repo.
13-
For static HTML sites, that means simply adding an `index.html` to the root of the repo.
14-
15-
GitHub now allows you to select the branch from which GitHub Pages are built.
16-
I've chosen to serve directly from the master branch.
17-
18-
To host on a custom URL, just two steps:
19-
20-
* in DNS, configure a CNAME to point to <username>.github.io
21-
* add a CNAME file to the repo root with the matching CNAME in DNS (GitHub does this for you automatically if you add the custom url in the web interface)
22-
9+
I'm using GitHub Pages to host [jtab.tardate.com](https://jtab.tardate.com) directly from the GitHub repository.
2310

2411
## Contributing
2512

26-
1. Fork it ( https://github.com/tardate/fretboard_web/fork )
13+
1. Fork it ( <https://github.com/tardate/jtab/fork> )
2714
2. Create your feature branch (`git checkout -b my-new-feature`)
2815
3. Commit your changes (`git commit -am 'Add some feature'`)
2916
4. Push to the branch (`git push origin my-new-feature`)

bower.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jtab",
3-
"version": "1.3.1",
3+
"version": "1.4.0",
44
"homepage": "https://github.com/tardate/jtab",
55
"authors": [
66
"Paul Gallagher <gallagher.paul@gmail.com>"

examples.htm

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
66

77
<title>jTab - Guitar Chord and Tab Library Examples</title>
8-
<meta name="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tabulature (tab) notation on the web"/>
9-
<meta name="keywords" content="guitar,chord,tab,tabulature,music,notation,javascript,css,svg,html,xhtml"/>
8+
<meta name="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tablature (tab) notation on the web"/>
9+
<meta name="keywords" content="guitar,chord,tab,tablature,music,notation,javascript,css,svg,html,xhtml"/>
1010

1111
<link type="text/css" rel="stylesheet" href="css/jtab-site.css"/>
1212

@@ -24,7 +24,7 @@
2424
<div id="header">
2525
<h1>jTab - Guitar Chord and Tab Notation for the Web</h1>
2626
<p>
27-
jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tabulature (tab)
27+
jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tablature (tab)
2828
notation on the web. Automatically. It works in most modern browsers that support javascript, CSS and scalable vector graphics (SVG) -
2929
for example, Internet Explorer 7+ and Firefox 3+.
3030
</p>
@@ -60,7 +60,7 @@ <h3>Render notation provided by a user</h3>
6060
</p>
6161
<span>Try it out. Enter a phrase here (see <a href="index.htm#notation">notation</a> for help):</span>
6262
<input id="notation" size="40">
63-
<input type="button" value="jTab this!" onclick="jtab.render('tab',$(#'notation').value);">
63+
<input type="button" value="jTab this!" onclick="jtab.render('tab',$('#notation').value);">
6464
<div id="tab"><i>jTab will render your phrase here</i></div>
6565

6666
<script type='text/javascript'>
@@ -184,4 +184,4 @@ <h3>Customising the color palette</h3>
184184
</div>
185185

186186
</body>
187-
</html>
187+
</html>

index.htm

Lines changed: 35 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
66

77
<title>jTab - Guitar Chord and Tab Library</title>
8-
<meta name="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tabulature (tab) notation on the web"/>
9-
<meta name="keywords" content="guitar,chord,tab,tabulature,music,notation,javascript,css,svg,html,xhtml"/>
8+
<meta name="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tablature (tab) notation on the web"/>
9+
<meta name="keywords" content="guitar,chord,tab,tablature,music,notation,javascript,css,svg,html,xhtml"/>
1010

1111
<link type="text/css" rel="stylesheet" href="css/jtab-site.css"/>
1212

@@ -23,7 +23,7 @@
2323
<div id="header">
2424
<h1>jTab - Guitar Chord and Tab Notation for the Web</h1>
2525
<p>
26-
jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tabulature (tab)
26+
jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tablature (tab)
2727
notation on the web. Automatically. It works in most modern browsers that support javascript, CSS and scalable vector graphics (SVG) -
2828
for example, Firefox 3+, Google Chrome and Internet Explorer.
2929
</p>
@@ -105,15 +105,15 @@ <h3>Implicit Rendering using CSS</h3>
105105
<a name="notation"><h2>Notation Reference</h2></a>
106106
<p>
107107
If you find this a little dry to read,
108-
see the <a href="examples.htm">examples</a> page which demostrate all these features and more.
108+
see the <a href="examples.htm">examples</a> page which demonstrates all these features and more.
109109
</p>
110110
<h3>Chord Notation</h3>
111111
<p>
112112
Chord notation is quite conventional e.g. C Gm F#7 Db.
113113
</p>
114114
<ul>
115115
<li>The root note (A..G) must be uppercase</li>
116-
<li>Seperate every item with spaces</li>
116+
<li>Separate every item with spaces</li>
117117
<li><strong>#</strong> indicates sharp</li>
118118
<li><strong>b</strong> (lowercase B) indicates flat</li>
119119
<li><strong>m</strong> (lowercase) indicates minor</li>
@@ -125,11 +125,11 @@ <h3>Chord Notation</h3>
125125
<li>Variations on the root chord: m, 6, m6, 69, 7, m7, maj7, 7b5, 7#5, m7b5,
126126
7b9, 9, m9, maj9, add9, 13, sus2, sus4, dim, dim7, aug</li>
127127
<li><strong>/</strong> indicates repeat of the previous chord</li>
128-
<li><strong>|</strong> is a standard <a href="http://en.wikipedia.org/wiki/Bar_(music)" target="_blank">bar line</a></li>
128+
<li><strong>|</strong> is a standard <a href="https://en.wikipedia.org/wiki/Bar_(music)" target="_blank">bar line</a></li>
129129
<li><strong>||</strong> is an ending bar line</li>
130130
</ul>
131131
<p>
132-
jTab also supports <a href="http://en.wikipedia.org/wiki/Guitar_chord#CAGED_major_chords" target="_blank">CAGED major chord notation</a>.
132+
jTab also supports <a href="https://en.wikipedia.org/wiki/Guitar_chord#CAGED_major_chords" target="_blank">CAGED major chord notation</a>.
133133
This is a convenient method for indicating major chords at various positions on the fretboard.
134134
</p>
135135
<ul>
@@ -162,7 +162,7 @@ <h3>Custom Chord Notation</h3>
162162

163163
<h3>Tab Notation</h3>
164164
<p>
165-
Representing <a href="http://en.wikipedia.org/wiki/Tablature" target="_blank">tab notation</a> is little special to jTab,
165+
Representing <a href="https://en.wikipedia.org/wiki/Tablature" target="_blank">tab notation</a> is little special to jTab,
166166
but aims to be as simple as possible.
167167
</p>
168168
<p>
@@ -172,7 +172,7 @@ <h3>Tab Notation</h3>
172172
e.g. $2 is the B string in standard tuning</li>
173173
<li>Alternatively, you can use the string tuning instead of string number, EADGBe low to high in standard tuning.
174174
e.g. $B is the 2nd string in standard tuning.</li>
175-
<li>Then you can in fact follow with anything you like - fret position, slides ( / \ ) hammerons (h), pulloffs (p) etc (just avoid uppercase characters to avoid confusion with chords)</li>
175+
<li>Then you can in fact follow with anything you like - fret position, slides ( / \ ) hammer-ons (h), pull-offs (p) etc (just avoid uppercase characters to avoid confusion with chords)</li>
176176
<li>Examples:
177177
<ul>
178178
<li>$2 0 1 3 (a simple three note sequence on the B string)</li>
@@ -189,7 +189,7 @@ <h3>Tab Notation</h3>
189189
</p>
190190
<p>Examples:
191191
<ul>
192-
<li>$3.6.$2.5h7 $1 5 $2 7 (start with two notes on G and B strings followed by a hammeron and two individual notes)</li>
192+
<li>$3.6.$2.5h7 $1 5 $2 7 (start with two notes on G and B strings followed by a hammer-on and two individual notes)</li>
193193
<li>$4.7/9.$3.6/8.$2.5/7 9p7 $2.9.$3.9.$4.9 (three notes across D,G,B strings with a slide up two steps and a twist)</li>
194194
</ul>
195195
</p>
@@ -232,28 +232,28 @@ <h3>Rendering Options: Size</h3>
232232
jTab is open source and free to use. You are welcome to use and reuse it however you like.
233233
</p>
234234
<p>
235-
The project home page is at <a href="http://jtab.tardate.com/">http://jtab.tardate.com</a>
235+
The project home page is at <a href="https://jtab.tardate.com/">https://jtab.tardate.com</a>
236236
</p>
237237
<p>
238-
The master source code repository is on github (<a href="http://github.com/tardate/jtab/tree/master">http://github.com/tardate/jtab/tree/master</a>).
239-
You will always find the latest version here and be able to <a href="#feedback">contribute</a> to the project yourself.
238+
The source code repository is on github (<a href="https://github.com/tardate/jtab">https://github.com/tardate/jtab</a>).
239+
You will always find the latest version there and be able to <a href="#feedback">contribute</a> to the project yourself.
240240
</p>
241241
<p>
242-
There is also a version located at <a href="http://jtab.tardate.com">jtab.tardate.com</a> that you can point to directly (although performance may suffer a little).
242+
There is also a version located at <a href="https://jtab.tardate.com">jtab.tardate.com</a> that you can point to directly (although performance may suffer a little).
243243
</p>
244244

245245
<a name="install"><h2>How To Install jTab on your Web Page or Site</h2></a>
246246
<h3>1. Include jTab Javascript files</h3>
247247
<p>
248248
jTab is provided as a single javascript source file (jtab.js) that needs to be included on your page.
249-
It depends on two additional libraries that must also be included: <a href="http://www.jquery.com/" target="_blank">jQuery</a>,
250-
and <a href="http://raphaeljs.com/" target="_blank">Rapha&euml;l</a> (raphael.js).
251-
Compatible versions of these libraries located along with jtab.js, or if you are already using a version of these libraries
249+
It depends on two additional libraries that must also be included: <a href="https://jquery.com/" target="_blank">jQuery</a>,
250+
and <a href="https://dmitrybaranovskiy.github.io/raphael/" target="_blank">Rapha&euml;l</a> (raphael.js).
251+
Compatible versions of these libraries located along with jtab.js (jQuery 3.7.1, Raphael 2.3.0), or if you are already using a version of these libraries
252252
you probably do not need to include them again.
253253
</p>
254254
<p>
255255
You can <a href="#download">download</a> these files and use them locally on your own site.
256-
There is also a version located at http://jtab.tardate.com that you can point to directly (although performance may suffer a little).
256+
There is also a version located at https://jtab.tardate.com that you can point to directly (although performance may suffer a little).
257257
The example below shows how to pull the files direct from tardate.com.
258258
</p>
259259

@@ -266,9 +266,9 @@ <h3>1. Include jTab Javascript files</h3>
266266
&lt;link type="text/css" rel="stylesheet" href="http://jtab.tardate.com/css/jtab-helper.css"/&gt;
267267

268268
&lt;!-- mandatory script includes for jtab --&gt
269-
&lt;script src="http://jtab.tardate.com/javascripts/jquery.js" type="text/javascript"&gt;&lt;/script&gt;
270-
&lt;script src="http://jtab.tardate.com/javascripts/raphael.js" type="text/javascript"&gt;&lt;/script&gt;
271-
&lt;script src="http://jtab.tardate.com/javascripts/jtab.js" type="text/javascript"&gt;&lt;/script&gt;
269+
&lt;script src="https://jtab.tardate.com/javascripts/jquery.js" type="text/javascript"&gt;&lt;/script&gt;
270+
&lt;script src="https://jtab.tardate.com/javascripts/raphael.js" type="text/javascript"&gt;&lt;/script&gt;
271+
&lt;script src="https://jtab.tardate.com/javascripts/jtab.js" type="text/javascript"&gt;&lt;/script&gt;
272272

273273
&lt;/head&gt;
274274
&lt;body&gt;
@@ -295,7 +295,7 @@ <h3>3. Explicit Rendering with Scripting</h3>
295295
<p>
296296
You can script the rendering of a guitar tab phrase into any HTML block using a line of javascript to call the jtab.render() function.
297297
jtab.render() takes two parameters. The first is the ID or name of the HTML element to render the tab into, and the second is the actual line of tab notation (a string).
298-
Obviously, you can bring all your javascripting expertise to bear: the tab notation may be preset in the page, pulled from a database, the result of a web services call, entered by the user, or ...
298+
Obviously, you can bring all your javascript expertise to bear: the tab notation may be preset in the page, pulled from a database, the result of a web services call, entered by the user, or ...
299299
</p>
300300
<pre>
301301
&lt;div id="mytab"&gt;&lt;/div&gt;
@@ -335,7 +335,7 @@ <h3>Page layout jitters while rendering jTab</h3>
335335
<p>
336336
An optional stylesheet is included in the jTab kit (css/jtab-helper.css)and can be included in you pages:
337337
</p>
338-
<pre>&lt;link type="text/css" rel="stylesheet" href="http://jtab.tardate.com/css/jtab-helper.css"/&gt;
338+
<pre>&lt;link type="text/css" rel="stylesheet" href="https://jtab.tardate.com/css/jtab-helper.css"/&gt;
339339
</pre>
340340
<p>
341341
The stylesheet presets the jtab class to the maximum possible height, and provides class modifiers if you know you
@@ -376,10 +376,10 @@ <h3>Implicit rendering isn't happening?</h3>
376376

377377
<a name="feedback"><h2>Feedback &amp; Contribute</h2></a>
378378
<p>
379-
jTab was created and is maintained by <a href="http://tardate.com" target="_blank">Paul Gallagher</a> and released as open source for all to exploit.
379+
jTab was created and is maintained by <a href="https://github.com/tardate" target="_blank">Paul Gallagher</a> and released as open source for all to exploit.
380380
Main contributors:
381-
<a href="http://twitter.com/tardate" target="_blank">@tardate</a>,
382-
<a href="http://twitter.com/jasonong" target="_blank">@jasonong</a>,
381+
<a href="https://github.com/tardate" target="_blank">tardate</a>,
382+
<a href="https://github.com/jasonong" target="_blank">@jasonong</a>,
383383
<a href="https://github.com/bborn" target="_blank">bborn</a>,
384384
<a href="https://github.com/binarybitlan" target="_blank">binarybitlan</a>,
385385
<a href="https://github.com/balpha" target="_blank">balpha</a>.
@@ -395,27 +395,26 @@ <h3>Implicit rendering isn't happening?</h3>
395395
</ul>
396396
</p>
397397
<p>
398-
<strong>Source:</strong> The master jTab source is hosted on <a href="http://github.com/tardate/jtab/tree/master" target="_blank">github</a>.
398+
<strong>Source:</strong> The jTab source is hosted on <a href="https://github.com/tardate/jtab" target="_blank">github</a>.
399399
All are welcome to fork and update.
400400
</p>
401401
<p>
402-
<strong>Issues:</strong> A formal isues list (with prioritisation) is maintained in the <a href="https://github.com/tardate/jtab/issues" target="_blank">github issues list</a>.
402+
<strong>Tests:</strong> currently implemented with <a href="https://github.com/drnic/jsunittest">JsUnitTest</a>
403+
and results can be checked <a href="./jtab-unittest.html">here</a>.
403404
</p>
404405
<p>
405-
<strong>Discuss:</strong> We have established a mailing list to discuss internal development issues, usage, and ideas for enhancement.
406-
All are welcomed to join: visit the <a href="http://groups.google.com/group/jtab" target="_blank">mailing list group on Google</a>.
406+
<strong>Issues:</strong> A formal issues list (with prioritisation) is maintained in the <a href="https://github.com/tardate/jtab/issues" target="_blank">github issues list</a>.
407407
</p>
408408
<p>
409409
<strong>Kudos:</strong> Aside from just scratching a personal itch, jTab was greatly inspired by
410-
Dmitry Baranovskiy's fantastic work on the <a href="http://raphaeljs.com/" target="_blank">Rapha&euml;l</a> SVG library,
410+
Dmitry Baranovskiy's fantastic work on the <a href="https://dmitrybaranovskiy.github.io/raphael/" target="_blank">Rapha&euml;l</a> SVG library,
411411
and Alex Gorbatchev's <a href="http://www.dreamprojections.com/syntaxhighlighter/" target="_blank">syntaxhighlighter</a> (for opening the door to what is possible!).
412412
</p>
413413

414-
415414
<a name="limitations"><h3>Limitations</h3></a>
416415
<p>
417416
jTab is a new project, so there are definitely some things it can't do at the moment.
418-
See the <a href="http://github.com/tardate/jtab/issues" target="_blank">issues list</a> on github for all currently open issues.
417+
See the <a href="https://github.com/tardate/jtab/issues" target="_blank">issues list</a> on github for all currently open issues.
419418
Some of the main things to note:
420419
</p>
421420
<ul>
@@ -428,12 +427,7 @@ <h3>Implicit rendering isn't happening?</h3>
428427
<a name="browsers"><h3>Browser Support</h3></a>
429428
<p>
430429
jTab works in most modern browsers that support javascript, CSS and scalable vector graphics (SVG) -
431-
for example, Firefox 3+, Google Chrome and Internet Explorer.
432-
</p>
433-
<p>
434-
Internet Explorer is a little problemmatic however. IE7 is the most reliable, IE6 has some imperfect rendering,
435-
and as of writing IE8 is exhibiting very poor performance rendering SVG (in the order of 10x slower than Firefox/Chome,
436-
and much slower than IE7).
430+
for example, Firefox, Google Chrome, Safari, and Internet Explorer.
437431
</p>
438432

439433

@@ -442,11 +436,11 @@ <h3>Implicit rendering isn't happening?</h3>
442436
Here are some places where you can see jTab in action:
443437
</p>
444438
<ul>
445-
<li><a href="http://chordmaster.tardate.com/" target="_blank">ChordMaster 2000</a> - a tool to help you learn chord fingerings for guitar</li>
439+
<li><a href="https://chordmaster.tardate.com/" target="_blank">ChordMaster 2000</a> - a tool to help you learn chord fingerings for guitar</li>
446440
<li><a href="http://jtab-guitar-tab-shortcode.marichiba.com/" target="_blank">Guitar Tab Shortcode</a> - jTab as a WordPress plugin by
447441
<a href="http://www.marichiba.com/" target="_blank">Matthew Marichiba</a>
448442
</li>
449-
<li><a href="http://music.stackexchange.com" target="_blank">
443+
<li><a href="https://music.stackexchange.com/" target="_blank">
450444
Musical Practice and Performance</a> - a StackExchange site dedicated to musical Q&amp;A</li>
451445
</ul>
452446
<p>

javascripts/jquery.js

Lines changed: 2 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)