Tinka pluging: How to add readme, usage and other tiddlers

[Mohammad]

Tinka: https://tinkaplugin.github.io/ does not correctly shows readme and usage!

plugin-type: plugin
plugin-path: $:/plugins/.mr/test-plugin
list:        readme usage

The below tiddlers are added in Step two

tid-a
tid-b
readme
usage

After creating the plugin, I see the readme tab and usage tab are empty! What is wrong here?

/Mohammad

[Jed Carty]

The tiddler names have to have the prefix for the plugin. Like this $:/plugins/.mr/test-plugin/readme

[Mohammad]

Thank you Jed! It worked.

Just for documentation purpose and other people who may have similar question:

• Name your readme like below
• $:/plugings/myName/myPlugin/readme
• In the List (Tinka) add: readme
  

That's all.

- Mohammad

[Mark S.]

In my tests, the caption didn't seem to do anything. It would be nice if there was a note about the relationship in naming between the list and the tiddlers.

-- Mark

On Friday, October 5, 2018 at 11:28:24 AM UTC-7, Mohammad wrote:

Thank you Jed! It worked.

Just for documentation purpose and other people who may have similar question:

• Name your readme like below
• $:/plugings/myName/myPlugin/readme

• set caption of tiddler to "readme"
  

• In the List (Tinka) add: readme

That's all.

- Mohammad

[Mark S.]

I couldn't get the caption to do anything. It seemed to only care about the name in the list field matching the tale end of the tiddler name. But perhaps I wasn't doing it right.

Meanwhile, I've submitted a PR with additional documentation toTinkaPlugin/Tinka . (https://github.com/TinkaPlugin/Tinka/pull/12)

-- Mark

On Friday, October 5, 2018 at 8:25:41 PM UTC-7, Mohammad wrote:

Mark, in my case the tab title is taken from caption (if not set from tiddler title).

As you said it is good Tinka documentation add a note on this.

-Mohammad

[Mat]

Mohammad wrote:

• set caption of tiddler to "readme"

"readme" is a special case in this; you don't need a caption for it. Any other tiddler you want to show there can use a caption.

The other special case is the "content" tab which is automatically created whether you ask for it or not. 

<:-)

 

[Mark S.]

Hi Mat,

I can't find that using a caption makes any difference to what gets displayed. If you put a name in the "list" field, that name will become a tab entry. But it if you didn't provide a matching name like $:/plugins/MAT/myplugin/mytiddler, there will be no content for the tab "mytiddler". If there's a way to make caption do something, can you give an example? I would like to make sure the documentation I suggested is accurate.

Thanks!

-- Mark

[Mohammad]

Mark, 

 It was my mistake, you are right. I have $:/plugins/.mr/pl1/readme and I used the `readme` in the list and it works for me!

I mean the plugin tab in control panel got the label readme.

So, as you and Mat already said there is no need to set the caption for readme tiddler.

-Mohammad

[Mat]

Mark S. wrote:

I can't find that using a caption makes any difference to what gets displayed. If you put a name in the "list" field, that name will become a tab entry. But it if you didn't provide a matching name like $:/plugins/MAT/myplugin/mytiddler, there will be no content for the tab "mytiddler".

My bad. It doesn't work, good you caught it. And you're right; you can add a shadow tiddler full-path name to the list field, and if this shadow does have a caption field, it will show but there will be no tab content so it would be pointless. 

I would like to make sure the documentation I suggested is accurate.

I'd like for documentation on this on tw.com (not just for Tinka). This is the second time this month I make some faulty statement on this matter so it would be better to have a place to point to in the tw docs.

<:-)

[Mark S.]

On Saturday, October 6, 2018 at 1:33:25 PM UTC-7, Mat wrote:

I'd like for documentation on this on tw.com (not just for Tinka). This is the second time this month I make some faulty statement on this matter so it would be better to have a place to point to in the tw docs.

Ok, you can upvote this PR: https://github.com/Jermolene/TiddlyWiki5/pull/3468

Thanks!

-- Mark

 

[Mat]

Mark S. wrote:

Mat wrote:

I'd like for documentation on this on tw.com (not just for Tinka). This is the second time this month I make some faulty statement on this matter so it would be better to have a place to point to in the tw docs.

Ok, you can upvote this PR: https://github.com/Jermolene/TiddlyWiki5/pull/3468

Hm, that doesn't seem to be the right place for it. The information is not for Tinka per se but about plugins so it should probably be in, or associated with, this tiddler;

https://tiddlywiki.com/#Plugin%20Information%20Tiddlers

<:-)

[@TiddlyTweeter]

I agree with Mat.

I think its more helpful than just for Tinka. Its a more generic set of clarifications about plugin-making.

Good stuff.

Josiah

[Mark S.]

Actually, the same information is already there. So perhaps my suggested doc isn't needed.

-- Mark