Variables, Parameters and transclusions - Cheat sheet RFC

[TonyM]

Folks,

I have a DRAFT copy of Variables, Parameters and transclusions - Cheat sheet - Request For Comments. With Intense debate Commenting.

THIS IS NOT THE FINAL - BUT IS CLOSE

• Based on Tobiases original document, with input from Eric and Jeremy, Mario and more over the years. Any errors are mine alone.
• Based on my own sometimes difficult struggle to comprehend the power and details of TiddlyWiki
  
• I am inviting Feedback to refine this so if you are will versed in one or more areas, or want to test the validity of an Item (Especially those Marked TEST) please do so.
• If you find an error please provide a code snipit that demonstrates the error here or in the IntenceDebate Comments.

Content Headings for Variables, Parameters and transclusions

• Within wikiText

      Shows what is valid in the body of a tiddler and wherever the content will be "wikified" (Eg Wikify or after transclusion)

• Within Filters

      Shows what is valid inside filter statements in widgets and 'Filtered transclusions'.

• Within HTML and Widgets - Parameters and Attributes

      HTML can be used in TiddlyWiki this shows how to use TiddlyWiki values in HTML tags / attributes

• Within HTML Content

      This section is about what you can place between HTML tags

• Additional features within macro definitions / macro body

      That is what is valid on the line after /define macroname() or until the /end statement.

• Within a Macro call or for a "macro parameter"

      What is valid on a macrocall eg <<macroname parameters>> Within a Macro call or for a "macro parameter" ie calling macros, passing parameters to the macro

• Concatenating values for use in Macros and Widgets

       If you read and understand everything documented here you will realise your instinct to try and concatenate more than one value will not work. Here we explain how to do this.

• Other special Cases

         Evans Formulae plugin (you will need to install) introduces the mushroom brackets (= content =) which is a way to calculate a value which will then be substituted where the (= content =)is placed.

         Since the values that can be calculated can also be transclusions or (Variables - not working as advertised) eg <<macrocall "(={{!!count}}=)">> works.

• Core Variables

        A Small list of variables generated by the "Core" of TiddlyWiki

• Useful transclusions

      A small set of useful transclusions populated by the "Core" of TiddlyWiki

Intense Debate or this thread are used for feedback

• Do not open and close the Comments without pause or you will generate an error (Just reload if you do)
• Feel free to comment on the comment system as well

I will include a PDF to help tempt you, in the next comment, with up-to-date links, but remember it will be abridged soon.

Regards

Tony

[TonyM]

Multiple page Document attached

I have a DRAFT copy of Variables, Parameters and transclusions - Cheat sheet - Request For Comments. With Intense debate Commenting.

THIS IS NOT THE FINAL - BUT IS CLOSE

[@TiddlyTweeter]

Ciao TonyM,

Cheat / Crib sheets are good! This one looks in the right direction--though maybe a little prolix?

Just FYI, recently there was an important public blog post at: https://opensource.com/article/19/2/tiddlywiki

The one problem with it is it refers to a PDF cribsheet for TW Classic of 2007!! http://www.tcm.phy.cam.ac.uk/~mdt26/PWT/hints.pdf 

It is interesting he chose to link to a PDF--even though inaccurate.

There is a kind of broader--"what is out there?"--struggle that is also part of this??

What worries me is that all the great work on documentation by you, S.S., and others, will NEVER meet its market audience.

Best wishes

Josiah

[Mohammad]

Hi Tony,

This is great!

Thank you for sharing. I may develop some examples using this cheatsheet in TW-Scripts.

Cheers

Mohammad

[S. S.]

Hi Josiah,

The Introduction level tiddlers I am working on for Beginners is 100% only for inclusion as documentation on the tiddlywiki.com website.
I have no interest to make a separate help site.

The first step was opening issue #3711 which led to pull request #3767 and my request on Google Groups: Need help testing new Documentation Tiddlers  

The main difficulty now is deciding HOW to display the Introduction tiddlers on tiddlywiki.com - as the present Table of Contents is not effective, and I feel the List Links style is outdated and cumbersome (github issue #3664).

With so much development going on now for the software side of TiddlyWiki, it takes some time to get responses to ideas put forward and questions asked about the documentation side. So it seems to be moving slowly, but I am glad that at least it is moving forward!

Cheers

[@TiddlyTweeter]

S.S.

Very good to know that! The penny hadn't dropped with me ... Duh!!

Best wishes

Josiah