• Folder
  … all files of Ekmelily: LilyPond include files, short demos of the notation styles, old versions, et al
• Zip Archive
  … with the LilyPond include files et al
• Esmuflily
  … an extensions for LilyPond to use other music symbols from Ekmelos / SMuFL – clefs, time signatures, noteheads, rests, flags, articulations, dynamics, playing techniques, etc.

The folder ly contains all available include files (*.ily).

• Copy the include file(s) for the desired tuning(s) as well as the main include file ekmel-main.ily into an appropriate folder, e.g. "LILYPOND/usr/share/lilypond/current/ly", with LILYPOND meaning the installation folder of LilyPond.
• Install the Ekmelos Font if it shall be used for the accidental symbols in Ekmelily; see Fonts.

Add the following lines near the top of your LilyPond input file. They are all optional – except for the include file of the desired tuning – but should be specified in this order.

ekmelicFont = FONTNAME
\include "ekmel*.ily"
\language "LANGUAGE"
\ekmelicStyle STYLENAME
\ekmelicUserStyle MYNAME #'((ALTERATION ACC-ELEMENT …) …)

Ekmelily supports different tunings available by separate include files. Each provides its own set of languages and predefined notation styles. The first LANGUAGE and STYLENAME specified in the following table is the default in the respective tuning.

Note: Ekmelily versions prior to 3.0 support only 72-EDO.

\language "LANGUAGE"

This selects the note names in LANGUAGE, provided that it is available for the respective tuning. Else, the default language is selected (which is usually "deutsch"). Ekmelily defines its own sets of note names based on the names for semi- and quarter-tones given in LilyPond. See the Tables for note names.

Enharmonically equivalent Note names

Some notation styles support two distinct, enharmonically equivalent accidentals; e.g. the arrow, rhm, and sims notations for the one-quarter-tone and three-quarters-tone. Therefore, Ekmelily defines two note names each, e.g. cqs and csaqf ("english") or cih and ciseh ("deutsch"). However, LilyPond does not support different accidentals for the same alteration. As a provisional solution, the combined note names (e.g. csaqf or ciseh) have slightly differing alterations and are therefore not suitable for MIDI output.

Predefined Notation Styles

\ekmelicStyle STYLENAME

This sets the predefined notation style STYLENAME. The default notation depends on the tuning or it is specified with the command line option3

-dekmelic-style=STYLENAME

The following table shows all predefined notation styles. N indicates the default style in tuning N.
See the Tables with alterations or the Ekmelos Documentation for details (code points etc.) on the accidentals.

User-defined Notation Styles

\ekmelicUserStyle MYNAME #'((ALTERATION ACC-ELEMENT …) …)

This creates a user-defined notation style derived from the current style – possibly set by a previous \ekmelicStyle command – with the name MYNAME. If MYNAME is an empty string (""), the name of the current style extended with the suffix -user is taken.

ALTERATION must be a rational number. For each specified ALTERATION, a new accidental is defined which is the concatenation of the ACC-ELEMENTs. For all other alterations where the previous accidental of ALTERATION appears likewise (usually in combination with further symbols), this accidental is also replaced by the new one.

ACC-ELEMENT must be either a code point as an integer number (e.g. #xE262), or a character literal (e.g. #\b), or a string of any length (e.g. "bb"). Two or more ACC-ELEMENTs are juxtaposed with a padding of 0.12 staff units, but no extra space is inserted between the characters of a string. Note that in a SMuFL10 compliant font, accidental symbols have a zero side-bearing. This also applies to the Basic Latin (ASCII) characters in the Ekmelos Font.

Ekmelily requires a font for the accidental symbols as an extension to LilyPond's own Emmentaler font. When using a predefined notation style, this font must be compliant with SMuFL.10

By default, the Ekmelos Font is used. Another font (e.g. Bravura) can be selected, either in the LilyPond input file before the include file with the variable

ekmelicFont = FONTNAME

or with the command line option3

-dekmelic-font=FONTNAME

\ekmelicOutputSuffix

Set the name of the current notation style as the output filename suffix for the current \book section.

\ekmelic-style-name

Draw the name of the current notation style as markup.

\ekmelic-char #ALTERATION

Draw an accidental according to the current notation style as markup. ALTERATION must be a rational number.

\ekmelic-fraction #ALTERATION

Draw ALTERATION as a fraction arranged vertically (not just a string num/denom) or as an integer if its denominator is 1, with a separate minus sign for a negative value. ALTERATION must be a rational number.

ekmelicFont = "Bravura"
\include "ekmel.ily"
\language "english"
\ekmelicStyle sims

This sets the predefined Sims notation for 72-EDO, selects the English note names, and draws the accidentals with the Bravura font.

\include "ekmel-24.ily"
\ekmelicStyle stz
\ekmelicUserStyle myNotation #'(
  (-3/4 #xE327)
  (1 #xE262 #xE262))

This sets the predefined Stein / Zimmermann notation (stz) for quarter-tones (24-EDO) and modifies it into a user-defined notation with the Sagittal flat 11 medium diesis down symbol  (U+E327) for three-quarter-tones flat, amd a concatenation of two sharp symbols  (U+E262) for double-sharp.

\include "ekmel-24.ily"
\ekmelicStyle stz
\ekmelicUserStyle myNotation #`(
  (,THREE-Q-FLAT #xE327)
  (,DOUBLE-SHARP #xE262 #xE262))

This is the same example but it makes use of the corresponding Scheme symbols.

\include "ekmel.ily"
\language "english"
\ekmelicUserStyle hewm #'(
  (1 #\x)
  (-1 "bb")
  (1/2 #\#)
  (-1/2 #\b)
  (1/4 #\^)
  (-1/4 #\v)
  (1/6 #\>)
  (-1/6 #\<)
  (1/12 #\+)
  (-1/12 #\-))

This sets the HEWM (Helmholtz / Ellis / Wolf / Monzo) notation for 72-EDO and selects the English note names.

\include "ekmel-24.ily"
\language "nederlands"
\ekmelicStyle stz
\ekmelicUserStyle stockhausen #'(
  (3/4 #xED5A)
  (-3/4 #xED59 #xE260)
  (1/4 #xED58)
  (-1/4 #xED59))

This sets the notation after Karlheinz Stockhausen for 24-EDO with the fractional sharp symbols  (U+ED58) and  (U+ED5A), and the quarter-tone flat symbol  (U+ED59), and selects the Dutch note names.

Further examples of user-defined styles can be found in the file styles/user-styles.ly.

• Version 3.7 (2021-05-17): New languages are available in ekmel-36.ily and ekmel.ily ("norsk", "suomi", "svenska"). In ekmel-24.ily, some quarter-tone names of "suomi" are corrected.
• Version 3.6 (2021-05-15): The note names are revised according to LilyPond 2.22. New languages are available in ekmel-24.ily ("catalan", "norsk", "suomi", "svenska", "vlaams"), in ekmel-36.ily ("nederlands"), and in ekmel.ily ("nederlands"). Native language names ("català", "español", "português") or their alias names can be used.
• Version 3.5 (2021-04-01): ekmel-24.ily: The Hába notation for quarter-tones uses the SMuFL glyphs (U+EE64-U+EE69) and the default notation is stc instead of go.
• Version 3.4 (2020-12-26): The Hába notation for quarter-tones (24-EDO) and for 1/3-, 1/6-, and 1/12-tones (36 and 72-EDO) is added.
• Version 3.3 (2020-08-16): Definitions to adjust the size of accidentals on grace notes are removed (obsolete since 3.2).
• Version 3.2 (2020-08-14): The output of accidentals is newly implemented (stencil instead of simple text) and the hair-space character (U+200A) is not used any more for padding in composite accidentals. The natural sign for restore and key cancellation now depends on the notation style (not always U+E261).
• Version 3.1 (2020-06-07): Key signatures are now supported. The file ekmel-24.ily defines an alteration order for key signatures including quarter tones. A new file ekmel-arabic.ily is available for Arabic scores (24-EDO) including maqamat (taken from arabic.ly).
• Version 3.0 (2019-01-08): A completely revised version that now supports different tunings (12, 19, 24, 31, 36, 48, 72-EDO) by separate include files. Arabic and Persian notation are added for 24-EDO.

See the file CHANGELOG.txt for older versions.

Copyright © 2013-2021 Thomas Richter

Ekmelily is licensed under the GNU General Public License, version 3 or later.
See the file LICENSE.txt. This license is also available at www.gnu.org/licenses.