github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

hugolib: Add .Name as a shortcode variable

Browse source 
Fixes #5546
This commit is contained in:
Bjørn Erik Pedersen 2018-12-21 09:51:15 +01:00
parent 6f069e549b
commit 1021714449
No known key found for this signature in database
GPG key ID: 330E6E2BD4859D8F
3 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/content/en/variables/shortcodes.md
View file

@ -20,6 +20,9 @@ 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.

3
hugolib/shortcode.go
View file

@ -58,6 +58,7 @@ type ShortcodeWithPage struct {
Inner template.HTML
Page *PageWithoutContent
Parent *ShortcodeWithPage
Name string
IsNamedParams bool
// Zero-based ordinal in relation to its parent. If the parent is the page itself,
@ -401,7 +402,7 @@ func renderShortcode(
return "", nil
}
data := &ShortcodeWithPage{Ordinal: sc.ordinal, posOffset: sc.pos, Params: sc.params, Page: p, Parent: parent}
data := &ShortcodeWithPage{Ordinal: sc.ordinal, posOffset: sc.pos, Params: sc.params, Page: p, Parent: parent, Name: sc.name}
if sc.params != nil {
data.IsNamedParams = reflect.TypeOf(sc.params).Kind() == reflect.Map
}

4
hugolib/shortcode_test.go
View file

@ -1027,7 +1027,7 @@ ordinal: 4 scratch ordinal: 5 scratch get ordinal: 4`)
}
func TestShortcodePosition(t *testing.T) {
func TestShortcodeVariables(t *testing.T) {
t.Parallel()
assert := require.New(t)
@ -1042,6 +1042,7 @@ title: "Hugo Rocks!"
{{< s1 >}}
`).WithTemplatesAdded("layouts/shortcodes/s1.html", `
Name: {{ .Name }}
{{ with .Position }}
File: {{ .Filename }}
Offset: {{ .Offset }}
@ -1059,6 +1060,7 @@ String: {{ . | safeHTML }}
filepath.FromSlash("File: content/page.md"),
"Line: 7", "Column: 4", "Offset: 40",
filepath.FromSlash("String: \"content/page.md:7:4\""),
"Name: s1",
)
}