hugo/content/en/functions/apply.md
Bjørn Erik Pedersen 77b976dd92 Squashed 'docs/' changes from a7e1e9be8..686c7b6eb
686c7b6eb ci(Netlify): specify `HUGO_VERSION` environment variable once
da99a356f fix: change heading level
e57da3f00 Update taxonomy methods
746172490 Update description of rendered breadcrumb navigation
6bc52fd40 Clarify term
dab07dcb0 Fix typo
e50fa452a Fix typo
6c1ea83c2 Update template overview page
a5dc97845 Clarify the append function
a135e52a0 Update GitHub hosting instructions
a51bf9f4f Update sections page
ed35fc6c4 Update archetypes and glossary
1a4522b3e Format examples
a70f20094 Use "hugo new content" to create content
673846ff9 Remove comment
b7febf0c5 Fix link
6f6fe2133 Miscellaneous edits
99227dd18 Remove lookup order table from output formats page
bc8870657 tools/editors: Add Prettier Plugin for Go Templates
157b169eb Update docs.yaml
1c8f514e0 Update cond function
e5f1f8113 Add assumptions to taxonomy and term template lookup order examples
475b406e2 Update postprocess
2d6cb8dfc glossary: Update content type
03b514bac Add descriptions to template lookup order example sections
06678f919 glossary: Fix broken link
4cd505612 Simplify news listing
fadb980db Update glossary of terms
491bacd78 Change order of example sections for template lookup order
04b8f39ec Create glossary of terms
12e896bc0 Remove reference to asciidoctor-rouge extension
055f7bb37 Insert missing words
8cd6ac387 Miscellaneous edits
2cbe17f41 Update configuration.md
529615373 Update data-templates.md
853154e65 Update theme
45f08627a resources.getRemote: Fix definition list
29a51dac1 Update docshelper
3bdfe88c6 Remove link to gitter from site footer
cacd0e461 Use "map" instead of "dictionary"
704dd5da6 Document the transform.Remarshal template function
e8d744951 Populate news section via GitHub releases API
3ff1118c7 Replace docs.json with docs.yaml
7726bbcac Use docs.json to generate default config throughout the site
57dca93df Use docs.json to generate default config for related content
74d5082c7 Add some .RenderShortcodes docs
cf5ab5062 netlify: Hugo 0.117.0
420f7aa69 Add all config to docshelper.json

git-subtree-dir: docs
git-subtree-split: 686c7b6eb182ed335dc94b3a0b80c564f7658380
2023-08-30 19:23:47 +02:00

4 KiB
Raw Blame History

title description categories menu keywords signature relatedfuncs
apply Given an array or slice, `apply` returns a new slice with a function applied over it.
functions
docs
parent
functions
advanced
apply COLLECTION FUNCTION [PARAM...]

apply expects at least three arguments, depending on the function being applied.

  1. The first argument is the sequence to operate on.
  2. The second argument is the name of the function as a string, which must be the name of a valid Hugo function.
  3. After that, the arguments to the applied function are provided, with the string "." standing in for each element of the sequence the function is to be applied against.

Here is an example of a content file with names: as a front matter field:

{{< code-toggle file="content/example.md" fm=true copy=false >}} title: Example names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ] {{< /code-toggle >}}

You can then use apply as follows:

{{ apply .Params.names "urlize" "." }}

Which will result in the following:

"derek-perkins", "joe-bergevin", "tanner-linsley"

This is roughly equivalent to using the following with range:

{{ range .Params.names }}{{ . | urlize }}{{ end }}

However, it is not possible to provide the output of a range to the delimit function, so you need to apply it.

If you have post-tag-list.html and post-tag-link.html as partials, you could use the following snippets, respectively:

{{< code file="layouts/partials/post-tag-list.html" copy=false >}} {{ with .Params.tags }}

Tags: {{ $len := len . }} {{ if eq $len 1 }} {{ partial "post-tag-link.html" (index . 0) }} {{ else }} {{ $last := sub $len 1 }} {{ range first $last . }} {{ partial "post-tag-link.html" . }}, {{ end }} {{ partial "post-tag-link.html" (index . $last) }} {{ end }}
{{ end }} {{< /code >}}

{{< code file="layouts/partials/post-tag-link.html" copy=false >}} {{ . }} {{< /code >}}

This works, but the complexity of post-tag-list.html is fairly high. The Hugo template needs to perform special behavior for the case where theres only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like Tags: tag1 , tag2 , tag3 because of the way that the HTML is generated and then interpreted by a browser.

This first version of layouts/partials/post-tag-list.html separates all of the operations for ease of reading. The combined and DRYer version is shown next:

{{ with .Params.tags }}
  <div class="tags-list">
    Tags:
    {{ $sort := sort . }}
    {{ $links := apply $sort "partial" "post-tag-link.html" "." }}
    {{ $clean := apply $links "chomp" "." }}
    {{ delimit $clean ", " }}
  </div>
{{ end }}

Now in the completed version, you can sort the tags, convert the tags to links with layouts/partials/post-tag-link.html, chomp off stray newlines, and join the tags together in a delimited list for presentation. Here is an even DRYer version of the preceding example:

{{< code file="layouts/partials/post-tag-list.html" >}} {{ with .Params.tags }}

Tags: {{ delimit (apply (apply (sort .) "partial" "post-tag-link.html" ".") "chomp" ".") ", " }}
{{ end }} {{< /code >}}

{{% note %}} apply does not work when receiving the sequence as an argument through a pipeline. {{% /note %}}