mirror of https://github.com/gohugoio/hugo
917 B
917 B
title | description | categories | keywords | params | |||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Position | Returns the file name and position from which the shortcode was called. |
|
The Position
method is useful for error reporting. For example, if your shortcode requires a "greeting" argument:
{{ $greeting := "" }}
{{ with .Get "greeting" }}
{{ $greeting = . }}
{{ else }}
{{ errorf "The %q shortcode requires a 'greeting' argument. See %s" .Name .Position }}
{{ end }}
In the absence of a "greeting" argument, Hugo will throw an error message and fail the build:
ERROR The "myshortcode" shortcode requires a 'greeting' argument. See "/home/user/project/content/about.md:11:1"
[!note] The position can be expensive to calculate. Limit its use to error reporting.