Block or shortcode to render MusicXML in the browser as sheet music using OSMD.

OSMD

Justin Litten

<p>This plugin provides two blocks for MusicXML usages:</p>
<ol>
<li>The ‘OSMD Sheet Music’ block brings <a href="https://github.com/opensheetmusicdisplay/opensheetmusicdisplay" rel="nofollow ugc">OpenSheetMusicDisplay</a> seamlessly to your WordPress site!<br />
This will allow you to render responsive MusicXML live in your visitors’ browser.</li>
</ol>
<p>It enables uploading of .xml, .musicxml and .mxl files to your WordPress Media Library, which can then be selected in the block for rendering.</p>
<p>(We have also added a shortcode in this plugin for those who do not use the Gutenberg editor.)</p>
<ol>
<li>Additionally, as of 1.3.0 we have added another block: ‘OSMD QR Code’. This block allows you to deeplink your musicXML directly into our PracticeBird app via QR code, mobile icon, or both!</li>
</ol>
<h3>OSMD Sheet Music Block Options</h3>
<p>The block has a number of options in the sidebar (Inspector Controls) described here.</p>
<h3>Rendering</h3>
<p>The section immediately below the block heading contains two controls related to re-rendering the sheet music.</p>
<h4>Automatically Rerender on Change</h4>
<p><em>Toggle, Default: Off</em><br />
When this is on, any change to the lower settings (except for ‘Container Aspect Ratio’) will trigger a re-render of the sheet music in the editor.</p>
<p>This is not recommended for larger pieces of sheet music, as rendering can take time.<br />
It is best to do ‘batch’ updates with the settings and use the ‘Rerender’ button to manually preview the changes.</p>
<h4>Rerender</h4>
<p><em>Button</em><br />
This button is used to trigger a manual rerender of the sheet music in the currently selected OSMD block.<br />
This is particularly useful for updating the settings of larger pieces of sheet music that take longer to render.</p>
<h3>Basic Options</h3>
<p>This section contains basic options for the block: the musicXML file to render as well as some display options.</p>
<h4>Select Media</h4>
<p><em>Button/File Select, Default: None Selected</em><br />
This control shows the currently selected score above it (if there is one).<br />
The button ‘Select Media’ opens your WordPress Media Library in a modal window, which allows you to select previously uploaded MusicXML, or to upload one to select for rendering in the block.</p>
<p><strong>NOTE:</strong> Selecting a new file will always trigger a render of the new file, no matter if “Automatically Rerender on Change” is selected or not.</p>
<h4>Width (%)</h4>
<p><em>Number Input, Default: 100</em><br />
This control translates directly to the CSS width of the sheet music.<br />
What this means is that it controls the percentage of the <em>parent container</em> that the sheet music will take up.<br />
e.g.<br />
– If you have the OSMD block in a post set to 100%, it will fill the entire width of the post<br />
– If you have the OSMD block in a column layout of a post set to 100%, it will fill the entire width of that column</p>
<h4>Container Aspect Ratio</h4>
<p><em>Dropdown/Number Input, Default: Auto (No Scrollbar)</em><br />
This dropdown sets the aspect ratio of the sheet music container – The height in relation to the width.<br />
What this does pratically is add a scrollbar, which is useful with very long pieces that you don’t want to extend all the way down the page.<br />
– Auto (No Scrollbar) will render the full sheet music as-is, taking up as much room as needed.<br />
– Landscape makes the height 0.667x the width. Or, put another way, the width will be 1.5x the height (3:2)<br />
– Portrait sets the height to 1.778x the width. Width being 0.5625x the height (9:16)<br />
– Custom allows you to set your own value of what the width will be divided by to get the height.</p>
<p><strong>NOTE:</strong> This control does not trigger or require a re-render since it is merely a CSS property of the sheet music container. It will be reflected immediately.</p>
<h4>Zoom (%)</h4>
<p><em>Number Input, Default: 100</em><br />
This input allows you to control the zoom level of the rendered sheet music.</p>
<h3>Drawing Options</h3>
<p>These are additional OSMD drawing options – Whether to render certain parts of the sheet music.</p>
<h4>Draw Title</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the sheet music title.</p>
<p><strong>NOTE:</strong> Draw Subtitle must be off for this to be reflected in the sheet music (currently).</p>
<h4>Draw Subtitle</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the sheet music subtitle.</p>
<h4>Draw Composer</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the sheet music composer.</p>
<p><strong>NOTE:</strong> There seem to be some rendering issues in OSMD with this option if ‘Draw Lyricist’ is not off as well. We are working on this.</p>
<h4>Draw Lyricist</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the sheet music Lyricist.</p>
<h4>Draw Metronome Marks</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the tempo markings.</p>
<h4>Draw Part Names</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the part names before each stave.</p>
<h4>Draw Part Abbreviations</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render the part abbreviations on subsequent music systems.</p>
<h4>Draw Measure Numbers</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render measure numbers</p>
<h4>Draw Measure Numbers Only at System Start</h4>
<p><em>Toggle, Default: Off</em><br />
Whether to render measure numbers just at the start of new music systems.</p>
<h4>Draw Time Signatures</h4>
<p><em>Toggle, Default: On</em><br />
Whether to render time signatures on the staves</p>
<h4>New Systems From XML</h4>
<p><em>Toggle, Default: Off</em><br />
This determines whether system breaks specified in the MusicXML will be honored.</p>
<h3>OpenSheetMusicDisplay Shortcode Options</h3>
<p>The shortcode has the same options as above, though as attributes written in camelCase.</p>
<p>In the shortcode any Toggle attribute values are specified with true or false.<br />
Numeric values can be specified as float or integers.</p>
<p>To specify the musicXML you need to provide a URL; This can be copied from your Media center in WordPress when viewing the details of a file.</p>
<p>The shortcode is “opensheetmusicdisplay”. Example given with full set of attributes:<br />
    <code>[opensheetmusicdisplay musicXmlUrl="http://url.com/wp-content/uploads/sites/2/2021/02/Beethoven_AnDieFerneGeliebte.xml" zoom="0.75" width="75"<br />
    drawTitle="false" drawSubtitle="false" drawComposer="true" drawLyricist="true" drawMetronomeMarks="false" drawPartNames="false" drawPartAbbreviations="false"<br />
    drawMeasureNumbers="true" drawMeasureNumbersOnlyAtSystemStart="true" drawTimeSignatures="true"]</code></p>
<p>It’s important to note that zoom is out of 1: so 1 = 100%, 0.75 = 75%, 2 = 200%, etc.</p>
<h3>OSMD QR Code Block Options</h3>
<p>This block also has a number of options in the sidebar (Inspector Controls) described here (as well as via info menus available in the sidebar).</p>
<h3>Basic Options</h3>
<p>This section contains basic options for the block: the musicXML file to deep link as well as how to render the deeplink.</p>
<h4>Select Media</h4>
<p><em>Button/File Select, Default: None Selected</em><br />
This control shows the currently selected score above it (if there is one).<br />
The button ‘Select Media’ opens your WordPress Media Library in a modal window, which allows you to select previously uploaded MusicXML, or to upload one for deep linking.</p>
<h4>Render Behavior</h4>
<p><em>Radio Button, Default: Responsive – QR and Icon</em><br />
These are full descriptions of what each option does:<br />
Responsive – QR and Icon: Both a QR code and icon for mobile devices will be generated. Which one is displayed will depend on the device screen size: greater than 991px for QR code, less than 992px for linked icon.<br />
QR Code Only: Only a QR code will be generated and displayed regardless of device size or type.<br />
Icon Only: Only a icon w/ a link will be generated and displayed regardless of device size or type.<br />
Smart Detect – QR or Icon: The device will attempt to be detected. If iOS or Android is detected, a mobile icon will be generated. For all other platforms, a QR code will be generated.</p>
<h3>QR Code Options</h3>
<h4>Scale</h4>
<p><em>Slider, Default: 1</em><br />
This is the scale of the QR code and changes it’s rendered size. (the Default scale of 1 is 256px x 256px)</p>
<h4>Icon Options</h4>
<h3>Auto-redirect to App Store</h3>
<p><em>Toggle Button, Default: On</em><br />
On: If the mobile deep-link icon is displayed and the deep-link fails on click, an attempt will be made to detect the mobile platform and redirect to the proper PracticeBird app store link (Android or iOS).<br />
Off: No attempt to redirect will be made, and if the deeplink fails, it will fail silently with the page not reacting.</p>
<p>Additionally, the icon can be resized via the block editor when it is rendered. If you select “Icon Only” while rendering, you will see resize toggles available on the corners of the icon.</p>
<h3>OSMD QR Code Shortcode Options</h3>
<p>The shortcode has the same options as above, though in some cases are named differently.</p>
<ul>
<li>the musicXML url is defined by the ‘target’ attribute.</li>
<li>The icon size is defined (in px) by the ‘iconSize’ attribute.</li>
<li>The QR scale is defined by the ‘qrScale’ attribute.</li>
<li>the ‘generateBehavior’ attribute is a string with the following possible values, which correspond to the values mentioned above:
<ul>
<li>QR_AND_MOBILE</li>
<li>QR_ONLY</li>
<li>MOBILE_ONLY</li>
<li>DETECT</li>
</ul>
</li>
</ul>
<p>In the shortcode any toggle or Toggle attribute values are specified with true or false.<br />
Numeric values can be specified as float or integers.</p>
<p>To specify the musicXML you need to provide a URL; This can be copied from your Media center in WordPress when viewing the details of a file.</p>
<p>The shortcode is “pb-deep-link”. Example given with full set of attributes:<br />
    <code>[pb-deep-link target="https://staging.opensheetmusicdisplay.org/wp-content/uploads/sites/2/2021/09/thescale.musicxml" generateBehavior="QR_AND_MOBILE" iconSize="50", qrScale="1.5", autoRedirectAppStore="false"]</code></p>
<h3>About Us</h3>
<p>We have developed the open-source <a href="https://opensheetmusicdisplay.org/" rel="nofollow ugc">OpenSheetMusicDisplay</a>: A library for rendering MusicXML in the browser using Vexflow.<br />
We created this plugin to make it as easy as possible for WordPress users to use our library to render sheet music on their site.<br />
We hope you find this plugin useful, and if so, please consider sponsoring us or donating at our link above.<br />
Thank you!</p>


Alternatives to OpenSheetMusicDisplay

Top alternatives