This version is out of date, covering development from v5.0.0 to v5.12.2. It is maintained here only for inbound reference links from elsewhere.

Jump to the current version of aTbRef.

Tinderbox Icon

^setRoot( [newRoot] )^

Code Type: 

Code Scope of Action: 

Code First Added: 

Code Altered: 

 Export Mark-up   [other codes of this type]

 document   [codes with similar scope]

 Already in v5.0.0


^setRoot( [newRoot] )^

The ^root^ code normally exports the relative path from a note to the top level of the Tinderbox document. This is valuable for defining relative paths, especially in macros.

In some cases, though, you may want a relative path in one page (an HTML page, say) and an absolute link in another (an RSS feed, where relative links may be forbidden).

The export element


tells Tinderbox to use its first argument (newRoot) as the value of ^root^ until either

To restore relative URLs, use ^setRoot()^ with no arguments.

For example:


Using ^setRoot()^ to set the logical host or root path for a page affects not only ^root^ but also ^url^, ^childLinks^, and ^basicLinks^.

Possible relevant notes (via "Similar Notes" feature):

A Tinderbox Reference File : Export Codes : Export Codes - Full Listing : ^setRoot( [newRoot] )^