Re: My quick rundown of how to use OpenLilyLib's Edition Engraver

[Ben]

On 1/29/2018 3:36 PM, Stefano Troncaro wrote:

Hello again everyone!

In a recent thread I was asked to write a little bit depicting how I would have liked to learn about using the Edition Engraver. I share it here so that others can give their insights. Hopefully we can make a "quick start guide" kind of thing to help future users.

I'll say it ended up being longer than I anticipated. I formatted it a little to improve readability. Here it goes:

My quick rundown of how to use OpenLilyLib's Edition Engraver
(OR I wish I could have read this instead of having to learn by poking example code with a stick)


What is it?

In a nutshell, the Edition Engraver provides a convenient way of storing a tweaks, overrides and other objects that can later be applied to some musical content.


Why use it?

To keep the "musical source" of a project free from tweaks, temporary overrides, and tagged material that needs to be filtered later. This serves to generate code that is clean, reusable and has clarity of purpose, meaning it's fast to read and understand.


How is it used?

In summary, by following this four logical steps:

1. Load the Edition Engraver into the project.
2. Create an edition (a container to store the edits)
3. Fill the edition with content.
4. Consist the contents of the edition to the musical contexts to which they apply.

Each step explained  [ ............ ]


Hopefully this will be enough to get anyone started. There is more functionality than this, as far as I know the only way to get a look into it is by examining the `usage-examples` folder in the Edition Engraver repository.

I'll be waiting for your input!

Stéfano

Stéfano,

Wow, thank you SO much for doing this! Great guide to get people up and running with EE!