My First Release Plugin

[TonyM]

Hi Developer folks,

I am using tinka to build my My First Release Plugin. I am a little unclear about the importance of naming standards,

My Current design has tiddlers with the Prefix $:/PSaT/PluginName/various tiddler names

PSaT is the initials of my Business name People, System and Things.

Is it fine to keep these in this naming standard? even although the plugin will be at $:/plugins/PSaT/PluginName?

Must I create before packaging even if the other content is using the above prefix?

$:/plugins/PSaT/PluginName/readme

$:/plugins/PSaT/PluginName/licence

I am trying to do what is correct.

Thanks

Tony

[TonyM]

Further to the above,

What happens when the plugin is disabled?

Tony

[Evan Balster]

It's a convention to prefix the plugin with $:/plugins/<developer_name>/<plugin_name> and to put all tiddlers "inside" that.  You can transgress that convention if you like, but it might be a little messy when it's unpacked into a wiki-folder.

You can include tiddlers of any name in plugins, and bundle them all up with one of the various plugin packing commands.  I've been using the browser console method:  https://tiddlywiki.com/dev/#How%20to%20create%20plugins%20in%20the%20browser

When the plugin is disabled, its shadow tiddlers aren't loaded into the wiki.  The plugin tiddler can still be accessed directly (or through sub-tiddler transclusion) but it's otherwise inert.

[PMario]

On Thursday, January 18, 2018 at 8:30:47 AM UTC+1, Evan Balster wrote:

It's a convention to prefix the plugin with $:/plugins/<developer_name>/<plugin_name> and to put all tiddlers "inside" that.  You can transgress that convention if you like, but it might be a little messy when it's unpacked into a wiki-folder.

That's right.

$:/plugins/<developer_name>/<plugin_name>

it's

$:/<type>/<developer_name>/<plugin_name>/<tiddler_title>

type may be:

 - plugins
 - editions
 - themes
 - languages
 
So I would encourage the existing schema, since everything else may cause trouble in the future.
... At the moment it seems, that the current convention is robust.

have fun!
mario

[PMario]

uups,
fix the typos:

[TonyM]

Thanks Gentlemen

So Just to clarify, my solution currently consists of the following tiddlers

$:/PSaT/MyMenus/examplemenu

$:/PSaT/MyMenus/FirstMenu
$:/PSaT/MyMenus/macros
$:/PSaT/MyMenus/manager
$:/PSaT/MyMenus/menufilterdefault
$:/PSaT/MyMenus/menumenu
$:/PSaT/MyMenus/readme
$:/PSaT/MyMenus/Styles
$:/PSaT/MyMenus/usage
$:/PSaT/MyMenus/viewfooter
$:/PSaT/MyMenus/viewheader

Yes, I will bundle them into a plugin called

$:/plugins/PSaT/MyMenus/

and rename

• $:/PSaT/MyMenus/readme to $:/plugins/PSaT/MyMenus/readme
  
• $:/PSaT/MyMenus/usage to $:/plugins/PSaT/MyMenus/usage
  

And add a $:/plugins/PSaT/MyMenus/licence

By Convention should I rename all remaining tiddlers to be prefixed $:/plugins/

or is that not relevant?

and since $:/PSaT/MyMenus/manager

Contains a MyMenus Manager perhaps I should call it that?

Thank you all so far.

Tony

[TonyM]

Bump, can someone confirm which direction I should go so I can do it right from the start please.

Tony

[Evan Balster]

Hello, Tony —

This looks more or less correct.  The plugin tiddler's "list" field can be used to list (without the full prefix) any subtiddlers to be displayed as tabs when viewing it.

The other tiddlers in your wiki don't need to be prefixed — only the ones you plan on including in the plugin.  It seems to be conventional to include only minimal documentation in the plugin itself.

You can use this technique to pack all your plugin tiddlers from the browser:  https://tiddlywiki.com/dev/#How%20to%20create%20plugins%20in%20the%20browser

[Diego Mesa]

Just want to mention, I've used the excellent tinka plugin:

https://tinkaplugin.github.io/

to package and edit plugins.

I have also noticed it seems to conventional to include minimal documentation, but I am not so sure why. I always have to end up refering to another website to look up details about a plugin I;ve already installed. I would suggest just bundling much more thorough documentation and (at least some) examples will all plugins - just my opinion though!

Diego

[@TiddlyTweeter]

Diego Mesa wrote:

Just want to mention, I've used the excellent tinka plugin:

https://tinkaplugin.github.io/

to package and edit plugins.

I have also noticed it seems to conventional to include minimal documentation, but I am not so sure why. I always have to end up refering to another website to look up details about a plugin I;ve already installed. I would suggest just bundling much more thorough documentation and (at least some) examples will all plugins - just my opinion though!

Some people do include more documentation in their plugins to good effect.

Part of the issue is, I think, that its not so easy to KNOW what is needed. A developer in midst of something that is now transparent to them is not necessarily able to fully grasp what is needed by an end user. On the one hand you want only what is enough. On the other its in everyone's interest that there is enough documentation.

I do think some superb plugins are UNDERUSED because they are not so well documented.

Josiah

[TonyM]

Interesting you discuss this,

I have recently started building a plugin repository to help me keep more information about plugins than the author gives me.

The plugin I am building needs details in it or it would not be very useful, and in fact I also intend to have a reference to additional notes on the internet because I can then add to the documentation as new tips and tricks come to light.

This has a lot to do with the nature of my plugin, however all plugins could/should  use this to a greater or lesser extent.

Regards

Tony

[TonyM]

Folks,

Almost there,

I have used Tinka to create the plugin

The Pre-release in on this site http://tiddlywiki.psat.com.au/mymenus/

As mentioned previously my current plugin content list is attached

You will notice the $:/PSaT/MyMenus/manager is not in bold

I discovered the menu item that should appear in the sidebar tab does not display until I edit it.

Why would it not work until edited?

Can anyone help me with this please?

Tony

[@TiddlyTweeter]

This plugin is not Yet Published or Working on this site

erm... that's a bit confusing! :-)

J, x

[TonyM]

Josiah,

But the statement is somewhat true, it remains version 0.0.x the key menu does not load automatically in the sideBar and I need to resolve the above to proceed.

Any ideas? Have you published a plugin before?

Tony

[@TiddlyTweeter]

Ciao Tony.

I have never published a plugin. Sorry to say.

Josiah

[TonyM]

Now solved

The Lists that would list $:/PSaT/MyMenus/manager  have had their filter updated to include all[] so that the specific shadow/system tiddlers are listed.

Regards

Tony