diff options
author | Renato Vargas <renato@vargas.gt> | 2016-01-30 01:43:29 +0300 |
---|---|---|
committer | digitalcraftsman <digitalcraftsman@users.noreply.github.com> | 2016-01-30 03:24:55 +0300 |
commit | 817d69487cbe58d38b8b13312c203fba42817bcf (patch) | |
tree | 4843322651f44663fcea90b70e7ab29b236b5c3a | |
parent | d158f7e339b9037a3160043db6660cac24f14aa9 (diff) |
Expanded the Page Params section in variables.md
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
-rw-r--r-- | docs/content/templates/variables.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/content/templates/variables.md b/docs/content/templates/variables.md index d656ddd21..18e933f5d 100644 --- a/docs/content/templates/variables.md +++ b/docs/content/templates/variables.md @@ -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). |