Skip to content

Commit c703a4e

Browse files
chore: autopublish 2025-03-04T00:05:24Z
1 parent c260106 commit c703a4e

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

docs/getting-started/script-checklist.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A script's name as returned by plugindef() should be in title case. [Windows and
2121

2222
> The capitalization rules for titles of books, movies, and other works vary a little between style guides. In general, you should capitalize the first word, all nouns, all verbs (even short ones, like is), all adjectives, and all proper nouns. That means you should lowercase articles, conjunctions, and prepositions—however, some style guides say to capitalize conjunctions and prepositions that are longer than five letters.
2323
24-
Additionally, if you're creating a [script group](../rgp-lua/finaleplugin-properties#group-scripts), the start of each menu item should be the same. Menu bar items are sorted alphabetically. So that way when a user tries to find the different menu items in their menu bar, they are listed together.
24+
Additionally, if you're creating a [script group](../rgp-lua/finaleplugin-properties.md#group-scripts), the start of each menu item should be the same. Menu bar items are sorted alphabetically. So that way when a user tries to find the different menu items in their menu bar, they are listed together.
2525

2626
## 2. Use a consistent file name
2727

docs/rgp-lua/finaleplugin-properties.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,11 @@ The security restrictions are:
6868
- Scripts with this value set to true must be explicitly configured in the [configuration dialog](/docs/rgp-lua/rgp-lua-configuration). They are not included as part of an Auto Folder.
6969
- The script must have the `Allow Startup` checkbox enabled in its configuration.
7070
- The script file must not have been modified since it was configured. If you modify it, RGP Lua reports an error, and you must reopen the configuration for that script and accept it again by hitting OK. You can disable this check if you select `Enable Debug`, but this is extremely ill-advised unless you are actively debugging the script. Remember that these scripts run invisibly every time you start up Finale.
71-
- Trusted status is _not_ required.
71+
- Trusted status is *not* required.
7272

73-
You can check if a script is running at startup with `finenv.QueryInitializationInProgress()`. Only the primary script runs at startup. If the script specifies `AdditionalMenuOptions`, the additional options are added to Finale's plugin menu, but they do not run at startup.
73+
You can check if a script is running at startup with `finenv.QueryInitializationInProgress()`. Only the primary script runs at startup. If the script specifies `AdditionalMenuOptions`, the additional options are added to Finale's plugin menu, but they do not run at startup.
7474

75-
You can set `IncludeInPluginMenu` to `false` to suppress the script from Finale's plugin menu. In this case the script _only_ runs at startup.
75+
You can set `IncludeInPluginMenu` to `false` to suppress the script from Finale's plugin menu. In this case the script *only* runs at startup.
7676

7777
Example:
7878

@@ -146,7 +146,7 @@ Default is `false`.
146146

147147
Both _JW Lua_ and _RGP Lua_ (by default) automatically run scripts within an undo block named according the undo string returned by the `plugindef()` function. However, it is possible for a script to notify _RGP Lua_ that it will handle undo blocks on its own by setting this value to `true`. This tells _RGP Lua_ to cancel the automatic undo block when the main script exits.
148148

149-
One primary reason a script might enable this option when creating a modeless dialog window.
149+
One primary reason a script might enable this option when creating a modeless dialog window.
150150

151151
Example:
152152

@@ -186,7 +186,7 @@ Default is `false`.
186186

187187
If this value is `false`, _RGP Lua_ does not include the script in Finale's plugin menu. A typical case where your might do this is in combination with `ExecuteAtStartup` set to `true`. This would allow your script to run at startup but not be accessible for the user to run from the menu.
188188

189-
This value applies only to the primary menu option. Any additional menu items specified with `AdditionalMenuOptions` _are_ included in Finale's plugin menu.
189+
This value applies only to the primary menu option. Any additional menu items specified with `AdditionalMenuOptions` *are* included in Finale's plugin menu.
190190

191191
Example:
192192

@@ -473,7 +473,7 @@ Additional Menu Options
473473

474474
Frequently you may wish to have shortcuts to functions that differ from each other by only one or a few variables. For example, you might wish to have a script that transposes a selected music region up an octave. If you then wanted another script to transpose a region _down_ an octave, you might duplicate the up-octave script and change a single value in it. You could instead reuse the first script by defining the interval value in a variable. This would allow for separate configurations of the script in the [configuration dialog](/docs/rgp-lua/rgp-lua-configuration), but it still would require end-users to set up the configurations for themselves. And they would have to be somewhat knowledgable of Lua syntax to do it.
475475

476-
_RGP Lua_ version 0.62 introduces the concept of **Additional Menu Options**. These allow a script to configure multiple versions of itself to appear in Finale's Plug-ins menu. The setup of Additional Menu Options is similar to the setup of the deprecated [Parameters](#parameters-deprecated) fields in _JW Lua_. Each of the necessary fields (menu option text, undo text, description, and prefix) appear in parallel lists delimited by line breaks. Each list is a multiline string value in the `finaleplugin` namespace.
476+
_RGP Lua_ version 0.62 introduces the concept of **Additional Menu Options**. These allow a script to configure multiple versions of itself to appear in Finale's Plug-ins menu. The setup of Additional Menu Options is similar to the setup of the deprecated [Parameters](parameters-deprecated) fields in _JW Lua_. Each of the necessary fields (menu option text, undo text, description, and prefix) appear in parallel lists delimited by line breaks. Each list is a multiline string value in the `finaleplugin` namespace.
477477

478478
_JW Lua_ does not support Additional Menu Options. It loads only the base menu option of the script, even if Additional Menu Options are supplied.
479479

docs/rgp-lua/rgp-lua-configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Add/Edit Dialog
6363

6464
**Optional Description.** Specifies the description to be used with this instance of the selected script file. If omitted, _RGP Lua_ uses the description returned by the `plugindef()` function in the script. This option is not available for Auto Folders.
6565

66-
**Prefix.** This is a multi-line code window that allows you to enter a brief snippet of Lua code. If a prefix exists, _RGP Lua_ executes it in the Lua environment before executing the script file. One use case for it would be to initialize some global variables that the script uses as input parameters. Another might be to require a library for a script or an Auto Folder. Each script inherits any global values set by the prefix. This prefix executes immediately _after_ the [System Prefix](#system-prefix-dialog), if any.
66+
**Prefix.** This is a multi-line code window that allows you to enter a brief snippet of Lua code. If a prefix exists, _RGP Lua_ executes it in the Lua environment before executing the script file. One use case for it would be to initialize some global variables that the script uses as input parameters. Another might be to require a library for a script or an Auto Folder. Each script inherits any global values set by the prefix. This prefix executes immediately *after* the [System Prefix](system-prefix-dialog), if any.
6767

6868
Note that you can select the same script file more than once and use the prefix and optional menu text, undo text, and description fields to tailor it to a specific use case.
6969

src/lib/lib/script-data.json

+1-1
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)