This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/

Documentation Macros

28th February 2015 at 8:28am
Improving TiddlyWiki Documentation

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

MacroUsed forExample
.defthe defining instance of a termwidget
.emminor emphasis within a sentencenot
.placea placeholder for the user to fill intagname
.strongmajor emphasis within a tiddlerImportant!
.worda mention of an ordinary word or phrase"hello world"

Advice

MacroUsed forExample
.tiphints and tips
Turn your screen on, otherwise
you won't be able to see much.
.warningwarning advice
Make a backup of your file
before you upgrade.

Blocks

MacroUsed for
.preamblean introductory sentence that stands apart from the rest of the tiddler

Tiddlers and fields

MacroUsed forExample
.tida tiddler titleExample
.taga tagExample
.fielda field nameexample
.valuea field valueexample value
.opa filter operatorbacklinks
.vara variable or macro namecurrentTiddler
.wida widget name$list
.attran attribute namefilter
.parama macro parameter nametext

Links

MacroUsed forExample
.linka link containing WikiTextan example
.clinka code link<$list>
.dlinka link on a defining instance of a termwidget
.dlink-exan external link on a defining instance of a termExample
.flinka link to a fieldlist
.mlinka link to a macroqualify
.mlink2a link to a macro, with specified targetfoo
.olinka link to an operatorprefix
.olink2a link to an operator, with specified targetfoo
.vlinka link to a variablecurrentTiddler
.vlink2a link to a variable, with specified targetfoo
.wlinka link to a widget$button
.wlink2a link to a widget, with specified textfoo

User interface

MacroUsed forExample
.keya key on the keyboardEscape
.keycomboa key combinationCtrl+Enter

Tabs

MacroUsed forExample
.sidebar-tabthe name of a sidebar tabMore
.more-tabthe name of a subtab of the More tabShadows
.info-tabthe name of a tiddler info tabFields
.controlpanel-tabthe name of a Control Panel tabSettings
.advancedsearch-tabthe name of an Advanced Search tabFilter
.toc-tabname of the tw5.com TOC tabContents
.example-taban example tab nameNotes

Parameters for .sidebar-tab

OpenOpen
RecentRecent
ToolsTools
MoreMore

Parameters for .more-tab

AllAll
RecentRecent
TagsTags
MissingMissing
DraftsDrafts
OrphansOrphans
TypesTypes
SystemSystem
ShadowsShadows

Parameters for .info-tab

ToolsTools
ReferencesReferences
TaggingTagging
ListList
ListedListed
FieldsFields
AdvancedAdvanced

Parameters for .controlpanel-tab

InfoInfo
AppearanceAppearance
SettingsSettings
SavingSaving
PluginsPlugins

Parameters for .advancedsearch-tab

StandardStandard
SystemSystem
ShadowsShadows
FilterFilter

Buttons

MacroUsed forExample
.buttona 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 </g> new here
new-journal-here 22 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 22 new journal
new-tiddler new tiddler
permaview permaview
refresh refresh
save-wiki save changes
storyview storyview
tag-manager tag manager
theme theme