HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 在本节中
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可
  • 安装
    • 在本节中
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 在本节中
    • 快速开始
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 在本节中
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 在本节中
    • 组织
    • 页面包
    • 内容格式
    • 前言
    • 构建选项
    • 页面资源
    • 图像处理
    • 简码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 在本节中
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 简码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 在本节中
    • cast
    • collections
    • compare
    • crypto
    • css
    • data
    • debug
    • diagrams
    • encoding
    • fmt
    • global
    • go template
    • hash
    • hugo
    • images
    • inflect
    • js
    • lang
    • math
    • openapi3
    • os
    • partials
    • path
    • reflect
    • resources
    • safe
    • strings
    • templates
    • time
    • transform
    • urls
  • 方法
    • 在本节中
    • Duration
    • Menu
    • Menu entry
    • Page
    • Pager
    • Pages
    • Resource
    • Shortcode
    • Site
    • Taxonomy
    • Time
  • 渲染钩子
    • 在本节中
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图像
    • 链接
    • 直通
    • 表格
  • 简码
    • 在本节中
    • 评论
    • 详情
    • 图
    • Gist
    • 高亮
    • Instagram
    • Param
    • QR
    • Ref
    • Relref
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 在本节中
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo Pipes
    • 在本节中
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • PostProcess
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹识别和 SRI 哈希
    • 从字符串获取资源
    • 从模板获取资源
  • CLI
  • 故障排除
    • 在本节中
    • 审计
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • 常见问题解答
  • 开发者工具
    • 在本节中
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 在本节中
    • Hugo Deploy
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 在本节中
    • 开发
    • 文档
    • 主题
  • 维护
方法 简码方法

Scratch

返回一个作用域为简码的“草稿板”,用于存储和操作数据。

语法

SHORTCODE.Scratch

返回

maps.Scratch

在 v0.139.0 中已弃用。

请改用 SHORTCODE.Store 方法。

这是一个软弃用。此方法将在未来的版本中删除,但尚未确定删除日期。即使您继续使用此方法,Hugo 也不会发出警告,但您应尽快开始使用 SHORTCODE.Store。

从 v0.139.0 开始,SHORTCODE.Scratch 方法被别名为 SHORTCODE.Store。

简码内的 Scratch 方法会创建一个 草稿板,用于存储和操作数据。草稿板的作用域限定为简码。

随着 newScratch 函数的引入,以及在初始化后将值分配给模板变量的能力,简码内的 Scratch 方法已过时。

方法

Set

设置给定键的值。

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

获取给定键的值。

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

将给定值添加到给定键的现有值。

对于单个值,Add 接受支持 Go 的 + 运算符的值。如果某个键的第一个 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" }}

另请参阅

  • collections.NewScratch

在本节中

  • Get
  • Inner
  • InnerDeindent
  • IsNamedParams
  • Name
  • Ordinal
  • Page
  • Params
  • Parent
  • Position
  • Ref
  • RelRef
  • Scratch
  • Site
  • Store
上次更新:2024 年 11 月 23 日:添加 hugo.Store、site.Store 和 Shortcode.Store (03e666038)
改进此页面
由 Hugo 作者 提供
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

您的公司?
 

Hugo 徽标的版权归 Steve Francia 2013–2025 所有。

Hugo Gopher 基于 Renée French 的原创作品。

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 入门
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • 简码
  • Hugo 模块
  • Hugo Pipes
  • CLI
  • 故障排除
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护