TiddlyWiki5 Syntax README
This extension adds TiddlyWiki5 syntax-highlighting and snippets to Visual Studio Code. TiddlyWiki5 is a rich, interactive tool for manipulating complex data, with structures that do not easily fit into conventional tools like spreadsheets or wordprocessors. It is a javascript environment that lives in the Browser and Node.js (and a few other implementations) which builds a Wiki/Content Management System. The design recommends building with "the smallest semantically meaningful chunks" – named tiddlers. A tiddler could be a system javascript module that is loaded on wiki boot, or a few paragraphs of user notes on a topic, or a wikitext function that build a Table of Contents out of a set of related Tags.
When run in the browser, each tiddler is a javascript object in memory (and is also represented as a json in custom <script class="tiddlywiki-tiddler-store" type="application/json"></script> element when the wiki is saved as a "single file" *.html). When run under Node.js, TiddlyWiki saves each wikitext tiddler to disk as a separate text file with a *.tid extension. Other "MIME Types" (images, json text, etc) are saved by the server along with a *.meta file that describes all other tiddler-fields (the file-content becomes the "text" field when loaded into the wiki).
This extension is intended for editing separate tiddler files on disk with Visual Studio Code.
Languages
This extension provides five languages, each with its own grammar and scope.
| language |
files |
scope |
covers |
tiddlywiki5 |
.tw, .tw5, .tiddlywiki5 |
text.html.tiddlywiki5 |
TiddlyWiki wikitext, following the rules in core/modules/parsers/wikiparser/rules |
tid |
.tid, .meta |
source.tiddlywiki5.tid-file |
the tiddler file format: a field block, a blank line, then a body parsed as wikitext |
multids |
.multids |
source.tiddlywiki5.multids-file |
the multiple-tiddler file format |
memetic-wikitext |
.mem |
text.html.tiddlywiki5.memetic-wikitext |
Memetic-Wikitext, a superset of TiddlyWiki wikitext |
tiddlywiki5.test |
.tw5.test |
text.html.tiddlywiki5.test |
the syntax-test files used to check the grammars |
Each language applies only to the file extensions listed, so adding one changes nothing about how the others behave.
Memetic-Wikitext
*.mem files open as Memetic-Wikitext (text/memetic-wikitext+tiddlywiki), a small extension of
TiddlyWiki wikitext used by the Lares agent tooling. Its scope,
text.html.tiddlywiki5.memetic-wikitext, includes the wikitext grammar, so ordinary wikitext highlights
inside a *.mem file exactly as it does in a *.tid file. On top of that it highlights four additions:
<<~ name … >> and its closing form <<~ /name >><<^ code="" … >>, a set of document-structure markerslar: URIs, highlighted as addresses where they appear in prose- named parameters written
key=value, which TiddlyWiki 5.4 accepts alongside key:value
Every addition uses syntax TiddlyWiki already parses — each of the first two reads as a macro call, and a
lar: URI reads as plain text. A *.mem file therefore loads and renders in an unmodified TiddlyWiki
without errors, and this extension simply shows more of its structure while editing.
If you do not use *.mem files, nothing here affects you: the language applies to that extension alone.
Features
Based primarily on the grammars found below, with heavy tweaking and editing.
*.tid and *.meta files have syntaxes that parse the metadata field "block" (and illegal characters detected). All field content (text field included) is parsed as text.html.tiddlywiki5 (defined in ./syntaxes/tiddlywiki5.json).
For contributors
contributing.md carries the detail. In short, the grammars answer to more than their own tests:
npm test — assertion files stating what each construct should scopenpm run snap — every sample's whole tokenization, pinned beside itnpm run canary — an ordinary sentence appended to every sample, which must stay ordinarynpm run corpus — broad ground, gated on every declared scope being reached and nothing bleedingnpm run upstream-coverage -- <path-to-TiddlyWiki5> — TiddlyWiki's own rule regexes, taken to its own tiddlersnpm run package-contents — every path the manifest names, checked inside the built packagenpm run bench — a disposable editor in a container, so you can look at the grammar with your own eyes
Known Issues
Please report issues or offer Pull Requests at the GitHub Repository:
Release Notes
Thank You for trying TiddlyWiki5 Syntax Highlighting for Visual Studio Code
Enjoy!
