From 32a504b635e9cc232b2f6ffe1e8c0c38d008fa07 Mon Sep 17 00:00:00 2001
From: Stephan Roos <StephanSJRoos@gmail.com>
Date: Sat, 28 Feb 2026 09:32:35 +0200
Subject: [PATCH] Added documentation for whistle fingering definitions

---
 whistle_tab_generator.qml | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/whistle_tab_generator.qml b/whistle_tab_generator.qml
index 2bc86b4..1e9313b 100644
--- a/whistle_tab_generator.qml
+++ b/whistle_tab_generator.qml
@@ -49,13 +49,13 @@ MuseScore {
       property int userJustification: 1   // 0=left,1=center,2=right
       property real userOffsetY: 1.2
       property real userLineSpacing: 0.6
-      property string userFormatString: "$1    \n$2\n$3\n$4\n$5\n$6\n$7\n$8\n$9\n$+"
+      property string userFormatString: "$1    \n$2\n$3\n$4\n$5\n\n$6\n$7\n$8\n$9\n$+\n$note"
 
       property int defaultFontSize: 8
       property int defaultJustification: 1
       property real defaultOffsetY: 1.2
       property real defaultLineSpacing: 0.6
-      property string defaultFormatString: "$1    \n$2\n$3\n$4\n$5\n$6\n$7\n$8\n$9\n$+"
+      property string defaultFormatString: "$1    \n$2\n$3\n$4\n$5\n\n$6\n$7\n$8\n$9\n$+\n$note"
 
       // For undo/redo
       property var history: 0
@@ -68,6 +68,31 @@ MuseScore {
 
       //Dictionary for your whistle, specifying the note and the fingering pattern (left-> right, starting from the fipple end).
       //2 indicates a closed hole, 1 indicates a half hole, 0 indicates open hole. The last digit is a reserved section indicating how many plusses (+) should be drawn to signal overblowing.
+
+//      ○ = 0
+//      ◐ = 1
+//      ● = 2
+
+      //Example fingering specification for high D whistle overblowing one octave to G6
+//            |---------------------------------------------
+//windway ->  | | |             ●  ●  ●    ○  ○  ○         |
+//            |---------------------------------------------
+//                "G6":   "     2  2  2    0  0  0  1 " <- last bit indicates number of +'s to add (i.e. how many times to overblow). Can be >= 0
+
+
+//Example fingering specification for G#5 on a high D whistle
+//            |---------------------------------------------
+//windway ->  | | |             ●  ●  ◐    ○  ○  ○         |
+//            |---------------------------------------------
+//                 "G#5": "     2  2  1    0  0  0  0 " <- overblow bit set to zero to indicate first octave
+//                              |  |  |    |  |  |  |
+// variables in format string: $1 $2 $3   $4 $5 $6 $+   and then $note would be replaced with 'G#5'
+
+
+//Can have any number of holes in the specification, but the formatting string must consume all hole variables
+
+property var fingeringDict: ({//Fingering dictionary for custom chromatic whistle in the key of
+
       property var fingeringDict: ({//Fingering dictionary for custom chromatic whistle in the key of
             "G4": "2222222220",      // G4
             "G#4": "2222222200",     // G#4 / Ab4