Extended HTML syntax is used in the Shadow Tiddlers that define the structure and layout of a TW. The main shadow tiddlers are PageTemplate, EditTemplate, ViewTemplate.
It allows users to use TW macros and plugins within their TW document and not just in their tiddlers. An example from the ViewTemplate would be:
When encountered it is often interpreted by the wikify() method. When wikify() recognizes the embedded macro syntax, it calls on invokeMacro(), which automatically sets a global window.tiddler variable to point to the current tiddler object that is being rendered. This enables the macro's parameter processing to use "evaluated parameters" that reference values within that tiddler object, like this:
Note: for security reasons evaluated parameters were turned off in TiddlySpace
If and when the calculation and substitution of evaluated parameters is complete, invokeMacro then passes the parameter values onward for further rendering by the appropriate macro handler function:
It allows users to use TW macros and plugins within their TW document and not just in their tiddlers. An example from the ViewTemplate would be:
<div class='title' macro='view title text'></div>More generically:
<... macro='macroName param param' ..>>
When encountered it is often interpreted by the wikify() method. When wikify() recognizes the embedded macro syntax, it calls on invokeMacro(), which automatically sets a global window.tiddler variable to point to the current tiddler object that is being rendered. This enables the macro's parameter processing to use "evaluated parameters" that reference values within that tiddler object, like this:
<... someMacro ... {{tiddler.title}} ...>
Note: prior to TW2.4.3, you needed TiddlyTools' CoreTweaks #444, which added the global window.tiddler (and window.place) variables to the invokeMacro() function. Starting with TW2.4.3, this functionality was added to the core.Note: for security reasons evaluated parameters were turned off in TiddlySpace
If and when the calculation and substitution of evaluated parameters is complete, invokeMacro then passes the parameter values onward for further rendering by the appropriate macro handler function:
config.macros.someMacro.handler(place,tiddler,params,wikifier,paramString,tiddler)For example in the view title example this would be:
config.macros.view.handler(place,tiddler,params,wikifier,paramString,tiddler)Note: Typically, the tiddler parameter passed to the macro handler function is the same as the 'current tiddler' that is being rendered. However, when you use the "" macro to transclude content from other tiddlers, the tiddler param that is passed to any macros within the transcluded tiddler will reference that transcluded tiddler, rather than the outer current tiddler that is being rendered.