Code Scope of Action:
Code First Added:
^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
- another ^setRoot^ is found.
- the current file being exported is complete.
To restore relative URLs, use ^setRoot()^ with no arguments.
Using ^setRoot()^ to set the logical host or root path for a page affects not only ^root^ but also ^url^, ^childLinks^, and ^basicLinks^.