Interesting way to document complex syntax

144 views
Skip to first unread message

Jeremy Ruston

unread,
Jan 4, 2021, 3:56:27 AM1/4/21
to TiddlyWiki Group
I recently came across an interesting way to apply dynamic labels to complex syntax examples. Here are the explainers for CSS and HTML:

http://apps.workflower.fi/vocabs/css/en

It’s a very simple idea:

* On the left, there’s the text being explained, with conventional syntax highlighting
* On the right, there’s a list of terms
* Clicking on a term lights up the examples of that term
* Clicking on a block of text lights up the term

One of the things I like about it is that it works on touch devices because it doesn’t use :hover.

I’d be very interested to get something like this into the core documentation. Done with care it could help explain many of the subtleties that trip people when learning TiddlyWiki.

Best wishes

Jeremy


Glenn Dixon

unread,
Jan 4, 2021, 9:17:57 AM1/4/21
to TiddlyWiki
I will wholeheartedly endorse this!

TW Tones

unread,
Jan 4, 2021, 9:56:44 PM1/4/21
to TiddlyWiki
Yes - very cool.

The same facility could be applied to view or editing of text tiddlers. An added trick is to be able to drag and drop either the titles or the content of tiddlers with title to access a content templating system.

The keyword tiddlers could contain descriptions, excerpts or example content that can be dropped on the selected tiddler to rapidly author content, including links to other content for cross referencing.

Drag and drop using modifier keys would keep the interface simple but powerful.

Tones.

Mohammad Rahmani

unread,
Jan 4, 2021, 11:20:28 PM1/4/21
to tiddl...@googlegroups.com
Hi Jeremy,

Very interesting! Moset newcomers confuse with filters and this can instruct new users to learn some TW basics.
Good idea to have it in TW documentation. Please add it!

--Mohammad

Reply all
Reply to author
Forward
0 new messages