Skip to content

Commit

Permalink
Merge pull request #2 from rettinghaus/fix-wording
Browse files Browse the repository at this point in the history
Fix typos
  • Loading branch information
lpugin authored Dec 20, 2023
2 parents 4308bd4 + 12d2c7a commit 0d04dae
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
4 changes: 2 additions & 2 deletions docs/features/tuplets-and-beaming.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ Relevant tests:
{% include test file="tuplet-03" %}

Known limitations:

* Nested tuplets (tuplet within tuplet) are not supported.
* Since `@breaksec` is not available in MEI-Basic, these are represented with the `@type` attribute. This can be changed if eventually `@breaksec` is added to MEI-Basic
* Feathered beams are not supported.
* Feathered beams are not supported.
22 changes: 11 additions & 11 deletions docs/input-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ nav_order: 2

Import and export in integrated in MuseScore (as of version 4.2). File opening and file saving follows the same workflow as for other external file formats (e.g., MusicXML).

## File opening
## File opening

MEI files can be imported from the `Open...` menu with a selection of `*.mei` files:
MEI files can be imported from the `Open...` menu with a selection of `*.mei` files:

<img width="639" alt="image" src="https://github.com/rism-digital/MuseScore/assets/689412/397c3e8c-ce50-4c63-a4f6-bd369851c092">

Expand All @@ -20,26 +20,24 @@ The `Preferences` dialog includes a MEI checkbox option `Import MEI layout` in t

<img width="881" alt="image" src="https://github.com/rism-digital/MuseScore/assets/689412/bd71e7cf-f148-4b03-9f8c-10c021cbb58c">

## File saving

## File saving

MEI files can be saved through the `Export...` menu that includes an MEI section. The MEI section includes an option `Include page and system breaks` as well as the standard part extraction option:

<img width="804" alt="image" src="https://github.com/rism-digital/MuseScore/assets/689412/cc2bf69b-baa9-4316-a237-b70b6b533767">

## User feedback

## User feedback

When possible, some feedback is provided when features cannot be imported. The feedback is shown in dialog that allows for the process to be continued if desirable:

<img width="514" alt="image" src="https://github.com/rism-digital/MuseScore/assets/689412/cb26cec3-5d9c-45e7-987f-209e6c58f10d">

Additional lower-level feedback might be provided in the logs

## Metadata

## Metadata

The following metadata tags from the score properties are exported to the MEI header:

* Work title
* Arranger
* Composer
Expand Down Expand Up @@ -69,7 +67,7 @@ The following metadata tags from the score properties are exported to the MEI he
</meiHead>
```

{: .warning }
{: .warning }
The tags `Creation date`, `Platform` and `Source` are currently **not preserved** since no appropriate place in MEI-Basic has been found

When importing and MEI file, the values in the MEI header (if found) as set back as score properties. The entire MEI header is also preserved. When exporting again to MEI, the original header is re-exported as such and the score properties are ignored. However, the original MEI header can be deleted from the score properties dialog.
Expand All @@ -79,13 +77,15 @@ When importing and MEI file, the values in the MEI header (if found) as set back
The conversion from and to MEI through the MuseScore is possible with standard MuseScore command-line options.

For example, converting a MuseScore file to MEI:

```bash
mscore file.mscz -o file.mei
```

Converting and MEI file to MuseScore:
Converting an MEI file to MuseScore:

```bash
mscore file.mei -o file.mscz
```

The option `-f` can also be added to by-pass score corruption warnings.
The option `-f` can also be added to by-pass score corruption warnings.
5 changes: 3 additions & 2 deletions docs/structure/xml-ids.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ parent: "General structure"

## XML IDs

Exporting from MEI from MuseScore generates MEI IDs (i.e., `@xml:id`s). These are used for internal referencing (e.g., the `@startid` on a `dynam` referencing the `chord` it is attached to), but they can also be used for referencing MEI elements externally.
Exporting to MEI from MuseScore generates MEI IDs (i.e., `@xml:id`s). These are used for internal referencing (e.g., the `@startid` on a `dynam` referencing the `chord` it is attached to), but they can also be used for referencing MEI elements externally.

The MEI IDs are randomly generated. This means that exporting a file twice will have different MEI IDs. However, it is possible to seed the random generator with a value to be given in a `xml:id` property in the MuseScore metatag properties. When exporting to MEI, the value in the metatag is set as the `@xml:id` of the root `mei` element. It is preserved at import too, meaning the the `mei@xml:id` is set as `xml:id` metatag property in the imported MuseScore file.

Some elements that do not have a corresponding MuseScore object have no `@xml:id`. These are:

* `accid`
* `beam`
* `gracegrp`
Expand All @@ -26,4 +27,4 @@ When no `mei@xml:id` is given in the imported data, IDs in MEI data imported int

Modifying the data (e.g., changing the pitch of a note) will not modify the ID for the note. If some of the data is copied (e.g., the content of a measure), the copied data will be attribute new random IDs at export.

If a `mei@xml:id` is given in the imported data, the value will be used to seed the random generator and IDs will be regenerated. Having modified the data (e.g., changed the pitch of a note) will not impact the MEI IDs, which will remain the same. However, if some elements are inserted or deleted, that will modify the IDs in the resulting MEI file.
If a `mei@xml:id` is given in the imported data, the value will be used to seed the random generator and IDs will be regenerated. Having modified the data (e.g., changed the pitch of a note) will not impact the MEI IDs, which will remain the same. However, if some elements are inserted or deleted, that will modify the IDs in the resulting MEI file.

0 comments on commit 0d04dae

Please sign in to comment.