mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 17:10:29 +00:00
Code Issues Releases Wiki Activity

Update JS macro docs

Browse Source
This commit is contained in:
Jermolene 2014-04-24 11:08:22 +01:00
parent 39ef0ad88f
commit fecf3a556f
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
editions/tw5.com/tiddlers/dev/JavaScript Macros.tid
View File

@ -1,5 +1,5 @@
created: 20131211222303769
modified: 20140120130146763
modified: 20140424130146763
tags: dev
title: JavaScript Macros
type: text/vnd.tiddlywiki
@ -25,3 +25,8 @@ There are several JavaScript macros built into the core which can serve as a jum
https://github.com/Jermolene/TiddlyWiki5/tree/master/core/modules/macros
Note that JavaScript macros work on both the client and the server, and so do not have access to the browser DOM.
!! Macro Behaviour
Macros are just used to return a chunk of wikitext for further processing. They should not make modifications to tiddlers in the wiki store. The reason is that you cannott control when the macro is called; it may be called repeatedly as part of refresh processing. So it is important that macros do not have any other side effects beyond generating their text.