[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

['Mark S.' via TiddlyWiki]

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

-- Mark

On Sunday, October 7, 2018 at 12:53:49 AM UTC-7, Mat wrote:
>
> 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
>
> <:-)
>
>
>

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/82d602fe-1129-4d3e-bf77-2856ccaa7836%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[@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

Mat wrote:
>>>
>>> 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%20Tiddler 
> 
>
>

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/068fc639-2b34-4cfc-882c-37e05ccf632d%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[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

<:-)


-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/6df48442-1970-4bbc-95ff-e33dc32b6293%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

['Mark S.' via TiddlyWiki]

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
 

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/0487cc97-09d8-4714-9604-e4c4d0d83e87%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[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.


<:-)

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/060c238c-0891-44c8-aacd-b53eb6f87bda%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[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

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/6d2b9c5b-6b5c-4567-8a48-bb1adde5b212%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

['Mark S.' via TiddlyWiki]

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

On Saturday, October 6, 2018 at 12:47:05 AM UTC-7, Mat wrote:
>
> 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. 
>
> <:-)
>
>  
>

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/803c6928-e438-4cb4-ab72-fd89ea87d8fe%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[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. 

<:-)

 

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/3012410a-7e43-4845-a6b7-61e3bc20ea6c%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

['Mark S.' via TiddlyWiki]

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
>

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/0bf60e44-ac6b-4c9f-b57a-2ff845b52427%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[Mohammad]

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

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/a39c3e8e-9b55-4f53-bfc9-638a35606f44%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

['Mark S.' via TiddlyWiki]

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
>

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/35b03988-6dc1-4909-b6da-2ee2178959c5%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[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
   - set caption of tiddler to "readme"
   - In the List (Tinka) add: readme

That's all.

- Mohammad

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/8ad79bff-05f8-43b1-87e4-0d92928db941%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[tw5] Re: Tinka pluging: How to add readme, usage and other tiddlers

[Jed Carty]

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

-- 
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+unsubscr...@googlegroups.com.
To post to this group, send email to tiddlywiki@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/8ef6e8cf-829e-47ef-a33b-578e0e23c53c%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.