Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.

Troubleshooting

TiddlyWiki Community Wiki

Jump to: navigation, search
This page is still incomplete. You can help by contributing to its expansion.
Please improve the article, or discuss the issue on the talk page.

In case of a problem, disabling all plugins — both in TiddlyWiki and in the browser — is the first step in identifying the cause. If the problem has disappeared then, re-enabling all plugins one at a time helps identifying the exact cause of the problem.

Creating a fresh browser profile (e.g. with Firefox) might help as well.

When encountering a plugin error, the plugin manager will automatically be displayed on startup, highlighting the problematic plugin and presenting an error message.

When encountering a macro error (e.g. "Error in macro <<[...]>>"), clicking on the error message will reveal more details that are helpful in identifying the issue.

[edit] Community Support

The TiddlyWiki community is always glad to help out.

Please provide

  • a concise description of the problem
  • if applicable, the exact error messages
  • step-by-step instructions for reproducing the issue
  • system information
    • TiddlyWiki version number
    • relevant plugins (with links)
    • operating system
    • browser version (and extensions, if any)
    • working online (via HTTP) or local (document on hard drive)
  • if possible, a minimal test case (a sample document illustrating the issue, using as few components as possible)
    Tiddlyspot provides free hosting for TiddlyWiki documents.

It is advised to use a descriptive topic title and provide a concise description of the problem.

Unrelated problems should be discussed in separate threads.

by Eric

In order to test in any kind of useful way, I need a *minimal* test case that demonstrates the problem *and* eliminates as many causes as possible. Typically this is done by installing the suspected plugin "in an empty TW", [...] so that I can immediately try a *simple* test case, without needing to suss what the rest of the document is about or how it has been customized. Of course, some problems aren't reproducible with a simple test case, so the fully- customized document *must* be used, but this should be avoided if at all possible.

by FND

Generally speaking, there are a variety of reasons which could result in lack of feedback, e.g.

  • bad timing: we might simply have missed your post (e.g. due to stress, holidays etc.) - bumping the thread after a few days usually helps
  • reproducibility: it's important for us to have all the details we need to properly analyze the problem (cf. http://tiddlywiki.org/wiki/Troubleshooting)
  • unclear expectations: sometimes it's not immediately obvious what the question is (also see below)
  • mixing topics: separate issues should be discussed separate threads - this also helps recognizing which issues are still unsolved
  • excessive verbosity: concise posts often have better chances of getting a response (AKA TLDR... ); while the personal background story might be (and indeed, often is) interesting, it's usually secondary to the actual issue

[edit] See Also

Personal tools