diff --git a/editions/tw5.com/tiddlers/Docs.tid b/editions/tw5.com/tiddlers/Docs.tid index 27e7bd456..16bd03f21 100644 --- a/editions/tw5.com/tiddlers/Docs.tid +++ b/editions/tw5.com/tiddlers/Docs.tid @@ -27,6 +27,7 @@ The machinery tying those concepts together includes: * TiddlerFilters * TiddlerFields * TiddlerTemplates +* DataTiddlers * ContentType * ShadowTiddlers * [[Plugins]] @@ -88,7 +89,6 @@ When run under node.js, TiddlyWiki supports a [[command line interface|Getting s * ServerCommand * VerboseCommand * VersionCommand -* WikiTestCommand ! Miscellaneous diff --git a/editions/tw5.com/tiddlers/EmbeddingTiddlyWiki.tid b/editions/tw5.com/tiddlers/EmbeddingTiddlyWiki.tid index 78281a825..36eae9aca 100644 --- a/editions/tw5.com/tiddlers/EmbeddingTiddlyWiki.tid +++ b/editions/tw5.com/tiddlers/EmbeddingTiddlyWiki.tid @@ -3,5 +3,4 @@ tags: docs scenarios dev TiddlyWiki can be embedded into a desktop or mobile application to enable it to perform operations that are not possible from a conventional browser. -For example, Mobile Safari on iOS runs TiddlyWiki well but doesn't provide wholly practical means to persistently save changes on the device. A wrapper application can embed TiddlyWiki using the ~UIWebView control - +For example, Mobile Safari on iOS runs TiddlyWiki well but doesn't provide any practical means to persistently save changes on the device. A wrapper application can embed TiddlyWiki using the ~UIWebView control. diff --git a/editions/tw5.com/tiddlers/HelloThere.tid b/editions/tw5.com/tiddlers/HelloThere.tid index 37ba050e7..7e203c3f1 100644 --- a/editions/tw5.com/tiddlers/HelloThere.tid +++ b/editions/tw5.com/tiddlers/HelloThere.tid @@ -4,10 +4,6 @@ tags: introduction greetings type: text/vnd.tiddlywiki modified: 201208121934 -@@.alert.alert-block -''6th January 2013'' -- the TiddlyWiki5 core code is emerging from some major refactoring upheavals, and there may still be regressions that will be fixed over the next few days, along with bringing the documentation back up to date -@@ - Welcome to TiddlyWiki5, a reboot of TiddlyWiki, the reusable non-linear personal web notebook [[first released in 2004|History]]. It is a complete interactive wiki in JavaScript that can be run from a single HTML file in the browser or as a powerful [[node.js application|node.js]]. TiddlyWiki is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks -- [[tiddlers|Tiddlers]] -- and give them titles so that they can be structured with links, tags and macros. TiddlyWiki aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives. diff --git a/editions/tw5.com/tiddlers/Improvements.tid b/editions/tw5.com/tiddlers/Improvements.tid index ccaa0664e..253b86712 100644 --- a/editions/tw5.com/tiddlers/Improvements.tid +++ b/editions/tw5.com/tiddlers/Improvements.tid @@ -11,7 +11,6 @@ For end users, the important improvements include: * TiddlyWiki can now be run under [[node.js]] as well as in the browser, allowing it to be used as a personal web server * Tiddlers containing images are now supported just like WikiText tiddlers, including integrated editing of bitmap and SVG images * Uses standard Twitter Bootstrap CSS (thus enabling the use of Boostrap themes such as http://bootswatch.com) -* Syntax highlighting for JavaScript and JSON tiddlers * TiddlyWiki5 can directly build both itself and previous (2.6.x) versions of TiddlyWiki from their constituent separate files, without needing external tools The internal changes mean that TiddlyWiki5 is not compatible with previous versions, using different plugins, themes and so on. The changes to the WikiText have been carefully developed to try to maximise backwards compatibility but content prepared for previous versions of TiddlyWiki will need massaging to work properly in TiddlyWiki5. diff --git a/editions/tw5.com/tiddlers/Internals.tid b/editions/tw5.com/tiddlers/Internals.tid index 438181796..fa83021ea 100644 --- a/editions/tw5.com/tiddlers/Internals.tid +++ b/editions/tw5.com/tiddlers/Internals.tid @@ -54,26 +54,14 @@ TiddlyWiki is built on a [[tiny microkernel|BootMechanism]] with all functionali * WikiMethodModules * WikiTextRuleModules -! Tree Nodes +! Parsers -The ParsingMechanism and the RenderingMechanism use a simple tree structure to represent both parsed WikiText and the HTML DOM structure of rendered content. +TiddlyWiki processes [[ContentTypes|ContentType]] such as WikiText using these parsers: -* TreeNode -* ElementNode -* EntityNode -* MacroNode -* RawNode -* TextNode - -! Other Parsers - -TiddlyWiki processes other [[ContentTypes|ContentType]] than WikiText using these parsers: - -* OldWikiTextParser +* WikiTextParser * JsonParser * ImageParser * PlainTextParser -* TiddlyTextParser * JavaScriptParser ! Deserializers @@ -83,7 +71,3 @@ Deserializers are modules that read tiddlers from different text formats: * RecipeFiles * TiddlerFiles * TiddlyWikiFiles - -! Serializers - -Serializers are modules that convert tiddlers to different text formats: diff --git a/editions/tw5.com/tiddlers/TextReference.tid b/editions/tw5.com/tiddlers/TextReference.tid index 6c973959d..13c0f5eae 100644 --- a/editions/tw5.com/tiddlers/TextReference.tid +++ b/editions/tw5.com/tiddlers/TextReference.tid @@ -8,3 +8,4 @@ TextReferences are made up of several parts, most of which can be optional: * `` - the text field of the specified tiddler * `!!` - a tiddler metadata field (eg, `modified`, `modifier`, `type` etc) * `!!` - a metadata field of the current tiddler +* `##` - extracts a named property from DataTiddlers diff --git a/editions/tw5.com/tiddlers/commands/DumpCommand.tid b/editions/tw5.com/tiddlers/commands/DumpCommand.tid index 163870bc9..d618a18c0 100644 --- a/editions/tw5.com/tiddlers/commands/DumpCommand.tid +++ b/editions/tw5.com/tiddlers/commands/DumpCommand.tid @@ -5,30 +5,30 @@ tags: docs command 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 +``` \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/commands/LoadCommand.tid b/editions/tw5.com/tiddlers/commands/LoadCommand.tid index 23f4c22e3..a01443941 100644 --- a/editions/tw5.com/tiddlers/commands/LoadCommand.tid +++ b/editions/tw5.com/tiddlers/commands/LoadCommand.tid @@ -3,6 +3,6 @@ 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 +``` \ No newline at end of file diff --git a/editions/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid b/editions/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid index bd2c256d9..2d2ddcc95 100644 --- a/editions/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid +++ b/editions/tw5.com/tiddlers/commands/SaveTiddlerCommand.tid @@ -3,8 +3,6 @@ tags: docs command Save an individual tiddler as a specified ContentType, defaults to `text/html` -{{{ ---savetiddler <title> <filename> [<type>] [<withparam> <withparam>...] -}}} - -The optional `<withparams>` are substituted for `$1`, `$2` etc before parsing. +``` +--savetiddler <title> <filename> [<type>] +``` diff --git a/editions/tw5.com/tiddlers/commands/ServerCommand.tid b/editions/tw5.com/tiddlers/commands/ServerCommand.tid index 59e9b6e80..756229ef7 100644 --- a/editions/tw5.com/tiddlers/commands/ServerCommand.tid +++ b/editions/tw5.com/tiddlers/commands/ServerCommand.tid @@ -3,21 +3,21 @@ 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") diff --git a/editions/tw5.com/tiddlers/commands/VerboseCommand.tid b/editions/tw5.com/tiddlers/commands/VerboseCommand.tid index cf111d6f3..b832e9c94 100644 --- a/editions/tw5.com/tiddlers/commands/VerboseCommand.tid +++ b/editions/tw5.com/tiddlers/commands/VerboseCommand.tid @@ -3,6 +3,6 @@ tags: docs command Triggers verbose output, useful for debugging -{{{ +``` --verbose -}}} +``` diff --git a/editions/tw5.com/tiddlers/commands/VersionCommand.tid b/editions/tw5.com/tiddlers/commands/VersionCommand.tid index ed662f878..4fd683a4c 100644 --- a/editions/tw5.com/tiddlers/commands/VersionCommand.tid +++ b/editions/tw5.com/tiddlers/commands/VersionCommand.tid @@ -3,6 +3,6 @@ tags: docs command Displays the version number of TiddlyWiki. -{{{ +``` --version -}}} \ No newline at end of file +``` diff --git a/readme.md b/readme.md index af9314d6d..bcc666536 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,4 @@ -<h1 class=''>Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a></h1><div class='tw-transclude'><p class='alert alert-block'><strong>6th January 2013</strong> – the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> core code is emerging from some major refactoring upheavals, and there may still be regressions that will be fixed over the next few days, along with bringing the documentation back up to date -</p><p>Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a>, a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a>, the reusable non-linear personal web notebook <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='History'>first released in 2004</a>. It is a complete interactive wiki in <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> that can be run from a single HTML file in the browser or as a powerful <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='node.js'>node.js application</a>.</p><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks – <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Tiddlers'>tiddlers</a> – and give them titles so that they can be structured with links, tags and macros. <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> has many <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Improvements'>improvements</a> over the original. It is currently labelled alpha, meaning it is working but incomplete. It is the best possible time to get involved and support its future development. You can:</p><ul><li>Explore its features online at <a class='tw-tiddlylink tw-tiddlylink-external' href='http://five.tiddlywiki.com/'>http://five.tiddlywiki.com/</a></li><li>Get involved in the <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>development on GitHub</a></li><li>Join the discussions on <a class='tw-tiddlylink tw-tiddlylink-external' href='http://groups.google.com/group/TiddlyWikiDev'>the TiddlyWikiDev Google Group</a></li><li>Follow <a class='tw-tiddlylink tw-tiddlylink-external' href='http://twitter.com/#!/TiddlyWiki'>@TiddlyWiki on Twitter</a> for the latest news</li></ul></div><h1 class=''>Usage</h1><div class='tw-transclude tw-tiddler-missing'/><h1 class=''>Architecture</h1><div class='tw-transclude'><h1 class=''>Overview</h1><p>The heart of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='ContentType'>ContentType</a>, the engine can produce a rendering of the tiddler in a new <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='ContentType'>ContentType</a>. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.</p><p>The primary use of the engine is to convert raw <code>text/vnd.tiddlywiki</code> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='WikiText'>WikiText</a> into a <code>text/html</code> or <code>text/plain</code> representation for display. The transclusion and templating features of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='WikiText'>WikiText</a> allow the engine to also be used to generate <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> HTML files from raw tiddlers.</p><p>You can explore this mechanism by opening the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> console in your browser. Typing this command will replace the text of the tiddler <code>HelloThere</code> with new content:</p><pre>$tw.wiki.addTiddler({title: "HelloThere", text: "This is some new content"});</pre><p>If the tiddler <code>HelloThere</code> is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist then you'll see any displayed links to it instantly change from italicised to normal:</p><pre>$tw.wiki.addTiddler({title: "TiddlyWiki5", text: "This tiddler now exists"});</pre><p>If you're interested in understanding more about the internal operation of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a>, it is recommended that you review the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Docs'>Docs</a> and read the code – start with the boot kernel <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='%24%3A%2Fcore%2Fboot.js'>$:/core/boot.js</a>. +<h1 class=''>Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a></h1><div class='tw-transclude'><p>Welcome to <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a>, a reboot of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a>, the reusable non-linear personal web notebook <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='History'>first released in 2004</a>. It is a complete interactive wiki in <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> that can be run from a single HTML file in the browser or as a powerful <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='node.js'>node.js application</a>.</p><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> is designed to fit around your brain, giving you a better way of managing information than traditional documents and emails. The fundamental idea is that information is more useful and reusable if we cut it up into the smallest semantically meaningful chunks – <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Tiddlers'>tiddlers</a> – and give them titles so that they can be structured with links, tags and macros. <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> aims to provide a fluid interface for working with tiddlers, allowing them to be aggregated and composed into longer narratives.</p><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> has many <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Improvements'>improvements</a> over the original. It is currently labelled alpha, meaning it is working but incomplete. It is the best possible time to get involved and support its future development. You can:</p><ul><li>Explore its features online at <a class='tw-tiddlylink tw-tiddlylink-external' href='http://five.tiddlywiki.com/'>http://five.tiddlywiki.com/</a></li><li>Get involved in the <a class='tw-tiddlylink tw-tiddlylink-external' href='https://github.com/Jermolene/TiddlyWiki5'>development on GitHub</a></li><li>Join the discussions on <a class='tw-tiddlylink tw-tiddlylink-external' href='http://groups.google.com/group/TiddlyWikiDev'>the TiddlyWikiDev Google Group</a></li><li>Follow <a class='tw-tiddlylink tw-tiddlylink-external' href='http://twitter.com/#!/TiddlyWiki'>@TiddlyWiki on Twitter</a> for the latest news</li></ul></div><h1 class=''>Usage</h1><div class='tw-transclude tw-tiddler-missing'/><h1 class=''>Architecture</h1><div class='tw-transclude'><h1 class=''>Overview</h1><p>The heart of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> can be seen as an extensible representation transformation engine. Given the text of a tiddler and its associated <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='ContentType'>ContentType</a>, the engine can produce a rendering of the tiddler in a new <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='ContentType'>ContentType</a>. Furthermore, it can efficiently selectively update the rendering to track any changes in the tiddler or its dependents.</p><p>The primary use of the engine is to convert raw <code>text/vnd.tiddlywiki</code> <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='WikiText'>WikiText</a> into a <code>text/html</code> or <code>text/plain</code> representation for display. The transclusion and templating features of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='WikiText'>WikiText</a> allow the engine to also be used to generate <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> HTML files from raw tiddlers.</p><p>You can explore this mechanism by opening the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> console in your browser. Typing this command will replace the text of the tiddler <code>HelloThere</code> with new content:</p><pre>$tw.wiki.addTiddler({title: "HelloThere", text: "This is some new content"});</pre><p>If the tiddler <code>HelloThere</code> is visible then you'll see it instantly change to reflect the new content. If you create a tiddler that doesn't currently exist then you'll see any displayed links to it instantly change from italicised to normal:</p><pre>$tw.wiki.addTiddler({title: "TiddlyWiki5", text: "This tiddler now exists"});</pre><p>If you're interested in understanding more about the internal operation of <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a>, it is recommended that you review the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Docs'>Docs</a> and read the code – start with the boot kernel <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='%24%3A%2Fcore%2Fboot.js'>$:/core/boot.js</a>. </p></div><h1 class=''>Boot Mechanism</h1><div class='tw-transclude'><h1 class=''>Introduction</h1><p><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a> is based on a 1,000 line boot kernel that runs on node.js or in the browser, with all other functionality added via dynamically loaded modules.</p><p>The kernel boots just enough of the <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> environment to allow it to load tiddlers and execute <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> modules. Plugin modules are written like <code>node.js</code> modules.</p><p>There are many <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='ModuleType'>different types of module</a>: parsers, serializers, deserializers, macros etc. It goes much further than you might expect. For example, individual tiddler fields are modules, too: there's a module that knows how to handle the <code>tags</code> field, and another that knows how to handle the special behaviour of the <code>modified</code> and <code>created</code> fields.</p><p>Some plugin modules have further sub-plugins: the wikitext parser, for instance, accepts rules as individual plugin modules.</p><h1 class=''>Plugins and Modules</h1><p>In <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a>, <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Plugins'>Plugins</a> are bundles of tiddlers that are distributed and managed as one; <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='Modules'>Modules</a> are <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> tiddlers with a module type identifying when and how they should be executed.</p><p>The tiddler <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='%24%3A%2Fcore%2Fboot.js'>$:/core/boot.js</a> is a barebones <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-resolves' href='TiddlyWiki'>TiddlyWiki</a> kernel that is just sufficient to load the core plugin modules and trigger a startup module to load up the rest of the application.</p><p>The kernel includes:</p><ul><li>Several short shared utility functions</li><li>A handful of methods implementing the plugin module mechanism</li><li>The <code>$tw.Tiddler</code> class (and field definition plugins)</li><li>The <code>$tw.Wiki</code> class (and tiddler deserialization methods)</li><li>Code for the browser to load tiddlers from the HTML DOM</li><li>Code for the server to load tiddlers from the file system</li></ul><p>Each module is an ordinary <code>node.js</code>-style module, using the <code>require()</code> function to access other modules and the <code>exports</code> global to return <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> values. The boot kernel smooths over the differences between <code>node.js</code> and the browser, allowing the same plugin modules to execute in both environments.</p><p>In the browser, <code>core/boot.js</code> is packed into a template HTML file that contains the following elements in order:</p><ul><li>Ordinary and shadow tiddlers, packed as HTML <code><DIV></code> elements</li><li><code>core/bootprefix.js</code>, containing a few lines to set up the plugin environment</li><li><a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='JavaScript'>JavaScript</a> modules, packed as HTML <code><SCRIPT></code> blocks</li><li><code>core/boot.js</code>, containing the boot kernel</li></ul><p>On the server, <code>core/boot.js</code> is executed directly. It uses the <code>node.js</code> local file API to load plugins directly from the file system in the <code>core/modules</code> directory. The code loading is performed synchronously for brevity (and because the system is in any case inherently blocked until plugins are loaded).</p><p>The boot kernel sets up the <code>$tw</code> global variable that is used to store all the state data of the system. </p></div><p><em>This <code>readme</code> file was automatically generated by <a class='tw-tiddlylink tw-tiddlylink-internal tw-tiddlylink-missing' href='TiddlyWiki5'>TiddlyWiki5</a></em> </p> \ No newline at end of file