(this is carried over from my earlier thread, because it's tangental to 
that thread)
 

>
>>    1. *Documentation* - With the latest version of TiddlyWiki being in 
>>    Alpha, I want to be sure that I'm reading useful help material. Are 
>>    websites like Tiddler Toddler not applicable to the new version? If not, 
>>    where are the best sources for introductions, etc.?
>>
>> Most of the core concepts are common between TW Classic and TW5 (e.g., 
> tiddlers, fields, tags, etc.), but lots of the details have changed. 
> TiddlyWiki5 is quite new still, and so there aren't yet as many resources 
> for it. We need new users like you to help us create the material.
>

So far I've been able to learn quite a bit from the documentation currently 
available at http://five.tiddlywiki.com/ although I think it will be better 
for newbies like myself once there has been some time to develop the 
documentation a bit. One other source I saw was tiddlywiki.org which is 
very robust and user-friendly, with clear examples. I see that's a 
community wiki. Are there plans to do a community wiki for version five? If 
so, I'm happy to help create the material however I can. 

A documentation style I'm used to, and which might add some value if used 
for TW5, is the one used by the WordPress function reference. Here, each of 
the "special tags" that you can use with your installation is explained 
with:

   - a plain text description of the tag, with particular regard for 
   contexts when the tag is or is not able to be used.
   - a (default) usage example
   - a list of paramaters/attributes, explained
   - before/after example(s) to show common usages and their expected 
   results
   - recent changes to the tag's behavior, if any
   - related tags

If you're not familiar with that model, here's a fairly ordinary 
example: http://codex.wordpress.org/Function_Reference/the_tags

Of course, it's a lot of work to document so much, but by coming up with a 
clear structure early on, it can be easier for others to fill in the rest 
over time. Again, I'm happy to help however I can.

-- 
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 http://groups.google.com/group/tiddlywiki.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to