Introduction
The $action-createtiddler widget is an action widget that creates new tiddlers. Action widgets are used within triggering widgets such as the ButtonWidget.
There are several differences from the tm-new-tiddler message:
- The new tiddler is not automatically displayed in the story river
- The title of the new tiddler is made available for subsequent operations
Content and Attributes
The action-createtiddler widget is invisible.
| Attribute | Description |
|---|---|
| $basetitle | The initial title that will be attempted. If a tiddler with that title already exists, then a numerical counter is added to the title and incremented until it is unique |
| $savetitle | Deprecated since:5.1.20(seeActionCreateTiddlerWidget Example 5) A text reference identifying a field or index into which the title of the newly created tiddler will be stored after it is created |
| $savedrafttitle | Deprecated since:5.1.20(seeActionCreateTiddlerWidget Example 5) A text reference identifying a field or index into which the draft title associated with the newly created tiddler will be stored after it is created. This is useful when using a sequence of action widgets to create a new tiddler, put it into edit mode, and position it within the list of its parent tag |
| $timestamp | Specifies whether the timestamp(s) of the target tiddler will be updated (modified and modifier, plus created and creator for newly created tiddlers). Can be "yes" (the default) or "no" |
| $template | Introduced in v5.1.22 The title of a template tiddler, that will be used to create a new tiddler |
| $overwrite | Introduced in v5.1.22 If set to "yes", it will overwrite existing tiddlers. Be careful! |
| {any attributes not starting with $} | Each attribute name specifies a field to be created in the new tiddler |
Variables
Introduced in v5.2.0 The content of the $action-createtiddler widget is executed after the new tiddler has been created. The title of the newly created tiddler is stored in the variable createTiddler-title.
| Variables | Description |
|---|---|
createTiddler-title | The tittle of the tiddler that has been created. See ActionCreateTiddlerWidget Example 5 |
createTiddler-draftTitle | This variable only exists to have feature parity with the deprecated parameters. It contains the title of a "draft tiddler" |
Examples
Caption for new button: <$edit-text tiddler="$:/state/new-button-caption" tag="input" default=""/> <$button> <$action-createtiddler $basetitle="Homemade Button" tags="$:/tags/PageControls" text={{$:/state/new-button-caption}}> <$action-navigate $to=<<createTiddler-title>>/> </$action-createtiddler> Create a new non-functional page control button and open the tiddler </$button>That renders as:
Caption for new button:
This example will create "New Tiddler", "New Tiddler 1", " New Tiddler 2" and so on
\define testCreate() <$action-createtiddler /> \end <$button actions=<<testCreate>> > Create Tiddler </$button>- Clicking this button, will also open the Right sidebar: Recent tab
This example will use the base title defined in $:/language/DefaultNewTiddlerTitle.
It will overwrite the tiddler, if the button is clicked several times.
\define testCreate() <$action-createtiddler $basetitle={{$:/language/DefaultNewTiddlerTitle}} $overwrite="yes"/> \end <$button actions=<<testCreate>> > Create Tiddler </$button>- Clicking this button, will also open the Right sidebar: Recent tab
This example will uses a base-title and a template: ActionCreateTiddlerWidget Template
It will create: "base", "base 1", "base 2" and so on
\define testCreate() <$action-createtiddler $basetitle="base" $template="ActionCreateTiddlerWidget Template"/> \end <$button actions=<<testCreate>> > Create Tiddler </$button>- Clicking this button will also open the Right sidebar: Recent tab
This example uses a base-title "base" and a template: ActionCreateTiddlerWidget Template.
There will be new fields "aa" and "bb" which are added to the new tiddlers.
\define testCreate() <$action-createtiddler $basetitle="base" $template="ActionCreateTiddlerWidget Template" aa="new field aa" bb="new field bb" /> \end <$button actions=<<testCreate>> > Create Tiddler </$button>- Clicking this button will also open the Right sidebar: Recent tab
This example will use the base title defined in ActionCreateTiddlerWidget Template.
It will create: "base", "base 1", "base 2" and so on, and navigate to this tiddler in draft mode.
\define testCreate() <$action-createtiddler $basetitle="base" $template="ActionCreateTiddlerWidget Template"> <$action-sendmessage $message="tm-edit-tiddler" $param=<<createTiddler-title>>/> </$action-createtiddler> \end <$button actions=<<testCreate>> > Create Tiddler </$button>- Clicking this button, will also open the Right sidebar: Recent tab