List Plug-ins

Version 01.51.00
Added 29 Aug 2005 (last updated 23 Aug 2024)

For use with Sibelius 4, Sibelius 4.1, Sibelius 5, Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plug-in writes a list of plugin names and numbers, sorted by name, to the trace window. If you have a lot of plug-ins, it makes it easier to find the plugin you want to assign a shortcut to, since the list on the Menus and Shortcuts page of File > Preferences is sorted by plug-in number.

Updated 17January2015. Added option to show full plugin path name for any loaded plugins so you can see if you will currently run a shipping or user version of a plugin. Sort by name is probably the useful option.

Updated 8 March 2019. Version 01.30,00. Sped up listing. Added ability to see all plugins, shipping plugins only, or user-installed plugins only.

Updated 20 March 2019. Version 01.40.00. Fixed plugin numbers when only shipping or only user plugins are listed.

Updated 15 May 2020. Version 01.51.00. Tidied up a bit, added option to not display plugin numbers, which are rarely useful.

Updated 22 August 2024. Version 01.52.00. Added an option to List plugin names only, with no path or subfolder name.

Plug-in written by Bob Zawalich.

Convert Spaces To Units

Version 01.08.00
Added 06 Nov 2009 (last updated 13 Jul 2023)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Convert Spaces To Units will convert fixed units like inches, mm, or points to or from "spaces" based units as used internally by Sibelius. (One "space" is defined as 1/4 of the staff height). __This plugin will probably only have niche uses, but if you are using wildcards that use space units, or are writing plugins, or are just trying to figure out how many x units in the General tab of the Properties window will make an inch, it can come in very handy. __This plugin requires Sibelius 6.1 __Updated 8 September 2010 to correct invalid conversion of points. __Updated 14 August 2016 to prepare for multiple staff sizes. __Updated 13 July 2023. Version 01.08.00. Fixed the scaled staff size to reflect the current staff units, and restructured some code so it can be called by other plugins.

Plug-in written by Bob Zawalich.

Backup Plug-in for Developers

Version 01.40.00
Added 09 Jun 2010 (last updated 27 Feb 2016)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plug-in allows plug-in authors to create multiple backup snapshots throughout the plug-in development process. Snapshots are useful to have when recent code changes impair/break your plug-in, and you can't or don't wish to spend time fixing the newly introduced errors.

Thanks to Bob Zawalich for use of some code, concepts and variable names from his Export Each Staff as Audio plug-in.

Thanks to Roman Molino Dunn for Mac testing and suggestions on how to make the plug-in more user-friendly.

Updated 20 June 2010.

The .zip file now also includes a copy of Restore Plugin for Developers, by Bob Zawalich, which can restore plugins which have been backed up by Backup Plug-in for Developers.

A number of bugs in Backup Plug-in for Developers have been fixed:

* Fixed bug whereas Comment was not being checked for illegal characters.

* Comment allowable characters are now platform specific and less restrictive.

* Added new Options button and dialog to allow user to select preferred date format, time format and delimiter character (space or tilde).

* Made dialog box wider to allow more path text to be shown.

* Made this Plug-in compatible with the Restore Plug-In.

* Fixed bug whereas after 1st session plug in path was not properly retrieved for some users.

* Added a validation to ensure "File backup location" ends with a legal path separator. If missing, it is automatically added.

* Fixed a bug whereas the "Filename for backup field" was not initially displaying the correct information.

Updated 8 August 2011 for Sib 7 user file location compatibility

Updated 26 February 2016 to speed up file copying.

Plug-in written by Ed Hirschman / Bob Zawalich.

Format ManuScript Comment For Developers

Version 01.01.00
Added 03 Aug 2010 (last updated 21 Feb 2020)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plug-in transforms free-form text into a nicely formatted comment box that can be pasted into other plug-ins. The plug-in handles comments of any length, and can be used for initial explanations that typically appear at the top of the "Run" method or for comments in other methods. The comment box width is user selectable, as are the horizontal and vertical borders characters. There are also several "signature line" type options available.

Any text pasted into the plug-in's input text box is truncated by Sibelius at the first encountered line break. As such, ensure there are no line breaks or carriage returns in your free-form text and then select an alternative line-break character such as the tilde (~) from the drop down menu, then type the selected line break character into your text to achieve multiple paragraphs. The formatted output is provided in the Trace window and can be pasted into your plug-in.

Updated 4 August 2010 with the following changes:

  • Added choice of left and right side border character
  • Right and/or Left borders can now be "None"
  • Right and/or Left borders can now be "//". Using // for the Left border ensures that line numbers are more accurate if syntax errors in your plug-in and that the cursor will jump to the correct error location.
  • Changed default left border to "//"
  • If options line is too wide, error message now suggests a minimum width
  • Added 110 and 120 as width choices

Plug-in written by Ed Hirschman.

Copy Plugin

Version 01.55.00
Added 02 Jan 2012 (last updated 28 Oct 2019)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Make a clone copy of an existing plugin, with a new file name and a new menu name, in the same folder as the original plugin. This can be useful when making a variant plugin, or for creating multiple plugins that save data associated with the menu name.

It will remember the name of the last plugin you copied across Sibelius sessions, so you can set up your favorite template to reuse.

Updated 3 January 2011 to correct typos.

Updated 24 January 2012 to add default plugin names for easier cloning.

Updated 31 January 2012 to fix crashes on OSX in version 7.1.

Updated 26 February 2016 to greatly speed up file copy.

Updated 13 April 2016.By default it will increment plugin names that end in a number for default names. Also, it will allow you to create multiple copies in a single session. Now requires Sibelius 6 or later.

Updated 26 April 2016 to clarify error message that appears when the menu name is not defined using the _PluginMenuName variable.

Updated 20 October 2019. Version 01.52.00. Added ability to put copied plugin into any existing plugin subfolder. For shipping plugins a user subfolder can be created if it does not already exist.

Updated 23 October 2019. Version 01.54.00. Added ability to create new plugin subfolders that are not existing categories.

Updated 27 October 2019. Version 01.55.00.Plugin file was being created without a plg extension. Fixed.

Plug-in written by Bob Zawalich.

Minimum Plugin

Version 01.11.00
Added 02 Jan 2012 (last updated 14 Nov 2020)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

A public-domain plugin that provides a basic framework for a plugin that processes objects in a score.

This plugin may be used as a template, and may be adapted, modified and distributed without attribution (and you use it at your own risk!)

Updated 3 January 2011 to correct typos.

Updated 11 February 2012 to update comments - no code changes.

Updated 12 May 2018 to tweak some text.

Updated 6 November 2020. Version 01.08.00. More cleanup. Added IsValidObject routine.

Updated 10 November 2020. Version 01.10.00.

Cleanup and internal documentation changes to support a document on using this plugin.

Updated 13 November 2020. Version 01.11.00.Added code to handle DoNotDisplayDialog.

Plug-in written by Bob Zawalich.

Restore Edited Shipping Files

Version 01.15.00
Added 05 Jan 2012 (last updated 06 Aug 2015)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Lists user copies of shipping plugins, house styles, and manuscript papers and offers to delete them or move them to a folder outside of the user subfolder.

This can be useful if you edit shipping plugins to see how they work, especially after a Sibelius update, when you cannot remember which ones you have edited, and want to enable the most recent versions.

Updated 3 August 2015. Renamed from Restore Shipping Edited Plugins to Restore Shipping Edited Files. Added tracking for edited House Style and Manuscript papers as well as plugins.

Updated 6 August 2015. Fixes Mac hanging bug.

Plug-in written by Bob Zawalich.

Pitch Values

Version 01.07.00
Added 12 Apr 2012 (last updated 29 Jan 2020)

For use with Sibelius 5, Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plugin displays the all possible MIDI values for note names, or all possible names for MIDI pitches, including double accidentals or quartertones. This can be helpful when writing plugins. It is pretty geeky.

Updated 5 September 2017. Added ability to trace pitches by accidental type, including triple accidentals, which can be produced only by plugins, convertors or other processes, but which sometimes appear. Now you can see all the possible sharp,or flat, or double/triple accidentals in one place. Still pretty geeky.

Updated 29 September 2017 Fixes to triple accidental display.

Updated 4 January 2018. Added accidental value for traces, chiefly for use with quartertones.

Updated 29 January 2020. Version 01.07.00. Reworked most of the code to fix problems with Cb and B# and their variants. Added triple accidentals to some listings and added a new option to trace note values in all pitches in a specific octave.

Plug-in written by Bob Zawalich.

Offtonic Note Info

Version 0.1
Added 26 Jul 2012 (last updated 07 Mar 2014)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Note Info simply displays basic information about a specific note in a computer-readable format. I wrote it as a tool to help me understand how Sibelius internally represents notes, but I can imagine others wanting the same thing. Note that Sibelius's representation of a Note object is as an object inside a NoteRest object, so Note Info does not display duration or velocity, for example.

Plug-in written by Mauro Braunstein.

Edit Text File

Version 01.80.00
Added 28 Sep 2012 (last updated 22 Aug 2019)

For use with Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

For Sibelius 7.1.3 and later only.

Launches an application that will edit a text file. You specify both the application and the text file, and these files will be remembered over Sibelius sessions.

This could be be useful for plugins that create log files and text files, or even html files, and would like to display them from within Sibelius.

For plugin developers, please note that the mechanism to launching apps is rather different in Windows and OSX.

This plugin is dedicated to Mary Elizabeth, for her invaluable testing assistance.

Updated 13Feb2015 to fix a typ0 and add entry points for calling from other plugins

Updated 22 August 2019. Version 01.80.00. Corrected some bugs when called from other plugins.

Plug-in written by Bob Zawalich.

Align Notes

Version 01.09.00
Added 23 Dec 2014 (last updated 17 Jun 2015)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plugin aligns notes in selected bars by removing any rests that follow the last (right-align) or precede the first (left-align) chord, or tuplet in the bar.

It does not delete any rests; it shifts the note data and adds rests to the front or back of the bar. The size of the bar does not change.

Entire bars are always processed; if any part of a bar is selected, the entire bar is processed. All voices in selected bars will be processed.

The plugin can be run by a user, or other plugins can call RightAlign(score, bar) or LeftAlign(score, bar) to accomplish note alignment.

Plug-in written by Bob Zawalich.

Plugin Info

Version 01.13.00
Added 30 Jan 2015 (last updated 03 Mar 2024)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plugin displays a list of all the plugins currently installed on your machine. Selecting a plugin in the list will display its full file pathname, Category (on the current machine), User or shipping plugin status, Version if available, Plugin number, and Date Installed. The dialog will also display the number of plugin installed on the current machine.

The can be useful for seeing if you are running a modified version of a shipping plugin, or to compare the version number with the one on the download page, so as to see if you have the most recent version of a plugin.

Updated 24 November 2015 to add a trace button.

Updated 8 February 2016 to add Locate All Copies to find copies of shipping plugins in all languages.

Updated 18 October 2017. Added ability to list only user or shipping plugins, and ability to trace plugin info for all plugins in list, so you can get a list of all installed shipping plugins.

Updated 1 February 2018. Added Find box so it can find plugins bases on any bits of a word in the name. Also added plugin menu name to the data list so you don't need to look back and forth to the list box to see everything.

Updated 4 January 2019. Version 01.10.01. Disabled Locate All Copies for Mac because it was crashing.

Updated 18 February 2019. Version 01.10.01. Updated version number in plugin file to match download page.

Updated 3 March 2024. Version 01.13.00. Added a Find-Search edit and button for the plugin list.

Plug-in written by Bob Zawalich.

Custom Simple Plugin

Version 01.50.00
Added 13 Oct 2019 (last updated 13 Oct 2019)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This is a template plugin meant to be copied and modified by users. It is in the public domain, and the code can be reused or modified at your own risk without need of attribution. The first published version is 01.50.00.

It is a model for a plugin that processes selected objects.

The default code, which is intended to be replaced, will select any Line objects in the original selection.

This is minimal code, with no error checking or warning messages. Use it for quick and dirty plugins.

Plug-in written by Bob Zawalich.

Trace Fonts For Text Styles

Version 01.07.00
Added 20 Aug 2020 (last updated 06 Sep 2020)

For use with Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Original version 20 August 2020. Version 01.06.00. Writes, to the plugin Trace window, the initial font name and font size for a set of built-in text styles in the current score.

A plugin can call API_TraceTextStyleFonts(score, fTraceFonts), and will get back an array of the strings that would be traced, with blank lines and header lines removed. Setting fTraceFont False will keep the plugin from writing the data to the trace window.

This plugin is only possible because Daniel Spreadbury added some ManuScript calls at the very end of 7.1.2. They did not get into the build, and were forgotten until I recently checked to see if they were built into later versions, and they did get added into Sibelius 7.5 and later.

Thanks to Daniel and to the Sib developers who made the code changes go through.

Updated 5 September 2020. Version 01.07.00. Added the ability to trace user-defined Text Styles that are used in objects created in the current score, as well as built-in styles from a list.

Plug-in written by Bob Zawalich.

Minimum Plugin Preferences

Version 01.05.00
Added 29 Dec 2020 (last updated )

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Added 29 December 2020, though written in 2011. Original version 01.05.00.

This is a plugin template for use by plugin developers, containing code that can be used to make it easier to save plugin preferences to the Preferences database.

The PDF file "Preferences plugin to save plugin preferences.pdf" is included in the zip file as well, and is also available at bobzawalich.com.

This plugin is in the public domain, and is available to be used and modified freely with no need for attribution. It is for use at your own risk, and no support is available.

Plug-in written by Bob Zawalich.

Add Plugin Preferences Lib

Version 01.09.00
Added 30 Dec 2020 (last updated 01 Jan 2023)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Added 12/29/2000. Original version 01.07.00 __This is a library plugin designed to be called by other plugins in order to more easily add calls to the Preferences database to save and restore dialog settings across Sibelius sessions. __See Minimum Plugin Add Plug Pref for an example of this in use. There is also a PDF file available explaining its use. _Updated 1 January 2023 version 01.09.00. Updated to fix a failure in GetPreferences that was not updating its global variables.

Plug-in written by Bob Zawalich.

Minimum Plugin Add Plug Pref

Version 01.09.00
Added 30 Dec 2020 (last updated 01 Jan 2023)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Original version 01.07.00 __This is a template plugin used to show how to call into the plugin Add Plugin Preferences Lib to more easily save plugin dialog preferences to the Preferences database. __There is also a PDF file available explaining its use. __This plugin is in the public domain, and is available to be used and modified freely with no need for attribution. It is for use at your own risk, and no support is available. _Updated 1 January 2023 version 01.09.00. Updated to fix a failure in GetPreferences that was not updating its global variables.

Plug-in written by Bob Zawalich.

Execute Commands

Version 01.81.70
Added 25 Feb 2021 (last updated 12 Sep 2024)

For use with Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Original version 01.14.00 added 25 February 2021. __From lists of available commands- add commands to a Command List, then choose Execute to run them after the dialog comes down. __You can also Export or Import a list of commands. The exported files will be stored in a subfolder of your default Scores folder called Execute_Commands, and will have the extension .dat. These files can be shared with other users. __You can also generate a new plugin that contains the commands in the Command List using New Plugin. __These actions can be accomplished without directly writing any ManuScript plugin code. __Updated 26 February 2021.Version 01.15.00. Added routines to be called by other plugins: API_AddLineObjectSelection, API_AddSymbolObjectAtSelection, API_AddTextObjectAtSelection, to enable plugins to simulate what the Add Text, Lines and Symbols commands do without bringing up the dialog. __Updated 27 February 2021.Version 01.16.00. Added warning when executing command list if there is no selection in the active score. __Updated 28 February 2021.Version 01.16.01. Some internal code changes to make calling from other plugins easier. __Updated 3 March 2021.Version 01.16.03. More internal code changes to make calling from other plugins easier. __Updated 8 March 2021. Version 01.17.00. __Updated 9 March 2021.Version 01.17.02. Mostly internal fixes to recent changes. __Updated 15 March 2021.Version 01.18.00. Added button to execute the currently selected command only- in addition to being able to execute all the commands in the Command List. Made some improvements to the New Plugin dialog as well. __Changed the way that commands that run plugins work in generated plugins and Command Macro Files. They now use the plugin file name as a Command Id so they will work in any language. __If you use the plugin Run Command Macros- you should update it as well- so it will work with the output of this plugin. __Updated 15 March 2021.Version 01.18.02. Bug fix for New Plugin. __Updated 27 April 2021.Version 01.27.00. Major update. Cmdutils files support. New ability to Add Comments and Edit commands. Ability to execute current command only. Restructuring of generated plugins with New Plugin. __Updated 01 May 2021. Version 01.28.00. Fixed bug that caused Mac users to crash when using New Plugin Several bug fixes and features- including the ability to clear the Command List with a button press. You will need to update cmdutils as well to use its features. Updating Run Command Macro is suggested but not required. After installing or updating this plugin you must close and restart Sibelius before you can use it. __Updated 02 May 2021. Fixed bug when importing data files that include plugins. __Updated 7 May 2021. Even more tweaks. Please update cmdutils.plg as well. __Updated 11 June 2021. Version 01.51.00. Mostly support for new cmdutils features. Update cmdutils.plg and RunCommandMacros.plg as well. Close and restart Sibelius after installing and before using this plugin. __Updated 26 June 2021. Version 01.52.00. Added button to run the Run Command plugin directly. __Updated 29 June 2021. Version 01.53.00. Using the Run Command Macro button now takes down the Execute Command dialog before calling Run Command Macro. I was hoping to be able to leave the dialog up- but Sibelius Commands will not run under a dialog- so this was the only real option. __Updated 24 July 2021. Version 01.55.00. Improved handling of edited command strings with trailing spaces or line feeds. __Updated 25 July 2021. Version 01.56.00. Removed trailing space change due to possible bugs. __Updated 01 August 2021. Added new dialog button Add new command. __Updated 05 August 2021. Version 01.60.00. Significant structural changes to the ways tables of commands are built and used both here and in Run Command Macros. The tables are now built once per Sibelius session and reused for the rest of the session rather than rebuilding each time the plugin is run. __Updated 12 August 2021. Version 01.71.00. Improved performance for generated plugins. __Updated 25 August 2021. Version 01.72.00. Renaming for generated plugins to avoid duplicate names. __Updated 22 September 2021. Version 01.73.00. Some error handling enhancements. __Updated 14 November 2021. Version 01.74.00. Now will generate code to create plugins that call plugins whose file names contain spaces. __Updated 15 December 2021. Version 01.75.00. Made it possible to save commands to a macro dat file from another plugin. __Updated 19 March 2022. Version 01.77.00. Support for Text, Line, and Clef style commands, except for those with names that duplicate other commands. __Updated 9 September 2022. Version 01.78.00. Cleaned up API_GeneratePlugin code. __Updated 10 September 2022. Version 01.79.00. Added API call to get list of all command names. ___Updated 3 October 2022. Version 01.80.00. Internal restructuring and some new API calls to let other plugins access this code. You should always install or update all the plugins Execute Commands, cmdutils, and Run Command Macro whenever you install or update any of them. __Updated 12 October 2022. Version 01.80.10. More internal restructuring and anew API call to let other plugins access this code. __Updated 22 October 2022. Version 01.81.01. When generating a plugin, the text in the message box at completion is also written to the plugin trace window. __Updated 28 October 2022. Version 01.81.02. Changed message when generating a new plugin to show the full path of the file being created. __Updated 21 January 2023. Version 01.81.10. Reworked Find button to return a list of all matching commands at once. __Updated 6 August 2023. Version 01.81.20.Simplified file name handling in New Plugin dialog. __Updated 2 March 2024. Version 01.81.44. Mostly internal code changes to improve New Plugin functions. Please update cmdutils as well. __Updated 25 April 2024. Version 01.81.46. If cmdutils is installed, its version number is now shown in the title bar of the Execute Commands Dialog. ___Updated 12 September 2024. Version 01.81.70. Changes to dialog handling and support for new cmdutils routines. Update cmdutils and Evaluate Plugin Condition if this plugin is updated.

Plug-in written by Bob Zawalich.

Run Command Macro

Version 01.47.02
Added 25 Feb 2021 (last updated 21 Sep 2023)

For use with Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Original version 01.06.00 Added 25 February 2021. __Runs the selected command macro, from those exported in the Execute Commands plugin. __Type the shortcut -the first number in a list entry, or select the entry with the mouse, then click Run or type Enter. __Run macro if list box changes runs a macro if you click, arrow, or type in the list box. __The first list box entry is a placeholder to support the Run macro if list box changes option. You will need to select a different entry to run a macro. _Updated 27 February 2021.Version 01.07.00. Bug fix involving Run Macro if List Changes option. Also new option to warn in active score has no selection. __Updated 15 March 2021. Version 01.08.00. __Updated to work with the output of the updated Execute Commands plugin. This plugin now requires that Execute Commands is also installed for it to run. __Updated 27 April 2021. Version 01.10.00. Updated to work with updated Execute Commands. Also shortcuts changed to allow 0-9, a-z, and A-Z as single character shortcuts before reverting to multi-digit numbers. __Updated 01 May 2021. Version 01.20.00. Bug fixes plus added ability to trace commands in macro files. __Updated 07 May 2021. Version 01.22.00. Bug fixes plus added ability to delete Command Macro files. __Updated 11 June 2021. Version 01.23.00. Macros in subfolders or the Execute_Commands folder are new treated as independent sets of commands with their own set of indexes. Update Execute Commands and cmdutils as well. __Updated 25 June 2021. Version 01.24.00. WARNING __Due to hard-to-debug crashes using this plugin, I have reverted it to an earlier version, which removes the ability to delete command macro files, or to treat subfolders as separate macro sets. You may get a warning from Preferences the first time you run this version, but you should ignore the warning, but check that the dialog settings are what you want. __I will attempt to restore the features lost at some point. __Updated 29 June 2021. Version 01.25.00. Removed the option to run a macro when the list box changes. Now to run a macro you need to type a shortcut, or otherwise select a list box entry, and then type Enter. I am still trying to find why some crashes occur, and this feature is my current best guess. __Updated 7 July 2021. Version 01.26.00. Restored the ability to have each subfolder of the Execute_Commands folder be a separate macro group. The Run If List Box Changes and Delete Macro functions are permanently removed. The path for the Execute_Commands folder is now displayed in the dialog to make it easier to find when deleting macro files. __Updated 21 July 2021. Version 01.28.00. __Updated 28 July 2021. Version 01.29.00. Moved Cancel button in dialog to keep it with the Run button. __Updated 05 August 2021. Version 01.40.00. Major restructuring. Laid out dialog differently. Changed the code so that tables built when calling Execute Commands to run macros are built only once per Sibelius session. Also restructured code so an outside plugin can call the code that will run the last macro run by this plugin. New RerunCommandMacro plugins will be available. __Updated 18 August 2021. Version 01.41.00. Fixed failure to trace macro at index 0. __Updated 4 December 2021. Version 01.42.00. Minor dialog layout fix. __Updated 15 September 2022. Version 01.44.00. Fixed some calls into Execute Commands that had changed. __Updated 3 October 2022. Version 01.47.00. Changes made to reflect changes in Execute Commands, which this plugin calls. __You should always install or update all the plugins Execute Commands, cmdutils, and Run Command Macro whenever you install or update any of them. __Updated 8 October 2022. Version 01.47.01. Changed layout of dialog, mostly to make the list box taller. __Updated 21 September 2023. Version 01.47.02. Added line to help about RerunCommandMacro.

Plug-in written by Bob Zawalich.

Execute Command Ids To Names

Version 01.15.00
Added 25 Feb 2021 (last updated 04 Mar 2021)

For use with Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Original version 01.14.00 added 25 February 2021.

This list box contains the language-independent command ids for commands used by the Sibelius.Execute instruction. When a list entry is selected, the corresponding command name in the current language and its category will be listed.

Tracing will write a comma-separated line of text of the form command id, command name, category, suitable to saving in a text file and opening in a spreadsheet. Tracing a single command will also trace Sibelius.Execute() statements for the selected command.

The intention is to provide a quick mapping from a command id to its local name and category.

Updated 4 March 2021. Version 01.15.00. Added ability to change the order of fields when tracing, and to sort the list in the new order.

Plug-in written by Bob Zawalich.

Move High Low Cross Staff

Version 01.06.00
Added 27 Feb 2021 (last updated )

For use with Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Added 27 February 2021. Initial version 01.06.00

Move selected notes cross staff if possible, based on the checkbox options. Uses new Sibelius.Execute commands.

* Move to the staff above if the highest note in a note or chord has too many ledger lines above the staff.

* Move to the staff below if the lowest note has too make ledger lines below the staff.

* If both the high note and low note are in range, reset the note or chord to the original staff.

Plug-in written by Bob Zawalich.

cmdutils

Version 01.50.09
Added 27 Apr 2021 (last updated 04 Oct 2024)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Added 27 April 2021. Version 01.08.00 __This is a library of plugin routines designed to be called by other plugins. In particular, most of the routines can be executed directly from Execute Commands, or generated macros or generated plugins. __The routines are in the style of Commands - they act on the current selection in the current score, and extend what is possible to do in macros commanded to just using the available Commands and plugins. __Updated 07 May 2021. Version 01.11.00. Bug fixes. Special handling for screen redraw. __Updated 08 May 2021. Version 01.11.00. Remove debug tracing. __Updated 11 June 2021. Version 01.16.00. Major update. Many new commands. See associated documentation for details. __Updated 26 June 2021. Version 01.19.00. New commands for Apply Named Color, Export PDF and others. As before, close and restart Sibelius after updating and before running Execute Commands. __Updated 27 June 2021. Version 01.20.00. Fixed crashing bug in ToggleCase routine. __Updated 10 July 2021. Version 01.21.00. Added additional ExitIf commands. __Updated 22 July 2021. Version 01.23.00. Added AddBarsAtEnd FilterNoteDuration commands and RunPluginEntry_cu. __Updated 23 July 2021. Version 01.24.00. Support for select options in FilterNotesByDuration. __Updated 24 July 2021. Version 01.25.00.Some bug fixing in validation of command names. __Updated 25 July 2021. Version 01.26.00. Updated validation of cmdutils command string to handle trailing linefeeds. __Updated 28 July 2021. Version 01.28.00. Internal code restructuring and cleanup. __Updated 05 August 2021.Version 01.29.00.Internal changes to sync with changes in Execute Commands. __Updated 25 August 2021. Version 01.30.00. Added new commands ExtendSelection_ObjTo_Bar_cu ExtendSelection_ObjTo_Page_cu ExtendSelection_ObjTo_Staff_cu ExtendSelection_ObjTo_System_cu to simulate mouse clicks to select larger areas. __Updated 22 September 2021. Version 01.40.00. Added command SetUserInput_Heading_cu. __Updated 19 March 2022. Version 01.42.00. Added command Select_All_NonPassage_cu. __Updated 21 April 2022. Version 01.43.00. Fixed crashing bug in Add Interval_Full that crashed all Add Interval commands.Also marked it to be runnable from Sib 6.2 on. __Updated 29 April 2022. Version 01.44.00.Fixed crashes in SelectAll routines and removed some debug traces. __Updated 23 May 2022. Version 01.45.00. Made the code completely independent of Sibelius.Execute to allow it to be used in plugins in earlier Sibelius versions. __Updated 2 June 2022. Version 01.46.00. Added Copy_cu, Cut_cu, and Paste_cu for use when Sibelius.Execute is unavailable. __Updated 3 October 2022. Version 01.47.00. Added View Invisible commands for Sibelius 2022.0 or later. __You should always install or update all the plugins Execute Commands, cmdutils, and Run Command Macro whenever you install or update any of them. __You should always install or update all the plugins Execute Commands, cmdutils, and Run Command Macro whenever you install or update any of them. __Updated 23 October 2022. Version 01.48.00. Updated to provide better error handling for NewMacro/Plugin plugins use. __Updated 10 November 2022. Version 01.48.10. Added new commands ExtendSelection_Visible_Down_cu, ExtendSelection_Visible_Up_cu, ExtendSelection_Visible_XHidden_Down_cu, ExtendSelection_Visible_XHidden_Up_cu __Added Updated 28 November 2022. Version 01.48.20. ContactSelection_Visible_Up/Down commands to skip over hidden staves when contracting. __Added Updated 11 January 2023. Version 01.48.30. Corrected typo in one of the Cmdutils Selection command names __Updated 26 June 2023. Version 01.48.33. Added new commands ExportPDF_DateTime_cu(), and ExportPDF_DateTime_cu(), which export a score as PDF and append the current date and time to the filename. __Updated 14 September 2023. Version 01.48.34. Added new commands RunPluginShowDialog_cu(), and reenabled the ViewInvisiblecommands __Updated 24 September 2023. Version 01.49.10. ____ Added a new View category for commands ____ Added these new commands for use in Execute Commands ____ RunPluginShowDialog_cu (strPluginMenuName) ____ HideAllInvisibles_Toggle_cu() ____ HideAllInvisibles_Hide_cu() ____ HideAllInvisibles_Show_cu() ____ HideAllInvisibles_Store_Current_Setting_cu() ____HideAllInvisibles_Restore_Setting_cu() ____ HideAllInvisibles_Current_cu() ____HideAllInvisibles_Full(score, selection, valAction, fTrace) ___ PanoramaOff_cu() ____ PanoramaOn_cu() __Updated 23 January 2024. Version 01.49.30. Fixed bug in ExtendSelection_ObjTo_System_cu. Added Routines RunPluginEntry1Param_cu, AddSelect_Line_Plain_cu __Updated 2 March 2024. Version 01.49.60. Some internal restructuring. Improvements to Mute-Unmute. AddText now includes styleid in its parameter list. __Updated 26 March 2024. Version 01.49.91. New commands for manipulating Score Info fields for use with wildcards: GetDataForWildcard_cu, SetDataForWildcard_cu __Updated 25 April 2024. Version 01.49.94. Added Select_None_cu command to clear the selection. __Updated 12 September 2024. Version 01.50.08. New IfCondition commands. __Updated 4 October 2024. Version 01.50.09. Fixed potential minor bug and removed some debug traces.

Plug-in written by Bob Zawalich.

Rerun Command Macro

Version 01.40.00
Added 06 Aug 2021 (last updated 06 Aug 2021)

For use with Sibelius 7.1, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Original version 01.40.00 added 05 August 2021.Run the last macro that had been run by the plugin Run Command Macro.

Plug-in written by Bob Zawalich.

Convert Folder Of Macros To Plugins

Version 01 51.00
Added 25 Aug 2021 (last updated )

For use with Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Added 25 August 2021. Version 01.51.00.

Generates plugins from all the macro files in the selected category, exporting to the corresponding plugins subfolder.

Plug-in written by Bob Zawalich.

Minimum Plugin Parent

Version 01.07.20
Added 06 Sep 2021 (last updated 25 Mar 2024)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Added 6 September 2021. Version 01.07.00. This zip file contains both MinimumPluginParent.plg and MinimumPluginChild.plg.

The Parent-Child plugin model creates a main, full-featured Parent plugin, and any number of smaller-featured, dialog-free, Child plugins, which call the parent to perform a subset of its features.

In the Parent plugin, the dialog variables and other globals are isolated from the main processing routine. Any data required by the proceesing routine (called in this template API_ProcessSelection), are passed in a specially formatted Dictionary object. Any child plugin can similarly set up an appropriately formatted dictionary with the desired dialog settings made, and run API_ProcessSelection without needing to bring up a dialog.

The 2 plugins presented here are templates which are intended to be copied, perhaps with the Copy Plugin plugin, and modified appropriately. The code in these plugins is in the public domain and may be modified and used freely with no need to permission or attribution. They will be used at your own risk.

Each of these plugins has a routine called AA_How_To_Modify_This_Plugin, and there is a document called Parent-Child Plugins on Bob Zawalich's website that discusses the plugins in more detail.

The command RunPluginEntryPoint_cu, available in Execute Commands, can serve as a universal child plugin for calling any properly set up parent plugin

__Updated 25 March 2024. Version 01.07.20. Removed obsolete code in New Plugin... code in validating outside callers. No change for normal use of plugin.

Plug-in written by Bob Zawalich.

Edit Formatted Text

Version 01.07.10
Added 22 Oct 2021 (last updated 17 Oct 2023)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Version 01.06.00. This plugin displays the formatted text string for the first selected Text or System Text object. It does not process Lyrics. If the text is very long it will be split into multiple edit boxes, which will be joined together before being used to update the selected text object. ----You can make changes to the text, and update the Text object with the updated text, but this plugin will not validate the changes you make. Use it carefully and at your own risk. You might use it on a copy of the text you want to change. ----A PDF file explaining how to use the plugin is included in the zip file. ----Updated 18 February 2022. Version 01.07.00. Added Help dialog with copyable wildcards. ----Updated 17 October 2023. Version 01.07.10. Added display of unformatted text field.

Plug-in written by Bob Zawalich.

Trace Instrument Changes

Version 01.07.00
Added 13 Jul 2022 (last updated 05 Oct 2022)

For use with Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Traces data for any selected Instrument Changes.Fields are: ____bar number,position as beat,staff number-staff ____name,textLabel,styleId,Full Instrument Name,Short ___Instrument Name,Default Instrument Name. ____Added 12 July 2022. Version 01.06.00. ____Updated 5 October 2022. Version 01.07.00. ____For Sib Ultimate 2022.9 or later, the plugin now also traces Full and Short Staff Names, and the Instrument Names will reflect any editing of names following an Instrument Change. Previously the plugin could only access Default Instrument Names from the Instrument Type associated with the Instrument Change.

Plug-in written by Bob Zawalich.

Custom Search Shortcut

Version 01.13.20
Added 07 Oct 2022 (last updated 23 Jan 2024)

For use with Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

This plugin lets you choose a command and convert it into a plugin that will run the command.This allows you you to choose a short Menu Name as a shortcut that you can use in Command Search. The Menu Name of a plugin is that name that appears on menus and is used as the search text for a plugin in Command Search. __Save Search Shortcut will be disabled at startup until you choose an entry in the listbox, either by clicking in the listbox or using Find. __Choose a command from the listbox, then add a short, unique, command search shortcut. This will become the text you use to find that command in Command Search. Punctuation and special symbols (%&*@!for example) can make an effective shortcut. __Updated 12 October 2022. Version 01.12.00. Added ability to insert RunPluginEntry_cu command line directly into the Execute Commands Command List. __Updated 23 October 2022. Version 01.13.00. Updated to provide better error handling for NewMacro/Plugin plugins use. __Updated 6 August 2023. Version 01.13.10. Fix for Find failure and some other internal fixes __Updated 23 January 2024. Version 01.13.20.o Fixed bugs in generated files names when used in New macro/plugin.

Plug-in written by Bob Zawalich.

Minimum Plugin Parent RPE_Enabled

Version 01.10.30
Added 14 Oct 2022 (last updated 03 Mar 2024)

For use with Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Added 14 October 2022. Version 01.07.00 __This is a freely modifiable plugin you can install and copy for a template for building a Parent plugin that can be called by the cmdutils routine RunPluginEntry_cu. __Some instructions for its use are in the code. See also the documents in bobzawalich.com under Writing your own plugins and Parent-Child plugins. __Updated 02 March 2024. Version 01.10.30. Updated to support New Plugin button. Needs updated Execute Commands, cmdutils, and New Plugin Lib.

Plug-in written by Bob Zawalich.

Backup Plugin Preferences

Version 01.06.00
Added 08 Jan 2024 (last updated 11 Jan 2024)

For use with Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

__Locates the file SibeliusPluginPreferences.dat, used by plugins to store settings across Sibelius sessions, on you machine. __It will make a copy and save the copy with the extension

New Plugin Lib

Version 01.20.51
Added 02 Mar 2024 (last updated 04 Mar 2024)

For use with Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Initial release 2 March 2024. Version 01.02.50.Replaces Custom Search Shortcut as the code library for plugins that can generate new plugins.

Updated 4 March 2024. Removed unintended debug trace message.

Plug-in written by Bob Zawalich.

Evaluate Plugin Condition

Version 01.50.08
Added 13 Sep 2024 (last updated 13 Sep 2024)

For use with Sibelius 18.x, Sibelius 19.x, Sibelius 20.x, Sibelius 21.x, Sibelius 22.x, Sibelius 23.x and Sibelius 24.x

Added 12 September 2024. Version 01.50.08.

Provides conditions used in cmdutils IfCondition commands

Will only be used when using the IfCondition commands in cmdutils

Can be run directly by a human to see which conditions are available and test on various selections.

Requires cmdutils to be installed.

Plug-in written by Bob Zawalich.

Categories