diff options
Diffstat (limited to 'docs/content/en/functions/_common')
5 files changed, 59 insertions, 0 deletions
diff --git a/docs/content/en/functions/_common/go-template-functions.md b/docs/content/en/functions/_common/go-template-functions.md new file mode 100644 index 000000000..b8722743e --- /dev/null +++ b/docs/content/en/functions/_common/go-template-functions.md @@ -0,0 +1,3 @@ +See Go's [text/template] documentation for more details. + +[text/template]: https://pkg.go.dev/text/template diff --git a/docs/content/en/functions/_common/index.md b/docs/content/en/functions/_common/index.md new file mode 100644 index 000000000..cbb7365a6 --- /dev/null +++ b/docs/content/en/functions/_common/index.md @@ -0,0 +1,3 @@ ++++ +headless = true ++++ diff --git a/docs/content/en/functions/_common/locales.md b/docs/content/en/functions/_common/locales.md new file mode 100644 index 000000000..259231cbf --- /dev/null +++ b/docs/content/en/functions/_common/locales.md @@ -0,0 +1,3 @@ +Localization of dates, currencies, numbers, and percentages is performed by the [gohugoio/locales] package. The language tag of the current site must match one of the listed locales. + +[gohugoio/locales]: https://github.com/gohugoio/locales diff --git a/docs/content/en/functions/_common/regular-expressions.md b/docs/content/en/functions/_common/regular-expressions.md new file mode 100644 index 000000000..9da340849 --- /dev/null +++ b/docs/content/en/functions/_common/regular-expressions.md @@ -0,0 +1,8 @@ +When specifying the regular expression, use a raw [string literal] (backticks) instead of an interpreted string literal (double quotes) to simplify the syntax. With an interpreted string literal you must escape backslashes. + +Go's regular expression package implements the [RE2 syntax]. The RE2 syntax is a subset of that accepted by [PCRE], roughly speaking, and with various [caveats]. Note that the RE2 `\C` escape sequence is not supported. + +[caveats]: https://swtch.com/~rsc/regexp/regexp3.html#caveats +[PCRE]: https://www.pcre.org/ +[RE2 syntax]: https://github.com/google/re2/wiki/Syntax/ +[string literal]: https://go.dev/ref/spec#String_literals diff --git a/docs/content/en/functions/_common/time-layout-string.md b/docs/content/en/functions/_common/time-layout-string.md new file mode 100644 index 000000000..40932f8cf --- /dev/null +++ b/docs/content/en/functions/_common/time-layout-string.md @@ -0,0 +1,42 @@ +Format a `time.Time` value based on [Go's reference time]: + +[Go's reference time]: https://pkg.go.dev/time#pkg-constants + +```text {copy=false} +Mon Jan 2 15:04:05 MST 2006 +``` + +Create a format string using these components: + +Description|Valid components +:--|:-- +Year|`"2006" "06"` +Month|`"Jan" "January" "01" "1"` +Day of the week|`"Mon" "Monday"` +Day of the month|`"2" "_2" "02"` +Day of the year|`"__2" "002"` +Hour|`"15" "3" "03"` +Minute|`"4" "04"` +Second|`"5" "05"` +AM/PM mark|`"PM"` +Time zone offsets|`"-0700" "-07:00" "-07" "-070000" "-07:00:00"` + +Replace the sign in the format string with a Z to print Z instead of an offset for the UTC zone. + +Description|Valid components +:--|:-- +Time zone offsets|`"Z0700" "Z07:00" "Z07" "Z070000" "Z07:00:00"` + +```go-html-template +{{ $t := "2023-01-27T23:44:58-08:00" }} +{{ $t = time.AsTime $t }} +{{ $t = $t.Format "Jan 02, 2006 3:04 PM Z07:00" }} + +{{ $t }} → Jan 27, 2023 11:44 PM -08:00 +``` + +Strings such as `PST` and `CET` are not time zones. They are time zone _abbreviations_. + +Strings such as `-07:00` and `+01:00` are not time zones. They are time zone _offsets_. + +A time zone is a geographic area with the same local time. For example, the time zone abbreviated by `PST` and `PDT` (depending on Daylight Savings Time) is `America/Los_Angeles`. |