20th May 2024 at 4:29pm
TiddlerFields are name:value pairs that make up a tiddler. Field names may contain any combination of characters (prior to v5.2.0, fields were constrained to be lowercase letters, digits or the characters - (dash), _ (underscore) and . (period)).
The standard fields are:
| Field Name | Description |
|---|---|
title | The unique name of a tiddler |
text | The body text of a tiddler |
modified | The date and time at which a tiddler was last modified |
modifier | The tiddler title associated with the person who last modified a tiddler |
created | The date a tiddler was created |
creator | The name of the person who created a tiddler |
tags | A list of tags associated with a tiddler |
type | The content type of a tiddler |
list | An ordered list of tiddler titles associated with a tiddler – see ListField |
caption | The text to be displayed on a tab or button |
Other fields used by the core are:
| Field Name | Description |
|---|---|
class | Introduced in v5.1.16 The CSS class applied to a tiddler when rendering it - see Custom styles by user-class. Also used for Modals |
code-body | Introduced in v5.2.1 The view template will display the tiddler as code if set to yes |
color | The CSS color value associated with a tiddler |
description | The descriptive text for a plugin, or a modal dialogue |
draft.of | For draft tiddlers, contains the title of the tiddler of which this is a draft |
draft.title | For draft tiddlers, contains the proposed new title of the tiddler |
footer | The footer text for a modal |
hide-body | The view template will hide bodies of tiddlers if set to yes |
icon | The title of the tiddler containing the icon associated with a tiddler |
library | Indicates that a tiddler should be saved as a JavaScript library if set to yes |
list-after | If set, the title of the tiddler after which this tiddler should be added to the ordered list of tiddler titles, or at the end of the list if this field is present but empty |
list-before | If set, the title of a tiddler before which this tiddler should be added to the ordered list of tiddler titles, or at the start of the list if this field is present but empty |
name | The human readable name associated with a plugin tiddler |
plugin-priority | A numerical value indicating the priority of a plugin tiddler |
plugin-type | The type of plugin in a plugin tiddler |
stability | The development status of a plugin: deprecated, experimental, stable, or legacy |
source | The source URL associated with a tiddler |
subtitle | The subtitle text for a modal |
throttle.refresh | If present, throttles refreshes of this tiddler |
toc-link | Suppresses the tiddler's link in a Table of Contents tree if set to no |
_canonical_uri | The full URI of an external image, audio, or html file |
The TiddlyWebAdaptor uses a few more fields:
| Field Name | Description |
|---|---|
bag | The name of the bag from which a tiddler came |
revision | The revision of the tiddler held at the server |
_is_skinny | If present, indicates that the tiddler text field must be loaded from the server |
Details of the fields used in this TiddlyWiki are shown in the control panel under the Info tab >> Advanced sub-tab >> Tiddler Fields