Improve .Get docs - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit 74520d2cfd39bb4428182e26c57afa9df83ce7b5
DIR parent e2b277bba5935c0686cb83f132eae021ef2dc5e1
HTML Author: cmal <paul@cmal.info>
Date: Tue, 17 Apr 2018 11:29:25 +0200
Improve .Get docs
Diffstat:
M docs/content/functions/get.md | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
---
DIR diff --git a/docs/content/functions/get.md b/docs/content/functions/get.md
@@ -20,10 +20,13 @@ needsexample: true
---
-`.Get` is specifically used when creating your own [shortcode template][sc].
-
+`.Get` is specifically used when creating your own [shortcode template][sc], to access the [positional and named](/templates/shortcode-templates/#positional-vs-named-parameters) parameters passed to it. When used with a numeric INDEX, it queries positional parameters (starting with 0). With a string KEY, it queries named parameters.
+When accessing a named parameter that does not exist, `.Get` returns an empty string instead of interrupting the build. The same goes with positional parameters in hugo version 0.40 and after. This allows you to chain `.Get` with `if`, `with`, `default` or `cond` to check for parameter existence. For example, you may now use:
+```
+{{ $quality := default "100" (.Get 1) }}
+```
[sc]: /templates/shortcode-templates/