This plugin allows Sibelius to export to the Music Encoding Initiative (MEI) format.
The latest release of the plugin can be found on the GitHub releases page: https://github.com/music-encoding/sibmei/releases
To install this plugin, copy or symlink the .plg files in the Sibelius Plugin directory on your machine. The specific location depends on your OS and version of Sibelius.
If you're only interested in running the plugin in Sibelius, this is all you need to do.
For working on Sibmei, you need to have git and node installed. Then, on the command line, run:
git clone [email protected]:music-encoding/sibmei.git
cd sibmei
npm installYou need to create a symbolic link from the Sibelius plugin folder to the build folder in the sibmei directory. The paths are system dependent.
Example for Mac:
ln -s "~/path/to/sibmei/build/develop" "~/Library/Application Support/Avid/Sibelius 7.5/Plugins/MEI Export"Example for Windows (run as administrator):
mklink /D "%APPDATA%\Avid\Sibelius\Plugins\MEI Export" "%HOMEPATH%\path\to\sibmei\build\develop"To start the compiler, run:
npm run developThis will build the plugin and and watch your source files for changes, re-building the plugin as you edit and save.
To make your changes to the Manuscript code active, you will need to "unload" and "reload" the plugin in Sibelius. (File => Plug-ins => Edit Plug-ins, then Select the Sibmei plugin, then click Unload, then click Reload).
There are two kinds of tests in two subfolders of the test folder that are run in two steps:
The unit tests in the test/sib-test folder are primarily used to test specific Sibmei functions. They use the sib-test plugin, developed by Tido. You should download and install this plugin first. After unloading and reloading Sibmei, (as described above), tests can be run by starting the "Sibmei Test Runner" from the menu/ribbon, or using a keyboard shortcut of your choice that can be assigned in File => Preferences => Keyboard Shortcuts (in "Tab or category" choose Plug-ins, then in "Feature" choose the Sibmei Test Runner and assign a shortcut).
The test/node has tests written in JavaScript. Node's built-in test runner is used to test Sibmei's output from a set of test files. After exporting the test file set with sibmei (the Sibmei Test Runner will automatically do that), either run npm test from the root directory of this git repository or have the Test Runner automatically trigger the tests. The latter requires a test.bat or test.sh file in the same directory as the Sibmei *.plg files, depending on the operating system. Create a file that looks like this:
x:
cd x:\path\to\sibmei
cmd /k npm testHelp for testing and documenting for Mac welcome!
The easiest and recommended way of writing test is to create a Sibelius test file with embedded XPath expressions that test if the file is exported to the expected MEI structures. These XPath expressions must be written using the text style "XPath test". For an example, see test/sibmeiTestSibs/extensions.sib. Any XPath expression that does not evaluate to a truthy result will make a test fail.
When creating a new test file, copy an XPath test text from an existing test file to the new test file and modify the XPath. XPath expressions are evaluated in the context of the <measure> the XPath is attached to.
(:
Clef is encoded in voices 1 and 2 of staff 1. Clef in layer 1 is the "main" clef,
clef in layer 2 has a @sameas attribute for pointing to the main clef.
:)
staff[@n=1][layer[@n=1]/clef][layer[@n=2]/clef[@sameas]]Especially if XPath expressions are not entirely self-explanatory, a leading comment is recommended. This comment will also be used in the assertion message should the test fail. Otherwise the XPath expression that did not evaluate to a truthy result will be used as message.
For project specific handling of text and symbols, extension plugins can be written.