Merge pull request music-encoding#1585 from music-encoding/stable

repo: merge stable into develop after release 5.1
musicEnfanthen · Jan 22, 2025 · 874f9e4 · 874f9e4
2 parents a838cef + 9d551da
commit 874f9e4
Show file tree

Hide file tree

Showing 51 changed files with 208 additions and 156 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -56,7 +56,7 @@ jobs:
 
       ### BUIDLING THE SCHEMA AND THE GUIDELINES ###
       - name: Checkout main repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           # Whether to checkout submodules: `true` to checkout submodules or `recursive` to
           # recursively checkout submodules.
@@ -72,13 +72,13 @@ jobs:
 
       ### UPLOADING THE ARTIFACTS ###
       - name: Upload PDF
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         with:
           name: pdf
           path: ${{ github.workspace }}/dist/guidelines/pdf/MEI_Guidelines_*.pdf
 
       - name: Upload Prince XML log
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
         with:
           name: prince_log
           path: ${{ github.workspace }}/build/prince.log
@@ -112,7 +112,7 @@ jobs:
       ### PUBLISHING THE SCHEMA ###
       - name: Checkout SCHEMA_REPO into SCHEMA_DIR
         if: github.repository_owner == env.REPO_OWNER && env.IS_DEV_OR_TAG == 'true'
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           # repository to check out
           repository: ${{ env.SCHEMA_REPO }}
@@ -176,7 +176,7 @@ jobs:
       ### PUBLISHING THE GUIDELINES ###
       - name: Checkout GUIDELINES_REPO into GUIDELINES_DIR
         if: github.repository_owner == env.REPO_OWNER && env.IS_DEV_OR_TAG == 'true'
-        uses: actions/checkout@v4
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           # repository to check out
           repository: ${{ env.GUIDELINES_REPO }}
@@ -242,7 +242,7 @@ jobs:
       # but then the version would have to be determined programatically
       - name: Create release
         if: startsWith(github.ref, 'refs/tags/v')
-        uses: ncipollo/release-action@2c591bcc8ecdcd2db72b97d6147f871fcd833ba5 # ratchet:ncipollo/release-action@v1.14.0
+        uses: ncipollo/release-action@cdcc88a9acf3ca41c16c37bb7d21b9ad48560d87 # v1.15.0
         with:
           allowUpdates: false
           artifacts: "${{ github.workspace }}/dist/guidelines/pdf/MEI_Guidelines_${{ github.ref_name }}.pdf"

diff --git a/.github/workflows/pr-labeler.yml b/.github/workflows/pr-labeler.yml
@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.repository_owner == 'music-encoding'
     steps:
-    - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # ratchet:actions/labeler@v5.0.0
+    - uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
       with:
         repo-token: "${{ secrets.GITHUB_TOKEN }}"
         sync-labels: true

diff --git a/build.properties b/build.properties
@@ -1,5 +1,5 @@
 meiversion.latest=5.0
-meiversion.next=5.1-dev
+meiversion.next=5.1
 saxon.edition.version=SaxonHE12-5
 saxon.version=12.5
 schematron.version=8.0.0

diff --git a/customizations/mei-CMN.xml b/customizations/mei-CMN.xml
@@ -106,12 +106,12 @@
           <attList>
             <attDef ident="meiversion" usage="rec" mode="change">
               <valList type="closed" mode="change">
-                <valItem ident="5.1-dev"/>
-                <valItem ident="5.1-dev+CMN"/>
-                <valItem ident="5.1-dev+anyStart" mode="delete"/>
-                <valItem ident="5.1-dev+basic" mode="delete"/>
-                <valItem ident="5.1-dev+Mensural" mode="delete"/>
-                <valItem ident="5.1-dev+Neumes" mode="delete"/>
+                <valItem ident="5.1"/>
+                <valItem ident="5.1+CMN"/>
+                <valItem ident="5.1+anyStart" mode="delete"/>
+                <valItem ident="5.1+basic" mode="delete"/>
+                <valItem ident="5.1+Mensural" mode="delete"/>
+                <valItem ident="5.1+Neumes" mode="delete"/>
             </valList>
             </attDef>
           </attList>

diff --git a/customizations/mei-Mensural.xml b/customizations/mei-Mensural.xml
@@ -106,12 +106,12 @@
           <attList>
             <attDef ident="meiversion" usage="rec" mode="change">
               <valList type="closed" mode="change">
-                <valItem ident="5.1-dev"/>
-                <valItem ident="5.1-dev+Mensural"/>
-                <valItem ident="5.1-dev+anyStart" mode="delete"/>
-                <valItem ident="5.1-dev+basic" mode="delete"/>
-                <valItem ident="5.1-dev+CMN" mode="delete"/>
-                <valItem ident="5.1-dev+Neumes" mode="delete"/>
+                <valItem ident="5.1"/>
+                <valItem ident="5.1+Mensural"/>
+                <valItem ident="5.1+anyStart" mode="delete"/>
+                <valItem ident="5.1+basic" mode="delete"/>
+                <valItem ident="5.1+CMN" mode="delete"/>
+                <valItem ident="5.1+Neumes" mode="delete"/>
             </valList>
             </attDef>
           </attList>

diff --git a/customizations/mei-Neumes.xml b/customizations/mei-Neumes.xml
@@ -107,12 +107,12 @@
           <attList>
             <attDef ident="meiversion" usage="rec" mode="change">
               <valList type="closed" mode="change">
-                <valItem ident="5.1-dev"/>
-                <valItem ident="5.1-dev+Neumes"/>
-                <valItem ident="5.1-dev+anyStart" mode="delete"/>
-                <valItem ident="5.1-dev+basic" mode="delete"/>
-                <valItem ident="5.1-dev+CMN" mode="delete"/>
-                <valItem ident="5.1-dev+Mensural" mode="delete"/>
+                <valItem ident="5.1"/>
+                <valItem ident="5.1+Neumes"/>
+                <valItem ident="5.1+anyStart" mode="delete"/>
+                <valItem ident="5.1+basic" mode="delete"/>
+                <valItem ident="5.1+CMN" mode="delete"/>
+                <valItem ident="5.1+Mensural" mode="delete"/>
             </valList>
             </attDef>
           </attList>

diff --git a/customizations/mei-all.xml b/customizations/mei-all.xml
@@ -108,14 +108,13 @@
         <classSpec ident="att.meiVersion" module="MEI.shared" type="atts" mode="change">
           <attList>
             <attDef ident="meiversion" usage="rec" mode="change">
-
               <valList type="closed" mode="change">
-                <valItem ident="5.1-dev"/>
-                <valItem ident="5.1-dev+anyStart" mode="delete"/>
-                <valItem ident="5.1-dev+basic" mode="delete"/>
-                <valItem ident="5.1-dev+CMN" mode="delete"/>
-                <valItem ident="5.1-dev+Mensural" mode="delete"/>
-                <valItem ident="5.1-dev+Neumes" mode="delete"/>
+                <valItem ident="5.1"/>
+                <valItem ident="5.1+anyStart" mode="delete"/>
+                <valItem ident="5.1+basic" mode="delete"/>
+                <valItem ident="5.1+CMN" mode="delete"/>
+                <valItem ident="5.1+Mensural" mode="delete"/>
+                <valItem ident="5.1+Neumes" mode="delete"/>
             </valList>
             </attDef>
           </attList>

diff --git a/customizations/mei-all_anyStart.xml b/customizations/mei-all_anyStart.xml
@@ -172,19 +172,19 @@
           <constraintSpec ident="meiVersion.warning.anyStart" scheme="schematron" mode="add">
             <constraint>
               <sch:rule context="/mei:*">
-                <sch:report role="error" test="not(local-name(.) = ('mei', 'meiHead', 'meiCorpus', 'music')) and not(@meiversion = '5.1-dev+anyStart')">If the document root element is any other than mei, meiHead, meiCorpus, or music the value of @meiversion must be '5.1-dev+anyStart'.</sch:report>
+                <sch:report role="error" test="not(local-name(.) = ('mei', 'meiHead', 'meiCorpus', 'music')) and not(@meiversion = '5.1+anyStart')">If the root element is any other than mei, meiHead, meiCorpus, or music the value of @meiversion must be '5.1+anyStart'.</sch:report>
               </sch:rule>
             </constraint>
           </constraintSpec>
           <attList>
             <attDef ident="meiversion" usage="rec" mode="change">
               <valList type="closed" mode="change">
-                <valItem ident="5.1-dev"/>
-                <valItem ident="5.1-dev+anyStart"/>
-                <valItem ident="5.1-dev+basic" mode="delete"/>
-                <valItem ident="5.1-dev+CMN" mode="delete"/>
-                <valItem ident="5.1-dev+Mensural" mode="delete"/>
-                <valItem ident="5.1-dev+Neumes" mode="delete"/>
+                <valItem ident="5.1"/>
+                <valItem ident="5.1+anyStart"/>
+                <valItem ident="5.1+basic" mode="delete"/>
+                <valItem ident="5.1+CMN" mode="delete"/>
+                <valItem ident="5.1+Mensural" mode="delete"/>
+                <valItem ident="5.1+Neumes" mode="delete"/>
             </valList>
             </attDef>
           </attList>

diff --git a/customizations/mei-basic.xml b/customizations/mei-basic.xml
@@ -857,6 +857,7 @@
                 <classSpec ident="att.harm.vis" module="MEI.visual" type="atts" mode="change">
                     <desc xml:lang="en">Visual domain attributes.</desc>
                     <classes>
+                        <memberOf key="att.color"/>
                         <memberOf key="att.extender"/>
                         <memberOf key="att.placementRelStaff"/>
                         <memberOf key="att.visualOffset"/>
@@ -1040,12 +1041,12 @@
                     <attList>
                         <attDef ident="meiversion" usage="req" mode="change">
                             <valList type="closed" mode="change">
-                                <valItem ident="5.1-dev"/>
-                                <valItem ident="5.1-dev+basic"/>
-                                <valItem ident="5.1-dev+anyStart" mode="delete"/>
-                                <valItem ident="5.1-dev+CMN" mode="delete"/>
-                                <valItem ident="5.1-dev+Mensural" mode="delete"/>
-                                <valItem ident="5.1-dev+Neumes" mode="delete"/>
+                                <valItem ident="5.1"/>
+                                <valItem ident="5.1+basic"/>
+                                <valItem ident="5.1+anyStart" mode="delete"/>
+                                <valItem ident="5.1+CMN" mode="delete"/>
+                                <valItem ident="5.1+Mensural" mode="delete"/>
+                                <valItem ident="5.1+Neumes" mode="delete"/>
                             </valList>
                         </attDef>
                     </attList>

diff --git a/source/contributors/curated.contributors.json b/source/contributors/curated.contributors.json
@@ -13,7 +13,7 @@
         "name": "Alastair Porter",
         "github": "https://github.com/alastair",
         "viaf": "",
-        "orcid": "",
+        "orcid": "https://orcid.org/0000-0001-8259-6028",
         "avatar": "https://avatars.githubusercontent.com/u/19217?v=4",
         "suppress":false
     },
@@ -170,6 +170,15 @@
         "avatar": "https://avatars.githubusercontent.com/u/10829937?v=4",
         "suppress":false
     },
+    {
+        "login": "janjusolja",
+        "name": "Olja Janjuš",
+        "github": "https://github.com/janjusolja",
+        "viaf": "http://viaf.org/viaf/24149233454276511312",
+        "orcid": "https://orcid.org/0009-0004-1498-495X",
+        "avatar": "https://avatars.githubusercontent.com/u/129741493?v=4",
+        "suppress":false
+    },
     {
         "login": "jcdevaney",
         "name": "Johanna Devaney",
@@ -260,6 +269,15 @@
         "avatar": "https://avatars.githubusercontent.com/u/13948831?v=4",
         "suppress":false
     },
+    {
+        "login": "maxrothman ",
+        "name": "Max Rothman",
+        "github": "https://github.com/maxrothman",
+        "viaf": "",
+        "orcid": "",
+        "avatar": "https://avatars.githubusercontent.com/u/2607086?v=4",
+        "suppress":false
+    },
     {
         "login": "mss2221",
         "name": "Mark Saccomano",

diff --git a/source/docs/01-introduction.xml b/source/docs/01-introduction.xml
@@ -177,15 +177,49 @@
                      Roland for his foresight, engagement and dedication in laying the foundations
                      of this initiative.</p>
                </div>
-               <div xml:id="aboutVersion" type="div3">
+               <div xml:id="aboutVersion5_1" type="div3">
+                  <head>About version 5.1</head>
+                  <p>Following release 5.0 from September 2023, Release 5.1 of MEI focuses primarily on maintenance 
+                     fixes of the guidelines and the development infrastructure, and on consistency, with only 
+                     limited changes to the specifications. Perhaps the most important additions are the enhancements 
+                     for the MEI tablature module, particularly the support for German Lute Tablature (GLT). 
+                     Notable fixes to the guidelines include correcting the description of the <att>optimize</att> 
+                     attribute on <gi scheme="MEI">scoreDef</gi> to clarify that empty staves 
+                     are <hi rend="italic">not</hi> displayed when its value is set to 'true'. 
+                     The Release Managers for MEI 5.1 were the Technical Co-Chairs, Benjamin W. Bohl and Stefan Münnich.</p>
+                  <p>With MEI 5.1, five additional elements have been added to the 
+                     schema: <gi scheme="MEI">tuning</gi>, <gi scheme="MEI">course</gi>, 
+                     <gi scheme="MEI">string</gi>, <gi scheme="MEI">tabDurSym</gi>, and 
+                     <gi scheme="MEI">tabGrp</gi>. All of these elements are used to encode tablature
+                     notation. The use of these elements, including relevant attributes, is documented in the
+                     largely rewritten chapter <ptr target="#tablature"/> of these Guidelines. The existing
+                     <ident type="class">att.stringtab.tuning</ident> attribute class has been deprecated
+                     in favor of these additions and will be removed in a future version of MEI.</p>
+                  <p>The new <ident type="class">att.dataSelecting</ident> class (currently available 
+                     only on <gi scheme="MEI">symbolDef</gi>) introduces an XPath-based selection 
+                     mechanism to identify elements to which certain features apply.</p>
+                  <p>All controlevents (see <ptr target="#eventsControlevents"/>, technically implemented 
+                     through membership in the <ident type="class">att.controlEvent</ident> class) are now member of 
+                     <ident type="class">att.color</ident>, enabling color customization through the <att>color</att>
+                     attribute. Similarly, directive-like elements (<gi scheme="MEI">bend</gi>, 
+                     <gi scheme="MEI">breath</gi>, <gi scheme="MEI">caesura</gi>, <gi scheme="MEI">cpMark</gi>, 
+                     <gi scheme="MEI">fermata</gi>, <gi scheme="MEI">fing</gi>, <gi scheme="MEI">fingGrp</gi>, 
+                     <gi scheme="MEI">harm</gi>, <gi scheme="MEI">harpPedal</gi>, <gi scheme="MEI">metaMark</gi>, 
+                     <gi scheme="MEI">mordent</gi>, <gi scheme="MEI">octave</gi>, <gi scheme="MEI">ornam</gi>,
+                     <gi scheme="MEI">trill</gi>, and <gi scheme="MEI">turn</gi>) are now member of the
+                     <ident type="class">att.verticalGroup</ident> class, which gives them access to the <att>vgrp</att>
+                     attribute, facilitating vertical alignment.</p>
+                  <p>Minor changes include the addition of <att>visible</att> and <att>enclose</att> on 
+                     <gi scheme="MEI">meterSigGrp</gi>.</p>
+               </div>   
+               <div xml:id="aboutVersion5" type="div3">
                   <head>About version 5.0</head>
                   <p>Release 5.0 of MEI focuses primarily on the guidelines, development infrastructure, 
                      and consistency, with only limited changes to the specifications. Perhaps the most important 
-                     additions are the introduction of the MEI Basic customization, and the availability 
+                     additions are the introduction of the MEI Basic customization, and the availability
                      of an auto-generated PDF version of the Guidelines (see below for more details on both).
                      The Release Managers for MEI 5.0 were the Technical Co-Chairs, Benjamin W. Bohl and Stefan
-                     Münnich.
-                  </p>
+                     Münnich.</p>
                   <div xml:id="meiBasic" type="div4">
                      <head>MEI Basic</head>
                      <p>As a framework to encode music, MEI offers extensive flexibility to encode music
@@ -236,7 +270,7 @@
                   </div>
                   <div xml:id="modelChanges" type="div4">
                      <head>Model changes in MEI</head>
-                     <p>MEI 5 introduces five new elements: <gi scheme="MEI">plica</gi> and 
+                     <p>MEI 5.0 introduces five new elements: <gi scheme="MEI">plica</gi> and 
                      <gi scheme="MEI">stem</gi>, for the encoding of documents written in Mensural 
                      notation, and <gi scheme="MEI">divLine</gi> for Neumes documents. The new CMN 
                      element <gi scheme="MEI">repeatMark</gi> can be used to express repetition marks 
@@ -283,8 +317,8 @@
                      <p>A lot of effort went into updating the infrastructure for generating releases. These
                      changes are designed to help improve the development workflow of MEI, improving consistency
                      and oversight of changes as they are contributed to MEI. Our new setup is explained in 
-                     great detail in <ref target="https://github.com/music-encoding/music-encoding/blob/dev/README.md">the project README file</ref>. 
-                     We have also expanded our <ref target="https://github.com/music-encoding/music-encoding/blob/dev/CONTRIBUTING.md">Contribution Guidelines</ref> 
+                     great detail in <ref target="https://github.com/music-encoding/music-encoding/blob/v5.0/README.md">the project README file</ref>. 
+                     We have also expanded our <ref target="https://github.com/music-encoding/music-encoding/blob/v5.0/CONTRIBUTING.md">Contribution Guidelines</ref> 
                      and other documentation files in the <ref target="https://github.com/music-encoding/music-encoding">music-encoding GitHub repository</ref>.</p>
                      <p>The MEI documentation and guidelines are now expressed in TEI ODD again, 
                      moving away from the MarkDown-based approach used in the preparation of 
@@ -777,8 +811,8 @@
                         target="#meiProfiles"/> are based on ODD customizations, and may serve as
                      starting point for further project-specific restrictions. They can be found
                         at <ref
-                        target="https://github.com/music-encoding/music-encoding/tree/dev/customizations"
-                        >https://github.com/music-encoding/music-encoding/tree/dev/customizations</ref>.
+                        target="https://github.com/music-encoding/music-encoding/tree/stable/customizations"
+                        >https://github.com/music-encoding/music-encoding/tree/stable/customizations</ref>.
                      In addition, several projects have shared their customizations on GitHub, such
                         as <ref
                         target="https://github.com/Freischuetz-Digital/data-music/tree/master/schemata/odd"

diff --git a/source/docs/02-shared.xml b/source/docs/02-shared.xml
@@ -619,7 +619,7 @@
                   <p>While <att>xml:lang</att> attribute may be used to encode the language of an element's contents, the <att>xml:space</att> attribute lets you define the handling of whitespace, <abbr>i.e.</abbr>, whitespace being important content (<val>preserve</val>) or negligible (<val>default</val>). With the latter also being the default value if no <att>xml:space</att> attribute is present.</p>
                </div>
                <div xml:id="sharedLabellingAttributes" type="div3">
-                  <head>Label Attributes</head> 
+                  <head>Label Attributes</head>
                   <p>
                      <specList>
                         <specDesc key="att.labelled" atts="label"/>