Merge branch 'dev'

Changes

@@ -1,3 +1,26 @@
+6.042 2024-01-09
+
+    - !This is a bugfix release.
+
+    - !Important
+
+    - To trace problems, the ChordPro 'about' information is included
+      in the PDF. This should not reveal sensitive information, but in
+      case this bothers you, you can disable this by setting
+      debug.runtimeinfo to 0 in the config.
+
+    - !Functionality
+    - Report XDG_CONFIG_HOME in runtime info.
+    - Include 'about' info as PDF metadata.
+    - !Bug fixes
+    - Post-release typo fixes.
+    - (Stringdiagram) Fix font size of base fret numeral (issue 337).
+    - (Stringdiagram) Fix fret number colours.
+    - Fix handling of XDG_CONFIG_HOME.
+    - Fix 'spread' images.
+    - Fix problem finding notes:german et al.
+    - (MMA) Fix test fail with perl >= 5.39.6.
+
 6.040 2023-12-26
 
     - !Highlights
@@ -6,13 +29,13 @@
       They can be placed relative to the paper, the page, the column,
       and the lyrics.
 
-    - Images can be [embedded[(https://chordpro.org/chordpro/directives-image/#inline-images) in text (lyrics) lines, either as part of
+    - Images can be [embedded](https://chordpro.org/chordpro/directives-image/#inline-images) in text (lyrics) lines, either as part of
       the text similar to a glyph, or somewhere else on the page
       relative to a particular place in the text. The latter is most
       interesting for annotations.
 
-    - Delegates are images too. Annotate your lyrics with SVG images,
-      or with musical notes using ABC or Lilypond.
+    - Delegates are images too. Annotate your lyrics with SVG images
+      and musical notes using ABC or Lilypond.
 
     - Chord and keyboard diagrams are images too. And you can use
       string and keyboard diagrams simultaneously.

Design/StructuredChordPro.org

@@ -0,0 +1,23 @@
+songbook ::= song+
+
+song ::= directive-or-part+
+
+directive-or-part ::= directive | part
+
+directive ::= '{' keyword [ ':' value ] '}'
+
+part ::= verse | chorus | tab
+
+verse ::= one or more consequetive songlines
+
+chorus ::= start-of-chorus verse+ end-of-chorus
+
+start-of-chorus ::= '{' 'start-of-chorus' | 'soc' '}'
+
+end-of-chorus ::= '{' 'end-of-chorus' | 'eoc' '}'
+
+tab ::= start-of-tab lines+ end-of-tab
+
+start-of-tab ::= '{' 'start-of-tab' | 'sot' '}'
+
+end-of-tab ::= '{' 'end-of-tab' | 'eot' '}'

Design/capo.txt

@@ -0,0 +1,23 @@
+                Key     Capo      Chord     Display
+Mod Down         D       -          D         D
+Mod Up           D       -          D         D
+Ignore           D       -          D         D
+
+Key = Concert key
+
+                Key     Capo      Chord     Display
+Mod Down         D       2          D         C
+Mod Up           D       2          D         E
+Ignore           D       2          D         D
+
+Key = Relative
+
+                Key     Capo      Chord     Display
+Mod Down         C       2          D         C
+Mod Up           E       2          D         E
+Ignore           D       2          D         D
+
+Note: MuseScore would display D(C) (sounding D, play C).
+
+While other will prefer D(E).
+

MANIFEST

@@ -135,6 +135,7 @@ lib/ChordPro/res/config/songbook_latex.json
 lib/ChordPro/res/config/ukulele-ly.json
 lib/ChordPro/res/config/ukulele.json
 lib/ChordPro/res/examples/bgdemo.pdf
+lib/ChordPro/res/examples/mollymalone.cho
 lib/ChordPro/res/examples/swinglow.cho
 lib/ChordPro/res/fonts/ChordProSymbols.ttf
 lib/ChordPro/res/icons/chordpro-doc.icns

Makefile.PL

@@ -43,7 +43,7 @@ WriteMakefile
 		    'Text::Layout'		  => 0.032,
 		    'JSON::PP'			  => 2.27203,
 		    'String::Interpolate::Named'  => 1.030,
-		    'File::LoadLines'		  => 1.042,
+		    'File::LoadLines'		  => 1.044,
 		    'File::HomeDir'		  => 1.004,
 		    'Image::Info'		  => 1.41,
 		    'List::Util'		  => 1.46,

docs/content/ChordPro-Configuration-Overview.md

@@ -108,9 +108,9 @@ Instrument definitions, in particular the settings `"tuning"`, `"notes"` and `"c
 
 For example, assume `"chords_italian.json"` defines a number of chords using italian (latin) note names and `"chords_german.json"` defines some chords using german note names. Then the following sequence of configuration files will work as expected:
 
-    notes::latin          (built-in, enable latin note names)
+    notes:latin           (built-in, enable latin note names)
     chords_italian.json   (defines chords with latin note names)
-    notes::german         (built-in, enable german note names)
+    notes:german          (built-in, enable german note names)
     chords_german.json    (defines chords with german note names)
 
 ### Merging hash valued items

docs/content/ChordPro-Reference-RelNotes.md

@@ -1,5 +1,37 @@
 # Release info
 
+## 6.042
+
+Released: 2024-01-09
+
+
+### This is a bugfix release.
+
+
+### Important
+
+* To trace problems, the ChordPro 'about' information is included in the PDF. This should not reveal sensitive information, but in case this bothers you, you can disable this by setting debug.runtimeinfo to 0 in the config.
+
+### Functionality
+
+* Report XDG_CONFIG_HOME in runtime info.
+* Include 'about' info as PDF metadata.
+
+### Bug fixes
+
+* Post-release typo fixes.
+* (Stringdiagram) Fix font size of base fret numeral (issue 337).
+* (Stringdiagram) Fix fret number colours.
+* Fix handling of XDG_CONFIG_HOME.
+* Fix 'spread' images.
+* Fix problem finding notes:german et al.
+* (MMA) Fix test fail with perl >= 5.39.6.
+
+### Social and support
+
+[User community](https://groups.io/g/ChordPro) for feedback and help.  
+Please use the [issue tracker](https://github.com/ChordPro/chordpro/issues) for bugs reports.
+
 ## 6.040
 
 Released: 2023-12-26
@@ -8,8 +40,8 @@ Released: 2023-12-26
 ### Highlights
 
 * Images can be [placed everywhere](https://chordpro.org/chordpro/directives-image/). They can be placed relative to the paper, the page, the column, and the lyrics.
-* Images can be [embedded[(https://chordpro.org/chordpro/directives-image/#inline-images) in text (lyrics) lines, either as part of the text similar to a glyph, or somewhere else on the page relative to a particular place in the text. The latter is most interesting for annotations.
-* Delegates are images too. Annotate your lyrics with SVG images, or with musical notes using ABC or Lilypond.
+* Images can be [embedded](https://chordpro.org/chordpro/directives-image/#inline-images) in text (lyrics) lines, either as part of the text similar to a glyph, or somewhere else on the page relative to a particular place in the text. The latter is most interesting for annotations.
+* Delegates are images too. Annotate your lyrics with SVG images and musical notes using ABC or Lilypond.
 * Chord and keyboard diagrams are images too. And you can use string and keyboard diagrams simultaneously.
 * Resources like configs, tasks and images are now more logically searched using [resource libraries](https://chordpro.org/chordpro/resources/).
 
@@ -52,11 +84,6 @@ Released: 2023-12-26
 * (PDF) Enhance assets (wip), labels; move grid to separate module.
 * Experimental ##include facility.
 
-### Social and support
-
-[User community](https://groups.io/g/ChordPro) for feedback and help.  
-Please use the [issue tracker](https://github.com/ChordPro/chordpro/issues) for bugs reports.
-
 ## 6.030
 
 Released: 2023-09-18

lib/ChordPro.pm

@@ -1059,6 +1059,11 @@ sub ::runtimeinfo {
 	    push( @p, $cp->display($_) );
 	}
     }
+    for ( qw( XDG_CONFIG_HOME ) ) {
+	if ( defined($ENV{$_}) && $ENV{$_} ne "" ) {
+	    $msg .= sprintf( $fmt, $_, $cp->display($ENV{$_}) );
+	}
+    }
     push( @p,  map { $cp->display($_) } @{ $cp->resdirs } );
     $tag = "Resource path";
     for ( uniq(@p) ) {

lib/ChordPro/Config.pm

@@ -733,6 +733,7 @@ sub hmerge( $left, $right, $path = "" ) {
             || $path =~ /^pdf\.(?:info|fonts)\./
             || $path =~ /^meta\./
             || $path =~ /^delegates\./
+            || $path =~ /^parser\.preprocess\./
             || $path =~ /^debug\./
             || $key =~ /^_/;
 
@@ -1127,6 +1128,7 @@ sub default_config () {
             "preamble" : [
                // Use ChordPro fonts for lyrics and chords.
                "%%textfont pdf.fonts.text",
+               "%%vocalfont pdf.fonts.text",
                "%%gchordfont pdf.fonts.chord",
             ],
             "preprocess" : { "abc" : [] },
@@ -1643,6 +1645,7 @@ sub default_config () {
 
     // For (debugging (internal use only)).
     "debug" : {
+        "runtimeinfo" : 1,
         "a2crd"     : 0,
         "assets"    : 0,
         "chords"    : 0,

lib/ChordPro/Output/MMA.pm

@@ -37,7 +37,7 @@ my $chords_under = 0;		# chords under lyrics
 
 sub safemeta {
     my ( $s, $meta, $default ) = @_;
-    return $default undef unless defined $meta && defined $s->{meta}->{$meta};
+    return $default unless defined $meta && defined $s->{meta}->{$meta};
     return $s->{meta}->{$meta}->[0];
 }