A Better Documentation for WikiText

Community Projects Documentation
,
#1

While there are several tiddlers on Tiddlywiki syntax, but I think for newbies a better structure is required. For example see

Basic Syntax | Markdown Guide

  1. It is one page (One composite tiddler generated from several tiddler)
  2. It has good and bad practice

Question: Tiddlywiki backward compatibility is an important rule in developing new features but do we shall follow that rule for the documentation wiki?

Also, I would recommend to separate documentation for main page (e.g tiddlywiki.com). Tiddlywiki.com is the main page of product (Tiddlywiki) and needs to advertise Tiddlywiki in a nice way. Right now it is a doc page with too many number of tiddlers.

4 Likes
#2

Thanks for your feedback!

You are right, the list at: https://tiddlywiki.com/#WikiText should be sorted in a different way.

We can create a button, that opens all tiddlers, so we get a long list, similar to the markdown info.

In the meantime, if you CTRL - click a link, the tiddler will be opened, but the focus won’t move. So you can open all tiddlers at once and you get a long list of tiddlers.

I think, the syntax should be explained in “best practice” mode. Everything else is not best practice. We don’t need to show that. Users will use it on their own :wink: …

But we can add a paragraph at the beginning, that makes it clear, that the syntax shown is “best practice” and that the wikitext itself should also be readable as plain text.

We can create some “Try it” buttons, that open an editor with the preview active in a separated window. … So users can read the docs and experiment in a browser side-by-side view.

I’ll create a GitHub issue with some todo’s, since this may be done in several pull requests.

2 Likes
#3

Right! Bingo!

Just FYI I personally like TW’s WikiText.

But, as you yourself know and made, parsing is a major theme in TW.
One where we can do much to bespoke wiki’s for purpose.

Your Custom Markup goes a long way towards that!

TT

#4

There is a example list of wikitext in the classic parser plugin documentation:

https://tiddlywiki.com/plugins/tiddlywiki/tw2parser/#Markup

2 Likes
#5

I did create a PR: https://github.com/jermolene/TiddlyWiki5/pull/6828 … There may be more to follow

I did use 7 Steps to Improve the TiddlyWiki Documentation to create the PR.

So I think I shouldn’t be the only one, which likes to use TiddlyWiki to create straight forward doc-fixes.

Tracking issue:

2 Likes
#6

Thanks for the pointer. I did add this info to the todo list … IMO we should add this tiddler as a cheat sheet to the core itself. So it is part of every wiki.

1 Like