Scratch

Scratch 方法在 Page 物件上創建一個 scratch pad 以便存儲和操作數據。若要創建一個在服務器重建時不會被重置的 scratch pad，請使用 Store 方法。

要創建一個本地作用範圍的 scratch pad，且不附加於 Page 物件，請使用 newScratch 函數。

方法

Set

設定指定鍵的值。

{{ .Scratch.Set "greeting" "Hello" }}
Get

取得指定鍵的值。

{{ .Scratch.Set "greeting" "Hello" }}
{{ .Scratch.Get "greeting" }} → Hello
Add

將指定的值加到給定鍵的現有值上。

對於單一值，Add 會接受可以支持 Go 的 + 運算符的值。如果第一次 Add 的鍵是陣列或切片，接下來的 Add 會將值附加到該清單中。

{{ .Scratch.Set "greeting" "Hello" }}
{{ .Scratch.Add "greeting" "Welcome" }}
{{ .Scratch.Get "greeting" }} → HelloWelcome

{{ .Scratch.Set "total" 3 }}
{{ .Scratch.Add "total" 7 }}
{{ .Scratch.Get "total" }} → 10

{{ .Scratch.Set "greetings" (slice "Hello") }}
{{ .Scratch.Add "greetings" (slice "Welcome" "Cheers") }}
{{ .Scratch.Get "greetings" }} → [Hello Welcome Cheers]
SetInMap

接受 key、mapKey 和 value，並將 mapKey 和 value 的映射添加到指定的 key 中。

{{ .Scratch.SetInMap "greetings" "english" "Hello" }}
{{ .Scratch.SetInMap "greetings" "french" "Bonjour" }}
{{ .Scratch.Get "greetings" }} → map[english:Hello french:Bonjour]
DeleteInMap

接受 key 和 mapKey，並移除指定 key 中的 mapKey 的映射。

{{ .Scratch.SetInMap "greetings" "english" "Hello" }}
{{ .Scratch.SetInMap "greetings" "french" "Bonjour" }}
{{ .Scratch.DeleteInMap "greetings" "english" }}
{{ .Scratch.Get "greetings" }} → map[french:Bonjour]
GetSortedMapValues

返回按 mapKey 排序的來自 key 的值陣列。

{{ .Scratch.SetInMap "greetings" "english" "Hello" }}
{{ .Scratch.SetInMap "greetings" "french" "Bonjour" }}
{{ .Scratch.GetSortedMapValues "greetings" }} → [Hello Bonjour]
Delete

移除指定的鍵。

{{ .Scratch.Set "greeting" "Hello" }}
{{ .Scratch.Delete "greeting" }}

確定值

Scratch 方法通常用於在短代碼、由短代碼調用的部分模板或 Markdown 渲染鉤子中設置 scratch pad 值。在這三種情況下，scratch pad 值在 Hugo 渲染頁面內容之前是未確定的。

如果需要從父模板訪問 scratch pad 值，並且父模板尚未渲染頁面內容，可以通過將返回值賦值給 noop 變數來觸發內容渲染：

{{ $noop := .Content }}
{{ .Store.Get "mykey" }}

您也可以使用 ContentWithoutSummary、FuzzyWordCount、Len、Plain、PlainWords、ReadingTime、Summary、Truncated 和 WordCount 方法來觸發內容渲染。例如：

{{ $noop := .WordCount }}
{{ .Store.Get "mykey" }}
Scratch safe.URL