What does actions={{Tiddler}} mean in a $button????

[Joe Armstrong]

I'm trying to understand the comment code plugin at

https://github.com/Jermolene/TiddlyWiki5/tree/master/plugins/tiddlywiki/comments

So I've been cutting and pasting trying to create a minimal example 

I'm now down to two tiddlers:

One is a test tiddler which contains

this:

<$button actions={{CommentButtonActions}}>

  Press Me To add a comment

</$button>

Then CommentButtonActions contains this:

<$action-createtiddler

     $basetitle = "My                 Comment"

      text="yes"/>

When I click on the button a tiddler called

   [[My Comment]] is created

If I click again a tiddler called

   [[My Comment]] 1 is created

My understanding of the createtiddler was that $basetitle was the

tiddler name - but somehow the (deliberate) blanks in the string

got squashed into a single blank some extra square brackets "[[" and

"]]" appeared by magic and a sequence number got appended.

The documentation of "actions" in $button says that actions is a string ...

so I guess it's my own fault for saying actions = {{...}} -- but this does

work in the comments example at GitHub -- the problem is that I haven't a clue

what it means.

So can anybody enlighten me?

Supplementary question. When I make my first button and pressed it nothing happened - I'd expected some code to be executed - how do I debug this?

Cheers

/Joe

[Mark S.]

When you say "squashed into a single blank" do you mean the appearance, or how many blanks you see when you open the tiddler?

TW displays via HTML, and HTML will take an infinite number of spaces and squash them down to one. The old rule of two spaces after a period kind of died in the HTML world.

But if you edit the tiddler, the spaces are still there. Actually, when I ran your example, something weirder occurred. The spaces were replaced with exactly 17 spaces. I'm thinking it's some sort of unicode translation error that may vary by platform.

I do not get the square brackets [ ], so that may be a platform thing too.

The number on the end is expected. When you use action-create tiddler it generates a new number to make sure that all new tiddlers are unique.

What browser and platform are you using?

Have fun,

-- Mark

[Joe Armstrong]

On Wednesday, 9 January 2019 16:01:43 UTC+1, Mark S. wrote:

When you say "squashed into a single blank" do you mean the appearance, or how many blanks you see when you open the tiddler?

TW displays via HTML, and HTML will take an infinite number of spaces and squash them down to one. The old rule of two spaces after a period kind of died in the HTML world.

I see - I'm using the node.js server -- the tiddler name has some embedded blanks

I assume the "[[" ..."]]" are added since the name contains blanks and follows the usual convention for

placing links with blanks inside brackets.

One thing I hadn't noticed was that blanks in titles get squashed in the display but not when editing

So if you create two tiddlers called "My Page" and "My  Page" (with two blanks) both appear

identical when display - they both look the same in the recent tab - but they are different.

I guess the rule is "beware of double blanks in titles"

 

But if you edit the tiddler, the spaces are still there. Actually, when I ran your example, something weirder occurred. The spaces were replaced with exactly 17 spaces. I'm thinking it's some sort of unicode translation error that may vary by platform.

I do not get the square brackets [ ], so that may be a platform thing too.

The number on the end is expected. When you use action-create tiddler it generates a new number to make sure that all new tiddlers are unique.

What browser and platform are you using?

The node version 5.1.19-prerelease - in chrome browser

 

Have fun,

I am - slowly digging deeper.

So am I right in thinking that

   

   <$button actions={{Tiddler}} ..>...

The documentation said action is a string containing actionwidgets

So {{Tiddler}} must mean "the string formed from the contents of Tiddler"

I suppose 

I think I'm ok with this now.

Thanks

/Joe

[TonyM]

Joe,

Some mussings that may help your learning path.

Just to keep it clear {{Tiddler}}
Means transclude Tiddler, by default the text field. You could transclude the content of fieldname as well eg {{Tiddler!!fieldname}}

Whilst calling this transclusion we often refer to as "text reference" because it references other text "in line". Commonly used for storing a tiddller containing a state of something, it also allows you include one or a set of predifined actions into the actions parameter, and thus can work as reusable code/actions.

When you transclude something in something else it clearly gets replaced before the widget or wiki text is interpreted, and usualy itself interpreted before hand. So if you transcluded a tiddler containing a list widget in wikitext it would tranlate into a list as wikitext is want to, but not in a parameter, allowing the widget to act on the parameter.

You can also include actions inside
<$button parms>
Zero or more Action widgets as in your example
Button text or image
</$button>

But the above model with action widgets inside buttons supposed to be avoided, which I do not like as it can sometimes make it harder to read your own code since actions parameter points to somewhere else.

Enjoy
Tony

[Joe Armstrong]

I didn't quite understand the last sentence.

I think you're saying that style A is better than B

where A is

     <$button actions = {{{Tiddler}}} > Text </$button>

and B is

      

      <$button>

           Actions

      </$button>

To my eye A is better in the sense that less verbose = good

It might be that B is better since you only have to read one tiddler code

to understand what's going on and if you have no intention of reusing the

action code it makes sense to put everything in one place.

Is their a recommended best practise?

Cheers

/Joe

Cheers

/Joe

    

 

Enjoy
Tony

[TonyM]

Joe,

They say option A is Preferred and Option B deprecated, which may suit you, but perhaps only if you simplify the content of {{tiddler}}

However I think you you can write

\define macroname()
<$action..
<$action..
<$action..
\end

<$button actions=<<macroname>> > Text </$button>

So  in your example yes "{{Tiddler}} must mean "the string formed from the contents of Tiddler"

I have even made macros containing the field=value pairs 

eg

\define new-tiddler-fields()
fieldname1=value
fieldname2=value
...
\end

Regards

Tony

[Jeremy Ruston]

I think you're saying that style A is better than B

where A is

     <$button actions = {{{Tiddler}}} > Text </$button>

and B is

      

      <$button>

           Actions

      </$button>

That's right: when action widgets were first introduced there was only style B, then we discovered some subtle evaluation order bugs, and so introduced style A, which is immune to most of the problems.

I personally prefer a variant of style A where one uses a variable to store the action widgets instead of a separate tiddler:

\define my-actions()

<$action-navigate $to="$:/ControlPanel"/>

<$action-setfield $tiddler="$:/SiteTitle" $value={{{ [{$:/SiteTitle}addsuffix[!]] }}}/>

\end

<$button actions=<<my-actions>>>

Click me to open control panel and add an exclamation mark to the site title

</$button>

Best wishes

Jeremy.

To my eye A is better in the sense that less verbose = good

It might be that B is better since you only have to read one tiddler code

to understand what's going on and if you have no intention of reusing the

action code it makes sense to put everything in one place.

Is their a recommended best practise?

Cheers

/Joe

Cheers

/Joe

    

 

Enjoy
Tony

--
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/fb1e0e87-f79b-45e5-bf50-18520723950a%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.