docs: Fix Ref and RelRef syntax
authorCameron Moore <moorereason@gmail.com>
Thu, 15 Dec 2016 16:39:29 +0000 (10:39 -0600)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Thu, 15 Dec 2016 18:32:41 +0000 (19:32 +0100)
Fixes #2793

docs/content/templates/variables.md

index 8fd65321168e6a74a09495ba6a0c962638f4dc37..db00ebcd5834f690a7d86e657bbdbf4931ca0cf5 100644 (file)
@@ -56,9 +56,9 @@ matter, content or derived from file location.
 **.RSSLink** Link to the taxonomies' RSS link.<br>
 **.RawContent** Raw Markdown content without the metadata header. Useful with [remarkjs.com](http://remarkjs.com)<br>
 **.ReadingTime** The estimated time it takes to read the content in minutes.<br>
-**.Ref(ref)** Returns the permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
+**.Ref** Returns the permalink for a given reference.  Example: `.Ref "sample.md"`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
 **.RelPermalink** The Relative permanent link for this page.<br>
-**.RelRef(ref)** Returns the relative permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments.<br> 
+**.RelRef** Returns the relative permalink for a given reference.  Example: `RelRef "sample.md"`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments.<br>
 **.Section** The [section](/content/sections/) this content belongs to.<br>
 **.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br>
 **.Summary** A generated summary of the content for easily showing a snippet in a summary view. Note that the breakpoint can be set manually by inserting <code>&lt;!&#x2d;&#x2d;more&#x2d;&#x2d;&gt;</code> at the appropriate place in the content page.  See [Summaries](/content/summaries/) for more details.<br>