document the siteRootPath template variable
authorDan Allen <dan@opendevise.com>
Tue, 1 Oct 2019 23:34:24 +0000 (17:34 -0600)
committerDan Allen <dan@opendevise.com>
Tue, 1 Oct 2019 23:34:24 +0000 (17:34 -0600)
docs/modules/ROOT/pages/templates.adoc

index 64e5deb..55c96d1 100644 (file)
@@ -24,7 +24,7 @@ Variable names and purposes may change.
 Here's an overview of the available UI model:
 
 .Variables available to the Handlebars templates
-[#template-variables-table,cols="1m,3"]
+[#template-variables-table,cols="1m,2"]
 |===
 | Name | Description
 
@@ -137,12 +137,11 @@ Then, the "Edit the Page" link will not appear.
 | page.parent
 | The parent page in the navigation tree. Will resolve to grandparent if parent item is not a page.
 
-| uiRootPath
-| The path to the root directory of the UI.
+| siteRootPath
+| The relative path to the root of the published site.
 
-//| siteRootUrl
-//| The URL of the site root relative to the current page.
-//If the site does not have a root component, this value is null.
+| uiRootPath
+| The relative path to the root directory of the UI.
 |===
 
 This model is likely to grow over time.