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
93 lines
2.5 KiB
Markdown
93 lines
2.5 KiB
Markdown
---
|
|
title: default
|
|
description: Allows setting a default value that can be returned if a first value is not set.
|
|
qref: "Returns a default value if a value is not set when checked."
|
|
godocref:
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
keywords: [defaults]
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
toc:
|
|
signature: ["default DEFAULT INPUT"]
|
|
workson: []
|
|
hugoversion:
|
|
relatedfuncs: []
|
|
deprecated: false
|
|
draft: false
|
|
aliases: [/functions/default/]
|
|
needsexamples: false
|
|
---
|
|
|
|
`default` checks whether a given value is set and returns a default value if it is not. *Set* in this context means different things depending on date type:
|
|
|
|
* non-zero for numeric types and times
|
|
* non-zero length for strings, arrays, slices, and maps
|
|
* any boolean or struct value
|
|
* non-nil for any other types
|
|
|
|
`default` function examples reference the following content page:
|
|
|
|
{{< code file="content/posts/default-function-example.md" >}}
|
|
---
|
|
title: Sane Defaults
|
|
seo_title:
|
|
date: 2017-02-18
|
|
font:
|
|
oldparam: The default function helps make your templating DRYer.
|
|
newparam:
|
|
---
|
|
{{< /code >}}
|
|
|
|
`default` can be written in more than one way:
|
|
|
|
```
|
|
{{ index .Params "font" | default "Roboto" }}
|
|
{{ default "Roboto" (index .Params "font") }}
|
|
```
|
|
|
|
Both of the above `default` function calls return `Roboto`.
|
|
|
|
A `default` value, however, does not need to be hard coded like the previous example. The `default` value can be a variable or pulled directly from the front matter using dot notation:
|
|
|
|
{{< code file="variable-as-default-value.html" nocopy="true" >}}
|
|
{{$old := .Params.oldparam }}
|
|
<p>{{ .Params.newparam | default $old }}</p>
|
|
{{< /code >}}
|
|
|
|
Which would return:
|
|
|
|
```
|
|
<p>The default function helps make your templating DRYer.</p>
|
|
```
|
|
|
|
And then using dot notation
|
|
|
|
{{< code file="dot-notation-default-value.html" >}}
|
|
<title>{{ .Params.seo_title | default .Title }}</title>
|
|
{{< /code >}}
|
|
|
|
Which would return
|
|
|
|
{{< output file="dot-notation-default-return-value.html" >}}
|
|
<title>Sane Defaults</title>
|
|
{{< /output >}}
|
|
|
|
The following have equivalent return values but are far less terse. This demonstrates the utility of `default`:
|
|
|
|
Using `if`:
|
|
|
|
{{< code file="if-instead-of-default.html" nocopy="true" >}}
|
|
<title>{{if .Params.seo_title}}{{.Params.seo_title}}{{else}}{{.Title}}{{end}}</title>
|
|
=> Sane Defaults
|
|
{{< /code >}}
|
|
|
|
Using `with`:
|
|
|
|
{{< code file="with-instead-of-default.html" nocopy="true" >}}
|
|
<title>{{with .Params.seo_title}}{{.}}{{else}}{{.Title}}{{end}}</title>
|
|
=> Sane Defaults
|
|
{{< /code >}}
|