clarify that canonical URL is only set if site.url is an absolute URL
authorDan Allen <dan@opendevise.com>
Fri, 24 Dec 2021 00:54:05 +0000 (17:54 -0700)
committerDan Allen <dan@opendevise.com>
Fri, 24 Dec 2021 00:54:05 +0000 (17:54 -0700)
docs/modules/ROOT/pages/templates.adoc

index bba83f6..5efa4fe 100644 (file)
@@ -133,8 +133,8 @@ It's often used as the base URL to generate relative URLs from this page.
 
 | page.canonicalUrl
 | The canonical URL for the current page.
-The canonicalUrl is only set if site.url is set.
-If there are multiple versions of the component, the canonical URL is the qualified URL of the most recent version of the page (excluding any prerelease versions).
+The canonicalUrl is only set if site.url is set to an absolute URL and the page's component has at least one non-prerelease version.
+If there are multiple versions of the component, the canonical URL is the qualified URL of the most recent, non-prerelease version of the page.
 If there's only a single version of the component, the canonical URL is the qualified URL of the current page.
 
 | page.editUrl