Documentation Macros

6th December 2021 at 8:08am

The following macros are used throughout TiddlyWiki's documentation. Their names start with a dot to keep them out of the way of names that a user might try experimenting with.

General

Macro	Used for	Example
.def	the defining instance of a term	widget
.em	minor emphasis within a sentence	not
.place	a placeholder for the user to fill in	`tagname`
.strong	major emphasis within a tiddler	Important!
.word	a mention of an ordinary word or phrase	"hello world"
.icon	an icon, sized to match the surrounding text

Advice

Macro	Used for	Example
.tip	hints and tips	Turn your screen on, otherwise you won't be able to see much.
.warning	warning advice	Make a backup of your file before you upgrade.

Blocks

Macro	Used for
.preamble	an introductory sentence that stands apart from the rest of the tiddler

Tiddlers and fields

Macro Used for Example

.tid a tiddler title Example

.tag a tag Example

.field a field name example

.value a field value example value

.op a filter operator backlinks

.var a variable or macro name currentTiddler

.wid a widget name $list

.attr an attribute name filter

.param a macro parameter name text

.tiddler-fields

a list of tiddler fields

Monday

created	20150117192113000
modified	20211116221111294
tags	[[Operator Examples]]
text	<<.this-is-operator-example>>
type	text/vnd.tiddlywiki

Links

Macro	Used for	Example
.link	a link containing WikiText	^an ~~example~~
.clink	a code link	`<$list>`
.dlink	a link on a defining instance of a term	widget
.dlink-ex	an external link on a defining instance of a term	Example
.flink	a link to a field	`list`
.mlink	a link to a macro	`qualify`
.mlink2	a link to a macro, with specified target	`foo`
.olink	a link to an operator	`prefix`
.olink2	a link to an operator, with specified target	`foo`
.vlink	a link to a variable	`currentTiddler`
.vlink2	a link to a variable, with specified target	`foo`
.wlink	a link to a widget	`$button`
.wlink2	a link to a widget, with specified text	foo

User interface

Macro	Used for	Example
.key	a key on the keyboard	Escape
.keycombo	a key combination	Ctrl+Enter

Tabs

Macro	Used for	Example
.sidebar-tab	the name of a sidebar tab	More
.more-tab	the name of a subtab of the More tab	Shadows
.info-tab	the name of a tiddler info tab	Fields
.controlpanel-tab	the name of a Control Panel tab	Settings
.advancedsearch-tab	the name of an Advanced Search tab	Filter
.toc-tab	name of the tw5.com TOC tab	Contents
.example-tab	an example tab name	Notes

Parameters for .sidebar-tab

Open	Open
Recent	Recent
Tools	Tools
More	More

Parameters for .more-tab

All	All
Recent	Recent
Tags	Tags
Missing	Missing
Drafts	Drafts
Orphans	Orphans
Types	Types
System	System
Shadows	Shadows

Parameters for .info-tab

Tools	Tools
References	Backlinks
Tagging	Tagging
List	List
Listed	Listed
Fields	Fields
Advanced	Advanced

Parameters for .controlpanel-tab

Info	Info
Appearance	Appearance
Settings	Settings
Saving	Saving
Plugins	Plugins

Parameters for .advancedsearch-tab

Standard	Standard
System	System
Shadows	Shadows
Filter	Filter

Buttons

Macro	Used for	Example
.button	a standard button name and icon	new tiddler

Parameters for .button

Tiddler toolbar

clone	clone
close	close
close-others	close others
edit	edit
export-tiddler	export tiddler
info	info
more-tiddler-actions	more
new-here	new here
new-journal-here	new journal here
permalink	permalink

Edit-mode toolbar

cancel	cancel
delete	delete
save	ok

Page toolbar

advanced-search	advanced search
close-all	close all
control-panel	control panel
encryption	encryption
export-page	export all
full-screen	full-screen
home	home
import	import
language	language
more-page-actions	more
new-journal	new journal
new-tiddler	new tiddler
permaview	permaview
refresh	refresh
save-wiki	save changes
storyview	storyview
tag-manager	tag manager
theme	theme