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 Rendered .def the defining instance of a term <<.def widget>>widget .em minor emphasis within a sentence <<.em not>>not .place a placeholder for the user to fill in <<.place tagname>>tagname.strong major emphasis within a tiddler <<.strong Important!>>Important! .word a mention of an ordinary word or phrase <<.word "hello world">>"hello world" .icon an icon, sized to match the surrounding text <<.icon "$:/core/images/globe">>
Textboxes Textbox Parameters text Text to be shown in the box title A title shown as an HTML STRONG element icon Core icons can be found at Icon Gallery class An optional custom class can be added to the text block. It will overwrite the defaults. To keep the defaults, add them to the custom class settings. .note -macro defaults to doc-note.tip -macro defaults to doc-tip.warning -macro defaults to doc-warningTextbox Examples Macro Used for Example Renderd .infoBox Text-box with an icon <<.infoBox text:"A generic ...">>A generic text box, with an optional title and a custom icon
.note Infos with a title <<.note text:"Some text ...">>Note
Some text in a box with a title by default
.tip hints and tips <<.tip text:"Eg: Turn ...">>Tip
Eg: Turn your screen on, otherwise
you won't be able to see much.
.warning warning advice <<.warning text:"Eg: Make a backup ...">>Warning
Eg: Make a backup of your file
before you upgrade.
Blocks Macro Example Used for .preamble <<.preamble "your text comes here">>an introductory sentence that stands apart from the rest of the tiddler
Tiddlers and Fields Macro Used for Example Rendered .tid a tiddler title <<.tid Example>>Example.tag a tag <<.tag Example>>Example.field a field name <<.field example>>example.value a field value <<.value "example value">>example value.op a filter operator <<.op backlinks>>backlinks.var a variable or macro name <<.var currentTiddler>>currentTiddler.wid a widget name <<.wid list>>$list.attr an attribute name <<.attr filter>>filter.param a macro parameter name <<.param text>>text.tiddler-fields a list of tiddler fields <<.tiddler-fields "Monday">>created 20150117192113000 modified 20211116221111294 tags [[Operator Examples]] text <<.this-is-operator-example>>
type text/vnd.tiddlywiki
Links Macro Used for Example Renderd .link link containing WikiText <<.link "^^an^^ ~~example~~" Example>>an example .clink code link <<.clink `<$list>` ListWidget>><$list>.dlink definition link for a instance of a term <<.dlink widget Widgets>>widget .dlink-ex external link to a defining instance of a term <<.dlink-ex Example "http://example.com/">>Example .flink field link <<.flink ListField>>list.mlink macro link <<.mlink qualify>>qualify.mlink2 macro link with a specified target <<.mlink2 foo "Examples of Macros">>foo.olink operator link <<.olink prefix>>prefix.olink2 operator link with specified target <<.olink2 foo prefix>>foo.vlink variable link <<.vlink currentTiddler>>currentTiddler.vlink2 variable link with specified target <<.vlink2 foo "Examples of Variables">>foo.wlink widget link <<.wlink ButtonWidget>>$button.wlink2 widget link with specified text <<.wlink2 foo ButtonWidget>>foo
Keyboard Shortcuts Macro Used for Example Rendered .key a key on the keyboard <<.key Escape>>Escape .keys a key combination <<.keys Ctrl+Enter>>Ctrl+Enter
Doc-Tabs See: CheckboxWidget
Macro Used for Example .doc-tabs showing a tab set in a documentation tiddler – .doc-tab-link button to activate a tab – .widget-attr-link button with a widget attribute name to activate a tab –
Sidebar Tabs Macro Used for Example Rendered .sidebar-tab the name of a sidebar tab <<.sidebar-tab More>>More .more-tab the name of a subtab of the More tab <<.more-tab Shadows>>Shadows .info-tab the name of a tiddler info tab <<.info-tab Fields>>Fields .controlpanel-tab the name of a Control Panel tab <<.controlpanel-tab Settings>>Settings .advancedsearch-tab the name of an Advanced Search tab <<.advancedsearch-tab Filter>>Filter .toc-tab name of the tw5.com TOC tab <<.toc-tab>>Contents .example-tab an example tab name <<.example-tab "Notes">>Notes
Parameters for .sidebar-tab Open <<.sidebar-tab Open>>Open Recent <<.sidebar-tab Recent>>Recent Tools <<.sidebar-tab Tools>>Tools More <<.sidebar-tab More>>More
Parameters for .more-tab All <<.more-tab All>>All Recent <<.more-tab Recent>>Recent Tags <<.more-tab Tags>>Tags Missing <<.more-tab Missing>>Missing Drafts <<.more-tab Drafts>>Drafts Orphans <<.more-tab Orphans>>Orphans Types <<.more-tab Types>>Types System <<.more-tab System>>System Shadows <<.more-tab Shadows>>Shadows
Parameters for .info-tab Tools <<.info-tab Tools>>Tools References <<.info-tab References>>Backlinks Tagging <<.info-tab Tagging>>Tagging List <<.info-tab List>>List Listed <<.info-tab Listed>>Listed Fields <<.info-tab Fields>>Fields Advanced <<.info-tab Advanced>>Advanced
Parameters for .controlpanel-tab Info <<.controlpanel-tab Info>>Info Appearance <<.controlpanel-tab Appearance>>Appearance Settings <<.controlpanel-tab Settings>>Settings Saving <<.controlpanel-tab Saving>>Saving Plugins <<.controlpanel-tab Plugins>>Plugins
Parameters for .advancedsearch-tab Standard <<.advancedsearch-tab Standard>>Standard System <<.advancedsearch-tab System>>System Shadows <<.advancedsearch-tab Shadows>>Shadows Filter <<.advancedsearch-tab Filter>>Filter
Buttons Macro Used for Example Rendered .button a standard button name and icon <<.button "new-tiddler">>
Parameters for .button Tiddler toolbar clone <<.button "clone">>close <<.button "close">>close-others <<.button "close-others">>edit <<.button "edit">>export-tiddler <<.button "export-tiddler">>info <<.button "info">>more-tiddler-actions <<.button "more-tiddler-actions">>new-here <<.button "new-here">>new-journal-here <<.button "new-journal-here">>21 permalink <<.button "permalink">>
Edit-mode toolbar cancel <<.button "cancel">>delete <<.button "delete">>save <<.button "save">>
Page toolbar advanced-search <<.button "advanced-search">>close-all <<.button "close-all">>control-panel <<.button "control-panel">>encryption <<.button "encryption">>export-page <<.button "export-page">>full-screen <<.button "full-screen">>home <<.button "home">>import <<.button "import">>language <<.button "language">>more-page-actions <<.button "more-page-actions">>new-journal <<.button "new-journal">>21 new-tiddler <<.button "new-tiddler">>permaview <<.button "permaview">>refresh <<.button "refresh">>save-wiki <<.button "save-wiki">>
save changesstoryview <<.button "storyview">>tag-manager <<.button "tag-manager">>theme <<.button "theme">>