chordsheetjs 7.7.0 → 7.9.0

package/README.md

@@ -379,7 +379,7 @@ metadata.get('author')   // =&gt; 'John'</p>
 <dt><a href="#HtmlDivFormatter">HtmlDivFormatter</a></dt>
 <dd><p>Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.</p></dd>
 <dt><a href="#HtmlFormatter">HtmlFormatter</a></dt>
-<dd><p>Acts as a base class for HTML formatters, taking care of whitelisting prototype property access.</p></dd>
+<dd><p>Acts as a base class for HTML formatters</p></dd>
 <dt><a href="#HtmlTableFormatter">HtmlTableFormatter</a></dt>
 <dd><p>Formats a song into HTML. It uses TABLEs to align lyrics with chords, which makes the HTML for things like
 PDF conversion.</p></dd>
@@ -387,10 +387,48 @@ PDF conversion.</p></dd>
 <dd><p>Formats a song into a plain text chord sheet</p></dd>
 <dt><a href="#ChordProParser">ChordProParser</a></dt>
 <dd><p>Parses a ChordPro chord sheet</p></dd>
-<dt><a href="#ChordSheetParser">ChordSheetParser</a></dt>
-<dd><p>Parses a normal chord sheet</p></dd>
+<dt><del><a href="#ChordSheetParser">ChordSheetParser</a></del></dt>
+<dd><p>Parses a normal chord sheet</p>
+<p>ChordSheetParser is deprecated, please use ChordsOverWordsParser.</p>
+<p>ChordsOverWordsParser aims to support any kind of chord, whereas ChordSheetParser lacks
+support for many variations. Besides that, some chordpro feature have been ported back
+to ChordsOverWordsParser, which adds some interesting functionality.</p></dd>
+<dt><a href="#ChordsOverWordsParser">ChordsOverWordsParser</a></dt>
+<dd><p>Parses a chords over words sheet into a song</p>
+<p>It support &quot;regular&quot; chord sheets:</p>
+<pre><code>       Am         C/G        F          C
+Let it be, let it be, let it be, let it be
+C                G              F  C/E Dm C
+Whisper words of wisdom, let it be
+</code></pre>
+<p>Additionally, some chordpro features have been &quot;ported back&quot;. For example, you can use chordpro directives:</p>
+<pre><code>{title: Let it be}
+{key: C}
+Chorus 1:
+       Am
+Let it be
+</code></pre>
+<p>For convenience, you can leave out the brackets:</p>
+<pre><code>title: Let it be
+Chorus 1:
+       Am
+Let it be
+</code></pre>
+<p>You can even use a markdown style frontmatter separator to separate the header from the song:</p>
+<pre><code>title: Let it be
+key: C
+---
+Chorus 1:
+       Am         C/G        F          C
+Let it be, let it be, let it be, let it be
+C                G              F  C/E Dm C
+Whisper words of wisdom, let it be
+</code></pre>
+<p><code>ChordsOverWordsParser</code> is the better version of <code>ChordSheetParser</code>, which is deprecated.</p></dd>
 <dt><a href="#ParserWarning">ParserWarning</a></dt>
 <dd><p>Represents a parser warning, currently only used by ChordProParser.</p></dd>
+<dt><a href="#PegBasedParser">PegBasedParser</a></dt>
+<dd><p>Parses a chords over words sheet</p></dd>
 <dt><a href="#UltimateGuitarParser">UltimateGuitarParser</a></dt>
 <dd><p>Parses an Ultimate Guitar chord sheet with metadata
 Inherits from [ChordSheetParser](#ChordSheetParser)</p></dd>
@@ -453,6 +491,8 @@ See https://www.chordpro.org/chordpro/directives-key/</p></dd>
 <dd><p>Year meta directive. See https://www.chordpro.org/chordpro/directives-year/</p></dd>
 <dt><a href="#defaultCss">defaultCss</a> ⇒ <code>string</code></dt>
 <dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p></dd>
+<dt><a href="#defaultCss">defaultCss</a> ⇒ <code>string</code></dt>
+<dd><p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p></dd>
 </dl>
 
 ## Constants
@@ -476,7 +516,7 @@ For a CSS string see [scopedCss](scopedCss)</p></dd>
 ## Functions
 
 <dl>
-<dt><del><a href="#parseChord">parseChord(chordString)</a> ⇒ <code>null</code> | <code><a href="#Chord">Chord</a></code></del></dt>
+<dt><del><a href="#parseChord">parseChord(chordString)</a> ⇒ <code><a href="#Chord">Chord</a></code> | <code>null</code></del></dt>
 <dd><p>Tries to parse a chord string into a chord</p></dd>
 <dt><a href="#getCapos">getCapos(key)</a> ⇒ <code>Object.&lt;string, string&gt;</code></dt>
 <dd><p>Returns applicable capos for the provided key</p></dd>
@@ -504,10 +544,10 @@ For a CSS string see [scopedCss](scopedCss)</p></dd>
 <p>Initialises a ChordLyricsPair</p>
 
 
-| Param | Type | Description |
-| --- | --- | --- |
-| chords | <code>string</code> | <p>The chords</p> |
-| lyrics | <code>string</code> | <p>The lyrics</p> |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| chords | <code>string</code> |  | <p>The chords</p> |
+| lyrics | <code>string</code> | <code>null</code> | <p>The lyrics</p> |
 
 <a name="ChordLyricsPair+chords"></a>
 
@@ -573,7 +613,7 @@ metadata.get('author')   // =&gt; 'John'</p>
 <a name="Metadata+get"></a>
 
 ### metadata.get(prop) ⇒ <code>Array.&lt;String&gt;</code> \| <code>String</code>
-<p>Reads a metadata value by key. This method supports simple value lookup, as fetching single array values.</p>
+<p>Reads a metadata value by key. This method supports simple value lookup, as well as fetching single array values.</p>
 <p>This method deprecates direct property access, eg: metadata['author']</p>
 <p>Examples:</p>
 <p>const metadata = new Metadata({ lyricist: 'Pete', author: ['John', 'Mary'] });
@@ -875,7 +915,7 @@ song.mapLines((line) => {
 * [Tag](#Tag)
     * [.name](#Tag+name) : <code>string</code>
     * [.originalName](#Tag+originalName) : <code>string</code>
-    * [.value](#Tag+value) : <code>string</code> \| <code>null</code>
+    * [.value](#Tag+value) : <code>string</code>
     * [.hasValue()](#Tag+hasValue) ⇒ <code>boolean</code>
     * [.isRenderable()](#Tag+isRenderable) ⇒ <code>boolean</code>
     * [.isMetaTag()](#Tag+isMetaTag) ⇒ <code>boolean</code>
@@ -895,7 +935,7 @@ song.mapLines((line) => {
 **Kind**: instance property of [<code>Tag</code>](#Tag)  
 <a name="Tag+value"></a>
 
-### tag.value : <code>string</code> \| <code>null</code>
+### tag.value : <code>string</code>
 <p>The tag value</p>
 
 **Kind**: instance property of [<code>Tag</code>](#Tag)  
@@ -966,64 +1006,81 @@ song.mapLines((line) => {
 ## HtmlDivFormatter
 <p>Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.</p>
 
+**Kind**: global class  
+<a name="HtmlFormatter"></a>
+
+## HtmlFormatter
+<p>Acts as a base class for HTML formatters</p>
+
 **Kind**: global class  
 
-* [HtmlDivFormatter](#HtmlDivFormatter)
+* [HtmlFormatter](#HtmlFormatter)
     * _instance_
-        * [.format(song)](#HtmlDivFormatter+format) ⇒ <code>string</code>
+        * [.cssObject](#HtmlFormatter+cssObject) ⇒ <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
+        * [.format(song)](#HtmlFormatter+format) ⇒ <code>string</code>
+        * [.cssString(scope)](#HtmlFormatter+cssString) ⇒ <code>string</code>
     * _static_
-        * [.cssString(scope)](#HtmlDivFormatter.cssString) ⇒ <code>string</code>
-        * [.cssObject()](#HtmlDivFormatter.cssObject) ⇒ <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
+        * ~~[.cssString()](#HtmlFormatter.cssString)~~
+        * ~~[.cssObject()](#HtmlFormatter.cssObject)~~
 
-<a name="HtmlDivFormatter+format"></a>
+<a name="HtmlFormatter+cssObject"></a>
 
-### htmlDivFormatter.format(song) ⇒ <code>string</code>
+### htmlFormatter.cssObject ⇒ <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
+<p>Basic CSS, in object style à la useStyles, to use with the HTML output
+For a CSS string see [cssString](cssString)</p>
+<p>Example:</p>
+<pre><code>'.paragraph': {
+  marginBottom: '1em'
+}
+</code></pre>
+
+**Kind**: instance property of [<code>HtmlFormatter</code>](#HtmlFormatter)  
+**Returns**: <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code> - <p>the CSS object</p>  
+<a name="HtmlFormatter+format"></a>
+
+### htmlFormatter.format(song) ⇒ <code>string</code>
 <p>Formats a song into HTML.</p>
 
-**Kind**: instance method of [<code>HtmlDivFormatter</code>](#HtmlDivFormatter)  
+**Kind**: instance method of [<code>HtmlFormatter</code>](#HtmlFormatter)  
 **Returns**: <code>string</code> - <p>The HTML string</p>  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | song | [<code>Song</code>](#Song) | <p>The song to be formatted</p> |
 
-<a name="HtmlDivFormatter.cssString"></a>
+<a name="HtmlFormatter+cssString"></a>
 
-### HtmlDivFormatter.cssString(scope) ⇒ <code>string</code>
-<p>Generates basic CSS, optionally scoped within the provided selector, to use with output generated by
-[HtmlDivFormatter](#HtmlDivFormatter)</p>
+### htmlFormatter.cssString(scope) ⇒ <code>string</code>
+<p>Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output</p>
 <p>For example, execute cssString('.chordSheetViewer') will result in CSS like:</p>
 <pre><code>.chordSheetViewer .paragraph {
   margin-bottom: 1em;
 }
 </code></pre>
 
-**Kind**: static method of [<code>HtmlDivFormatter</code>](#HtmlDivFormatter)  
+**Kind**: instance method of [<code>HtmlFormatter</code>](#HtmlFormatter)  
 **Returns**: <code>string</code> - <p>the CSS string</p>  
 
 | Param | Description |
 | --- | --- |
 | scope | <p>the CSS scope to use, for example <code>.chordSheetViewer</code></p> |
 
-<a name="HtmlDivFormatter.cssObject"></a>
+<a name="HtmlFormatter.cssString"></a>
 
-### HtmlDivFormatter.cssObject() ⇒ <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
-<p>Basic CSS, in object style à la useStyles, to use with output generated by [HtmlDivFormatter](#HtmlDivFormatter)</p>
-<p>Example:</p>
-<pre><code>'.paragraph': {
-  marginBottom: '1em'
-}
-</code></pre>
-<p>For a CSS string see [cssString](cssString)</p>
+### ~~HtmlFormatter.cssString()~~
+***Deprecated***
 
-**Kind**: static method of [<code>HtmlDivFormatter</code>](#HtmlDivFormatter)  
-**Returns**: <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code> - <p>the CSS object</p>  
-<a name="HtmlFormatter"></a>
+<p>Generates basic CSS, optionally scoped within the provided selector, to use with the HTML output</p>
 
-## HtmlFormatter
-<p>Acts as a base class for HTML formatters, taking care of whitelisting prototype property access.</p>
+**Kind**: static method of [<code>HtmlFormatter</code>](#HtmlFormatter)  
+<a name="HtmlFormatter.cssObject"></a>
 
-**Kind**: global class  
+### ~~HtmlFormatter.cssObject()~~
+***Deprecated***
+
+<p>Basic CSS, in object style à la useStyles, to use with the HTML output</p>
+
+**Kind**: static method of [<code>HtmlFormatter</code>](#HtmlFormatter)  
 <a name="HtmlTableFormatter"></a>
 
 ## HtmlTableFormatter
@@ -1031,57 +1088,6 @@ song.mapLines((line) => {
 PDF conversion.</p>
 
 **Kind**: global class  
-
-* [HtmlTableFormatter](#HtmlTableFormatter)
-    * _instance_
-        * [.format(song)](#HtmlTableFormatter+format) ⇒ <code>string</code>
-    * _static_
-        * [.cssString(scope)](#HtmlTableFormatter.cssString) ⇒ <code>string</code>
-        * [.cssObject()](#HtmlTableFormatter.cssObject) ⇒ <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
-
-<a name="HtmlTableFormatter+format"></a>
-
-### htmlTableFormatter.format(song) ⇒ <code>string</code>
-<p>Formats a song into HTML.</p>
-
-**Kind**: instance method of [<code>HtmlTableFormatter</code>](#HtmlTableFormatter)  
-**Returns**: <code>string</code> - <p>The HTML string</p>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| song | [<code>Song</code>](#Song) | <p>The song to be formatted</p> |
-
-<a name="HtmlTableFormatter.cssString"></a>
-
-### HtmlTableFormatter.cssString(scope) ⇒ <code>string</code>
-<p>Generates basic CSS, optionally scoped within the provided selector, to use with output generated by
-[HtmlTableFormatter](#HtmlTableFormatter)</p>
-<p>For example, execute cssString('.chordSheetViewer') will result in CSS like:</p>
-<pre><code>.chordSheetViewer .paragraph {
-  margin-bottom: 1em;
-}
-</code></pre>
-
-**Kind**: static method of [<code>HtmlTableFormatter</code>](#HtmlTableFormatter)  
-**Returns**: <code>string</code> - <p>the CSS string</p>  
-
-| Param | Description |
-| --- | --- |
-| scope | <p>the CSS scope to use, for example <code>.chordSheetViewer</code></p> |
-
-<a name="HtmlTableFormatter.cssObject"></a>
-
-### HtmlTableFormatter.cssObject() ⇒ <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
-<p>Basic CSS, in object style à la useStyles, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)
-For a CSS string see [cssString](cssString)</p>
-<p>Example:</p>
-<pre><code>'.paragraph': {
-  marginBottom: '1em'
-}
-</code></pre>
-
-**Kind**: static method of [<code>HtmlTableFormatter</code>](#HtmlTableFormatter)  
-**Returns**: <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code> - <p>the CSS object</p>  
 <a name="TextFormatter"></a>
 
 ## TextFormatter
@@ -1106,17 +1112,6 @@ For a CSS string see [cssString](cssString)</p>
 <p>Parses a ChordPro chord sheet</p>
 
 **Kind**: global class  
-
-* [ChordProParser](#ChordProParser)
-    * [.warnings](#ChordProParser+warnings) : [<code>Array.&lt;ParserWarning&gt;</code>](#ParserWarning)
-    * [.parse(chordProChordSheet)](#ChordProParser+parse) ⇒ [<code>Song</code>](#Song)
-
-<a name="ChordProParser+warnings"></a>
-
-### chordProParser.warnings : [<code>Array.&lt;ParserWarning&gt;</code>](#ParserWarning)
-<p>All warnings raised during parsing the ChordPro chord sheet</p>
-
-**Kind**: instance property of [<code>ChordProParser</code>](#ChordProParser)  
 <a name="ChordProParser+parse"></a>
 
 ### chordProParser.parse(chordProChordSheet) ⇒ [<code>Song</code>](#Song)
@@ -1131,19 +1126,26 @@ For a CSS string see [cssString](cssString)</p>
 
 <a name="ChordSheetParser"></a>
 
-## ChordSheetParser
+## ~~ChordSheetParser~~
+***Deprecated***
+
 <p>Parses a normal chord sheet</p>
+<p>ChordSheetParser is deprecated, please use ChordsOverWordsParser.</p>
+<p>ChordsOverWordsParser aims to support any kind of chord, whereas ChordSheetParser lacks
+support for many variations. Besides that, some chordpro feature have been ported back
+to ChordsOverWordsParser, which adds some interesting functionality.</p>
 
 **Kind**: global class  
 
-* [ChordSheetParser](#ChordSheetParser)
+* ~~[ChordSheetParser](#ChordSheetParser)~~
     * [new ChordSheetParser([options])](#new_ChordSheetParser_new)
     * [.parse(chordSheet, [options])](#ChordSheetParser+parse) ⇒ [<code>Song</code>](#Song)
 
 <a name="new_ChordSheetParser_new"></a>
 
 ### new ChordSheetParser([options])
-<p>Instantiate a chord sheet parser</p>
+<p>Instantiate a chord sheet parser
+ChordSheetParser is deprecated, please use ChordsOverWordsParser.</p>
 
 
 | Param | Type | Default | Description |
@@ -1165,6 +1167,54 @@ For a CSS string see [cssString](cssString)</p>
 | [options] | <code>Object</code> | <code>{}</code> | <p>Optional parser options</p> |
 | [options.song] | [<code>Song</code>](#Song) | <code></code> | <p>The [Song](#Song) to store the song data in</p> |
 
+<a name="ChordsOverWordsParser"></a>
+
+## ChordsOverWordsParser
+<p>Parses a chords over words sheet into a song</p>
+<p>It support &quot;regular&quot; chord sheets:</p>
+<pre><code>       Am         C/G        F          C
+Let it be, let it be, let it be, let it be
+C                G              F  C/E Dm C
+Whisper words of wisdom, let it be
+</code></pre>
+<p>Additionally, some chordpro features have been &quot;ported back&quot;. For example, you can use chordpro directives:</p>
+<pre><code>{title: Let it be}
+{key: C}
+Chorus 1:
+       Am
+Let it be
+</code></pre>
+<p>For convenience, you can leave out the brackets:</p>
+<pre><code>title: Let it be
+Chorus 1:
+       Am
+Let it be
+</code></pre>
+<p>You can even use a markdown style frontmatter separator to separate the header from the song:</p>
+<pre><code>title: Let it be
+key: C
+---
+Chorus 1:
+       Am         C/G        F          C
+Let it be, let it be, let it be, let it be
+C                G              F  C/E Dm C
+Whisper words of wisdom, let it be
+</code></pre>
+<p><code>ChordsOverWordsParser</code> is the better version of <code>ChordSheetParser</code>, which is deprecated.</p>
+
+**Kind**: global class  
+<a name="ChordsOverWordsParser+parse"></a>
+
+### chordsOverWordsParser.parse(chordsOverWordsSheet) ⇒ [<code>Song</code>](#Song)
+<p>Parses a chords over words sheet into a song</p>
+
+**Kind**: instance method of [<code>ChordsOverWordsParser</code>](#ChordsOverWordsParser)  
+**Returns**: [<code>Song</code>](#Song) - <p>The parsed song</p>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| chordsOverWordsSheet | <code>string</code> | <p>the chords over words sheet</p> |
+
 <a name="ParserWarning"></a>
 
 ## ParserWarning
@@ -1178,6 +1228,18 @@ For a CSS string see [cssString](cssString)</p>
 
 **Kind**: instance method of [<code>ParserWarning</code>](#ParserWarning)  
 **Returns**: <code>string</code> - <p>The string warning</p>  
+<a name="PegBasedParser"></a>
+
+## PegBasedParser
+<p>Parses a chords over words sheet</p>
+
+**Kind**: global class  
+<a name="PegBasedParser+warnings"></a>
+
+### pegBasedParser.warnings : [<code>Array.&lt;ParserWarning&gt;</code>](#ParserWarning)
+<p>All warnings raised during parsing the chord sheet</p>
+
+**Kind**: instance property of [<code>PegBasedParser</code>](#PegBasedParser)  
 <a name="UltimateGuitarParser"></a>
 
 ## UltimateGuitarParser
@@ -1195,14 +1257,14 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p>
 * [Chord](#Chord)
     * _instance_
         * [.clone()](#Chord+clone) ⇒ [<code>Chord</code>](#Chord)
-        * [.toChordSymbol([key])](#Chord+toChordSymbol) ⇒ [<code>Chord</code>](#Chord)
-        * [.toChordSymbolString([key])](#Chord+toChordSymbolString) ⇒ <code>string</code>
+        * [.toChordSymbol([referenceKey])](#Chord+toChordSymbol) ⇒ [<code>Chord</code>](#Chord)
+        * [.toChordSymbolString([referenceKey])](#Chord+toChordSymbolString) ⇒ <code>string</code>
         * [.isChordSymbol()](#Chord+isChordSymbol) ⇒ <code>boolean</code>
-        * [.toNumeric([key])](#Chord+toNumeric) ⇒ [<code>Chord</code>](#Chord)
-        * [.toNumeral(key)](#Chord+toNumeral) ⇒ [<code>Chord</code>](#Chord)
-        * [.toNumeralString([key])](#Chord+toNumeralString) ⇒ <code>string</code>
+        * [.toNumeric([referenceKey])](#Chord+toNumeric) ⇒ [<code>Chord</code>](#Chord)
+        * [.toNumeral([referenceKey])](#Chord+toNumeral) ⇒ [<code>Chord</code>](#Chord)
+        * [.toNumeralString([referenceKey])](#Chord+toNumeralString) ⇒ <code>string</code>
         * [.isNumeric()](#Chord+isNumeric) ⇒ <code>boolean</code>
-        * [.toNumericString([key])](#Chord+toNumericString) ⇒ <code>string</code>
+        * [.toNumericString([referenceKey])](#Chord+toNumericString) ⇒ <code>string</code>
         * [.isNumeral()](#Chord+isNumeral) ⇒ <code>boolean</code>
         * [.toString()](#Chord+toString) ⇒ <code>string</code>
         * [.normalize([key], [options])](#Chord+normalize) ⇒ [<code>Chord</code>](#Chord)
@@ -1211,7 +1273,7 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p>
         * [.transposeDown()](#Chord+transposeDown) ⇒ [<code>Chord</code>](#Chord)
         * [.transpose(delta)](#Chord+transpose) ⇒ [<code>Chord</code>](#Chord)
     * _static_
-        * [.parse(chordString)](#Chord.parse) ⇒ <code>null</code> \| [<code>Chord</code>](#Chord)
+        * [.parse(chordString)](#Chord.parse) ⇒ [<code>Chord</code>](#Chord) \| <code>null</code>
 
 <a name="Chord+clone"></a>
 
@@ -1221,7 +1283,7 @@ Inherits from [ChordSheetParser](#ChordSheetParser)</p>
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
 <a name="Chord+toChordSymbol"></a>
 
-### chord.toChordSymbol([key]) ⇒ [<code>Chord</code>](#Chord)
+### chord.toChordSymbol([referenceKey]) ⇒ [<code>Chord</code>](#Chord)
 <p>Converts the chord to a chord symbol, using the supplied key as a reference.
 For example, a numeric chord <code>#4</code> with reference key <code>E</code> will return the chord symbol <code>A#</code>.
 When the chord is already a chord symbol, it will return a clone of the object.</p>
@@ -1231,11 +1293,11 @@ When the chord is already a chord symbol, it will return a clone of the object.<
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a numeric or numeral.</p> |
 
 <a name="Chord+toChordSymbolString"></a>
 
-### chord.toChordSymbolString([key]) ⇒ <code>string</code>
+### chord.toChordSymbolString([referenceKey]) ⇒ <code>string</code>
 <p>Converts the chord to a chord symbol string, using the supplied key as a reference.
 For example, a numeric chord <code>#4</code> with reference key <code>E</code> will return the chord symbol <code>A#</code>.
 When the chord is already a chord symbol, it will return a string version of the chord.</p>
@@ -1246,7 +1308,7 @@ When the chord is already a chord symbol, it will return a string version of the
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a numeric or numeral.</p> |
 
 <a name="Chord+isChordSymbol"></a>
 
@@ -1256,7 +1318,7 @@ When the chord is already a chord symbol, it will return a string version of the
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
 <a name="Chord+toNumeric"></a>
 
-### chord.toNumeric([key]) ⇒ [<code>Chord</code>](#Chord)
+### chord.toNumeric([referenceKey]) ⇒ [<code>Chord</code>](#Chord)
 <p>Converts the chord to a numeric chord, using the supplied key as a reference.
 For example, a chord symbol A# with reference key E will return the numeric chord #4.</p>
 
@@ -1265,11 +1327,11 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
 
 <a name="Chord+toNumeral"></a>
 
-### chord.toNumeral(key) ⇒ [<code>Chord</code>](#Chord)
+### chord.toNumeral([referenceKey]) ⇒ [<code>Chord</code>](#Chord)
 <p>Converts the chord to a numeral chord, using the supplied key as a reference.
 For example, a chord symbol A# with reference key E will return the numeral chord #IV.</p>
 
@@ -1278,11 +1340,11 @@ For example, a chord symbol A# with reference key E will return the numeral chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| key | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
 
 <a name="Chord+toNumeralString"></a>
 
-### chord.toNumeralString([key]) ⇒ <code>string</code>
+### chord.toNumeralString([referenceKey]) ⇒ <code>string</code>
 <p>Converts the chord to a numeral chord string, using the supplied kye as a reference.
 For example, a chord symbol A# with reference key E will return the numeral chord #4.</p>
 
@@ -1292,7 +1354,7 @@ For example, a chord symbol A# with reference key E will return the numeral chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
 
 <a name="Chord+isNumeric"></a>
 
@@ -1302,7 +1364,7 @@ For example, a chord symbol A# with reference key E will return the numeral chor
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
 <a name="Chord+toNumericString"></a>
 
-### chord.toNumericString([key]) ⇒ <code>string</code>
+### chord.toNumericString([referenceKey]) ⇒ <code>string</code>
 <p>Converts the chord to a numeric chord string, using the supplied kye as a reference.
 For example, a chord symbol A# with reference key E will return the numeric chord #4.</p>
 
@@ -1312,7 +1374,7 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [key] | [<code>Key</code>](#Key) \| <code>string</code> | <code></code> | <p>the reference key</p> |
+| [referenceKey] | [<code>Key</code>](#Key) \| <code>string</code> \| <code>null</code> | <code></code> | <p>the reference key. The key is required when converting a chord symbol</p> |
 
 <a name="Chord+isNumeral"></a>
 
@@ -1344,6 +1406,8 @@ For example, a chord symbol A# with reference key E will return the numeric chor
 <p>Besides that it normalizes the suffix if <code>normalizeSuffix</code> is <code>true</code>.
 For example, <code>sus2</code> becomes <code>2</code>, <code>sus4</code> becomes <code>sus</code>.
 All suffix normalizations can be found in <code>src/normalize_mappings/suffix-mapping.txt</code>.</p>
+<p>When the chord is minor, bass notes are normalized off of the relative major
+of the root note. For example, <code>Em/A#</code> becomes <code>Em/Bb</code>.</p>
 
 **Kind**: instance method of [<code>Chord</code>](#Chord)  
 **Returns**: [<code>Chord</code>](#Chord) - <p>the normalized chord</p>  
@@ -1394,14 +1458,15 @@ All suffix normalizations can be found in <code>src/normalize_mappings/suffix-ma
 
 <a name="Chord.parse"></a>
 
-### Chord.parse(chordString) ⇒ <code>null</code> \| [<code>Chord</code>](#Chord)
-<p>Tries to parse a chord string into a chord</p>
+### Chord.parse(chordString) ⇒ [<code>Chord</code>](#Chord) \| <code>null</code>
+<p>Tries to parse a chord string into a chord
+Any leading or trailing whitespace is removed first, so a chord like <code> \n  E/G# \r</code> is valid.</p>
 
 **Kind**: static method of [<code>Chord</code>](#Chord)  
 
 | Param | Description |
 | --- | --- |
-| chordString | <p>the chord string, eg <code>Esus4/G#</code> or <code>1sus4/#3</code></p> |
+| chordString | <p>the chord string, eg <code>Esus4/G#</code> or <code>1sus4/#3</code>.</p> |
 
 <a name="ChordSheetSerializer"></a>
 
@@ -1601,6 +1666,18 @@ See https://www.chordpro.org/chordpro/directives-key/</p>
 
 <a name="defaultCss"></a>
 
+## defaultCss ⇒ <code>string</code>
+<p>Generates basic CSS, scoped within the provided selector, to use with output generated by [HtmlTableFormatter](#HtmlTableFormatter)</p>
+
+**Kind**: global variable  
+**Returns**: <code>string</code> - <p>the CSS string</p>  
+
+| Param | Description |
+| --- | --- |
+| scope | <p>the CSS scope to use, for example <code>.chordSheetViewer</code></p> |
+
+<a name="defaultCss"></a>
+
 ## defaultCss : <code>Object.&lt;string, Object.&lt;string, string&gt;&gt;</code>
 <p>Basic CSS, in object style à la useStyles, to use with output generated by {@link }HtmlTableFormatter}
 For a CSS string see [scopedCss](scopedCss)</p>
@@ -1638,7 +1715,7 @@ For a CSS string see [scopedCss](scopedCss)</p>
 **Kind**: global constant  
 <a name="parseChord"></a>
 
-## ~~parseChord(chordString) ⇒ <code>null</code> \| [<code>Chord</code>](#Chord)~~
+## ~~parseChord(chordString) ⇒ [<code>Chord</code>](#Chord) \| <code>null</code>~~
 ***Deprecated***
 
 <p>Tries to parse a chord string into a chord</p>