Looking for a tutorial on how to write a plugin

[joearms]

Can anybody recommend a tutorial on how to write a plugin?

Failing a tutorial can anybody point me to the simplest possible

plugin(s) that I can study?

Possible several examples - with and without javascript etc.

Nothing fancy - I just want to see the essentials and the structure

Thanks

/Joe

[Jeremy Ruston]

Hi Joe

Some resources that might be helpful:

* https://tiddlywiki.com/#Plugins contains a brief explanation of what a plugin actually is, and how it works

* https://tiddlywiki.com/dev/#Developing%20plugins%20using%20Node.js%20and%20GitHub explains how to create plugins under Node.js

* https://tiddlywiki.com/dev/#How%20to%20create%20plugins%20in%20the%20browser is a brief guide to creating plugins in the browser

* https://github.com/Jermolene/TiddlyWiki5/tree/master/plugins/tiddlywiki is a list of the official core plugins. Good simple examples include “blog”, “comments” and “help"

Best wishes

Jeremy

--
You received this message because you are subscribed to the Google Groups "TiddlyWikiDev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywikide...@googlegroups.com.
To post to this group, send email to tiddly...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywikidev.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywikidev/c6790be4-d19c-4808-a258-5a624ce52af5%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Matthew Lauber]

I'd add to this list:  Tinka a plugin packer that can pack things from within Tiddlywiki https://tinkaplugin.github.io/

[Matthew Lauber]

I've got a few simple plugins that are a pretty good example of what you can do with JS.

* <$calc> widget:  https://github.com/mklauber/tiddly-calc It's a total of 3 files, one of which is a cop/pasted library. You can check calc.js to see how to handle creating a custom widget.

* [shuffle[]] filter: https://github.com/mklauber/tiddly-shuffle shuffle.js.tid shows how to create a custom filter operator.  

[@TiddlyTweeter]

Joe

Very useful is the Tinka plugin maker. It is very well thought through and gives much useful support to do them.

https://tinkaplugin.github.io/

Josiah

[joearms]

Thank you very much.

This is exactly what I was looking for I shall study these closely.

/Joe

[TonyM]

Joe,

As TiddlyTweeter mentioned, The Tinka plugin is quite helpful making plugins. 

Something to keep in mind;

Plugins are a package that once installed needs you to save and reload, they can be disabled and present shadow tiddlers that can be overwritten, you can delete these overwritten tiddlers and revert to the plugin version, all quite nice. But a point I would like to make is you can package any tiddlers in a plugin and they do not need to include java script, they could just provide macros, data tiddlers, or simple tiddlers.

There is a separate set of issues about creating plugins that include javascript and or javascript libraries. This requires more technical information.

Regards

Tony