Skip to content

Commit

Permalink
Add information about the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lpugin committed Nov 29, 2023
1 parent 5c7b56b commit 4f02671
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into t
callouts:
warning:
title: Warning
color: red
color: yellow

color_scheme: mei_musescore

Expand Down
17 changes: 15 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav_order: 1

# MEI support in MuseScore

[MEI](https://music-encoding.org) support in MuseScore started through a collaboration between the Digital and Cognitive Musicology Lab (DCML) at the École polytechnique fédérale de Lausanne (EPFL) and the Répertoire international des sources musicales (RISM) Digital Center in Bern, Switzerland.
[MEI](https://music-encoding.org) support in [MuseScore](https://musescore.org) started through a collaboration between the Digital and Cognitive Musicology Lab (DCML) at the École polytechnique fédérale de Lausanne (EPFL) and the Répertoire international des sources musicales (RISM) Digital Center in Bern, Switzerland.

| [![DCML]({{ site.baseurl }}/assets/images/dcml.png)](https://github.com/DCMLab) | [![DCML]({{ site.baseurl }}/assets/images/rism-digital.png)](https://rism.digital) |

Expand All @@ -18,4 +18,17 @@ This is not the first attempt at supporting MEI in MuseScore. Members of the MEI

## MEI Basic

The goal is to provide "round trip" import and export of MEI from MuseScore. We are targeting the "MEI Basic" form of MEI, so called because it has been designed by the MEI community as a smaller, more limited subset of the larger MEI specification. MEI Basic is targeted at implementers of notation software for the purposes of supporting notation interchange. MEI v5, released in summer 2023, is the version of MEI that is read and written by MuseScore.
The goal is to provide "round trip" import and export of MEI from MuseScore. We are targeting the "MEI Basic" form of MEI, so called because it has been designed by the MEI community as a smaller, more limited subset of the larger MEI specification. MEI Basic is targeted at implementers of notation software for the purposes of supporting notation interchange. MEI v5, released in summer 2023, is the version of MEI that is read and written by MuseScore.

## Implementation

The implementation is based on the concept of round-trip loss-less conversion. This means that, exporting a file to MEI from MuseScore, re-importing it in MuseScore and re-exporting it to MEI is expected to produce twice exactly the same MEI file. Of course, since not all features are supported in the MEI export and import, only the ones implemented are taken into account for the evaluation.

The MuseScore implementation includes a set of [MEI test units]({{ site.musescore_test }}) that are used for evaluating the round-trip conversion. The status of these tests is constantly monitored through the continuous integration (CI) infrastructure of MuseScore.

## About this documentation

This documentation provides some information about the current status of the MEI support in MuseScore referencing the test units integrated in the MuseScore repository. In order to offer a direct visual impression of what each test unit is about, a rendering of them as obtained with the [Verovio](https://verovio.org) is included in the documentation.

{: .warning }
Readers should keep in mind that the Verovio rendering is only to give an idea of the content of the test unit and that the rendering in MuseScore will never be exactly the same.

0 comments on commit 4f02671

Please sign in to comment.