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.