Skip to content

Commit 28dac45

Browse files
PatrickMassotrolandlo
authored andcommitted
docs: Mention different versions of the lua api
1 parent 810ef91 commit 28dac45

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/guide/plugins/plugins.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,8 +97,12 @@ such errors to Lua errors by wrapping with [`assert`](https://www.lua.org/manual
9797
Any Lua Plugin can execute a number of Xournal++ functions to interact with Xournal++.Those are defined in the Plugin API as seen in the
9898
[definition file](https://github.com/xournalpp/xournalpp/blob/master/plugins/luapi_application.def.lua). That file shows the list of all Xournal++ functions, its function parameters, return values and example usage. Moreover it can be used with the [Lua language server](https://luals.github.io/) to get code completion, hover tooltips, jump-to-definition, find-references, and more. For writing plugins using
9999
one of the many [code editors](https://microsoft.github.io/language-server-protocol/implementors/tools/) that support the Lua language server is advisable. If you need
100-
more information how these Xournal++ functions are defined, see the file
101-
[luapi_application.h](https://github.com/xournalpp/xournalpp/blob/master/src/core/plugin/luapi_application.h).
100+
more information how these Xournal++ functions are defined, see the
101+
`luapi_application.h` file which is relevant to your version of xournalpp:
102+
103+
* [1.1.x series](https://github.com/xournalpp/xournalpp/blob/release-1.1/src/plugin/luapi_application.h)
104+
* [1.2.x series](https://github.com/xournalpp/xournalpp/blob/release-1.2/src/core/plugin/luapi_application.h)
105+
* [nightly builds](https://github.com/xournalpp/xournalpp/blob/master/src/core/plugin/luapi_application.h)
102106

103107
### Using plugins to define shortcuts for ui actions
104108

0 commit comments

Comments
 (0)