mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
978856e2ad
785e375f5 Change 'my-another-post' to 'my-other-post' ba9a69d25 Update reflect.IsSlice.md 806344258 Update reflect.IsMap.md 757c0dafa Update index.md d3f20a2d5 Update index.md 9952e72a0 Formatting 70458ccf2 Formatting 7e0dd3969 Merge branch 'config-dir' 06a5c11fc Release 0.53 01c00229f releaser: Prepare repository for 0.54-DEV 29b223f78 releaser: Add release notes to /docs for release of 0.53 4f61d1194 releaser: Bump versions for release of 0.53 320a0ac68 Refactor config below /config ec16b611e docs: Adjust CSV example cecf97dfc Rename CSV option from comma to delimiter 18d06df58 docs: Document transform.Unmarshal fdace78b5 docs: Regenerate CLI docs b8f84ac59 hugolib: Add .Name as a shortcode variable 6612dd1b8 Merge commit '5a83bf314f4c0ce1d61341e0a1df21c9998e8154' 9b211089f docs: Regenerate CLI docs 9af46af3c Merge commit 'eb16165694f868d73e57b6aed5c26ba5e98229de' 12f46f356 tpl: Add reflect namespace git-subtree-dir: docs git-subtree-split: 785e375f577394c6f782ef51796e2efe88d52cbb
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
---
|
|
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:
|
|
|
|
.Name
|
|
: Shortcode name.
|
|
|
|
.Ordinal
|
|
: Zero-based ordinal in relation to its parent. If the parent is the page itself, this ordinal will represent the position of this shortcode in the page content.
|
|
|
|
.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.
|
|
|
|
.Position
|
|
: Contains [filename and position](https://godoc.org/github.com/gohugoio/hugo/common/text#Position) for the shortcode in a page. Note that this can be relatively expensive to calculate, and is meant for error reporting. See [Error Handling in Shortcodes](/templates/shortcode-templates/#error-handling-in-shortcodes).
|
|
|
|
|
|
|
|
|
|
.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/
|
|
|
|
|