There are Lua scripts, embedded scripts and there are Plugins, all are said to be able to automate NoteCase Pro.
What's the difference? What should I use or develop? What's suited for what purpose?
- Lua script:
A stand-alone ".lua" file, basically a text file containing Lua instructions, can be registered in NoteCase Pro and called via "Scripts" menu, as well as assigned to a keyboard shortcut.
Suitable for less complex automation purposes, basically one action only.
Registration in NoteCase Pro via the "Scripts" menu. Manual installation and configuration.
Pros and Cons:
+ Easy and quick solution
- only one script per file
- Not very end-user-friendly, so suitable mainly for your own automation purposes, not for distribution - Embedded script:
A Lua script can also be included in a NoteCase Pro document and executed from there. This is called "embedded". Embedding a script allows to tie a script to a certain data document. Or this method can be used to build script collections, i.e. combine several related scripts in one document.
Registration in NoteCase Pro via the "Scripts" menu. Manual installation and configuration
Pros and Cons:
+ Easy and quick solution
+ Possibility to bundle several or a lot of different scripts / actions in one file
- Not very end-user-friendly, so suitable mainly for your own automation purposes, not for distribution - A Plugin
is basically an embedded script document, i.e. a collection of an arbitrary number of different scripts, but it follows specific rules for its internal structure, so that NoteCase Pro is able to make immediate use of the contents. Furthermore, it is easily installable, updateable and removable using the Plugin Manager. Plugins, when they are installed, automatically build their own sub menus inside the "Plugins" menu, so each Plugin action can be started using an own menu entry conveniently by the user.
Plugins may be "locked", i.e. encrypted, so that the user won't be able to see the source code. This is important for preserving copyrights on algorithms used inside the Plugin, and for commercial distribution.
Pros and Cons:
+ Very end-user-friendy solutiuon
+ Possibility to bundle several or a lot of different scripts / actions in one file
- More efforts needed than developing a simple script or embedded script file