You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-16Lines changed: 3 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,28 +2,15 @@
2
2
3
3
this is the source repository for the jTab Javascript library.
4
4
5
-
See [jTab](http://jtab.tardate.com/) for more info..
6
-
5
+
See [jTab](https://jtab.tardate.com/) for more info..
7
6
8
7
## Hosting
9
8
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.
23
10
24
11
## Contributing
25
12
26
-
1. Fork it ( https://github.com/tardate/fretboard_web/fork )
13
+
1. Fork it ( <https://github.com/tardate/jtab/fork> )
27
14
2. Create your feature branch (`git checkout -b my-new-feature`)
28
15
3. Commit your changes (`git commit -am 'Add some feature'`)
29
16
4. Push to the branch (`git push origin my-new-feature`)
<title>jTab - Guitar Chord and Tab Library Examples</title>
8
-
<metaname="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tabulature (tab) notation on the web"/>
<metaname="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tablature (tab) notation on the web"/>
<title>jTab - Guitar Chord and Tab Library</title>
8
-
<metaname="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tabulature (tab) notation on the web"/>
<metaname="description" content="jTab is a javascript-based library that allows you to easily render arbitrary guitar chord and tablature (tab) notation on the web"/>
Representing <ahref="http://en.wikipedia.org/wiki/Tablature" target="_blank">tab notation</a> is little special to jTab,
165
+
Representing <ahref="https://en.wikipedia.org/wiki/Tablature" target="_blank">tab notation</a> is little special to jTab,
166
166
but aims to be as simple as possible.
167
167
</p>
168
168
<p>
@@ -172,7 +172,7 @@ <h3>Tab Notation</h3>
172
172
e.g. $2 is the B string in standard tuning</li>
173
173
<li>Alternatively, you can use the string tuning instead of string number, EADGBe low to high in standard tuning.
174
174
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>
176
176
<li>Examples:
177
177
<ul>
178
178
<li>$2 0 1 3 (a simple three note sequence on the B string)</li>
@@ -189,7 +189,7 @@ <h3>Tab Notation</h3>
189
189
</p>
190
190
<p>Examples:
191
191
<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>
193
193
<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>
jTab is open source and free to use. You are welcome to use and reuse it however you like.
233
233
</p>
234
234
<p>
235
-
The project home page is at <ahref="http://jtab.tardate.com/">http://jtab.tardate.com</a>
235
+
The project home page is at <ahref="https://jtab.tardate.com/">https://jtab.tardate.com</a>
236
236
</p>
237
237
<p>
238
-
The master source code repository is on github (<ahref="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 <ahref="#feedback">contribute</a> to the project yourself.
238
+
The source code repository is on github (<ahref="https://github.com/tardate/jtab">https://github.com/tardate/jtab</a>).
239
+
You will always find the latest version there and be able to <ahref="#feedback">contribute</a> to the project yourself.
240
240
</p>
241
241
<p>
242
-
There is also a version located at <ahref="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 <ahref="https://jtab.tardate.com">jtab.tardate.com</a> that you can point to directly (although performance may suffer a little).
243
243
</p>
244
244
245
245
<aname="install"><h2>How To Install jTab on your Web Page or Site</h2></a>
246
246
<h3>1. Include jTab Javascript files</h3>
247
247
<p>
248
248
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: <ahref="http://www.jquery.com/" target="_blank">jQuery</a>,
250
-
and <ahref="http://raphaeljs.com/" target="_blank">Raphaë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: <ahref="https://jquery.com/" target="_blank">jQuery</a>,
250
+
and <ahref="https://dmitrybaranovskiy.github.io/raphael/" target="_blank">Raphaë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
252
252
you probably do not need to include them again.
253
253
</p>
254
254
<p>
255
255
You can <ahref="#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).
257
257
The example below shows how to pull the files direct from tardate.com.
258
258
</p>
259
259
@@ -266,9 +266,9 @@ <h3>1. Include jTab Javascript files</h3>
@@ -295,7 +295,7 @@ <h3>3. Explicit Rendering with Scripting</h3>
295
295
<p>
296
296
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.
297
297
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 ...
299
299
</p>
300
300
<pre>
301
301
<div id="mytab"></div>
@@ -335,7 +335,7 @@ <h3>Page layout jitters while rendering jTab</h3>
335
335
<p>
336
336
An optional stylesheet is included in the jTab kit (css/jtab-helper.css)and can be included in you pages:
<aname="feedback"><h2>Feedback & Contribute</h2></a>
378
378
<p>
379
-
jTab was created and is maintained by <ahref="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 <ahref="https://github.com/tardate" target="_blank">Paul Gallagher</a> and released as open source for all to exploit.
<strong>Source:</strong> The master jTab source is hosted on <ahref="http://github.com/tardate/jtab/tree/master" target="_blank">github</a>.
398
+
<strong>Source:</strong> The jTab source is hosted on <ahref="https://github.com/tardate/jtab" target="_blank">github</a>.
399
399
All are welcome to fork and update.
400
400
</p>
401
401
<p>
402
-
<strong>Issues:</strong> A formal isues list (with prioritisation) is maintained in the <ahref="https://github.com/tardate/jtab/issues" target="_blank">github issues list</a>.
402
+
<strong>Tests:</strong> currently implemented with <ahref="https://github.com/drnic/jsunittest">JsUnitTest</a>
403
+
and results can be checked <ahref="./jtab-unittest.html">here</a>.
403
404
</p>
404
405
<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 <ahref="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 <ahref="https://github.com/tardate/jtab/issues" target="_blank">github issues list</a>.
407
407
</p>
408
408
<p>
409
409
<strong>Kudos:</strong> Aside from just scratching a personal itch, jTab was greatly inspired by
410
-
Dmitry Baranovskiy's fantastic work on the <ahref="http://raphaeljs.com/" target="_blank">Raphaël</a> SVG library,
410
+
Dmitry Baranovskiy's fantastic work on the <ahref="https://dmitrybaranovskiy.github.io/raphael/" target="_blank">Raphaël</a> SVG library,
411
411
and Alex Gorbatchev's <ahref="http://www.dreamprojections.com/syntaxhighlighter/" target="_blank">syntaxhighlighter</a> (for opening the door to what is possible!).
412
412
</p>
413
413
414
-
415
414
<aname="limitations"><h3>Limitations</h3></a>
416
415
<p>
417
416
jTab is a new project, so there are definitely some things it can't do at the moment.
418
-
See the <ahref="http://github.com/tardate/jtab/issues" target="_blank">issues list</a> on github for all currently open issues.
417
+
See the <ahref="https://github.com/tardate/jtab/issues" target="_blank">issues list</a> on github for all currently open issues.
0 commit comments