Skip to content

Commit 8930e60

Browse files
authored
Merge pull request #330 from finale-lua/script-names
Add docs on script names
2 parents 1e8e20b + 3e82a64 commit 8930e60

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/getting-started/script-checklist.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ All scripts must have at least some minimal details in their [PluginDef](http://
1515

1616
Of course, the more complete the PluginDef, the better. This info is also used to generate the script's documentation, and it's what's shown to users when the download the script.
1717

18+
### Naming scripts
19+
20+
A script's name as returned by plugindef() should be in title case. [Windows and macOS use title case for their menu items](https://github.com/finale-lua/lua-scripts/issues/313), so we should be consistent with that. If you aren't familiar with Title case, here's a relevant description from [this Grammarly blog post](https://www.grammarly.com/blog/capitalization-rules/):
21+
22+
> 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.
23+
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.
25+
1826
## 2. Use a consistent file name
1927

2028
Let's follow a unified syntax for the file name. Use snake case:

0 commit comments

Comments
 (0)