mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
83bef6955e
e161ea09d Add one more Chinese file to workaround reflect: Zero(nil) b595b3a21 Add more Chinese translation 56e4e95d9 Use lang.Merge to "fill in the gaps" for untranslated pages ef079406c Merge commit '650fac3a4e7d256f4505402ab44cfc3c804b8dea' 650fac3a4 Squashed 'themes/gohugoioTheme/' changes from a1768ebb..f31a3dc8 322eff899 Add Chinese language for menus d90b886e0 Fix Markdown table syntax in previous commit 737f3dfca Update the leaf bundle vs branch bundle table 09fa1bc4e Clarify that `.Now` is obsolete 879ea3f6a Make release notes somewhat more consistent 0113e2051 Move 0.40.2-relnotes into content/en/news 77578f5bf Move content/ into new contentDir content/en/ 4dcf7c709 Fix "reflect: Zero(nil)" error in showcase 63dd25505 Release 0.40.2 2076c0d56 releaser: Prepare repository for 0.41-DEV 070fe565e releaser: Add release notes to /docs for release of 0.40.2 4ce52e913 releaser: Bump versions for release of 0.40.2 41907c487 Fix typos in syntax-highlighting.md 91753ef3d Add missing backtick b77274301 Remove duplicate release notes (0.27, 0.27.1, 0.35) 6e00da316 Remove obsolete content/release-notes/ directory 00a6d8c02 Change en dash back to `--` in 0.38.2-relnotes 51b32dc00 Update archetypes.md d0e5c2307 Release 0.40.1 4538a6d5b releaser: Prepare repository for 0.41-DEV 91b391d70 releaser: Add release notes to /docs for release of 0.40.1 e0979d143 releaser: Bump versions for release of 0.40.1 7983967c2 Clean images fe3fdd77d Polish showcase for Flesland Flis e6dde3989 Showcase - Flesland Flis AS by Absoluttweb 73aa62290 Revive @spf13's special Hugo font add67b335 Release Hugo 0.40 c0a26e5a6 Merge branch 'temp40' beeabaaae releaser: Prepare repository for 0.41-DEV e67d5e985 releaser: Add release notes to /docs for release of 0.40 6cdd95273 releaser: Bump versions for release of 0.40 bee21fb9b Revive the other Hugo logos too 4f45e8fe1 Fix the link type attribute for RSS in examples 8c67dc89a Fix example in delimit doc e7f6c00d5 Revive the logo used on the forum 82b0cd26e Merge commit 'a215abf70e018f4bf40d6c09d8bd148d8684b33d' 119c8ca58 Merge commit 'd2ec1a06df8ab6b17ad05cb008d5701b40327d47' db4683bd2 Improve .Get docs 05260b886 .Get function: fix syntax signature git-subtree-dir: docs git-subtree-split: e161ea09d33e3199f4998e4d2e9068d5a850f042
119 lines
4.2 KiB
Markdown
119 lines
4.2 KiB
Markdown
---
|
||
title: apply
|
||
description: Given a map, array, or slice, `apply` returns a new slice with a function applied over it.
|
||
godocref:
|
||
date: 2017-02-01
|
||
publishdate: 2017-02-01
|
||
lastmod: 2017-02-01
|
||
categories: [functions]
|
||
menu:
|
||
docs:
|
||
parent: "functions"
|
||
keywords: [advanced]
|
||
signature: ["apply COLLECTION FUNCTION [PARAM...]"]
|
||
workson: []
|
||
hugoversion:
|
||
relatedfuncs: []
|
||
deprecated: false
|
||
draft: false
|
||
aliases: []
|
||
---
|
||
|
||
{{< todo >}}
|
||
POTENTIAL NEW CONTENT: see apply/sequence discussion: https://discourse.gohugo.io/t/apply-printf-on-a-sequence/5722;
|
||
{{< /todo >}}
|
||
|
||
`apply` expects at least three parameters, depending on the function being applied.
|
||
|
||
1. The first parameter is the sequence to operate on.
|
||
2. The second parameter is the name of the function as a string, which must be the name of a valid [Hugo function][functions].
|
||
3. After that, the parameters 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:
|
||
|
||
```
|
||
+++
|
||
names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ]
|
||
+++
|
||
```
|
||
|
||
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][delimit], 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/partial/post-tag-list.html" copy="false" >}}
|
||
{{ with .Params.tags }}
|
||
<div class="tags-list">
|
||
Tags:
|
||
{{ $len := len . }}
|
||
{{ if eq $len 1 }}
|
||
{{ partial "post/tag/link" (index . 0) }}
|
||
{{ else }}
|
||
{{ $last := sub $len 1 }}
|
||
{{ range first $last . }}
|
||
{{ partial "post/tag/link" . }},
|
||
{{ end }}
|
||
{{ partial "post/tag/link" (index . $last) }}
|
||
{{ end }}
|
||
</div>
|
||
{{ end }}
|
||
{{< /code >}}
|
||
|
||
{{< code file="layouts/partial/post-tag-link.html" copy="false" >}}
|
||
<a class="post-tag post-tag-{{ . | urlize }}" href="/tags/{{ . | urlize }}">{{ . }}</a>
|
||
{{< /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 there’s 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" "." }}
|
||
{{ $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" download="post-tag-list.html" >}}
|
||
{{ with .Params.tags }}
|
||
<div class="tags-list">
|
||
Tags:
|
||
{{ delimit (apply (apply (sort .) "partial" "post-tag-link" ".") "chomp" ".") ", " }}
|
||
</div>
|
||
{{ end }}
|
||
{{< /code >}}
|
||
|
||
{{% note %}}
|
||
`apply` does not work when receiving the sequence as an argument through a pipeline.
|
||
{{% /note %}}
|
||
|
||
[chomp]: /functions/chomp/ "See documentation for the chomp function"
|
||
[delimit]: /functions/delimit/ "See documentation for the delimit function"
|
||
[functions]: /functions/ "See the full list of Hugo functions to see what can be passed as an argument to the apply function."
|
||
[partials]: /templates/partials/
|
||
[range]: /functions/range/ "Learn the importance of the range function, a fundamental keyword in both Hugo templates and the Go programming language."
|