diff --git a/readme.md b/readme.md index 33d60d98d..0423dde99 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -

Welcome to TiddlyWiki5

Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful node.js application.

TiddlyWiki5 is currently at version 5.0.0.a2 and is under active development, which is to say that it is useful but incomplete. You can try out the online prototype at http://tiddlywiki.com/tiddlywiki5, try out the command line incarnation, get involved in the development on GitHub or join the discussions on the TiddlyWikiDev Google Group.

Usage

TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlerFiles and TiddlyWikiFiles. For example, this loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:

node core/boot.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html

Usage

Running boot.js from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces. The commands are identified by the prefix --.

node core/boot.js [--<option> [<arg>[,<arg>]]]

Commands

The following commands are available.

load

Load tiddlers from 2.x.x TiddlyWiki files (.html), .tiddler, .tid, .json or other files 

--load <filepath>

savetiddler

Save an individual tiddler as a specified MIME type, defaults to text/html 

--savetiddler <title> <filename> [<type>]

wikitest

Run wikification tests against the tiddlers in the given directory. Include the save flag to save the test result files as the new targets.

--wikitest <dir> [save]

--wikitest looks for *.tid files in the specified folder. It then wikifies the tiddlers to both "text/plain" and "text/html" format and checks the results against the content of the *.html and *.txt files in the same directory.

server

The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for GET, PUT and DELETE.

--server <port> <roottiddler> <rendertype> <servetype>

For example:

--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html

The parameters are:

--server <port> <roottiddler> <rendertype> <servetype>

dump tiddlers

Dump the titles of the tiddlers in the wiki store 

--dump tiddlers

dump tiddler

Dump the fields of an individual tiddler 

--dump tiddler <title>

dump shadows

Dump the titles of the shadow tiddlers in the wiki store 

--dump shadows

dump config

Dump the current core configuration 

--dump config

verbose

Triggers verbose output, useful for debugging 

--verbose

Architecture

Overview

The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated MIME type, the engine can produce a rendering of the tiddler in a new MIME type. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.

The most important transformations are from text/x-tiddlywiki wikitext into text/html or text/plain but the engine is used throughout the system for other transformations, such as converting images for display in HTML, sanitising fragments of JavaScript, and processing CSS.

The key feature of wikitext is the ability to include one tiddler within another (usually referred to as transclusion). For example, one could have a tiddler called Disclaimer that contains the boilerplate of a legal disclaimer, and then include it within lots of different tiddlers with the macro call <<tiddler Disclaimer>>. This simple feature brings great power in terms of encapsulating and reusing content, and evolving a clean, usable implementation architecture to support it efficiently is a key objective of the TiddlyWiki5 design.

It turns out that the transclusion capability combined with the selective refreshing mechanism provides a good foundation for building TiddlyWiki's user interface itself. Consider, for example, the StoryMacro in its simplest form:

<<story story:MyStoryTiddler>>

The story macro looks for a list of tiddler titles in the tiddler MyStoryTiddler, and displays them in sequence. The subtle part is that subsequently, if MyStoryTiddler changes, the <<story>> macro is selectively re-rendered. So, to navigate to a new tiddler, code merely needs to add the name of the tiddler and a line break to the top of MyStoryTiddler:

var storyTiddler = store.getTiddler("MyStoryTiddler");
+
 Welcome to TiddlyWiki5
Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the venerable, reusable non-linear personal web notebook first released in 2004. It is a complete interactive wiki that can run from a single HTML file in the browser or as a powerful node.js application.
TiddlyWiki5 is currently at version 5.0.0.a2 and is under active development, which is to say that it is useful but incomplete. You can try out the online prototype at http://tiddlywiki.com/tiddlywiki5, try out the command line incarnation, get involved in the development on GitHub or join the discussions on the TiddlyWikiDev Google Group.
 Usage
 Architecture
 Overview
The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
The most important transformations are from text/x-tiddlywiki wikitext into text/html or text/plain but the engine is used throughout the system for other transformations, such as converting images for display in HTML, sanitising fragments of JavaScript, and processing CSS.
The key feature of wikitext is the ability to include one tiddler within another (usually referred to as transclusion). For example, one could have a tiddler called Disclaimer that contains the boilerplate of a legal disclaimer, and then include it within lots of different tiddlers with the macro call <<tiddler Disclaimer>>. This simple feature brings great power in terms of encapsulating and reusing content, and evolving a clean, usable implementation architecture to support it efficiently is a key objective of the TiddlyWiki5 design.
It turns out that the transclusion capability combined with the selective refreshing mechanism provides a good foundation for building TiddlyWiki's user interface itself. Consider, for example, the StoryMacro in its simplest form:
<<story story:MyStoryTiddler>>
The story macro looks for a list of tiddler titles in the tiddler MyStoryTiddler, and displays them in sequence. The subtle part is that subsequently, if MyStoryTiddler changes, the <<story>> macro is selectively re-rendered. So, to navigate to a new tiddler, code merely needs to add the name of the tiddler and a line break to the top of MyStoryTiddler:
var storyTiddler = store.getTiddler("MyStoryTiddler");
 store.addTiddler(new Tiddler(storyTiddler,{text: navigateTo + "\n" + storyTiddler.text}));
The mechanisms that allow all of this to work are fairly intricate. The sections below progressively build the key architectural concepts of TiddlyWiki5 in a way that should provide a good basis for exploring the code directly.
 Plugin Mechanism
Introduction
TiddlyWiki5 is based on a 500 line boot kernel that runs on node.js or in the browser, and everything else is plugins.
The kernel boots just enough of the TiddlyWiki environment to allow it to load tiddlers as plugins and execute them (a barebones tiddler class, a barebones wiki store class, some utilities etc.). Plugin modules are written like node.js modules; you can use require() to invoke sub components and to control load order.
There are several different types of plugins: parsers, serializers, deserializers, macros etc. It goes much further than you might expect. For example, individual tiddler fields are plugins, too: there's a plugin that knows how to handle the tags field, and another that knows how to handle the special behaviour of
 the modified and created fields.
Some plugins have further sub-plugins: the wikitext parser, for instance, accepts rules as individual plugins.
Plugins and Modules
In TiddlyWiki5, a plugin is a bundle of related tiddlers that are distributed together as a single unit. Plugins can include tiddlers which are JavaScript modules. 
The file core/boot.js is a barebones TiddlyWiki kernel that is just sufficient to load the core plugin modules and trigger a startup plugin module to load up the rest of the application.
The kernel includes:
  •  Eight short shared utility functions
  •  Three methods implementing the plugin module mechanism
  •  The $tw.Tiddler class (and three field definition plugins)
  •  The $tw.Wiki class (and three tiddler deserialization methods)
  •  Code for the browser to load tiddlers from the HTML DOM
  •  Code for the server to load tiddlers from the file system
Each module is an ordinary node.js-style module, using the require() function to access other modules and the exports global to return JavaScript values. The boot kernel smooths over the differences between node.js and the browser, allowing the same plugin modules to execute in both environments.
In the browser, core/boot.js is packed into a template HTML file that contains the following elements in order:
  •  Ordinary and shadow tiddlers, packed as HTML <DIV> elements
  •  core/bootprefix.js, containing a few lines to set up the plugin environment
  •  Plugin JavaScript modules, packed as HTML <SCRIPT> blocks
  •  core/boot.js, containing the boot kernel
On the server, core/boot.js is executed directly. It uses the node.js local file API to load plugins directly from the file system in the core/modules directory. The code loading is performed synchronously for brevity (and because the system is in any case inherently blocked until plugins are loaded).
The boot kernel sets up the $tw global variable that is used to store all the state data of the system.
Core 
The 'core' is the boot kernel plus the set of plugin modules that it loads. It contains plugins of the following types:
  •  tiddlerfield - defines the characteristics of tiddler fields of a particular name
  •  tiddlerdeserializer - methods to extract tiddlers from text representations or the DOM
  •  startup - functions to be called by the kernel after booting
  •  global - members of the $tw global
  •  config - values to be merged over the $tw.config global
  •  utils - general purpose utility functions residing in $tw.utils
  •  tiddlermethod - additional methods for the $tw.Tiddler class
  •  wikimethod - additional methods for the $tw.Wiki class
  •  treeutils - static utility methods for parser tree nodes 
  •  treenode - classes of parser tree nodes
  •  macro - macro definitions
  •  editor - interactive editors for different types of content
  •  parser - parsers for different types of content
  •  wikitextrule - individual rules for the wikitext parser
  •  command - individual commands for the $tw.Commander class
TiddlyWiki5 makes extensive use of JavaScript inheritance:
  •  Tree nodes defined in $:/core/treenodes/ all inherit from $:/core/treenodes/node.js
  •  Macros defined in $:/core/macros/ all inherit from $:/core/treenodes/macro.js
tiddlywiki.plugin files
 
This readme file was automatically generated by TiddlyWiki5
diff --git a/tw5.com/tiddlers/Command Line Sketch.jpg b/tw5.com/tiddlers/Command Line Sketch.jpg
deleted file mode 100644
index 83f6e8167..000000000
Binary files a/tw5.com/tiddlers/Command Line Sketch.jpg and /dev/null differ
diff --git a/tw5.com/tiddlers/Command Line Sketch.jpg.meta b/tw5.com/tiddlers/Command Line Sketch.jpg.meta
deleted file mode 100644
index 4578890a3..000000000
--- a/tw5.com/tiddlers/Command Line Sketch.jpg.meta	
+++ /dev/null
@@ -1,4 +0,0 @@
-title: Command Line Sketch.jpg
-modifier: JeremyRuston
-type: image/jpeg
-tags: picture
diff --git a/tw5.com/tiddlers/Main Screen Sketch.jpg b/tw5.com/tiddlers/Main Screen Sketch.jpg
deleted file mode 100644
index 456dc4408..000000000
Binary files a/tw5.com/tiddlers/Main Screen Sketch.jpg and /dev/null differ
diff --git a/tw5.com/tiddlers/Main Screen Sketch.jpg.meta b/tw5.com/tiddlers/Main Screen Sketch.jpg.meta
deleted file mode 100644
index bb1699595..000000000
--- a/tw5.com/tiddlers/Main Screen Sketch.jpg.meta	
+++ /dev/null
@@ -1,4 +0,0 @@
-title: Main Screen Sketch.jpg
-modifier: JeremyRuston
-type: image/jpeg
-tags: picture
diff --git a/tw5.com/tiddlers/SiteSubtitle.tid b/tw5.com/tiddlers/SiteSubtitle.tid
deleted file mode 100644
index 256e89024..000000000
--- a/tw5.com/tiddlers/SiteSubtitle.tid
+++ /dev/null
@@ -1,4 +0,0 @@
-title: SiteSubtitle
-modifier: JeremyRuston
-
-a reusable non-linear personal web notebook
\ No newline at end of file
diff --git a/tw5.com/tiddlers/SiteTitle.tid b/tw5.com/tiddlers/SiteTitle.tid
deleted file mode 100644
index 5280b839a..000000000
--- a/tw5.com/tiddlers/SiteTitle.tid
+++ /dev/null
@@ -1,4 +0,0 @@
-title: SiteTitle
-modifier: JeremyRuston
-
-TiddlyWiki5
\ No newline at end of file
diff --git a/tw5.com/tiddlers/TiddlyWikiArchitecture.tid b/tw5.com/tiddlers/TiddlyWikiArchitecture.tid
index f2d7de5b5..8724c891c 100644
--- a/tw5.com/tiddlers/TiddlyWikiArchitecture.tid
+++ b/tw5.com/tiddlers/TiddlyWikiArchitecture.tid
@@ -4,7 +4,7 @@ tags: docs internals
 
 !! Overview
 
-The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated MIME type, the engine can produce a rendering of the tiddler in a new MIME type. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
+The heart of TiddlyWiki can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated ContentType, the engine can produce a rendering of the tiddler in a new ContentType. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.
 
 The most important transformations are from `text/x-tiddlywiki` wikitext into `text/html` or `text/plain` but the engine is used throughout the system for other transformations, such as converting images for display in HTML, sanitising fragments of JavaScript, and processing CSS.
 
diff --git a/tw5.com/tiddlers/TryingOutTiddlyWiki.tid b/tw5.com/tiddlers/TryingOutTiddlyWiki.tid
deleted file mode 100644
index 142a823c8..000000000
--- a/tw5.com/tiddlers/TryingOutTiddlyWiki.tid
+++ /dev/null
@@ -1,7 +0,0 @@
-title: TryingOutTiddlyWiki
-tags: introduction
-
-For trying TiddlyWiki5 out under node.js, two batch files are provided:
-
-* `run.sh` runs the wikitests
-* `bld.sh` builds the new TiddlyWiki 5 HTML file (placed in the `tmp/tw5/` directory by default)
diff --git a/tw5.com/tiddlers/View Switcher Sketch.jpg b/tw5.com/tiddlers/View Switcher Sketch.jpg
deleted file mode 100644
index d7a2c3593..000000000
Binary files a/tw5.com/tiddlers/View Switcher Sketch.jpg and /dev/null differ
diff --git a/tw5.com/tiddlers/View Switcher Sketch.jpg.meta b/tw5.com/tiddlers/View Switcher Sketch.jpg.meta
deleted file mode 100644
index ba01145b0..000000000
--- a/tw5.com/tiddlers/View Switcher Sketch.jpg.meta	
+++ /dev/null
@@ -1,4 +0,0 @@
-title: View Switcher Sketch.jpg
-modifier: JeremyRuston
-type: image/jpeg
-tags: picture
diff --git a/tw5.com/tiddlers/commands/DumpCommand.tid b/tw5.com/tiddlers/commands/DumpCommand.tid
new file mode 100644
index 000000000..163870bc9
--- /dev/null
+++ b/tw5.com/tiddlers/commands/DumpCommand.tid
@@ -0,0 +1,34 @@
+title: DumpCommand
+tags: docs command
+
+!!! dump tiddlers
+
+Dump the titles of the tiddlers in the wiki store 
+
+{{{
+--dump tiddlers
+}}}
+
+!!! dump tiddler
+
+Dump the fields of an individual tiddler 
+
+{{{
+--dump tiddler 
+}}}
+
+!!! dump shadows
+
+Dump the titles of the shadow tiddlers in the wiki store 
+
+{{{
+--dump shadows
+}}}
+
+!!! dump config
+
+Dump the current core configuration 
+
+{{{
+--dump config
+}}}
\ No newline at end of file
diff --git a/tw5.com/tiddlers/commands/LoadCommand.tid b/tw5.com/tiddlers/commands/LoadCommand.tid
new file mode 100644
index 000000000..23f4c22e3
--- /dev/null
+++ b/tw5.com/tiddlers/commands/LoadCommand.tid
@@ -0,0 +1,8 @@
+title: LoadCommand
+tags: docs command
+
+Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files 
+
+{{{
+--load <filepath>
+}}}
\ No newline at end of file
diff --git a/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid b/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid
new file mode 100644
index 000000000..5cf01698a
--- /dev/null
+++ b/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid
@@ -0,0 +1,8 @@
+title: SaveTiddlerCommand
+tags: docs command
+
+Save an individual tiddler as a specified ContentType, defaults to `text/html` 
+
+{{{
+--savetiddler <title> <filename> [<type>]
+}}}
diff --git a/tw5.com/tiddlers/commands/ServerCommand.tid b/tw5.com/tiddlers/commands/ServerCommand.tid
new file mode 100644
index 000000000..59e9b6e80
--- /dev/null
+++ b/tw5.com/tiddlers/commands/ServerCommand.tid
@@ -0,0 +1,25 @@
+title: ServerCommand
+tags: docs command
+
+The server is very simple. At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.
+
+{{{
+--server <port> <roottiddler> <rendertype> <servetype>
+}}}
+
+For example:
+
+{{{
+--server 8080 $:/core/tiddlywiki5.template.html text/plain text/html
+}}}
+
+The parameters are:
+
+{{{
+--server <port> <roottiddler> <rendertype> <servetype>
+}}}
+
+* ''port'' - port number to serve from (defaults to "8080")
+* ''roottiddler'' - the tiddler to serve at the root (defaults to "$:/core/tiddlywiki5.template.html") 
+* ''rendertype'' - the content type to which the root tiddler should be rendered (defaults to "text/plain")
+* ''servetype'' - the content type with which the root tiddler should be served (defaults to "text/html")
diff --git a/tw5.com/tiddlers/commands/VerboseCommand.tid b/tw5.com/tiddlers/commands/VerboseCommand.tid
new file mode 100644
index 000000000..cf111d6f3
--- /dev/null
+++ b/tw5.com/tiddlers/commands/VerboseCommand.tid
@@ -0,0 +1,8 @@
+title: VerboseCommand
+tags: docs command
+
+Triggers verbose output, useful for debugging 
+
+{{{
+--verbose
+}}}
diff --git a/tw5.com/tiddlers/commands/VersionCommand.tid b/tw5.com/tiddlers/commands/VersionCommand.tid
new file mode 100644
index 000000000..ed662f878
--- /dev/null
+++ b/tw5.com/tiddlers/commands/VersionCommand.tid
@@ -0,0 +1,8 @@
+title: VersionCommand
+tags: docs command
+
+Displays the version number of TiddlyWiki.
+
+{{{
+--version
+}}}
\ No newline at end of file
diff --git a/tw5.com/tiddlers/commands/WikiTestCommand.tid b/tw5.com/tiddlers/commands/WikiTestCommand.tid
new file mode 100644
index 000000000..c7bc96ad0
--- /dev/null
+++ b/tw5.com/tiddlers/commands/WikiTestCommand.tid
@@ -0,0 +1,10 @@
+title: WikiTestCommand
+tags: docs command
+
+Run wikification tests against the tiddlers in the given directory. Include the `save` flag to save the test result files as the new targets.
+
+{{{
+--wikitest <dir> [save]
+}}}
+
+`--wikitest` looks for `*.tid` files in the specified folder. It then wikifies the tiddlers to both "text/plain" and "text/html" format and checks the results against the content of the `*.html` and `*.txt` files in the same directory.
diff --git a/tw5.com/tiddlers/ShadowTiddlers.tid b/tw5.com/tiddlers/concepts/ShadowTiddlers.tid
similarity index 100%
rename from tw5.com/tiddlers/ShadowTiddlers.tid
rename to tw5.com/tiddlers/concepts/ShadowTiddlers.tid
diff --git a/tw5.com/tiddlers/TiddlerFilters.tid b/tw5.com/tiddlers/concepts/TiddlerFilters.tid
similarity index 100%
rename from tw5.com/tiddlers/TiddlerFilters.tid
rename to tw5.com/tiddlers/concepts/TiddlerFilters.tid
diff --git a/tw5.com/tiddlers/Tiddlers.tid b/tw5.com/tiddlers/concepts/Tiddlers.tid
similarity index 95%
rename from tw5.com/tiddlers/Tiddlers.tid
rename to tw5.com/tiddlers/concepts/Tiddlers.tid
index b0edc3c08..34d29dac0 100644
--- a/tw5.com/tiddlers/Tiddlers.tid
+++ b/tw5.com/tiddlers/concepts/Tiddlers.tid
@@ -9,4 +9,4 @@ The only field that is required is the {{{title}}} field, but useful tiddlers al
 
 Hardcoded in the system is the knowledge that the `tags` field is a string array, and that the `modified` and `created` fields are JavaScript `Date` objects. All other fields are strings.
 
-The {{{type}}} field identifies the representation of the tiddler text with a MIME type.
\ No newline at end of file
+The {{{type}}} field identifies the representation of the tiddler text with a ContentType.
\ No newline at end of file
diff --git a/tw5.com/tiddlers/TiddlyWiki.tid b/tw5.com/tiddlers/concepts/TiddlyWiki.tid
similarity index 100%
rename from tw5.com/tiddlers/TiddlyWiki.tid
rename to tw5.com/tiddlers/concepts/TiddlyWiki.tid
diff --git a/tw5.com/tiddlers/Wiki.tid b/tw5.com/tiddlers/concepts/Wiki.tid
similarity index 100%
rename from tw5.com/tiddlers/Wiki.tid
rename to tw5.com/tiddlers/concepts/Wiki.tid
diff --git a/tw5.com/tiddlers/WikiText.tid b/tw5.com/tiddlers/concepts/WikiText.tid
similarity index 100%
rename from tw5.com/tiddlers/WikiText.tid
rename to tw5.com/tiddlers/concepts/WikiText.tid
diff --git a/tw5.com/tiddlers/TiddlerFiles.tid b/tw5.com/tiddlers/deserializers/TiddlerFiles.tid
similarity index 84%
rename from tw5.com/tiddlers/TiddlerFiles.tid
rename to tw5.com/tiddlers/deserializers/TiddlerFiles.tid
index 4ff43d713..224662927 100644
--- a/tw5.com/tiddlers/TiddlerFiles.tid
+++ b/tw5.com/tiddlers/deserializers/TiddlerFiles.tid
@@ -20,7 +20,7 @@ modifier: Jeremy
 This is the text of my tiddler.
 }}}
 
-//The MIME type `application/x-tiddler` is used internally for these files//
+//The ContentType `application/x-tiddler` is used internally for these files//
 
 !! TiddlyWiki `<DIV>` .tiddler files
 
@@ -42,16 +42,16 @@ Older `*.tiddler` files more closely matched the store format used by TiddlyWiki
 <div tiddler="AnotherExampleStyleSheet" modifier="JeremyRuston" modified="200508181432" created="200508181432" tags="examples">This is an old-school .tiddler file, without an embedded <pre> tag.\nNote how the body is "HTML encoded" and new lines are escaped to \\n</div>
 }}}
 
-//The MIME type `application/x-tiddler-html-div` is used internally for these files//
+//The ContentType `application/x-tiddler-html-div` is used internally for these files//
 
 !! ~TiddlyWeb-style JSON files
 
 These files are a straightforward array of hashmaps of name:value fields. Currently only these known fields are processed: `title`, `text`, `created`, `creator`, `modified`, `modifier`, `type` and `tags`.
 
-//The MIME type `application/json` is used internally for these files//
+//The ContentType `application/json` is used internally for these files//
 
 !! TiddlyWiki HTML files
 
 TiddlyWiki HTML files contain a collection of tiddlers encoded in `<DIV>` format.
 
-//The MIME type `application/x-tiddlywiki` is used internally for these files//
+//The ContentType `application/x-tiddlywiki` is used internally for these files//
diff --git a/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid b/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid
new file mode 100644
index 000000000..ba91864d4
--- /dev/null
+++ b/tw5.com/tiddlers/guides/Getting_started_with_TiddlyWiki_under_node.js.tid
@@ -0,0 +1,28 @@
+title: Getting started with TiddlyWiki under node.js
+modifier: JeremyRuston
+tags: guide
+
+TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on tiddlers, TiddlerFiles and TiddlyWikiFiles. For example, this loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in HTML:
+
+{{{
+node core/boot.js --verbose --load mywiki.html --savetiddler ReadMe ./readme.html
+}}}
+!!Usage
+
+Running `boot.js` from the command line boots the TiddlyWiki kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces. The commands are identified by the prefix `--`.
+
+{{{
+node core/boot.js [--<option> [<arg>[,<arg>]]]
+}}}
+
+!! Batch Files
+
+For trying TiddlyWiki5 out under node.js, two batch files are provided:
+
+* `run.sh` runs the wikitests
+* `bld.sh` builds the new TiddlyWiki 5 HTML file (placed in the `tmp/tw5/` directory by default)
+
+!!Commands
+
+The following commands are available:
+
diff --git a/tw5.com/tiddlers/Motovun Jack.jpg b/tw5.com/tiddlers/images/Motovun Jack.jpg
similarity index 100%
rename from tw5.com/tiddlers/Motovun Jack.jpg
rename to tw5.com/tiddlers/images/Motovun Jack.jpg
diff --git a/tw5.com/tiddlers/Motovun Jack.jpg.meta b/tw5.com/tiddlers/images/Motovun Jack.jpg.meta
similarity index 100%
rename from tw5.com/tiddlers/Motovun Jack.jpg.meta
rename to tw5.com/tiddlers/images/Motovun Jack.jpg.meta
diff --git a/tw5.com/tiddlers/Motovun Jack.svg b/tw5.com/tiddlers/images/Motovun Jack.svg
similarity index 100%
rename from tw5.com/tiddlers/Motovun Jack.svg
rename to tw5.com/tiddlers/images/Motovun Jack.svg
diff --git a/tw5.com/tiddlers/Motovun Jack.svg.meta b/tw5.com/tiddlers/images/Motovun Jack.svg.meta
similarity index 100%
rename from tw5.com/tiddlers/Motovun Jack.svg.meta
rename to tw5.com/tiddlers/images/Motovun Jack.svg.meta
diff --git a/tw5.com/tiddlers/Tiddler Fishes.svg b/tw5.com/tiddlers/images/Tiddler Fishes.svg
similarity index 100%
rename from tw5.com/tiddlers/Tiddler Fishes.svg
rename to tw5.com/tiddlers/images/Tiddler Fishes.svg
diff --git a/tw5.com/tiddlers/Tiddler Fishes.svg.meta b/tw5.com/tiddlers/images/Tiddler Fishes.svg.meta
similarity index 100%
rename from tw5.com/tiddlers/Tiddler Fishes.svg.meta
rename to tw5.com/tiddlers/images/Tiddler Fishes.svg.meta
diff --git a/tw5.com/tiddlers/ImageMacro.tid b/tw5.com/tiddlers/macros/ImageMacro.tid
similarity index 100%
rename from tw5.com/tiddlers/ImageMacro.tid
rename to tw5.com/tiddlers/macros/ImageMacro.tid
diff --git a/tw5.com/tiddlers/SliderMacro.tid b/tw5.com/tiddlers/macros/SliderMacro.tid
similarity index 100%
rename from tw5.com/tiddlers/SliderMacro.tid
rename to tw5.com/tiddlers/macros/SliderMacro.tid
diff --git a/tw5.com/tiddlers/ParsingMechanism.tid b/tw5.com/tiddlers/mechanisms/ParsingMechanism.tid
similarity index 100%
rename from tw5.com/tiddlers/ParsingMechanism.tid
rename to tw5.com/tiddlers/mechanisms/ParsingMechanism.tid
diff --git a/tw5.com/tiddlers/PluginMechanism.tid b/tw5.com/tiddlers/mechanisms/PluginMechanism.tid
similarity index 100%
rename from tw5.com/tiddlers/PluginMechanism.tid
rename to tw5.com/tiddlers/mechanisms/PluginMechanism.tid
diff --git a/tw5.com/tiddlers/RenderingMechanism.tid b/tw5.com/tiddlers/mechanisms/RenderingMechanism.tid
similarity index 100%
rename from tw5.com/tiddlers/RenderingMechanism.tid
rename to tw5.com/tiddlers/mechanisms/RenderingMechanism.tid
diff --git a/tw5.com/tiddlers/SampleJavaScriptTiddler.tid b/tw5.com/tiddlers/samples/SampleJavaScriptTiddler.tid
similarity index 100%
rename from tw5.com/tiddlers/SampleJavaScriptTiddler.tid
rename to tw5.com/tiddlers/samples/SampleJavaScriptTiddler.tid
diff --git a/tw5.com/tiddlers/SampleJavaScriptTiddlerWithError.tid b/tw5.com/tiddlers/samples/SampleJavaScriptTiddlerWithError.tid
similarity index 100%
rename from tw5.com/tiddlers/SampleJavaScriptTiddlerWithError.tid
rename to tw5.com/tiddlers/samples/SampleJavaScriptTiddlerWithError.tid
diff --git a/tw5.com/tiddlers/SampleJsonTiddler.tid b/tw5.com/tiddlers/samples/SampleJsonTiddler.tid
similarity index 100%
rename from tw5.com/tiddlers/SampleJsonTiddler.tid
rename to tw5.com/tiddlers/samples/SampleJsonTiddler.tid
diff --git a/tw5.com/tiddlers/ImageWikiText.tid b/tw5.com/tiddlers/wikitextrules/ImageWikiText.tid
similarity index 100%
rename from tw5.com/tiddlers/ImageWikiText.tid
rename to tw5.com/tiddlers/wikitextrules/ImageWikiText.tid
diff --git a/tw5.com/tiddlers/TypedBlockTests.tid b/tw5.com/tiddlers/wikitextrules/TypedBlockWikiText.tid
similarity index 85%
rename from tw5.com/tiddlers/TypedBlockTests.tid
rename to tw5.com/tiddlers/wikitextrules/TypedBlockWikiText.tid
index 4ecee02b6..06512b4b8 100644
--- a/tw5.com/tiddlers/TypedBlockTests.tid
+++ b/tw5.com/tiddlers/wikitextrules/TypedBlockWikiText.tid
@@ -1,7 +1,7 @@
-title: TypedBlockTests
-tags: demo
+title: TypedBlockWikiText
+tags: docs wikitextrule
 
-WikiText can include blocks of text that are rendered with an explicit MIME type like this:
+WikiText can include blocks of text that are rendered with an explicit ContentType like this:
 
 {{{
 $$$application/javascript
@@ -17,7 +17,7 @@ $$$application/javascript
 var thing = 2 + "one";
 $$$
 
-It is also possible to abbreviate the MIME type to a file extension. For example:
+It is also possible to abbreviate the ContentType to a file extension. For example:
 
 {{{
 $$$.svg
diff --git a/tw5.com/wiki/SiteSubtitle.tid b/tw5.com/wiki/SiteSubtitle.tid
index a527346ee..256e89024 100644
--- a/tw5.com/wiki/SiteSubtitle.tid
+++ b/tw5.com/wiki/SiteSubtitle.tid
@@ -1,4 +1,4 @@
 title: SiteSubtitle
-type: text/x-tiddlywiki
+modifier: JeremyRuston
 
 a reusable non-linear personal web notebook
\ No newline at end of file
diff --git a/tw5.com/wiki/SiteTitle.tid b/tw5.com/wiki/SiteTitle.tid
index 4b2e182ec..5280b839a 100644
--- a/tw5.com/wiki/SiteTitle.tid
+++ b/tw5.com/wiki/SiteTitle.tid
@@ -1,4 +1,4 @@
 title: SiteTitle
-type: text/x-tiddlywiki
+modifier: JeremyRuston
 
 TiddlyWiki5
\ No newline at end of file