Skip to content

Commit

Permalink
Renamed 'tied' to 'tie' in Note object.
Browse files Browse the repository at this point in the history
This fixes #256. The rationale is that 'tie' is easier to
remember and is a noun instead of an adjective.
  • Loading branch information
adrianholovaty committed Mar 7, 2024
1 parent 89f4aaf commit 2f2fe5b
Show file tree
Hide file tree
Showing 8 changed files with 39 additions and 47 deletions.
38 changes: 15 additions & 23 deletions docgenerator/data.json

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/comparisons/musicxml/index.html
Expand Up @@ -1859,7 +1859,7 @@ <h2>Ties</h2>

<p class="examplenotes">MusicXML uses two elements: <code>&lt;tie&gt;</code> to describe the sound and <code>&lt;tied&gt;</code> to indicate a visual tie in notation. The first note gets <code>type="start"</code>, the second gets <code>type="stop"</code>.</p>
<p class="examplenotes"></p>
<p class="examplenotes">MNX uses a single object: <code>"tied"</code>. Only the first note in the tie encodes this; its <code>target</code> points at the <code>id</code> of the end note.</p>
<p class="examplenotes">MNX uses a single object: <code>"tie"</code>. Only the first note in the tie encodes this; its <code>target</code> points at the <code>id</code> of the end note.</p>
<p class="examplenotes"></p>
<p class="examplenotes">For a series of notes tied together (e.g., the second tie in the above example), both MusicXML and MNX require you to encode each “inner tie” separately.</p>

Expand Down Expand Up @@ -2021,8 +2021,8 @@ <h3>MNX</h3>
<a class="tag" href="../../mnx-reference/objects/pitch/">"octave"</a>: <a class="tag" href="../../mnx-reference/objects/octave/">5</a>,
<a class="tag" href="../../mnx-reference/objects/pitch/">"step"</a>: <a class="tag" href="../../mnx-reference/objects/step/">"E"</a>
},
<a class="tag" href="../../mnx-reference/objects/note/">"tied"</a>: {
<a class="tag" href="../../mnx-reference/objects/tied/">"target"</a>: <a class="tag" href="../../mnx-reference/objects/id/">"note3"</a>
<a class="tag" href="../../mnx-reference/objects/note/">"tie"</a>: {
<a class="tag" href="../../mnx-reference/objects/tie/">"target"</a>: <a class="tag" href="../../mnx-reference/objects/id/">"note3"</a>
}
}
]
Expand Down Expand Up @@ -2053,8 +2053,8 @@ <h3>MNX</h3>
<a class="tag" href="../../mnx-reference/objects/pitch/">"octave"</a>: <a class="tag" href="../../mnx-reference/objects/octave/">5</a>,
<a class="tag" href="../../mnx-reference/objects/pitch/">"step"</a>: <a class="tag" href="../../mnx-reference/objects/step/">"C"</a>
},
<a class="tag" href="../../mnx-reference/objects/note/">"tied"</a>: {
<a class="tag" href="../../mnx-reference/objects/tied/">"target"</a>: <a class="tag" href="../../mnx-reference/objects/id/">"note5"</a>
<a class="tag" href="../../mnx-reference/objects/note/">"tie"</a>: {
<a class="tag" href="../../mnx-reference/objects/tie/">"target"</a>: <a class="tag" href="../../mnx-reference/objects/id/">"note5"</a>
}
}
]
Expand All @@ -2079,8 +2079,8 @@ <h3>MNX</h3>
<a class="tag" href="../../mnx-reference/objects/pitch/">"octave"</a>: <a class="tag" href="../../mnx-reference/objects/octave/">5</a>,
<a class="tag" href="../../mnx-reference/objects/pitch/">"step"</a>: <a class="tag" href="../../mnx-reference/objects/step/">"C"</a>
},
<a class="tag" href="../../mnx-reference/objects/note/">"tied"</a>: {
<a class="tag" href="../../mnx-reference/objects/tied/">"target"</a>: <a class="tag" href="../../mnx-reference/objects/id/">"note6"</a>
<a class="tag" href="../../mnx-reference/objects/note/">"tie"</a>: {
<a class="tag" href="../../mnx-reference/objects/tie/">"target"</a>: <a class="tag" href="../../mnx-reference/objects/id/">"note6"</a>
}
}
]
Expand Down
4 changes: 2 additions & 2 deletions docs/mnx-reference/examples/organ-layout/index.html
Expand Up @@ -349,8 +349,8 @@ <h1>Organ layout</h1>
<a class="tag" href="../../objects/pitch/">"octave"</a>: <a class="tag" href="../../objects/octave/">3</a>,
<a class="tag" href="../../objects/pitch/">"step"</a>: <a class="tag" href="../../objects/step/">"E"</a>
},
<a class="tag" href="../../objects/note/">"tied"</a>: {
<a class="tag" href="../../objects/tied/">"target"</a>: <a class="tag" href="../../objects/id/">"pedNote2"</a>
<a class="tag" href="../../objects/note/">"tie"</a>: {
<a class="tag" href="../../objects/tie/">"target"</a>: <a class="tag" href="../../objects/id/">"pedNote2"</a>
}
}
]
Expand Down
12 changes: 6 additions & 6 deletions docs/mnx-reference/examples/ties/index.html
Expand Up @@ -120,8 +120,8 @@ <h1>Ties</h1>
<a class="tag" href="../../objects/pitch/">"octave"</a>: <a class="tag" href="../../objects/octave/">5</a>,
<a class="tag" href="../../objects/pitch/">"step"</a>: <a class="tag" href="../../objects/step/">"E"</a>
},
<a class="tag" href="../../objects/note/">"tied"</a>: {
<a class="tag" href="../../objects/tied/">"target"</a>: <a class="tag" href="../../objects/id/">"note3"</a>
<a class="tag" href="../../objects/note/">"tie"</a>: {
<a class="tag" href="../../objects/tie/">"target"</a>: <a class="tag" href="../../objects/id/">"note3"</a>
}
}
]
Expand Down Expand Up @@ -152,8 +152,8 @@ <h1>Ties</h1>
<a class="tag" href="../../objects/pitch/">"octave"</a>: <a class="tag" href="../../objects/octave/">5</a>,
<a class="tag" href="../../objects/pitch/">"step"</a>: <a class="tag" href="../../objects/step/">"C"</a>
},
<a class="tag" href="../../objects/note/">"tied"</a>: {
<a class="tag" href="../../objects/tied/">"target"</a>: <a class="tag" href="../../objects/id/">"note5"</a>
<a class="tag" href="../../objects/note/">"tie"</a>: {
<a class="tag" href="../../objects/tie/">"target"</a>: <a class="tag" href="../../objects/id/">"note5"</a>
}
}
]
Expand All @@ -178,8 +178,8 @@ <h1>Ties</h1>
<a class="tag" href="../../objects/pitch/">"octave"</a>: <a class="tag" href="../../objects/octave/">5</a>,
<a class="tag" href="../../objects/pitch/">"step"</a>: <a class="tag" href="../../objects/step/">"C"</a>
},
<a class="tag" href="../../objects/note/">"tied"</a>: {
<a class="tag" href="../../objects/tied/">"target"</a>: <a class="tag" href="../../objects/id/">"note6"</a>
<a class="tag" href="../../objects/note/">"tie"</a>: {
<a class="tag" href="../../objects/tie/">"target"</a>: <a class="tag" href="../../objects/id/">"note6"</a>
}
}
]
Expand Down
2 changes: 1 addition & 1 deletion docs/mnx-reference/objects/index.html
Expand Up @@ -256,7 +256,7 @@ <h1>Objects used in MNX</h1>

<li><a href="tenuto/">tenuto</a></li>

<li><a href="tied/">tied</a></li>
<li><a href="tie/">tie</a></li>

<li><a href="time/">time signature</a></li>

Expand Down
4 changes: 2 additions & 2 deletions docs/mnx-reference/objects/note/index.html
Expand Up @@ -147,10 +147,10 @@ <h2>Keys:</h2>
</tr>

<tr>
<td><nobr><b>"tied"</b></nobr></td>
<td><nobr><b>"tie"</b></nobr></td>
<td>

<a href="../tied/">tied object</a>
<a href="../tie/">tie object</a>

</td>
<td>No</td>
Expand Down
Expand Up @@ -2,7 +2,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>The tied object | MNX specification</title>
<title>The tie object | MNX specification</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width">
<link rel="stylesheet" href="../../../static/styles.css">
Expand Down Expand Up @@ -44,15 +44,15 @@
<a href="../../../">MNX specification</a> &gt;
<a href="../../">MNX reference</a> &gt;
<a href="../">Objects</a> &gt;
tied
tie
</p>

<h1>The tied object</h1>
<h1>The tie object</h1>

<p><b>Type:</b> Dictionary</p>


The "tied" object is used to indicate that a note is tied to a subsequent note.
The "tie" object is used to indicate that a note is tied to a subsequent note.



Expand Down Expand Up @@ -100,7 +100,7 @@ <h2 id="examples">Examples</h2>

<p>This object is used in the following examples:</p>
<p>
<nobr><a href="../../examples/organ-layout/">Organ layout</a></nobr>, <nobr><a href="../../examples/ties/">Ties</a></nobr>
<nobr><a href="../../examples/ties/">Ties</a></nobr>
</p>


Expand Down
2 changes: 1 addition & 1 deletion docs/mnx-schema.json
Expand Up @@ -193,7 +193,7 @@
"staff": {
"$ref": "#/$defs/staff-number"
},
"tied": {
"tie": {
"additionalProperties": false,
"properties": {
"location": {
Expand Down

0 comments on commit 2f2fe5b

Please sign in to comment.