Expanded the Page Params section in variables.md
authorRenato Vargas <renato@vargas.gt>
Fri, 29 Jan 2016 22:43:29 +0000 (16:43 -0600)
committerdigitalcraftsman <digitalcraftsman@users.noreply.github.com>
Sat, 30 Jan 2016 00:24:55 +0000 (01:24 +0100)
Expanded on the use of Page Params in the templates/variables.md
documentation. Added sample code for something that keeps coming up on
discuss.github.io

docs/content/templates/variables.md

index d656ddd211babc9aa96f6a15db9c9714cf4d7299..18e933f5d74949f76df79ff4d36bb43c729b89bd 100644 (file)
@@ -67,6 +67,26 @@ For example, the *tags* and *categories* taxonomies are accessed with:
 
 **All Params are only accessible using all lowercase characters.**
 
+This is particularly useful for the introduction of user defined fields in content files. For example, a Hugo website on book reviews could have in the front matter of <code>/content/review/book01.md</code>
+
+    ---
+       ...
+    affiliatelnk: "http://www.my-book-link.here"
+       recommendedby: "my Mother"
+    ---
+
+Which would then be accessible to a template at <code>/theme/yourtheme/review/single.html</code>, for example, through <code>.Params.affiliatelnk</code> and <code>.Params.recommendedby</code>, respectively. Two common situations where these could be introduced are as a value of a certain attribute (like <code>href=""</code> below) or by itself if it will be displayed. Sample syntaxes include:
+
+    <h3><a href="{{ printf "%s" $.Params.affiliatelnk }}">Buy this book</a></h3>
+       <p>It was recommended by {{ .Params.recommendedby }}.</p>
+
+which would render
+
+    <h3><a href="http://www.my-book-link.here">Buy this book</a></h3>
+       <p>It was recommended by my Mother.</p>
+
+**See also:** [cross-references]({{% ref "content/archetypes.md" %}}) for consistency of `Params` accross pieces of content.
+
 ### Param method
 In Hugo you can declare params both for the site and the individual page.  A common use case is to have a general value for the site and a more specific value for some of the pages (i.e. an image).