The parameters |renderStep |See below |
Currently, the only macro that supports rerendering is the <<story>> macro; all other macros are rerendered by calling the ordinary render() method again. The reason that the <<story>> macro goes to the trouble of having a rerender() method is so that it can be carefully selective about not disturbing tiddlers in the DOM that aren't affected by the change. If there were, for instance, a video playing in one of the open tiddlers it would be reset to the beginning if the tiddler were rerendered.
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.
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:
$tw.Tiddler class (and three field definition plugins)$tw.Wiki class (and three tiddler deserialization methods)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:
<DIV> elementscore/bootprefix.js, containing a few lines to set up the plugin environment<SCRIPT> blockscore/boot.js, containing the boot kernelOn 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.
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 nametiddlerdeserializer - methods to extract tiddlers from text representations or the DOMstartup - functions to be called by the kernel after bootingglobal - members of the $tw globalconfig - values to be merged over the $tw.config globalutils - general purpose utility functions residing in $tw.utilstiddlermethod - additional methods for the $tw.Tiddler classwikimethod - additional methods for the $tw.Wiki classtreeutils - static utility methods for parser tree nodes treenode - classes of parser tree nodesmacro - macro definitionseditor - interactive editors for different types of contentparser - parsers for different types of contentwikitextrule - individual rules for the wikitext parsercommand - individual commands for the $tw.Commander classTiddlyWiki5 makes extensive use of JavaScript inheritance:
$:/core/treenodes/ all inherit from $:/core/treenodes/node.js$:/core/macros/ all inherit from $:/core/treenodes/macro.jstiddlywiki.plugin files
-
It is proposed to extend the existing TiddlyWiki WikiText syntax with the following extensions
**bold** character formatting`backtick for code` character formattingforce\\linebreak==Heading|=|=table|=header|[[description -> link]]<<myMacro -param1: Parameter value -param2: value -"unnamed parameter" -param4: (( -A multiline parameter that can go on for as long as it likes -and contain linebreaks. -)) ->>
$$$.js - return "This will have syntax highlighting applied" - $$$
This readme file was automatically generated by TiddlyWiki5
+
This readme file was automatically generated by TiddlyWiki5