mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-15 08:38:30 -04:00
Merge branch 'v0861'
This commit is contained in:
commit
467a89a021
@ -134,7 +134,7 @@ Or individually access EXIF data with dot access, e.g.:
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
Some fields may need to be formatted with [`lang.NumFmt`]({{< relref "functions/numfmt" >}}) function to prevent display like `Aperture: 2.278934289` instead of `Aperture: 2.28`.
|
||||
Some fields may need to be formatted with [`lang.FormatNumberCustom`]({{< relref "functions/lang" >}}) function to prevent display like `Aperture: 2.278934289` instead of `Aperture: 2.28`.
|
||||
|
||||
#### Exif fields
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: dateFormat
|
||||
description: Converts the textual representation of the `datetime` into the specified format.
|
||||
title: time.Format
|
||||
description: Converts a date/time to a localized string.
|
||||
godocref: https://golang.org/pkg/time/
|
||||
date: 2017-02-01
|
||||
publishdate: 2017-02-01
|
||||
@ -10,23 +10,47 @@ menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [dates,time,strings]
|
||||
signature: ["dateFormat LAYOUT INPUT"]
|
||||
signature: ["time.Format LAYOUT INPUT"]
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: [Format,now,Unix,time]
|
||||
deprecated: false
|
||||
---
|
||||
|
||||
`dateFormat` converts a timestamp string `INPUT` into the format specified by the `LAYOUT` string.
|
||||
`time.Format` (alias `dateFormat`) converts either a `time.Time` object (e.g. `.Date`) or a timestamp string `INPUT` into the format specified by the `LAYOUT` string.
|
||||
|
||||
```
|
||||
{{ dateFormat "Monday, Jan 2, 2006" "2015-01-21" }} → "Wednesday, Jan 21, 2015"
|
||||
```go-html-template
|
||||
{{ time.Format "Monday, Jan 2, 2006" "2015-01-21" }} → "Wednesday, Jan 21, 2015"
|
||||
```
|
||||
|
||||
{{% warning %}}
|
||||
As of v0.19 of Hugo, the `dateFormat` function is *not* supported as part of Hugo's [multilingual feature](/content-management/multilingual/).
|
||||
{{% /warning %}}
|
||||
Note that since Hugo 0.87.0, `time.Format` will return a localized string for the currrent language. {{< new-in "0.87.0" >}}
|
||||
|
||||
See [Go’s Layout String](/functions/format/#gos-layout-string) to learn about how the `LAYOUT` string has to be formatted. There are also some useful examples.
|
||||
The `LAYOUT` string can be either:
|
||||
|
||||
* [Go’s Layout String](/functions/format/#gos-layout-string) to learn about how the `LAYOUT` string has to be formatted. There are also some useful examples.
|
||||
* A custom Hugo layout identifier (see full list below)
|
||||
|
||||
See the [`time` function](/functions/time/) to convert a timestamp string to a Go `time.Time` type value.
|
||||
|
||||
|
||||
## Date/time formatting layouts
|
||||
|
||||
{{< new-in "0.87.0" >}}
|
||||
|
||||
Go's date layout strings can be hard to reason about, especially with multiple languages. Since Hugo 0.87.0 you can alternatively use some predefined layout idenfifiers that will output localized dates or times:
|
||||
|
||||
```go-html-template
|
||||
{{ .Date | time.Format ":date_long" }}
|
||||
```
|
||||
|
||||
The full list of custom layouts with examples for English:
|
||||
|
||||
* `:date_full` => `Wednesday, June 6, 2018`
|
||||
* `:date_long` => `June 6, 2018`
|
||||
* `:date_medium` => `Jun 6, 2018`
|
||||
* `:date_short` => `6/6/18`
|
||||
|
||||
* `:time_full` => `2:09:37 am UTC`
|
||||
* `:time_long` => `2:09:37 am UTC`
|
||||
* `:time_medium` => `2:09:37 am`
|
||||
* `:time_short` => `2:09 am`
|
||||
|
@ -1,10 +1,8 @@
|
||||
---
|
||||
title: lang.NumFmt
|
||||
description: "Formats a number with a given precision using the requested `negative`, `decimal`, and `grouping` options. The `options` parameter is a string consisting of `<negative> <decimal> <grouping>`."
|
||||
godocref: ""
|
||||
date: 2017-02-01
|
||||
publishdate: 2017-02-01
|
||||
lastmod: 2017-08-21
|
||||
title: lang
|
||||
package: lang
|
||||
description: "TODO.."
|
||||
date: 2021-07-28
|
||||
categories: [functions]
|
||||
keywords: [numbers]
|
||||
menu:
|
||||
@ -12,18 +10,13 @@ menu:
|
||||
parent: "functions"
|
||||
toc: false
|
||||
signature: ["lang.NumFmt PRECISION NUMBER [OPTIONS [DELIMITER]]"]
|
||||
workson: []
|
||||
hugoversion:
|
||||
relatedfuncs: []
|
||||
deprecated: false
|
||||
draft: false
|
||||
aliases: []
|
||||
comments:
|
||||
aliases: ['/functions/numfmt/']
|
||||
type: 'template-func'
|
||||
---
|
||||
|
||||
The default options value is `- . ,`. The default delimiter within the options
|
||||
value is a space. If you need to use a space as one of the options, set a
|
||||
custom delimiter.
|
||||
custom delimiter.s
|
||||
|
||||
Numbers greater than or equal to 5 are rounded up. For example, if precision is set to `0`, `1.5` becomes `2`, and `1.4` becomes `1`.
|
||||
|
@ -11,7 +11,7 @@ menu:
|
||||
docs:
|
||||
parent: "functions"
|
||||
keywords: [dates,time,location]
|
||||
signature: ["time INPUT [LOCATION]"]
|
||||
signature: ["time INPUT [TIMEZONE]"]
|
||||
workson: []
|
||||
hugoversion: "v0.77.0"
|
||||
relatedfuncs: []
|
||||
@ -19,6 +19,7 @@ deprecated: false
|
||||
aliases: []
|
||||
---
|
||||
|
||||
|
||||
`time` converts a timestamp string with an optional default location into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields:
|
||||
|
||||
```
|
||||
@ -29,10 +30,12 @@ aliases: []
|
||||
|
||||
## Using Locations
|
||||
|
||||
The optional `LOCATION` parameter is a string that sets a default location that is associated with the specified time value. If the time value has an explicit timezone or offset specified, it will take precedence over the `LOCATION` parameter.
|
||||
The optional `TIMEZONE` parameter is a string that sets a default time zone (or more specific, the location, which represents the collection of time offsets in a geographical area) that is associated with the specified time value. If the time value has an explicit timezone or offset specified, it will take precedence over the `TIMEZONE` parameter.
|
||||
|
||||
The list of valid locations may be system dependent, but should include `UTC`, `Local`, or any location in the [IANA Time Zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
||||
|
||||
If no `TIMEZONE` is set, the `timeZone` from site configuration will be used.
|
||||
|
||||
```
|
||||
{{ time "2020-10-20" }} → 2020-10-20 00:00:00 +0000 UTC
|
||||
{{ time "2020-10-20" "America/Los_Angeles" }} → 2020-10-20 00:00:00 -0700 PDT
|
||||
|
@ -302,6 +302,9 @@ themesDir ("themes")
|
||||
timeout (10000)
|
||||
: Timeout for generating page contents, in milliseconds (defaults to 10 seconds). *Note:* this is used to bail out of recursive content generation, if your pages are slow to generate (e.g., because they require large image processing or depend on remote contents) you might need to raise this limit.
|
||||
|
||||
timeZone {{< new-in "0.86.0" >}}
|
||||
: The time zone (or location), e.g. `Europe/Oslo`, used to parse front matter dates without such information and in the [`time` function](/functions/time/).
|
||||
|
||||
title ("")
|
||||
: Site title.
|
||||
|
||||
|
19
content/en/news/0.86.1-relnotes/index.md
Normal file
19
content/en/news/0.86.1-relnotes/index.md
Normal file
@ -0,0 +1,19 @@
|
||||
|
||||
---
|
||||
date: 2021-07-30
|
||||
title: "Hugo 0.86.1: A couple of Bug Fixes"
|
||||
description: "This version fixes a couple of bugs introduced in 0.86.0."
|
||||
categories: ["Releases"]
|
||||
images:
|
||||
- images/blog/hugo-bug-poster.png
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
This is a bug-fix release with one important fix.
|
||||
|
||||
* config: Fix a potential deadlock in config reading [94b616bd](https://github.com/gohugoio/hugo/commit/94b616bdfad177daa99f5e87535943f509198f6f) [@bep](https://github.com/bep) [#8791](https://github.com/gohugoio/hugo/issues/8791)
|
||||
|
||||
|
||||
|
@ -3902,14 +3902,52 @@
|
||||
}
|
||||
},
|
||||
"lang": {
|
||||
"Merge": {
|
||||
"Description": "",
|
||||
"Args": null,
|
||||
"FormatAccounting": {
|
||||
"Description": "FormatAccounting returns the currency reprecentation of number for the given currency and precision\nfor the current language in accounting notation.",
|
||||
"Args": [
|
||||
"precision",
|
||||
"currency",
|
||||
"number"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": null
|
||||
"Examples": [
|
||||
[
|
||||
"{{ 512.5032 | lang.FormatAccounting 2 \"NOK\" }}",
|
||||
"NOK512.50"
|
||||
]
|
||||
]
|
||||
},
|
||||
"NumFmt": {
|
||||
"Description": "NumFmt formats a number with the given precision using the\nnegative, decimal, and grouping options. The `options`\nparameter is a string consisting of `\u003cnegative\u003e \u003cdecimal\u003e \u003cgrouping\u003e`. The\ndefault `options` value is `- . ,`.\n\nNote that numbers are rounded up at 5 or greater.\nSo, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.",
|
||||
"FormatCurrency": {
|
||||
"Description": "FormatCurrency returns the currency reprecentation of number for the given currency and precision\nfor the current language.",
|
||||
"Args": [
|
||||
"precision",
|
||||
"currency",
|
||||
"number"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{ 512.5032 | lang.FormatCurrency 2 \"USD\" }}",
|
||||
"$512.50"
|
||||
]
|
||||
]
|
||||
},
|
||||
"FormatNumber": {
|
||||
"Description": "FormatNumber formats number with the given precision for the current language.",
|
||||
"Args": [
|
||||
"precision",
|
||||
"number"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{ 512.5032 | lang.FormatNumber 2 }}",
|
||||
"512.50"
|
||||
]
|
||||
]
|
||||
},
|
||||
"FormatNumberCustom": {
|
||||
"Description": "FormatNumberCustom formats a number with the given precision using the\nnegative, decimal, and grouping options. The `options`\nparameter is a string consisting of `\u003cnegative\u003e \u003cdecimal\u003e \u003cgrouping\u003e`. The\ndefault `options` value is `- . ,`.\n\nNote that numbers are rounded up at 5 or greater.\nSo, with precision set to 0, 1.5 becomes `2`, and 1.4 becomes `1`.\n\nFor a simpler function that adapts to the current language, see FormatNumberCustom.",
|
||||
"Args": [
|
||||
"precision",
|
||||
"number",
|
||||
@ -3918,19 +3956,19 @@
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{ lang.NumFmt 2 12345.6789 }}",
|
||||
"{{ lang.FormatNumberCustom 2 12345.6789 }}",
|
||||
"12,345.68"
|
||||
],
|
||||
[
|
||||
"{{ lang.NumFmt 2 12345.6789 \"- , .\" }}",
|
||||
"{{ lang.FormatNumberCustom 2 12345.6789 \"- , .\" }}",
|
||||
"12.345,68"
|
||||
],
|
||||
[
|
||||
"{{ lang.NumFmt 6 -12345.6789 \"- .\" }}",
|
||||
"{{ lang.FormatNumberCustom 6 -12345.6789 \"- .\" }}",
|
||||
"-12345.678900"
|
||||
],
|
||||
[
|
||||
"{{ lang.NumFmt 0 -12345.6789 \"- . ,\" }}",
|
||||
"{{ lang.FormatNumberCustom 0 -12345.6789 \"- . ,\" }}",
|
||||
"-12,346"
|
||||
],
|
||||
[
|
||||
@ -3939,6 +3977,32 @@
|
||||
]
|
||||
]
|
||||
},
|
||||
"FormatPercent": {
|
||||
"Description": "FormatPercent formats number with the given precision for the current language.\nNote that the number is assumbed to be percent.",
|
||||
"Args": [
|
||||
"precision",
|
||||
"number"
|
||||
],
|
||||
"Aliases": null,
|
||||
"Examples": [
|
||||
[
|
||||
"{{ 512.5032 | lang.FormatPercent 2 }}",
|
||||
"512.50%"
|
||||
]
|
||||
]
|
||||
},
|
||||
"Merge": {
|
||||
"Description": "",
|
||||
"Args": null,
|
||||
"Aliases": null,
|
||||
"Examples": null
|
||||
},
|
||||
"NumFmt": {
|
||||
"Description": "",
|
||||
"Args": null,
|
||||
"Aliases": null,
|
||||
"Examples": null
|
||||
},
|
||||
"Translate": {
|
||||
"Description": "Translate returns a translated string for id.",
|
||||
"Args": [
|
||||
|
54
layouts/template-func/page.html
Normal file
54
layouts/template-func/page.html
Normal file
@ -0,0 +1,54 @@
|
||||
{{ $pkg := .Params.package}}
|
||||
{{ $funcs := index site.Data.docs.tpl.funcs $pkg }}
|
||||
|
||||
{{ range $k, $v := $funcs }}
|
||||
{{ if $v.Description }}
|
||||
{{ $func := printf "%s.%s" $pkg $k }}
|
||||
<h2>
|
||||
<a class="header-link" href="#{{ $func | anchorize | safeURL }}">
|
||||
<svg class="fill-current o-60 hover-accent-color-light" height="22px" viewBox="0 0 24 24" width="22px" xmlns="http://www.w3.org/2000/svg">
|
||||
<path d="M0 0h24v24H0z" fill="none"/>
|
||||
<path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/>
|
||||
</svg>
|
||||
</a>
|
||||
{{ $func }}
|
||||
</h2>
|
||||
{{ with $v.Description }}
|
||||
<p class="f4 lh-copy">
|
||||
{{ . | $.RenderString | safeHTML }}
|
||||
</p>
|
||||
{{ end }}
|
||||
<h4 class="minor mb3 pt2 primary-color-dark">
|
||||
Syntax
|
||||
</h4>
|
||||
<div class="f5 mb4 ph3 pv2 bg-light-gray" style="border-left:4px solid #0594CB;">
|
||||
{{ $pkg }}.{{ $k }}
|
||||
{{ with $v.Args }}
|
||||
<span class="ttu">
|
||||
{{ delimit $v.Args ", "}}
|
||||
</span>
|
||||
{{ end }}
|
||||
<span></span>
|
||||
</div>
|
||||
{{ if $v.Examples }}
|
||||
<h4 class="minor mb3 pt2 primary-color-dark">
|
||||
Examples
|
||||
</h4>
|
||||
{{ end }}
|
||||
{{ range $v.Examples }}
|
||||
{{ $input := index . 0 }}
|
||||
{{ $result := index . 1 }}
|
||||
{{ $example := printf "%s ---> %s" $input $result }}
|
||||
|
||||
{{ highlight $example "go-html-template" "" }}
|
||||
{{ end }}
|
||||
{{ with $v.Aliases }}
|
||||
<h4 class="minor mb3 pt2 primary-color-dark">
|
||||
Aliases
|
||||
</h4>
|
||||
<p>
|
||||
{{ delimit . ", "}}
|
||||
</p>
|
||||
{{ end }}
|
||||
{{ end }}
|
||||
{{ end }}
|
Loading…
x
Reference in New Issue
Block a user