Plugin Overriding Core Tiddler

67 views
Skip to first unread message

Kevin Kleinfelter

unread,
Apr 7, 2018, 11:59:07 AM4/7/18
to TiddlyWiki
When I see a plugin which says it contains a shadow tiddler from $:/core/modules/, I presume it is overriding a core tiddler.  Is that right?  

When the developer is developing that plugin, is he editing on the core tiddler itself, and then packaging it into the plugin, or is there a way of overriding a core tiddler for development, and then bundling that override-tiddler into the plugin?  

I'm assuming  he is using Node.js and GitHub for development.  Maybe it is best to use the experimental 'create plugins in the browser' if the plugin will override core tiddlers? 

Jeremy Ruston

unread,
Apr 7, 2018, 12:08:09 PM4/7/18
to tiddl...@googlegroups.com
Hi Kevin

When I see a plugin which says it contains a shadow tiddler from $:/core/modules/, I presume it is overriding a core tiddler.  Is that right?  

Not necessarily; a plugin might contain a tiddler using the same naming convention (e.g. $:/core/modules/foobar) that doesn’t actually override a shadow tiddler. You can check using the “Info” panel; look in the “Advanced” tab.

When the developer is developing that plugin, is he editing on the core tiddler itself, and then packaging it into the plugin, or is there a way of overriding a core tiddler for development, and then bundling that override-tiddler into the plugin?  

I'm assuming  he is using Node.js and GitHub for development.  Maybe it is best to use the experimental 'create plugins in the browser' if the plugin will override core tiddlers? 

Any of the available techniques for building a plugin can include tiddlers that override core tiddlers.

There are some core tiddlers that are OK to overwrite (eg settings like $:/theme). The problems come when overwriting the core logic of TiddlyWiki (whether JS modules or wikitext templates). The risk is that a future update to the underlying core will not be propagated to the modified copy.

If a plugin author finds that they need to overwrite a core plugin then I'd advise raising it so that we can explore whether it’s possible to add hooks to make it possible to avoid the overwrite.

Best wishes

Jeremy.




--
You received this message because you are subscribed to the Google Groups "TiddlyWiki" group.
To unsubscribe from this group and stop receiving emails from it, send an email to tiddlywiki+...@googlegroups.com.
To post to this group, send email to tiddl...@googlegroups.com.
Visit this group at https://groups.google.com/group/tiddlywiki.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/b57b5e0f-374e-4d0f-b191-dc1eb04005ac%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Jed Carty

unread,
Apr 7, 2018, 5:19:55 PM4/7/18
to TiddlyWiki
If this is in reference to the multi-user plugin than I kept forgetting to make a pull request for the changes to the navigator widget that adds some new hooks. I just made a pull request.

It also has a modified edit button that is used to disable the edit button on tiddlers if that tiddler is being edited by another person or from another browser tab.

In the case of that plugin both of the tiddlers in the plugin override what is in the core plugin.
Reply all
Reply to author
Forward
0 new messages