mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-08-27 22:09:53 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add map support to scratch

Browse Source
This commit is contained in:
Marek Janda
2015-08-02 07:00:43 +02:00
committed by Bjørn Erik Pedersen
parent 8d28686edc
commit 4bed69629e
3 changed files with 66 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/extras/scratch.md
View File

@@ -14,9 +14,13 @@ weight: 80
`Scratch` -- a "scratchpad" for your node- or page-scoped variables. In most cases you can do well without `Scratch`, but there are some use cases that aren't solvable with Go's templates without `Scratch`'s help, due to scoping issues.
`Scratch` is added to both `Node` and `Page` -- with the three methods `Set`, `Get` and `Add`. `Set` and `Add` takes a `key` and the `value` to add. Get returns the `value` for the `key` given.
`Scratch` is added to both `Node` and `Page` -- with following methods:
* `Set` and `Add` takes a `key` and the `value` to add.
* `Get` returns the `value` for the `key` given.
* `SetInMap` takes a `key`, `mapKey` and `value`
* `GetSortedMapValues` returns array of values from `key` sorted by `mapKey`
`Set` can store values of any type. `Add` accepts values that support Go's `+` operator.
`Set` and `SetInMap` can store values of any type. `Add` accepts values that support Go's `+` operator.
The scope of the backing data is global for the given `Node` or `Page`, and spans partial and shortcode includes.
@@ -37,6 +41,12 @@ The usage is best illustrated with some samples:
{{ $.Scratch.Set "v1" 123 }}
{{ $.Scratch.Get "v1" }} {{/* => 123 */}}
{{ $.Scratch.SetInMap "a3" "b" "XX" }}
{{ $.Scratch.SetInMap "a3" "a" "AA" }}
{{ $.Scratch.SetInMap "a3" "c" "CC" }}
{{ $.Scratch.SetInMap "a3" "b" "BB" }}
{{ $.Scratch.GetSortedMapValues "a3" }} {{/* => []interface {}{"AA", "BB", "CC"} */}}
```
**Note:** The examples above uses the special `$` variable, which refers to the top-level node. This is the behavior you most likely want, and will help remove some confusion when using `Scratch` inside page range loops -- and you start inadvertently calling the wrong `Scratch`. But there may be use cases for `{{ .Scratch.Add "key" "some value" }}`.