Skip to content

Commit

Permalink
Added enum data for many objects.
Browse files Browse the repository at this point in the history
Several of the string types in MNX are limited to specific values.
These values are now (for the most part) explicitly documented,
both in the HTML docs and in the machine-readable JSON Schema.
  • Loading branch information
adrianholovaty committed Mar 28, 2024
1 parent 20fd5b0 commit dfd0aa3
Show file tree
Hide file tree
Showing 114 changed files with 1,053 additions and 39 deletions.
415 changes: 410 additions & 5 deletions docgenerator/data.json

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/accent/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/accidental-display/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/alter/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ <h1>The note alter object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/barline-type/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The barline type object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/barline/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
29 changes: 23 additions & 6 deletions docs/mnx-reference/objects/beam-hook-direction/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,33 @@ <h1>The beam hook direction object</h1>
<p><b>Type:</b> String</p>


<p>Allowed values are:</p>

<ul>
<li><code>"left"</code></li>
<li><code>"right"</code></li>
</ul>




<h2>Allowed values:</h2>

<table>
<thead>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
</thead>

<tr>
<td><nobr><b>"left"</b></nobr></td>
<td></td>
</tr>

<tr>
<td><nobr><b>"right"</b></nobr></td>
<td></td>
</tr>

</table>



<h2 id="examples">Examples</h2>

Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/beam-hook/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/beam/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/boolean/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The boolean object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/bpm/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The bpm object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/breath-mark-symbol/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ <h1>The breath mark symbol object</h1>





</main>
</div>

Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/breath-mark/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ <h2>Keys:</h2>





</main>
</div>

Expand Down
29 changes: 29 additions & 0 deletions docs/mnx-reference/objects/clef-sign/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,35 @@ <h1>The clef sign object</h1>



<h2>Allowed values:</h2>

<table>
<thead>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
</thead>

<tr>
<td><nobr><b>"C"</b></nobr></td>
<td></td>
</tr>

<tr>
<td><nobr><b>"F"</b></nobr></td>
<td></td>
</tr>

<tr>
<td><nobr><b>"G"</b></nobr></td>
<td></td>
</tr>

</table>



<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/clef/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/color/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The color object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/dynamic-type/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ <h1>The dynamic type object</h1>





</main>
</div>

Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/dynamic/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,8 @@ <h2>Keys:</h2>





</main>
</div>

Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/ending-duration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The ending duration object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/ending-number/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The ending number object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/ending-open/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The ending open object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/ending/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/event-markings/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/event/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/fifths/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The fifths object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/fine/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/global/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
35 changes: 28 additions & 7 deletions docs/mnx-reference/objects/grace-type/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,38 @@ <h1>The grace type object</h1>
<p><b>Type:</b> String</p>


<p>Allowed values are:</p>

<p><b>"make-time"</b>: The run of grace notes delays the onset of the next non-grace event.</p>

<p><b>"steal-following"</b>: The run of grace notes occupies a time interval starting at the expected onset of the next non-grace event, both delaying its onset and shortening its duration.</p>

<p><b>"steal-previous"</b>: The run of grace notes occupies a time interval that ends before the expected onset of the next non-grace event, shortening the duration of the preceding non-grace event.</p>




<h2>Allowed values:</h2>

<table>
<thead>
<tr>
<th>Value</th>
<th>Description</th>
</tr>
</thead>

<tr>
<td><nobr><b>"make-time"</b></nobr></td>
<td>The run of grace notes delays the onset of the next non-grace event.</td>
</tr>

<tr>
<td><nobr><b>"steal-following"</b></nobr></td>
<td>The run of grace notes occupies a time interval starting at the expected onset of the next non-grace event, both delaying its onset and shortening its duration.</td>
</tr>

<tr>
<td><nobr><b>"steal-previous"</b></nobr></td>
<td>The run of grace notes occupies a time interval that ends before the expected onset of the next non-grace event, shortening the duration of the preceding non-grace event.</td>
</tr>

</table>





Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/grace/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ <h2>Keys:</h2>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/id/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ <h1>The id object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/integer-signed/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ <h1>The integer (signed) object</h1>





</main>
</div>

Expand Down
2 changes: 2 additions & 0 deletions docs/mnx-reference/objects/integer-unsigned/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@ <h1>The integer (unsigned) object</h1>





<h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
Expand Down
Loading

0 comments on commit dfd0aa3

Please sign in to comment.