^inboundBasicLinks( [start, list-item-prefix, list-item-suffix, end, type] )^

Tinderbox Icon

Code Type:   Link Creation
Code Scope of Action:   item

^inboundBasicLinks( [start, list-item-prefix, list-item-suffix, end, type] )^

returns all of the notes that have a basic (note-level) link to the current note, formatted as an unordered list, excluding prototype links.

The optional parameters allow you to format the group of links as an HTML list or table in the exact format you want, where start is text that will be inserted before all of the links, end is text that will be inserted after all of the links, list-item-prefix is text that will be inserted before each link, and list-item-suffix is text that will be inserted after each link. The type parameter restricts the scope of link inclusion and is discussed separately below.

If start, list-item-prefix, list-item-suffix, end are omitted then the default values of <ul>, <li>, </li>, </ul> are used. type my be omitted but if you do wish to use it, the preceding 4 parameters must all be specified.

The optional fifth argument, type, lets you restrict exported lists to specific link types, as in the named types seen in the TBX's Link Types palette. For example:


will list only inbound links of type "example". As the type argument is a regular expression, besides specifying a particular link type name, you can specify wildcard characters or lists of eligible link types, etc.


will list links of the types untitled and example.

Also see ^inboundLinks^, ^inboundTextLinks^. The logical opposite of this code is ^outboundBasicLinks^.

This code exports CSS class and target based on their underlying Tinderbox link values - assuming these are actually completed; the link type value is not picked up as a class name.

If there is more than one inbound link from the same source, said link is only listed once.

New item objects source and destination may be used to indicate from where data used within the arguments is drawn.

Up: Item-based
Previous: ^getFor(path | item, attribute[, format] )^  Next: ^inboundLinks( start, list-item-prefix, list-item-suffix, end )^ 

[Last updated: 14 Dec 2009, using v5.0]

Google search aTbRef for:  

Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]

Creative Commons License

Made with Tinderbox