summaryrefslogtreecommitdiffstats
path: root/docs/content/en/variables/shortcodes.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-05-04 09:44:59 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-05-04 09:44:59 +0200
commit914cc85e22af2e6c28f24a5fc70de94e4b9f1b1b (patch)
treee7b5fcc856003415c613312c80ba2f301eeae03c /docs/content/en/variables/shortcodes.md
parenta6816db77574ba3d48a6414c97a53a691c34e705 (diff)
parent83bef6955e014d40c0f00db9cebe09113154e999 (diff)
downloadhugo-914cc85e22af2e6c28f24a5fc70de94e4b9f1b1b.tar.gz
hugo-914cc85e22af2e6c28f24a5fc70de94e4b9f1b1b.zip
Merge commit '83bef6955e014d40c0f00db9cebe09113154e999'
Diffstat (limited to 'docs/content/en/variables/shortcodes.md')
-rw-r--r--docs/content/en/variables/shortcodes.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/content/en/variables/shortcodes.md b/docs/content/en/variables/shortcodes.md
new file mode 100644
index 000000000..b194eb7db
--- /dev/null
+++ b/docs/content/en/variables/shortcodes.md
@@ -0,0 +1,36 @@
+---
+title: Shortcode Variables
+linktitle: Shortcode Variables
+description: Shortcodes can access page variables and also have their own specific built-in variables.
+date: 2017-03-12
+publishdate: 2017-03-12
+lastmod: 2017-03-12
+categories: [variables and params]
+keywords: [shortcodes]
+draft: false
+menu:
+ docs:
+ parent: "variables"
+ weight: 20
+weight: 20
+sections_weight: 20
+aliases: []
+toc: false
+---
+
+[Shortcodes][shortcodes] have access to parameters delimited in the shortcode declaration via [`.Get`][getfunction], page- and site-level variables, and also the following shortcode-specific fields:
+
+.Parent
+: provides access to the parent shortcode context in nested shortcodes. This can be very useful for inheritance of common shortcode parameters from the root.
+
+.IsNamedParams
+: boolean that returns `true` when the shortcode in question uses [named rather than positional parameters][shortcodes]
+
+.Inner
+: represents the content between the opening and closing shortcode tags when a [closing shortcode][markdownshortcode] is used
+
+[getfunction]: /functions/get/
+[markdownshortcode]: /content-management/shortcodes/#shortcodes-with-markdown
+[shortcodes]: /templates/shortcode-templates/
+
+