Tinderbox 7 Icon

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


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"


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

returns an unordered list, excluding prototype links, to all of the notes to which the current note has text links (links anchored in body text) and web 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.

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. type my be omitted but if you do wish to use it, the preceding 4 parameters must all be specified. For example:

^outboundTextLinks(<ul>,<li>,</li>,</ul>,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.

^outboundTextLinks(<ul>,<li>,</li>,</ul>,(example|untitled))^ 

will list links of the types "untitled" and "example".

The is no option to show only the text links without the web links. However, careful use of different link types for text vs. web links would allow filtering via type.

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

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.

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

From v7.2.0,

always uses the original note, even when this is an alias.



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