The tm-rename-tiddler message renames a tiddler by deleting it and recreating it with a new title. The rename tiddler message requires the following properties on the event object:
| Name | Description |
|---|---|
| from | Current title of tiddler |
| to | New title of tiddler |
| renameInTags | Introduced in v5.1.23 Optional value "no" to disable renaming in tags fields of other tiddlers (defaults to "yes") |
| renameInLists | Introduced in v5.1.23 Optional value "no" to disable renaming in list fields of other tiddlers (defaults to "yes") |
The very similar WidgetMessage: tm-relink-tiddler message does not rename the tiddler, it just relinks the references to it.
The rename tiddler message is usually generated with the ButtonWidget and is handled by the core.
Examples
To rename a tiddler called Tiddler1 to Tiddler2 and also renaming Tiddler1 in tags and list fields of other tiddlers:
<$action-sendmessage $message="tm-rename-tiddler" from="Tiddler1" to="Tiddler2" />To rename a tiddler called Tiddler1 to Tiddler2 and not rename Tiddler1 in tags and list fields of other tiddlers:
<$action-sendmessage $message="tm-rename-tiddler" from="Tiddler1" to="Tiddler2" renameInTags="no" renameInLists="no"/>To rename a tiddler called Tiddler1 to Tiddler2 and respect the setting in the tiddler $:/config/RelinkOnRename for whether to rename Tiddler1 in tags and list fields of other tiddlers:
<$action-sendmessage $message="tm-rename-tiddler" from="Tiddler1" to="Tiddler2" renameInTags={{$:/config/RelinkOnRename}} renameInLists={{$:/config/RelinkOnRename}}/>