User Tools
jwlua:finaleplugin_properties
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
jwlua:finaleplugin_properties [2013/09/03 14:12] jariw created |
jwlua:finaleplugin_properties [2013/11/21 14:17] (current) jariw |
||
|---|---|---|---|
| Line 68: | Line 68: | ||
| The release date (in any text format). Example: <code lua>finaleplugin.Date = "July 28, 2013"</code> | The release date (in any text format). Example: <code lua>finaleplugin.Date = "July 28, 2013"</code> | ||
| - | === Notes (string) === | + | === Notes (multiline string) === |
| Longer description of the plug-in and user instructions. The string can contain multiple lines. Example: <code lua>finaleplugin.Notes = [[ | Longer description of the plug-in and user instructions. The string can contain multiple lines. Example: <code lua>finaleplugin.Notes = [[ | ||
| Line 75: | Line 75: | ||
| ]]</code> | ]]</code> | ||
| - | === RevisionNotes === | + | === RevisionNotes (multiline string) === |
| Revision history text that might be of interest to an end user. The string can contain multiple lines. Example: <code lua>finaleplugin.RevisionNotes = [[ | Revision history text that might be of interest to an end user. The string can contain multiple lines. Example: <code lua>finaleplugin.RevisionNotes = [[ | ||
| Line 97: | Line 97: | ||
| <code lua>finaleplugin.Id = "742d0ea0-c109-4b81-87ae-d059f27cb028"</code> | <code lua>finaleplugin.Id = "742d0ea0-c109-4b81-87ae-d059f27cb028"</code> | ||
| + | === ParameterTypes (multiline string) === | ||
| + | |||
| + | The types to the script parameters. The syntax is similar to the ''SetTypes()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. Use one line for each parameter. Don't use quotation marks around the types. The number of types must be identical to the number of descriptions. | ||
| + | |||
| + | Valid types are ''Number'', ''String'', ''Boolean'' and ''NumberedList''. Example: | ||
| + | <code lua>finaleplugin.ParameterTypes = [[ | ||
| + | Number | ||
| + | Boolean | ||
| + | ]]</code> | ||
| + | |||
| + | === ParameterDescriptions (multiline string) === | ||
| + | |||
| + | The syntax is similar to the ''SetDescriptions()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. Use one line for each parameter. Don't put quotation marks around the descriptions. The number of descriptions must be identical to the number of types. Example: | ||
| + | <code lua>finaleplugin.ParameterDecriptions = [[ | ||
| + | Resize (in percent) | ||
| + | Resize relative | ||
| + | ]]</code> | ||
| + | |||
| + | === ParameterLists (multiline string) === | ||
| + | |||
| + | The syntax is similar to the ''SetLists()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. These settings are optional for script parameters. Use one line for each parameter, but __don't__ put ''{}'' around the list. If a list isn't required for a parameter, set it to ''nil''. If a comma is needed within a list item, quotation marks can be used around that list item. Example: | ||
| + | <code lua>finaleplugin.ParameterLists = [[ | ||
| + | nil | ||
| + | Yes, No | ||
| + | ]]</code> | ||
| + | |||
| + | === ParameterInitValues (multiline string) === | ||
| + | |||
| + | The syntax is similar to the ''SetInitValues()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. These settings are optional for script parameters. Use one line for each parameter. If a user value isn't required for a parameter, set it to ''nil''. Example: | ||
| + | <code lua>finaleplugin.ParameterInitValues = [[ | ||
| + | nil | ||
| + | true | ||
| + | ]]</code> | ||
jwlua/finaleplugin_properties.1378217546.txt.gz ยท Last modified: 2013/09/03 14:12 by jariw
Page Tools
