HI Dylan 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. >
Help with the documentation is much appreciated; even just asking questions about it can help a lot. I don't refer to the docs everyday so I usually only see mistakes and omissions when I'm doing a structured review of the docs to support some change. Another few hundred pairs of eyes should improve things! > 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. > Yes, I do think there should be a community wiki - it really only needs a few volunteers to get started (just as tobibeer takes care of the content at tiddlywiki.org). I've just reserved five.tiddlyspace.com for the purpose; we can arrange the space like tiddlywiki.org so that everybody with a tiddlyspace account can make changes. > 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 > That makes sense. tw5.com does already use a fixed format for widget documentation, but it could certainly be improved. I'm happy to accept pull requests for the docs on tw5.com, by the way. > 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. > Great, much appreciated. Best wishes Jeremy > -- > 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. > -- Jeremy Ruston mailto:[email protected] -- 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.
