Tinderbox 7 Icon

^similarTo( item, count[, start, list-item-prefix, list-item-suffix, end] )^


Code Type: 

Code Scope of Action: 

Code First Added: 

Code Altered: 

 Creation of Links   [other codes of this type]

 item   [codes with similar scope]

 Baseline

 format"


^similarTo( item, count[, start, list-item-prefix, list-item-suffix, end] )^

The HTML Export element ^similarTo^ locates notes that appear similar to a given note.

The query will find up to count notes, but may find fewer, and exports a list of notes it finds. The count parameter is not evaluated so must be stated as a value and not an expression.

Basic form, returning links to the 10 most similar notes:

^similarTo("this",10)^ 

The longer form is only needed if it is desired to use non-default list HTML mark-up or include extra per-item captioning. If one of the option input is specified, all the other must be also - even if only as the default.

The code must be used in $text or directly in a template. If used in a code include to a template, the links generated will have incorrect relative paths.

Similarity is based on several factors, including:

In addition, weighting is applied for:

The results are based on the Similar Notes view. The same matching is also available as an action similarTo().

New item objects source and destination may be used with list/item inputs to indicate from where data used within such inputs are drawn.



A Tinderbox Reference File : Export Codes : Export Codes - Full Listing : ^similarTo( item, count[, start, list-item-prefix, list-item-suffix, end] )^