This version is out of date, covering development from v8.0.0 to v8.x.x. It is maintained here only for inbound reference links from elsewhere. It is no longer actively updated.

Jump to the current version of aTbRef

Tinderbox v8 Icon

Name


Attribute Data Type: 

Attribute Default Value: 

Attribute Group: 

Attribute Purpose: 

Attribute Inherited from Preferences?   

Attribute UI-configurable? 

Attribute Read-Only? 

Attribute Intrinsic? 

Attribute First Added: 

Attribute Altered: 

 string   [other string-type attributes]

 untitled

 General   [other General Group attributes]

 Note title

 No

 Yes

 No

 No

 Baseline

 


Specifies the title of the note.

$Name is equivalent to the ^title^ export code in the context of exporting data. The $Name string can be one word or more and can include symbols etc., though the latter are not suggested for use if you're going to export to HTML as you may/will have issues to resolve with HTML entities in the output.

$Name of a selected object can easily be set/edited via the title box at the top of the text pane, or in some views by left-click-hold on the title text of the icon in the view pane.

Because Tinderbox recognises operators such as + and -, notes whose names begin with characters other than letters and numbers may sometimes be interpreted in unexpected ways.

For example, if a note is named "6*7", rules like

$Prototype=6*7 

might be parsed as a multiplication with the result of 42.

$Prototype="6*7" 

should have the expected effect.

The attributes $DisplayExpression and (read-only) $DisplayName allow the user the option of showing the original name or as a manipulated version, e.g. with some information such as a word count concatenated on the end. Use of the new features is non-intrusive to existing use such as in actions & rules as $Name always retains the name as before any expression is applied to it.

Although marked as intrinsic, $Name, differs from general intrinsic behaviour in that it is the same for the original note and all its aliases. It is not possible to set a different $Name, $DisplayName or $DisplayExpression for an alias. But, $DisplayExpression is evaluated in the current context which may differ for an original and alias (e.g. if in different containers) offering and opportunity for discrete $DisplayName labels using contextual inputs.