Use tiddlers written in reStructuredText (RST) markup

102 views
Skip to first unread message

Tejasvi S Tomar

unread,
Jul 5, 2020, 7:06:04 AM7/5/20
to TiddlyWiki
Hi there! I am fortunate enough to discover TiddlyWiki and Zettlekasten well before committing to a specific note-taking method. Since markdown is relatively limited and lacks a standard, I have been using reST for taking notes instead. So my question is, is there an equivalent plugin for RST which is as functional as the markdown counterpart?

TW Tones

unread,
Jul 5, 2020, 7:57:48 AM7/5/20
to TiddlyWiki
Hi

I don't know about rst but I use tiddlywiki native markdowns widgets and macros. Add in some plugins a editor toolbar buttons and I want for nothing. So I wonder why you say markdowns not enough that you want an alternate one?

Are you yet familiar with native tiddlywiki?

please give some examples of why you want rst?

Regards
Tony

Eric Shulman

unread,
Jul 5, 2020, 7:59:56 AM7/5/20
to TiddlyWiki
On Sunday, July 5, 2020 at 4:06:04 AM UTC-7, Tejasvi S Tomar wrote:
Hi there! I am fortunate enough to discover TiddlyWiki and Zettlekasten well before committing to a specific note-taking method. Since markdown is relatively limited and lacks a standard, I have been using reST for taking notes instead. So my question is, is there an equivalent plugin for RST which is as functional as the markdown counterpart?

There is *currently* no support for parsing RST-formatted content.

However, since everything in TiddlyWiki is based on HTML/CSS/Javascript, it should be *possible* to create such a plugin.

After a quick look, I found this: https://github.com/thoward/rst2html which converts RST content into HTML.

TiddlyWiki already handles rendering of HTML content, so it shouldn't be *too* hard to take a tiddler
containing RST content with type="text/x-rst" (the "unofficial official" MIME type for RST) and pass it
through a plugin library such as the above "rst2html", and then render the resulting HTML output.

However, this is not trivial, and would require a TiddlyWiki technical expert to implement the various
parts and glue it all together.  Unfortunately, while I can envision the possibility,  I personally have
*no* experience in implementing alternative parser plugins for the TWCore, so this would have to
be a project for one of the other TiddlyWiki "wizards" out there.

Note that, even if this was done, there would still be some issues with the results.  For example:
* would it be possible to create links to other tiddlers from within RST-formatted content?
* similarly, could TW transclusions be used?
* and, what about TW macro definitions (either TWCore or custom-written macros)?

I suspect that, with some additional effort, at least some of the above issues could be addressed
once the basic parsing and rendering of RST-to-HTML is working.

All in all, this seems like an interesting project for someone with the right skill set, but it would
probably be a significant investment of time and effort, so there would need to be a strong
motivation for doing the work and maintaining the results.  Since you are the first person
to ask about support for RST-formatted content, I suspect that the demand for such functionality
is currently limited in the TiddlyVerse.

-e
Eric Shulman
TiddlyTools.com: "Small Tools for Big Ideas!" (tm)







Reply all
Reply to author
Forward
0 new messages