Improved tuplet-display-setting to be an enum.

Fixes #335.
w3c · Apr 22, 2024 · bffb472 · bffb472
1 parent fabcc1d
commit bffb472
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 4 deletions.
diff --git a/docgenerator/data.json b/docgenerator/data.json
@@ -5303,7 +5303,7 @@
         "child_key": "show-number",
         "child": 121,
         "is_required": false,
-        "description": "Controls the display of the quantity of inner and outer note value units for the tuplet.\r\n\r\n* \"none\" — do not show any tuplet number.\r\n\r\n* \"inner\" (default) — display only the numerator of the tuplet's \"inner\" attribute.\r\n\r\n* \"both\" — display both the numerators of the tuplet's \"inner\" and \"outer\" attributes."
+        "description": "Controls the display of the quantity of inner and outer note value units for the tuplet. If not provided, \"inner\" is assumed."
     }
 },
 {
@@ -5314,7 +5314,7 @@
         "child_key": "show-value",
         "child": 121,
         "is_required": false,
-        "description": "Controls the display of the note value units used inside and outside the tuplet.\r\n\r\n* \"none\" (default) — do not show any tuplet units.\r\n\r\n* \"inner\" — display only the note value unit of the tuplet’s \"inner\" attribute.\r\n\r\n* \"both\" — display both the note value units of the tuplet's \"inner\" and \"outer\" attributes."
+        "description": "Controls the display of the note value units used inside and outside the tuplet. If not provided, \"none\" is assumed."
     }
 },
 {
@@ -6498,6 +6498,33 @@
         "description": ""
     }
 },
+{
+    "model": "spec.jsonobjectenum",
+    "pk": 65,
+    "fields": {
+        "parent": 121,
+        "name": "none",
+        "description": "Do not show any tuplet units."
+    }
+},
+{
+    "model": "spec.jsonobjectenum",
+    "pk": 66,
+    "fields": {
+        "parent": 121,
+        "name": "inner",
+        "description": "Display only the note value unit of the tuplet’s \"inner\" attribute."
+    }
+},
+{
+    "model": "spec.jsonobjectenum",
+    "pk": 67,
+    "fields": {
+        "parent": 121,
+        "name": "both",
+        "description": "Display both the note value units of the tuplet's \"inner\" and \"outer\" attributes."
+    }
+},
 {
     "model": "spec.exampledocument",
     "pk": 1,

diff --git a/docs/mnx-reference/objects/tuplet-display-setting/index.html b/docs/mnx-reference/objects/tuplet-display-setting/index.html
@@ -56,6 +56,33 @@ <h1>The tuplet display setting object</h1>
 
 
 
+<h2>Allowed values:</h2>
+
+<table>
+<thead>
+<tr>
+    <th>Value</th>
+    <th>Description</th>
+</tr>
+</thead>
+
+<tr>
+    <td><nobr><b>&quot;both&quot;</b></nobr></td>
+    <td>Display both the note value units of the tuplet's "inner" and "outer" attributes.</td>
+</tr>
+
+<tr>
+    <td><nobr><b>&quot;inner&quot;</b></nobr></td>
+    <td>Display only the note value unit of the tuplet’s "inner" attribute.</td>
+</tr>
+
+<tr>
+    <td><nobr><b>&quot;none&quot;</b></nobr></td>
+    <td>Do not show any tuplet units.</td>
+</tr>
+
+</table>
+
 
 
 

diff --git a/docs/mnx-reference/objects/tuplet/index.html b/docs/mnx-reference/objects/tuplet/index.html
@@ -137,7 +137,7 @@ <h2>Keys:</h2>
 
     </td>
     <td>No</td>
-    <td>Controls the display of the quantity of inner and outer note value units for the tuplet.<br><br>* "none" — do not show any tuplet number.<br><br>* "inner" (default) — display only the numerator of the tuplet's "inner" attribute.<br><br>* "both" — display both the numerators of the tuplet's "inner" and "outer" attributes.</td>
+    <td>Controls the display of the quantity of inner and outer note value units for the tuplet. If not provided, "inner" is assumed.</td>
 </tr>
 
 <tr>
@@ -148,7 +148,7 @@ <h2>Keys:</h2>
 
     </td>
     <td>No</td>
-    <td>Controls the display of the note value units used inside and outside the tuplet.<br><br>* "none" (default) — do not show any tuplet units.<br><br>* "inner" — display only the note value unit of the tuplet’s "inner" attribute.<br><br>* "both" — display both the note value units of the tuplet's "inner" and "outer" attributes.</td>
+    <td>Controls the display of the note value units used inside and outside the tuplet. If not provided, "none" is assumed.</td>
 </tr>
 
 <tr>

diff --git a/docs/mnx-schema.json b/docs/mnx-schema.json
@@ -484,6 +484,11 @@
       "type": "array"
     },
     "tuplet-display-setting": {
+      "enum": [
+        "none",
+        "inner",
+        "both"
+      ],
       "type": "string"
     },
     "up-or-down": {