How can I import the TiddlyWiki docs into my own wiki?

160 views
Skip to first unread message

si

unread,
Feb 13, 2021, 10:05:24 AM2/13/21
to TiddlyWiki
Hi all.

I plan to import the entirety of tiddlywiki.com into my personal wiki, so that I can learn TiddlyWiki more thoroughly by making flashcards and notes as I read through the docs.

Here are a couple of more specific points:
  • In order to keep track of what I have ready, I will create a checkbox to add a "Done" tag to a tiddler if I have read it.
  • There may be overlap between the titles of tiddlers in the docs and titles that already exist in my wiki. To get around this I will prefix every tiddler from the docs with "TiddlyWiki docs/".
So far so good - I know how to do all that. The problem that I have is that I want to be able to keep up with updates to the docs. This means that I want to be able to re-import the docs, but only replace tiddlers that have been modified more recently than already imported tiddlers.

I don't know a way to approach this last point, so any help would be much appreciated. Thanks in advance.

Soren Bjornstad

unread,
Feb 13, 2021, 12:04:58 PM2/13/21
to TiddlyWiki
I'm very interested in this question, as Grok TiddlyWiki  faces a similar problem moving forward -- users might want to update to the latest edition of the book, but presumably will not want to lose their progress in all of the takeaways. What I've done so far is load the takeaways (and the snippets) in shadow tiddlers, so if the user has personalized any of them, they won't change if a different version is imported (I imagine the easiest way to upgrade will actually be to export the takeaways from the old version and then import them into the new version, where the user's existing takeaways will hide any takeaways with the same ID in the new version, e.g., showing only the user's versions unless new takeaways have been added).

I could imagine extending this with a tool that identifies places where a shadow tiddler differs from an overridden tiddler, perhaps displaying the modification dates and a diff and providing the option of overwriting your version (or even just specific fields on your version -- e.g., in the takeaways scenario, the user might want to update the text of the prompt but keep the scheduling history).

Jeremy Ruston

unread,
Feb 13, 2021, 2:13:33 PM2/13/21
to TiddlyWiki Group
Hi Soren, si,

Some time ago we made the docs from tiddlywiki.com available as a plugin in the official plugin library under the name $:/plugins/tiddlywiki/tw5.com-docs. The idea was very much as you suggest, to be able to keep a copy of the docs in ones own wiki.

Sadly, most of the documentation had already been written on the assumption that the docs tiddlers were ordinary tiddlers, not shadow tiddlers, and so constructions like this don’t work properly:

<<list-links "[tag[ActionWidgets]]”>>

It would be terrific to go through and fix these issues to make things a bit more useful.

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 tiddlywiki+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/tiddlywiki/571f95f9-9c9b-4a2d-9b66-ef9e9eadda70n%40googlegroups.com.

si

unread,
Feb 14, 2021, 9:22:10 AM2/14/21
to TiddlyWiki
@Jeremy - I did notice that the docs were available as a plugin, which is definitely useful, but I'm not sure that it will solve my problem. Since I will tag tiddlers from the docs "Read" when I have read them, I'll end up just overriding every shadow tiddler anyway. In my case I want to be able to tag tiddlers as "Read", but if that tiddler gets updated in the docs have a way to overwrite that tiddler so that I know that I need to re-read it and see what the updates were, without overwriting tiddlers that have not been updated.

@Soren - Yep there is certainly overlap between our respective problems. Please let me know if you find a solution!

Jeremy Ruston

unread,
Feb 14, 2021, 9:27:04 AM2/14/21
to tiddl...@googlegroups.com
@Jeremy - I did notice that the docs were available as a plugin, which is definitely useful, but I'm not sure that it will solve my problem. Since I will tag tiddlers from the docs "Read" when I have read them, I'll end up just overriding every shadow tiddler anyway. In my case I want to be able to tag tiddlers as "Read", but if that tiddler gets updated in the docs have a way to overwrite that tiddler so that I know that I need to re-read it and see what the updates were, without overwriting tiddlers that have not been updated.

I wouldn't recommend using tags to mark docs tiddlers as read, for the reason you've spotted. A reasonable alternative might be to use a separate tiddler to keep track of the status of each docs tiddler. You might use a prefix like `$:/read/`, so that the status for "HelloThere" would be in `$:/read/HelloThere`. You could use the "modified" field of the $:/read/ tiddler to track when you marked a tiddler as read. You'd also be able to detect tiddlers that had changed since you read them.

Best wishes

Jeremy

si

unread,
Feb 14, 2021, 3:02:14 PM2/14/21
to TiddlyWiki
Thanks Jeremy that makes way more sense than what I was going to do!
Reply all
Reply to author
Forward
0 new messages