docs: Add an example of how to use .PrevInSection
authorRoy Reveltas <roy@codeandsend.com>
Wed, 18 May 2016 07:43:30 +0000 (08:43 +0100)
committerdigitalcraftsman <digitalcraftsman@protonmail.com>
Fri, 27 May 2016 18:02:29 +0000 (20:02 +0200)
It's not a common knowledge what the "pointer" is so let's
add an example of how to use .PrevInSection

docs/content/templates/variables.md

index 03398277e930d2e26d3054008e1b56334f7a3152..25557c2ecbeb254b7b2ba58f39924ecfb6d6d76d 100644 (file)
@@ -44,7 +44,7 @@ matter, content or derived from file location.
 **.TableOfContents** The rendered table of contents for this content.<br>
 **.Prev** Pointer to the previous content (based on pub date).<br>
 **.Next** Pointer to the following content (based on pub date).<br>
-**.PrevInSection** Pointer to the previous content within the same section (based on pub date)<br>
+**.PrevInSection** Pointer to the previous content within the same section (based on pub date). For example, `{{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}`.<br>
 **.NextInSection** Pointer to the following content within the same section (based on pub date)<br>
 **.FuzzyWordCount** The approximate number of words in the content.<br>
 **.WordCount** The number of words in the content.<br>