^setRoot( [newRoot] )^
|
This version is out of date, covering development from v4.6.0 to v4.7.1. It is maintained here only for inbound reference links from elsewhere. Jump to the current version of aTbRef. |
|
| A Tinderbox Reference File : Export Codes : Export Code Scope : Document-based : ^setRoot( [newRoot] )^ | aTbRef Site Map |
^setRoot( [newRoot] )^ |
|
| Code Type: | Export Mark-up |
| Code Scope of Action: | document |
^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
^setRoot(newRoot)^
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:
^setRoot(http://example.com/)^
Using ^setRoot()^ to set the logical host or root path for a page affects not only ^root^ but also ^url^, ^childLinks^, and ^basicLinks^.
| Up: Document-based | |
| Previous: ^root^ | Next: ^docTitle^ |
Licensed under Creative Commons Attribution-Noncommercial-Share Alike 3.0 License
[See aTbRef CC licence Attribution/Waiver info info]
