xournalpp / xournalpp.github.io

Xournal++ website
https://xournalpp.github.io/
Other
54 stars 36 forks source link

Updated plugins.md #61

Closed DielN closed 2 years ago

DielN commented 2 years ago

Added info on new plugin functions:

I also corrected app.changeBackgroundPdfPageNr function name (was app.changePdfBackgroundPageNr) and reordered the function list to match the order in luapi_application.h. The broken/outdated links to the plugin API have been updated, too. Unified plugin descriptions to end with no comma/dot. I'm considering unifying the wording of the description, e.g. some begin with for and/or use the -ing form, and some simply use the simple present (sets, scrolls), which is also what I used for the plugin descriptions.

Still looking over the rest of the plugins page, so this is WIP. Feedback is welcome.

DielN commented 2 years ago

I just noticed the getToolInfo function has only recently been pushed to master and is not yet available in the latest release.

Should it be removed for now? Also, should we link to master for the luapi_application.h or to the most recent release branch (1.1 in this case)? The other plugin API link would also have to be updated to not include getToolInfo.

Technius commented 2 years ago

Thanks for helping out!

Also, should we link to master for the luapi_application.h or to the most recent release branch

Most recent release is preferred, but new plugin API functions should link to a pinned nightly/master commit.

Should it be removed for now?

It can be added, but it needs to be accompanied by a note saying that it's only available in the nightly builds.

DielN commented 2 years ago

I'm pretty much done with updating things. I am thinking about adding a more detailed description for getToolInfo like getDocumentStructure has and maybe for changeCurrentPageBackground to explain the possible config values, not sure about that. Would that fit into the same pull request or should I create another one for that?

Apart from that, I'd say the page is ready for review. I hope the changed wording of the descriptions is fine, any feedback is appreciated.

A summary of what I updated:

rolandlo commented 2 years ago

Can you please squash your commits into one?

rolandlo commented 2 years ago

Merging in 24 hours if no objections are raised.

rolandlo commented 2 years ago

Thanks again!