Note: An alternative skin, TW4MW (work in progress), is available from the user preferences.

Dev:Macros

TiddlyWiki Community Wiki

Jump to: navigation, search

A macro is a specialized form of TiddlyWiki plugin that is invoked in a particular tiddler. See Plugin Development for more information on developing them.

[edit] Macro Execution

Each macro has a handler (config.macros.*.handler) as well as an optional initialization (config.macros.*.init) method.

The init function is executed on document startup and takes no arguments.

Macro handlers are invoked when the respective macro is being rendered and are passed the following arguments:

  • place: the respective macro call's containing DOM object
  • macroName: the respective macro's name
  • params: parameters retrieved from the macro call, as an array
  • wikifier: the wikifier object being used
  • paramString: parameters retrieved from the macro call, as a string
  • tiddler: the respective macro call's containing tiddler

[edit] See Also

Personal tools