Undocumented IF-THEN-ELSE macro

136 views
Skip to first unread message

S. S.

unread,
Jan 18, 2019, 5:26:20 AM1/18/19
to TiddlyWiki
As some regular readers here might be aware, I have been dabbling with putting together an Introduction to TiddlyWiki tutorial for tiddlywiki.com

I am still quite a novice to TiddlyWiki, and there are many terms and definitions that are difficult for me to write about accurately. There are many intricate parts of the program that I am unaware of. I am not a "programmer" so I am always worried about not defining terms properly.

As Jeremy has pointed out at one point, the Documentation on tiddlywiki.com needs to be authoritative - that means - what appears on the website is how the program is supposed to work, and how it behaves & responds. That means the accuracy of documentation and careful phrasing is essential.

The right place for documentation discussions is in the TiddlywikiDocs google groups list - but that place is rarely, if ever, visited - even by regulars of this group.

I do need some feedback on documentation now and again before I can move forward. So to remind some regulars to pop in there once in a while, I am adding a hopefully enticing post there that reveals an undocumented little gem that is on tiddlywiki.com to help with Documentation.

It is a javascript IF-THEN-ELSE macro - that I am enjoying using.

If you want to know about it, then you will have to go to TiddlywikiDocs google groups to read my post. When you are there, please do take a few moments to respond to some of the recent posts there asking for help.

Link to the undocumented IF-THEN-ELSE macro.


Dave

unread,
Jan 18, 2019, 10:03:24 AM1/18/19
to TiddlyWiki
Hi, I'm a "regular" here, but very hit and miss (gone for long stretches of time) so this is the first I've seen of that documentation Google group

Just to clarify, let's say I'm reading some documentation on Tiddlywiki.com and its making me pull my hair out in frustration (more often than not). Once I figure out how the feature in question actually works, how am I supposed to suggest a fix for the documentation? I assume the following (it's not documented clearly at the documentation group, ha ha):

* Go to the group
* Make a new thread entitled "how to use (feature)"
* State what the current documentation says
* State what it should say
* State the reasons why

Is that it? Someone more knowledgeable will (someday) implement it on Tiddlywiki.com?

S. S.

unread,
Jan 19, 2019, 12:54:28 AM1/19/19
to TiddlyWiki
Dave,

You have shown a perfect work-flow for someone who sees additions/corrections are needed, but doesn't want to deal with actually making/modifying the info tiddler and submitting it for review on GitHub.

My post above was asking for suggestions to improve a help file that's meant to make it easier for a new contributor to submit to TiddlyWiki's GitHub area.
But just posting a write up into TiddlywikiDocs google groups  means 75% of the work is done! After that it's easy for someone to pick it up and submit it.

My understanding is that within the past month or so, documentation updates to tiddlywiki.com are now separate from new releases (features/bug-fixes).

Thus documentation is updated quite quickly once a submission is made - it no longer has to wait for a new release.

I'm so enjoying using the program, I want to give back to help it thrive. That's the reason I'm spending some time on this documentation aspect of TiddlyWiki - a part of the program that needs a little more attention.

barro...@gmail.com

unread,
Jan 19, 2019, 6:35:27 AM1/19/19
to TiddlyWiki
On Saturday, January 19, 2019 at 12:54:28 AM UTC-5, S. S. wrote:

My post above was asking for suggestions to improve a help file that's meant to make it easier for a new contributor to submit to TiddlyWiki's GitHub area.
But just posting a write up into TiddlywikiDocs google groups  means 75% of the work is done! After that it's easy for someone to pick it up and submit it.


You got me with your bait : )  I do have a simple suggestion for documentation in general and if posting in the doc Group is aldo good-- because setting up a Github account was dwelaying me because I haven't had the time to do it.  B ut going to the doc Group wouldn't require any extra effort though its on my endless list of what I should really do, so don't expect me too soon-- sorry : )

I actually had a really good excuse-- eye surgeries on both eyes and now nearly 4 months without glasses to use.

TonyM

unread,
Jan 19, 2019, 7:14:41 PM1/19/19
to TiddlyWiki
Barro,

Me too, 2 inter ocular lenses, (For cataracts) and recently to fix a detached retina. Marvellous how what used to result in blindness can now be fixed.

Regards
Tony

barro...@gmail.com

unread,
Jan 19, 2019, 7:51:55 PM1/19/19
to TiddlyWiki
Tony

I can emphamize-- they extended my sight for another couple years.  Are you active over in the Doc Group?  You best be, since you're so active with TW.  I'm gonna present my Guide and Help documentation you saw during the late Summer.

Reply all
Reply to author
Forward
0 new messages