Add test images

_config.yml

@@ -1,6 +1,7 @@
 title: MEI in MuseScore
 description: Documentation for MEI support in MuseScore
 theme: just-the-docs
+baseurl: "/mei-musescore-doc"
 
 url: https://lpugin.github.io/mei-musescore-doc
 

_includes/test

@@ -1,2 +1,10 @@
-{{ include.file }}.mei ([View MEI test file]({{ site.musescore_test }}{{ include.file }}.mei) or 
-[open in the Verovio Editor]({{ site.verovio_editor }}{{ site.musescore_raw }}{{ include.file }}.mei))
+
+| {{ include.file }} |
+|:-------------|
+| ![{{ include.file }}]({{ site.baseurl}}/tests/{{ include.file }}.mei.svg) |
+| [View MEI test file]({{ site.musescore_test }}{{ include.file }}.mei) or [open in the Verovio Editor]({{ site.verovio_editor }}{{ site.musescore_raw }}{{ include.file }}.mei) |
+
+
+
+
+

docs/features/additional-text-directives.md

@@ -19,7 +19,7 @@ The distinction of the type of directive is encoded in the `dir@type` attribute.
 The style (normal or italic) and the position (above or below) is inferred from the type. A custom position in MuseScore is encoded in `@place`.
 
 Relevant tests:
-* {% include test file="dir-01" %}
+{% include test file="dir-01" %}
 
 Known limitations:
 * Text formatting within the directive is ignored.

docs/features/chord-labels-and-roman-numerals.md

@@ -12,8 +12,8 @@ Chord labels and roman numerals in MuseScore are encoded with `harm`. In the exp
 For distinguishing between chord labels and roman numerals, a `harm@type` attribute is used with `mscore-roman` for roman numerals.
 
 Relevant tests:
-* {% include test file="chord-label-01" %}
-* {% include test file="roman-numeral-01" %}
+{% include test file="chord-label-01" %}
+{% include test file="roman-numeral-01" %}
 
 Known limitations:
 * Chord labels or roman numerals attached to a voice for which there is no note or rest are ignored.

docs/features/clefs.md

@@ -8,4 +8,4 @@ parent: "Features"
 ## Clefs
 
 Relevant tests:
-* {% include test file="clef-01" %}
+{% include test file="clef-01" %}

docs/features/dynamics.md

@@ -14,7 +14,7 @@ In addition to the text, the dynamic code is encoded in `@label`. Multi-line dyn
 Import of dynamic encoded with `@tstamp` attribute is also supported, even though these will not be preserved. Only dynamics for which a `chord`, `note`, or `rest` corresponding to the `@tstamp` can be found will be imported.
 
 Relevant tests:
-* {% include test file="dynamic-01" %}
+{% include test file="dynamic-01" %}
 
 Known limitations:
 * Text formatting (i.e., italic, bold, etc.) within a text element is currently not preserved.

docs/features/endings-and-repeat-signs.md

@@ -18,9 +18,9 @@ An additional `@type` attribute is used to encoded the specific MuseScore type.
 * `repeatMark@type="mscore-jump-dc-al-double-coda` for the MuseScore jump D.C. al Double Coda.
 
 Relevant tests:
-* {% include test file="ending-01" %}
-* {% include test file="jump-01" %}
-* {% include test file="jump-02" %}
+{% include test file="ending-01" %}
+{% include test file="jump-01" %}
+{% include test file="jump-02" %}
 
 Known limitations:
 * For Jump, values for jumpTo, playUntil and continueAt are not exported and default values are assume during import. Similarly, the default value for label is used for Marker during import.

docs/features/fermata-and-breaths.md

@@ -21,8 +21,8 @@ Import with `@tstamp` encoded breath and caesura works as long as as correspondi
 Import of fermata, breath and caesura with `glyph.num` is also supported.
 
 Relevant tests:
-* {% include test file="fermata-01" %}
-* {% include test file="breath-01" %}
+{% include test file="fermata-01" %}
+{% include test file="breath-01" %}
 
 Known limitations:
 * The vertical position of a breath and caesura is different (lower) after import.

docs/features/grace-notes.md

@@ -12,5 +12,5 @@ Grace notes are encoded as `graceGrp` with the appropriate `@attach` and `@grace
 For wider compatibility, MEI import also supports grace notes encoded without being wrapped within a `graceGrp`. One limitation of this approach is that ending grace notes are not supported. The grace notes will always be attached to the following `chord` or `note`, or ignored if appearing at the end of a measure.
 
 Relevant tests:
-* {% include test file="gracenote-01" %}
-* {% include test file="gracenote-02" %}
+{% include test file="gracenote-01" %}
+{% include test file="gracenote-02" %}

docs/features/key-signatures.md

@@ -10,4 +10,4 @@ parent: "Features"
 Key signature changes work as time signature. That is, there are encoded in a `scoreDef` when the same for all staves or in `staffDef` when not.
 
 Relevant tests:
-* {% include test file="key-signature-01" %}
+{% include test file="key-signature-01" %}

docs/features/measures.md

@@ -16,8 +16,8 @@ MuseScore also has the option of adding a number to the measure count. The value
 For end barlines with a repetition, the number of sounding repetitions given in MuseScore is encoded as `@type="mscore-repeat-n` where `n` is the value of the repeat parameter in MuseScore.
 
 Relevant tests:
-* {% include test file="measure-01" %}
-* {% include test file="measure-02" %}
+{% include test file="measure-01" %}
+{% include test file="measure-02" %}
 
 Known limitations: 
 * The MuseScore barline type `Reverse final` does not exist in MEI, it is exported as double `dbl` barline.

docs/features/notes-and-rests.md

@@ -16,10 +16,10 @@ Stemless notes are encoded with `@stem.len="0"`. (This could eventually be chang
 Cross-staff notation is encoded with `@staff` and the appropriate staff number value. It is supported for `chord`, `note` and `rest`. The staff displacement is constrained to one staff above or below since it seems there is not reason to allow for more than that.
 
 Relevant tests:
-* {% include test file="accid-01" %}
-* {% include test file="accid-02" %}
-* {% include test file="stem-01" %}
-* {% include test file="cross-staff-01" %}
+{% include test file="accid-01" %}
+{% include test file="accid-02" %}
+{% include test file="stem-01" %}
+{% include test file="cross-staff-01" %}
 
 Known limitations:
 * Enclosing accidentals are not supported (not available in MEI-Basic).

docs/features/other-features.md

@@ -10,19 +10,19 @@ parent: "Features"
 ### Ottava lines
 
 Relevant tests:
-* {% include test file="octava-01" %}
+{% include test file="octava-01" %}
 
 ### Hairpins
 
 Relevant tests:
-* {% include test file="hairpin-01" %}
+{% include test file="hairpin-01" %}
 
 ### Lyrics
 
 Relevant tests:
-* {% include test file="lyric-01" %}
-* {% include test file="lyric-02" %}
-* {% include test file="lyric-03" %}
+{% include test file="lyric-01" %}
+{% include test file="lyric-02" %}
+{% include test file="lyric-03" %}
 
 Known limitations:
 * Any SMuFL character within a lyric is considered to be an elision character
@@ -31,25 +31,25 @@ Known limitations:
 ### Figure bass
 
 Relevant tests:
-* {% include test file="fig-bass-01" %}
+{% include test file="fig-bass-01" %}
 
 ### Note articulation (stacc.)
 
 Relevant tests:
-* {% include test file="artic-01" %}
+{% include test file="artic-01" %}
 
 ### Ornaments such as mordents and turns
 
 Relevant tests:
-* {% include test file="ornam-01" %}
-* {% include test file="mordent-01" %}
+{% include test file="ornam-01" %}
+{% include test file="mordent-01" %}
 
 ### Arpeggios
 
 Relevant tests:
-* {% include test file="arpeg-01" %}
+{% include test file="arpeg-01" %}
 
 ### Piano pedal marks
 
 Relevant tests:
-* {% include test file="pedal-01" %}
+{% include test file="pedal-01" %}

docs/features/slurs-and-ties.md

@@ -12,9 +12,9 @@ Slurs are encoded with `slur`, and ties with `tie`, both using `@startid` and `@
 The placement of the slurs or ties is encoded with `@curvedir`, and the style with `@lform`.
 
 Relevant tests:
-* {% include test file="slur-01" %}
-* {% include test file="slur-02" %}
-* {% include test file="tie-01" %}
+{% include test file="slur-01" %}
+{% include test file="slur-02" %}
+{% include test file="tie-01" %}
 
 Known limitations:
 * The is no distinction in the export between dashed and wide-dashed slur and both are exported with `@lform="dashed"`.

docs/features/tempo-markings.md

@@ -14,7 +14,7 @@ The text of the tempo indication is encoded as text withing the `tempo` element.
 The tempo value is encoded as `@midi.bpm`. And additional `@type="mscore-infer-from-text"` is added for indication for which MuseScore is expected to infer the tempo value from the text.
 
 Relevant tests:
-* {% include test file="tempo-01" %}
+{% include test file="tempo-01" %}
 
 Known limitations:
 * Spanning tempo indications (e.g., ritardando) are currently not supported.

docs/features/time-signatures.md

@@ -10,5 +10,5 @@ parent: "Features"
 Time signature changes occurring at all staves are encoded in a `scoreDef` change. When the time signature change is not the same on all staves, or is occurring only on some staves, a `scoreDef` with appropriate `staffDef` descendants is generated.
 
 Relevant tests:
-* {% include test file="time-signature-01" %}
-* {% include test file="time-signature-02" %}
+{% include test file="time-signature-01" %}
+{% include test file="time-signature-02" %}

docs/features/tuplets-and-beaming.md

@@ -20,12 +20,12 @@ Beam modes in MuseScore (e.g., forcing the start of a new beam, or joining beams
 * 32nd sub beam as `note|rest|chord@type="mscore-beam-begin32"`
 
 Relevant tests:
-* {% include test file="beam-01" %}
-* {% include test file="beam-02" %}
-* {% include test file="beam-03" %}
-* {% include test file="tuplet-01" %}
-* {% include test file="tuplet-02" %}
-* {% include test file="tuplet-03" %}
+{% include test file="beam-01" %}
+{% include test file="beam-02" %}
+{% include test file="beam-03" %}
+{% include test file="tuplet-01" %}
+{% include test file="tuplet-02" %}
+{% include test file="tuplet-03" %}
 
 Known limitations:
 * Nested tuplets (tuplet within tuplet) are not supported.

docs/structure/general-strcuture.md

@@ -14,8 +14,8 @@ Since there is not direct mapping of  part structure from MuseScore within the M
 Bracket supported are `bracket`, `brace`, `bracketsq` and `line`.
 
 Relevant tests:
-* {% include test file="score-01" %}
-* {% include test file="score-02" %}
+{% include test file="score-01" %}
+{% include test file="score-02" %}
 
 Known limitations:
 * Bar line spanning in MuseScore is defined on a staff level. In MEI, this is defined through `[email protected]`. The current implementation, the value for `@bar.thru` is determined by the spanning of the first staff, and only for the first level of nesting `staffGrp`. 

docs/structure/layout.md

@@ -14,4 +14,4 @@ When writing, all page and line (system) breaks are encoded into the MEI. The on
 When reading the MEI, only `pb` and `sb` with `@type="mscore-manual` are set as page and line breaks and all the others are ignored.
 
 Relevant tests:
-* {% include test file="breaks-01" %}
+{% include test file="breaks-01" %}

docs/structure/title.md

@@ -27,8 +27,8 @@ The `pgHead` is organized in `<rend>` elements (up to 9) representing positions
 Text element on multiple lines is supported will be encoded as mixed content and `lb`.
 
 Relevant tests:
-* {% include test file="page-head-01" %}
-* {% include test file="page-head-02" %}
+{% include test file="page-head-01" %}
+{% include test file="page-head-02" %}
 
 Known limitations:
 * Text formatting (i.e., italic, bold, etc.) within a text element is currently not preserved.

docs/structure/transposition.md

@@ -12,4 +12,4 @@ Status ✅
 Transposing information is encoded in `[email protected]` and `[email protected]`
 
 Relevant tests:
-* {% include test file="transpose-01" %}
+{% include test file="transpose-01" %}