I understand
It should read at least "Widgets always start with a <$"
Another example could have
!Wikitext heading
*Bulleted item
*Bulleted item
<$button message="tm-close-tiddler">I'm {{!!title}}<br> Click to Close Me!
</$button>
etc...
Good documentation is never so easy, but especially when coders and
designers write it, because they are so familiar with the content, they
make to many assumptions and always think it "obvious". It is people like
yourself on this learning path who can provide the best documentation if
people can help explain the gaps. Although sometimes the gaps are hard to
bridge.
See my current work
here
https://tiddlywiki.psat.com.au/#Variables%2C%20Parameters%20and%20transclusions
Regards
Tony
On Thursday, February 21, 2019 at 4:25:35 PM UTC+11, S. S. wrote:
>
> Thanks Tony.
>
> I'm still confused as to why that particular example above was used. I
> only see a Widget and no WikiText. I feel like my understanding is not
> complete, and that makes it difficult for me to write confidently.
>
> This is the text used in that documentation tiddler:
>
>
> Furthermore the WikiText is used to access the widgets which are
>> integrated in the application.These widgets are used to enhance the the
>> WikiText with a rich functionality. Widgets are based on the HTML-Syntax
>> but always starts with a $.
>>
>
> WikiText:
> <$button message="tm-close-tiddler">Close Me!</$button>
>
>
> If instead this example had been used, it would make more sense to me:
>
> <$button message="tm-close-tiddler">I'm {{!!title}}<br> Click to Close
> Me! </$button>
>
> I am beginning to understand how painstakingly careful one needs to be to
> write accurate official documentation for software, even if its only for
> the novice level.
>
> I think I am finding it takes so much time because there is so much about
> the software's complex internals that are difficult to easily understand.
> Thus, though it seems the topic is simple, it's not so easy to present it
> to a beginner while ensuring no language is used that infers "this is all
> there is to it" - while also not burdening the reader with the more complex
> concepts.
>
> Still, we are slowly getting there!
>
> On Thursday, February 21, 2019 at 4:13:32 AM UTC+7, TonyM wrote:
>>
>> S s
>>
>> Widgets are themselves placed in wiki text.
>>
>> Because they have there own parameter and content rules we typically go
>> on to discuss these, but skim over the fact they are placed in wikitext and
>> often also contain wikitext between widget opening and closing tags.
>>
>> Regards
>> 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 [email protected].
To post to this group, send email to [email protected].
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/a47c609d-4eda-4e1d-8eb5-c17090afd832%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
