Merge branch 'dev'

ChordPro · Aug 23, 2021 · ba034f2 · ba034f2
2 parents f89c98c + fe7ab72
commit ba034f2
Show file tree

Hide file tree

Showing 30 changed files with 1,227 additions and 765 deletions.
diff --git a/Changes b/Changes
@@ -1,3 +1,14 @@
+0.000
+
+5.981 2021-08-23
+
+    - !ChordPro Syntax
+    - Add Cheat Sheet with ChordPro syntax and availability.
+    - !ChordPro functionality
+    - Document properties for the PDF can be supplied in the config file.
+    - !BugFixes
+    - Fix issue #159.
+
 5.980 2021-08-14
 
     - !ChordPro functionality

diff --git a/Makefile.PL b/Makefile.PL
@@ -48,9 +48,10 @@ WriteMakefile
 # },
 
  TEST_REQUIRES  => {
-		    'Test::More'  => 0,
-		    'JSON::PP'	  => 2.27203,
-		    'String::Interpolate::Named' => 0.05,
+		    'Test::More'                  => 0,
+		    'JSON::PP'	                  => 2.27203,
+		    'String::Interpolate::Named'  => 1.01,
+		    'Storable'			  => 3.08,
 		   },
 
  META_MERGE => {

diff --git a/docs/config/_default/config.yaml b/docs/config/_default/config.yaml
@@ -30,3 +30,9 @@ params:
 # Currently the goldmark parser misinterprets `[%`_name_`%]`.
 #markup:
 #  defaultMarkdownHandler: blackFriday
+
+markup:
+  goldmark:
+    parser:
+      attribute:
+        block: true
diff --git a/docs/content/ChordPro-Cheat_Sheet.md b/docs/content/ChordPro-Cheat_Sheet.md
diff --git a/docs/content/ChordPro-Configuration-PDF.md b/docs/content/ChordPro-Configuration-PDF.md
@@ -5,7 +5,7 @@ description: "Configuration for PDF output"
 
 # Configuration for PDF output
 
-Layout definitions for PDF output are stored in the configuration under the key `"pdf"`.
+Definitions for PDF output are stored in the configuration under the key `"pdf"`.
 
     {
        // ... generic part ...
@@ -17,6 +17,19 @@ Layout definitions for PDF output are stored in the configuration under the key
 Topics in this document:
 {{< toc >}}
 
+## Document info
+
+PDF document properties.
+
+      "info" : {
+          "title"    : "%{title}",
+          "author"   : "",
+          "subject"  : "",
+          "keywords" : "",
+      },
+
+Note that the context for substitutions is the first song.
+
 ## Papersize
 
 The size of the paper for which output must be formatted. The size can be specified either as the name of a known page size, e.g. `"a4"`, or as a 2-element list containing the width and height of the page in _PDF units_ (_DTP points_, _pt_, 1/72 inch).

diff --git a/docs/content/ChordPro-Directives.md b/docs/content/ChordPro-Directives.md
@@ -50,6 +50,7 @@ See also [Using metadata in texts]({{< relref "ChordPro-Configuration-Format-Str
 ## Formatting directives
 
 * [comment]({{< relref "Directives-comment" >}}) (short: c)
+* [highlight]({{< relref "Directives-comment" >}})
 * [comment_italic]({{< relref "Directives-comment" >}}) (short: ci)
 * [comment_box]({{< relref "Directives-comment" >}}) (short: cb)
 * [image]({{< relref "Directives-image" >}})
@@ -90,21 +91,31 @@ output.
 
 These directives can be used to temporarily change the font, size and/or colour for lyrics and chords. To permanently change these the reference implementation uses much more powerful [configuration files]({{< relref "ChordPro-Configuration" >}}).
 
-* [textfont]({{< relref "Directives-props_text_legacy" >}})
-* [textsize]({{< relref "Directives-props_text_legacy" >}})
+* [textfont]({{< relref "Directives-props_text_legacy" >}}) (short: tf)
+* [textsize]({{< relref "Directives-props_text_legacy" >}}) (short: ts)
 * [textcolour]({{< relref "Directives-props_text_legacy" >}})
-* [chordfont]({{< relref "Directives-props_chord_legacy" >}})
-* [chordsize]({{< relref "Directives-props_chord_legacy" >}})
+* [titlefont]({{< relref "Directives-props_title_legacy" >}})
+* [titlesize]({{< relref "Directives-props_title_legacy" >}})
+* [titlecolour]({{< relref "Directives-props_title_legacy" >}})
+* [footerfont]({{< relref "Directives-props_footer_legacy" >}})
+* [footersize]({{< relref "Directives-props_footer_legacy" >}})
+* [footercolour]({{< relref "Directives-props_footer_legacy" >}})
+* [chordfont]({{< relref "Directives-props_chord_legacy" >}}) (short: cf)
+* [chordsize]({{< relref "Directives-props_chord_legacy" >}}) (short: cs)
 * [chordcolour]({{< relref "Directives-props_chord_legacy" >}})
 * [tabfont]({{< relref "Directives-props_tab_legacy" >}})
 * [tabsize]({{< relref "Directives-props_tab_legacy" >}})
 * [tabcolour]({{< relref "Directives-props_tab_legacy" >}})
+* [tocfont]({{< relref "Directives-props_toc_legacy" >}})
+* [tocsize]({{< relref "Directives-props_toc_legacy" >}})
+* [toccolour]({{< relref "Directives-props_toc_legacy" >}})
 
 ## Output related directives
 
 * [new_page]({{< relref "Directives-new_page" >}}) (short: np)
 * [new_physical_page]({{< relref "Directives-new_physical_page" >}}) (short: npp)
 * [column_break]({{< relref "Directives-column_break" >}}) (short: cb)
+* [pagetype]({{< relref "Directives-pagetype_legacy" >}})
 
 The following directives are legacy from the old `chord` program. The modern reference implementation uses much more powerful configuration files for this purpose.
 

diff --git a/docs/content/ChordPro-File-Format-Specification.md b/docs/content/ChordPro-File-Format-Specification.md
@@ -5,7 +5,11 @@ description: "ChordPro: The File Format Specification"
 
 # ChordPro: The File Format Specification
 
-In a hurry? See the [ChordPro 6 Release information]({{< relref "ChordPro-RelNotes" >}}).
+In a hurry? See the
+[ChordPro Cheat Sheet]({{< relref "ChordPro-Cheat_Sheet" >}}).
+
+Want to know what's new? See the
+[ChordPro 6 Release information]({{< relref "ChordPro-RelNotes" >}}).
 
 ## Overview
 

diff --git a/docs/content/ChordPro-History.md b/docs/content/ChordPro-History.md
@@ -15,7 +15,6 @@ still unknown reasons these files became known as `ChordPro` files.
 The content is written in a [Domain Specific Language](https://en.wikipedia.org/wiki/Domain-specific_language) called the
 ChordPro language, or short, ChordPro.
 
-{{<table "table table-striped table-bordered table-sm">}}
 | Chord Version | Release Date     | Remarks |
 |---------|----------|---|
 | 1.0 | 1992-05-20 | reconstructed from internet archives|
@@ -26,7 +25,7 @@ ChordPro language, or short, ChordPro.
 | 3.6.2 | 1995-03 | date from the manual|
 | 3.6.3 | | unofficial |
 | 3.6.4 | 2009-12-30 | GPL release |
-{{</table>}}
+{ .table .table-striped .table-bordered .table-sm }
 
 For convenience, the ChordPro language version supported by the latter
 programs is set to `3`, to reflect the major version number of the
@@ -70,7 +69,6 @@ existing unofficial 3.6.3 version. Following the `Chord` GPL release
 `Chord`<sub><i>ii</i></sub> was rebased on the 3.6.4 version, making
 it officially and legally GPL.
 
-{{<table "table table-striped table-bordered table-sm">}}
 | Chordii Version | Release Date     | Remarks |
 |---------|----------|---|
 | 4.0.0 | 2007-11-30 ||
@@ -84,7 +82,7 @@ it officially and legally GPL.
 | 4.5.3 | 2015-11-23 ||
 | 4.6.0 | 2017-11-09 ||
 | | 2020-02-02 | Post-EOL fix for legacy packages |
-{{</table>}}
+{ .table .table-striped .table-bordered .table-sm }
 
 `Chord`ii development was tracked in a public repository on
 [SourceForge](https://sourceforge.net/projects/chordii/).

diff --git a/docs/content/ChordPro-Install-on-Linux.md b/docs/content/ChordPro-Install-on-Linux.md
@@ -21,7 +21,6 @@ available. On RPM-based systems (RedHat, Fedora, Suze) packages can be
 installed with `dnf` or `yum`. On Debian/Ubuntu-based systems use the
 `apt-get` tool.
 
-{{<table "table table-striped table-bordered">}}
 Module | RPM | Debian
 --|--|--
 `PDF::API2` | `perl-PDF-API2` | `libpdf-api2-perl`
@@ -30,7 +29,7 @@ Module | RPM | Debian
 `File::LoadLines` | `perl-File-LoadLines` | `libfile-loadlines-perl`
 `String::Interpolate::Named` | `perl-String-Interpolate-Named` | `libstring-interpolate-named-perl`
 `Image::Info` | `perl-Image-Info` | `libimage-info-perl`
-{{</table>}}
+{ .table .table-striped .table-bordered .table-sm }
 
 Do not worry if any of these packages are not available, the `cpan`
 install process will build them if necessary.

diff --git a/docs/content/ChordPro-Reference-RelNotes.md b/docs/content/ChordPro-Reference-RelNotes.md
@@ -1,5 +1,28 @@
 # Release info
 
+## 5.981
+
+Released: 2021-08-23
+
+
+### ChordPro Syntax
+
+* Add Cheat Sheet with ChordPro syntax and availability.
+
+### ChordPro functionality
+
+* Document properties for the PDF can be supplied in the config file.
+
+### BugFixes
+
+* Fix issue #159.
+
+### Social and support
+
+[User community](https://groups.io/g/ChordPro) for feedback and help.
+
+[Follow us on Twitter](https://twitter.com/ChordPro_Org) to stay informed about new releases and updates.
+
 ## 5.980
 
 Released: 2021-08-14
@@ -38,12 +61,6 @@ Released: 2021-08-14
 * Fix issue #149.
 * Fix issue #158.
 
-### Social and support
-
-[User community](https://groups.io/g/ChordPro) for feedback and help.
-
-[Follow us on Twitter](https://twitter.com/ChordPro_Org) to stay informed about new releases and updates.
-
 ## 0.979
 
 Released: 2021-07-09
@@ -769,3 +786,8 @@ Released: 2016-06-04
 
 * First alpha version released.
 
+## 0.000
+
+Under development
+
+
diff --git a/docs/content/ChordPro-RelNotes.md b/docs/content/ChordPro-RelNotes.md
diff --git a/docs/content/ChordPro-RelNotes.md b/docs/content/ChordPro-RelNotes.md
@@ -0,0 +1 @@
+ChordPro6-RelNotes.md