mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-25 01:20:30 +00:00
1ff1390863
Been playing with the railraod plugin and I thought I'd try my hand at writing some syntax specs for the MultiTiddlerFiles tiddler.
37 lines
1.2 KiB
Plaintext
37 lines
1.2 KiB
Plaintext
created: 20140209143652456
|
|
modified: 20150621182140407
|
|
tags: [[TiddlyWiki on Node.js]]
|
|
title: MultiTiddlerFiles
|
|
type: text/vnd.tiddlywiki
|
|
|
|
MultiTiddlerFiles allow multiple tiddlers to be concisely represented in a single text file.
|
|
|
|
The goals of this format are:
|
|
|
|
* To be easy to type and easy to read
|
|
* Optimised for single line strings
|
|
* To allow common fields or tags to be shared within groups of tiddlers
|
|
* To be simple to process with external tools
|
|
|
|
MultiTiddlerFiles have the extension `multids`. The file is structured as a block of shared fields followed by a blank line. The rest of the file is a sequence of comments and tiddlers. Tiddlers are specified by their title, followed by a colon, at least one space character, and then the rest of the line is the text field for the tiddler.
|
|
|
|
For example:
|
|
|
|
```
|
|
title: $:/language/ControlPanel/
|
|
tags: strings
|
|
modifier: JoeBloggs
|
|
|
|
Basics/Caption: Basics
|
|
# This is a comment
|
|
Basics/Version: ~TiddlyWiki Version
|
|
```
|
|
|
|
This example defines two tiddlers, [[$:/language/ControlPanel/Basics/Caption]] and [[$:/language/ControlPanel/Basics/Version]].
|
|
|
|
If a `title` field is specified in the header then it is treated as a prefix for the individual tiddlers defined in the title.
|
|
|
|
!! Syntax Specification
|
|
|
|
{{MultiTiddlerFileSyntax}}
|