tpl: Refactor time.AsTime location implementation

This commit is contained in:
Cameron Moore
2020-10-20 20:07:11 -05:00
committed by Bjørn Erik Pedersen
parent 26eeb29147
commit 807db97af8
2 changed files with 51 additions and 55 deletions

View File

@@ -13,13 +13,13 @@ menu:
keywords: [dates,time,location]
signature: ["time INPUT [LOCATION]"]
workson: []
hugoversion:
hugoversion: "v0.77.0"
relatedfuncs: []
deprecated: false
aliases: []
---
`time` converts a timestamp string with an optional timezone into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields:
`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:
```
{{ time "2016-05-28" }} → "2016-05-28T00:00:00Z"
@@ -27,9 +27,11 @@ aliases: []
{{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }} → 1464395400000, or Unix time in milliseconds
```
## Using Timezone
## Using Locations
The optional 2nd parameter [LOCATION] argument is a string that references a timezone that is associated with the specified time value. If the time value has an explicit timezone or offset specified, it will take precedence over an explicit [LOCATION].
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 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).
```
{{ time "2020-10-20" }} → 2020-10-20 00:00:00 +0000 UTC
@@ -37,8 +39,6 @@ The optional 2nd parameter [LOCATION] argument is a string that references a tim
{{ time "2020-01-20" "America/Los_Angeles" }} → 2020-01-20 00:00:00 -0800 PST
```
> **Note**: Timezone support via the [LOCATION] parameter is included with Hugo `0.77`.
## Example: Using `time` to get Month Index
The following example takes a UNIX timestamp---set as `utimestamp: "1489276800"` in a content's front matter---converts the timestamp (string) to an integer using the [`int` function][int], and then uses [`printf`][] to convert the `Month` property of `time` into an index.