TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-11 14:40:17 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update terminology on shortcode templates page

Browse Source
This commit is contained in:
Tanya Bouman 2023-12-29 15:43:54 -05:00 committed by GitHub
parent 01e10942a3
commit f7e19a25b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
content/en/templates/shortcode-templates.md
View File

@ -155,7 +155,7 @@ While you can create shortcode templates that accept both positional and named p
You can also use the variable `.Page` to access all the normal [page variables][pagevars]. You can also use the variable `.Page` to access all the normal [page variables][pagevars].
A shortcodes can also be nested. In a nested shortcode, you can access the parent shortcode context with [`.Parent` variable][shortcodesvars]. This can be very useful for inheritance of common shortcode parameters from the root. Shortcodes can also be nested. In a nested shortcode, you can access the parent shortcode context with the [`.Parent`] shortcode method. This can be very useful for inheritance of common shortcode parameters from the root.
### Checking for existence ### Checking for existence
@ -307,7 +307,7 @@ The rendered output of the HTML example code block will be as follows:
### Nested shortcode: image gallery ### Nested shortcode: image gallery
Hugo's [`.Parent` shortcode variable][parent] provides access to the parent shortcode context when the shortcode in question is called within the context of a *parent* shortcode. This provides an inheritance model for common shortcode parameters. Hugo's [`.Parent`] shortcode method provides access to the parent shortcode context when the shortcode in question is called within the context of a *parent* shortcode. This provides an inheritance model for common shortcode parameters.
The following example is contrived but demonstrates the concept. Assume you have a `gallery` shortcode that expects one named `class` parameter: The following example is contrived but demonstrates the concept. Assume you have a `gallery` shortcode that expects one named `class` parameter:
@ -350,7 +350,7 @@ This will output the following HTML. Note how the first two `img` shortcodes inh
## Error handling in shortcodes ## Error handling in shortcodes
Use the [errorf](/functions/fmt/errorf) template func and [.Position](/variables/shortcode/) variable to get useful error messages in shortcodes: Use the [errorf](/functions/fmt/errorf) template function and [`.Position`] shortcode method to get useful error messages in shortcodes:
```sh ```sh
{{ with .Get "name" }} {{ with .Get "name" }}
@ -406,8 +406,8 @@ The same inline shortcode can be reused later in the same content file, with dif
[hugosc]: /content-management/shortcodes/#using-hugo-s-built-in-shortcodes [hugosc]: /content-management/shortcodes/#using-hugo-s-built-in-shortcodes
[lookup order]: /templates/lookup-order/ [lookup order]: /templates/lookup-order/
[pagevars]: /variables/page/ [pagevars]: /variables/page/
[parent]: /variables/shortcode/ [`.Parent`]: /methods/shortcode/parent/
[shortcodesvars]: /variables/shortcode/ [`.Position`]: /methods/shortcode/position/
[spfscs]: https://github.com/spf13/spf13.com/tree/master/layouts/shortcodes [spfscs]: https://github.com/spf13/spf13.com/tree/master/layouts/shortcodes
[vimeoexample]: #single-flexible-example-vimeo [vimeoexample]: #single-flexible-example-vimeo
[youtubeshortcode]: /content-management/shortcodes/#youtube [youtubeshortcode]: /content-management/shortcodes/#youtube