This page is part of a static HTML representation of the TiddlyWiki at http://tiddlywiki.com/

Macros

28th February 2015 at 11:49am

A macro is a named snippet of text. WikiText can use the name as a shorthand way of transcluding the snippet. Such transclusions are known as macro calls, and each call can supply a different set of parameters that get substituted for special placeholders within the snippet.

For the syntax, see Macros in WikiText.

Most macros are in fact just parameterised variables.

They are created using the \define pragma. (Behind the scenes, this is transformed into a $set, i.e. macros and variables are two sides of the same coin.)

The snippet and its incoming parameter values are treated as simple strings of characters with no WikiText meaning, at least until the placeholders have been filled in and the macro call has returned. This means that a macro can assemble and return the complete syntax of a WikiText component, such as a link. (See Transclusion and Substitution for further discussion of this.)

The string returned by a macro call is parsed separately from any surrounding WikiText components. So a safe way to insert a special character sequence (such as [[ or <) without triggering its normal WikiText meaning is to wrap it in a macro.

Within a snippet itself, the only markup detected is $name$ (a placeholder for a macro parameter) and $(name)$ (a placeholder for a variable).

The dumpvariables macro lists all variables (including macros) that are available at that position in the widget tree.

An $importvariables widget can be used to copy macro definitions to another branch of the widget tree. TiddlyWiki uses this technique internally to implement global macros – namely any macros defined in tiddlers with the $:/tags/Macro tag.

For maximum flexibility, macros can also be written as JavaScript modules.

A similar effect to a parameterised macro call can be produced by setting variables around a transclusion.

TiddlyWiki's core has several macros built in.