mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 23:38:53 +00:00
1002 B
1002 B
title, description, categories, keywords, action
| title | description | categories | keywords | action | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Position | Returns the filename and position from which the shortcode was called. |
|
The Position method is useful for error reporting. For example, if your shortcode requires a "greeting" parameter:
{{< code file=layouts/shortcodes/myshortcode.html lang=go-html-template >}} {{ $greeting := "" }} {{ with .Get "greeting" }} {{ $greeting = . }} {{ else }} {{ errorf "The %q shortcode requires a 'greeting' parameter. See %s" .Name .Position }} {{ end }} {{< /code >}}
In the absence of a "greeting" parameter, Hugo will throw an error message and fail the build:
ERROR The "myshortcode" shortcode requires a 'greeting' parameter. See "/home/user/project/content/about.md:11:1"
{{% note %}} The position can relatively expensive to calculate. Limit its use to error reporting. {{% /note %}}