clarify info about canonical URL [skip ci]
authorDan Allen <dan@opendevise.com>
Wed, 21 Aug 2019 07:00:36 +0000 (01:00 -0600)
committerDan Allen <dan@opendevise.com>
Wed, 21 Aug 2019 07:00:36 +0000 (01:00 -0600)
docs/modules/ROOT/pages/templates.adoc

index 652fdda..f74a28e 100644 (file)
@@ -101,8 +101,9 @@ It's often used as the base URL to generate relative URLs from this page.
 
 | page.canonicalUrl
 | The canonical URL for the current page.
-If there are older versions of the page, the canonical URL is the URL of the latest version.
-//If this is an aspect page, the canonical URL is the URL of the primary (non-aspect) 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).
+If there's only a single version of the component, the canonical URL is the qualified URL of the current page.
 
 | page.editUrl
 | The URL to edit the current page, typically on GitHub.