Re: [tw5] TiddlyWiki Documentation - Syntax

I'm not following all the tech discussion here, but I like the idea of accessible, standard documentation that's trivially easy to author. One good example that comes to mind is the documentation for ansible modules. There are lots of them, and they all have consistent, (mostly) understandable

Re: [tw5] TiddlyWiki Documentation - Syntax

Sorry, I meant to add I think version three could be at the bottom of every definition with all parameters, copy or drag. Tones On Tuesday, 8 June 2021 at 09:21:02 UTC+10 TW Tones wrote: > *Stobot et al* > *I'm not that familiar with screen readers etc. but if you want to take a > crack at

Re: [tw5] TiddlyWiki Documentation - Syntax

*Stobot et al* *I'm not that familiar with screen readers etc. but if you want to take a crack at an example to help me understand, I'd be happy to look at it* Nor am I but alt apparently making use of alt text is important for images at least. No what I am saying is making use of the other

Re: [tw5] TiddlyWiki Documentation - Syntax

- To TiddlyTweeter's point, if <$details> stored state, wouldn't it just be a less-flexible <$reveal>? RIGHT. Point is it is just a dumb state that requires NO state tiddlers at all. You can simply, directly, change the toggle state. It is mostly ONLY useful for ON/OFF situations.

Re: [tw5] TiddlyWiki Documentation - Syntax

Great continued feedback. I'll keep going, but just to mass-reply: PMario - I agree that the "closed version" should be in a small general syntax notes area - maybe right below the syntax block. Things like: - Each attribute can be given as "Text Value", {{Trancluded Value}},

Re: [tw5] TiddlyWiki Documentation - Syntax

> TiddlyTweeter wrote: > >> ... using either *<$reveal>... *or ... to hide sections so its >> not too overwhelming and the end-user can expand only the sections they >> need to see. > > PMario replied: > At the moment Jeremy doesn't accept PRs that contain the > element, because it doesn't

Re: [tw5] TiddlyWiki Documentation - Syntax

On Monday, May 31, 2021 at 10:06:33 AM UTC+2 TiddlyTweeter wrote: ... using either *<$reveal>... *or ... to hide sections so its not > too overwhelming and the end-user can expand only the sections they need to > see. At the moment Jeremy doesn't accept PRs that contain the element, because

Re: [tw5] TiddlyWiki Documentation - Syntax

On Saturday, May 29, 2021 at 6:10:32 PM UTC+2 Stobot wrote: Examples - more complex = Edit-text > [image: edit-text-widget.PNG] > I personally would favour Version 1 for the Intro overview. The valure-options as shown in Versioin 2 should be part of the detailed description in the "Attributes

Re: [tw5] TiddlyWiki Documentation - Syntax

Stobot wrote: > Review here: > Documentation — Syntax for Widgets (tiddlyhost.com) > > > So on the site now I show a V1 (original), V2 (adding the metasyntactic > variables), and V3 with them, but splitting each attribute into a new line. > It's not clear

Re: [tw5] TiddlyWiki Documentation - Syntax

I like V1 the best in combination with the table. This way the part in the codeblock in a quick overview that can be copied. And if an user needs more information, they can look it up in the table. Op zaterdag 29 mei 2021 om 19:01:03 UTC+2 schreef Mohammad: > I love this bold/italic format! Now

Re: [tw5] TiddlyWiki Documentation - Syntax

I love this bold/italic format! Now at a short glance one understand how to call the widget! If readability does matter, then V3 is the most readable but may take more space and look lengthy! My experience says having a standard form for all widgets makes learning them easier! I also recommend

Re: [tw5] TiddlyWiki Documentation - Syntax

I have no idea if this would be more hassle than it's worth or would be a workable work flow but could text stretch or stretch text be used to present a condensed version which could be expanded? https://links.tiddlywiki.com/urls/7f9e7e60ed40b5098996

Re: [tw5] TiddlyWiki Documentation - Syntax

Progress and feedback gathering: - The main suggestion I wanted to take a look at first was adding "metasyntactic variables", which was suggested by many of you. I had expressed my concern with length, so want to show that below and at the link to get feedback. - Added these

Re: [tw5] TiddlyWiki Documentation - Syntax

Folks, When documenting code perhaps mouse over and alt text could be used along with highlighting so an optional items being bold nd green could support screen readers and the color blind with mouse over text? We do have rich environment available after all. I am sure there are standards we

Re: [tw5] TiddlyWiki Documentation - Syntax

Best wishes Mohammad On Thu, May 27, 2021 at 4:28 PM Stobot wrote: > Thanks everyone for the feedback! > > @Soren > >- Good point about the formatting on the values in the Default >section, I'll try parentheses. >- I ''strongly'' agree that every attribute should have an example. I

Re: [tw5] TiddlyWiki Documentation - Syntax

Thanks everyone for the feedback! @Soren - Good point about the formatting on the values in the Default section, I'll try parentheses. - I ''strongly'' agree that every attribute should have an example. I might have to put that as a secondary effort though to make sure I finish

Re: [tw5] TiddlyWiki Documentation - Syntax

Thanks for the iniciative and the work. - I think that put only name attribute could be confused for newcomers. They can think that widgets work like a macro, when (I think that) the widget works like a html tag. - I am rethinking the idea of create a syntax example for each widget or macro.

Re: [tw5] TiddlyWiki Documentation - Syntax

Mohammad wrote: > I have attached a sample doc from Excel > > The same sequence: purpose, syntax, arguments (in/out parameters), > remarks, examples > [image: Screenshot 2021-05-27 085252.jpg] Ha. Very good example! And, YES. We are all Sinners, and especially Microsoft :-) TT -- You