Export 2

This is Tinderbox Cookbook version 2.0.1, created in conjunction with Tinderbox 7.0.1.

The locale settings used to export this document: en-GB. Most date tests were written/tested on a UK day/month order system and thus tests may fail if exported using different locale settings.

This page explores Tinderbox export elements, used in export templates. Export templates can also be used in some actions, but this syntax is now deprecated. Export template elements begin with the character ^. This page covers all the export codes relating to creation of links, the remainder are covered in part 1 of the page.

Deprecation. Some codes are now marked 'deprecated'. This means that while they may still work, such syntax should be avoided. New documents should not use such syntax and existing documents in regular use should be have their code reviewed to avoid retaining deprecated usage.

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

Create HTML backlinks to all ancestors back to root level. Links are space-colon-space delimited.

description try expect result ok

Default output - no user-supplied parameters. This note is linked to a note called 'Link Target'.

^ancestors^ not sure with an include! not yet

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

Creates a list of HTML links for the current note's basic links.

description try expect result ok

Default output - no user-supplied parameters. This note is linked to a note called 'Link Target'.

^basicLinks^ <ul><li><a href="Basic-nouserparameters/LinkTarget.html">Link Target</a></li></ul> not yet

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

Creates a list of HTML links to each of the current note's immediate children (but not all descendants).

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

Creates a list of HTML links to the source of all the current note's inbound basic links.

^inboundLinks( start, list-item-prefix, list-item-suffix, end] )^

Creates a list of HTML links to the source of all the current note's inbound links, both basic and text.

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

Creates a list of HTML links to the source of all the current note's inbound text links.

^linkTo( item [, data] [, css class] )^

Exports the data as the anchor text of a link to the web page corresponding to the designated item (or note).

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

Creates a list of HTML links to the source of all the current note's outbound basic links.

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

Creates a list of HTML links to the source of all the current note's outbound text links.

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

Creates a list of HTML links to the source of all the current note's outbound web links.

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

Creates a list of HTML links to each of the current note's siblings.

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

Creates a list of HTML links to each of the (optionally limited to count number) of the notes listed in current note's Similar Notes window.

^url( item )^

The URL of the exported HTML web page for the item, as a relative path from the current page to the note. q.v. ^path^