Naming Conventions
Common Variable/Parameter names (with associated types)
| tiddler | JavaScript? Tiddler object |
|
| tiddlerElem | tiddler DOM object |
|
| title | Title of a tiddler (String) (if "title" is ambiguous in the given context, use "tiddlerTitle") |
|
| tiddlerOrTitle | either JS Tiddler object or tiddler title (rare case, e.g. used in resolveTiddler or TiddlyWiki.getValue)
|
| e | DOM Element |
|
| btn | Button (DOM element) |
|
| txt | Textfield (DOM element) | Exception: config.options
|
| s | String |
|
| ev | Event |
|
| ex | Exception |
|
| n | Integer (number/count/length) |
|
| i,j,k,... | Integer (iterator) |
|
| c | Character (1 char string) |
|
| re | RegExp? (may also use a "...RegExp?" suffix to indicate a RegExp? variable) |
|
| m | Match (of a RegExp?) |
|
| w | Wikifier
|
| place | DOM element | don't use "output"
|
Common Abbreviations
| cur | current
|
| def | default
|
| dest | destination
|
| fld | field
|
| src | source
|
| val | value
|
avoid "the" or "a" prefixes in (variable/parameter) names (like in "theClass" or "aName")