HUGO

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
gohugoio Star
  • 关于
    • 本节内容
    • 简介
    • 特性
    • 隐私
    • 安全
    • 许可证
  • 安装
    • 本节内容
    • macOS
    • Linux
    • Windows
    • BSD
  • 入门
    • 本节内容
    • 快速入门
    • 基本用法
    • 目录结构
    • 配置
    • 配置标记
    • 配置构建
    • 术语表
    • 外部学习资源
  • 快速参考
    • 本节内容
    • 表情符号
    • 函数
    • 方法
    • 页面集合
  • 内容管理
    • 本节内容
    • 组织
    • 页面包
    • 内容格式
    • 前言
    • 构建选项
    • 页面资源
    • 图像处理
    • 短代码
    • 相关内容
    • 章节
    • 内容类型
    • 原型
    • 分类法
    • 摘要
    • 链接和交叉引用
    • URL 管理
    • 菜单
    • 评论
    • 多语言
    • Markdown 属性
    • 语法高亮
    • 图表
    • 数学
    • 数据源
    • 内容适配器
  • 模板
    • 本节内容
    • 简介
    • 模板类型
    • 查找顺序
    • 基础模板
    • 主页模板
    • 单页模板
    • 章节模板
    • 分类法模板
    • 术语模板
    • 局部模板
    • 内容视图模板
    • 短代码模板
    • 站点地图模板
    • RSS 模板
    • 404 模板
    • robots.txt 模板
    • 菜单
    • 分页
    • 嵌入式模板
    • 自定义输出格式
  • 函数
    • 本节内容
    • 类型转换
    • 集合
    • 比较
    • 加密
    • CSS
    • 数据
    • 调试
    • 图表
    • 编码
    • 格式化
    • 全局
    • Go 模板
    • 哈希
    • Hugo
    • 图像
    • 变形
    • JS
    • 语言
    • 数学
    • OpenAPI3
    • 操作系统
    • 局部
    • 路径
    • 反射
    • 资源
    • 安全
    • 字符串
    • 模板
    • 时间
    • 转换
    • URL
  • 方法
    • 本节内容
    • 持续时间
    • 菜单
    • 菜单项
    • 页面
    • 分页器
    • 页面集合
    • 资源
    • 短代码
    • 站点
    • 分类法
    • 时间
  • 渲染钩子
    • 本节内容
    • 简介
    • 块引用
    • 代码块
    • 标题
    • 图像
    • 链接
    • 直接传递
    • 表格
  • 短代码
    • 本节内容
    • 注释
    • 详情
    • 图
    • Gist
    • 高亮
    • Instagram
    • 参数
    • 二维码
    • 引用
    • 相对引用
    • Vimeo
    • X
    • YouTube
  • Hugo 模块
    • 本节内容
    • 配置 Hugo 模块
    • 使用 Hugo 模块
    • 主题组件
  • Hugo Pipes
    • 本节内容
    • 简介
    • 将 Sass 转译为 CSS
    • PostCSS
    • 后处理
    • JavaScript 构建
    • 资源压缩
    • 连接资源
    • 指纹识别和 SRI 哈希
    • 从字符串创建资源
    • 从模板创建资源
  • 命令行界面
  • 问题排查
    • 本节内容
    • 审计
    • 日志记录
    • 检查
    • 弃用
    • 性能
    • 常见问题
  • 开发者工具
    • 本节内容
    • 编辑器插件
    • 前端
    • 搜索
    • 迁移
    • 其他项目
  • 托管和部署
    • 本节内容
    • Hugo 部署
    • 使用 Rclone 部署
    • 使用 Rsync 部署
    • 在 21YunBox 上托管
    • 在 AWS Amplify 上托管
    • 在 Azure Static Web Apps 上托管
    • 在 Cloudflare Pages 上托管
    • 在 Firebase 上托管
    • 在 GitHub Pages 上托管
    • 在 GitLab Pages 上托管
    • 在 KeyCDN 上托管
    • 在 Netlify 上托管
    • 在 Render 上托管
  • 贡献
    • 本节内容
    • 开发
    • 文档
    • 主题
  • 维护
方法 短代码方法

序号

返回短代码相对于其父级的从零开始的序号。

语法

SHORTCODE.Ordinal

返回

int

Ordinal 方法返回短代码相对于其父级的从零开始的序号。如果父级是页面本身,则序号表示此短代码在页面内容中的位置。

无论具体的短代码类型如何,Hugo 都会在每次调用短代码时递增序号。这意味着序号值会在给定页面中的所有短代码中按顺序跟踪。

此方法对于(尤其)在同一页面多次调用短代码时分配唯一的元素 ID 非常有用。例如

content/about.md
{{< img src="images/a.jpg" >}}

{{< img src="images/b.jpg" >}}

此短代码执行错误检查,然后使用唯一的 id 属性渲染 HTML img 元素

layouts/shortcodes/img.html
{{ $src := "" }}
{{ with .Get "src" }}
  {{ $src = . }}
  {{ with resources.Get $src }}
    {{ $id := printf "img-%03d" $.Ordinal }}
    <img id="{{ $id }}" src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
  {{ else }}
    {{ errorf "The %q shortcode was unable to find %s. See %s" $.Name $src $.Position }}
  {{ end }}
{{ else }}
  {{ errorf "The %q shortcode requires a 'src' argument. See %s" .Name .Position }}
{{ end }}

Hugo 将页面渲染为

<img id="img-000" src="/images/a.jpg" width="600" height="400" alt="">
<img id="img-001" src="/images/b.jpg" width="600" height="400" alt="">

在上面的短代码模板中,with 语句用于创建条件块。请记住,with 语句将其表达式绑定到上下文(点)。在 with 块内部,在调用短代码方法时,在前面加上 $ 以访问传递到模板的顶层上下文。

本节内容

  • 获取
  • 内部
  • 内部取消缩进
  • 是否为命名参数
  • 名称
  • 序号
  • 页面
  • 参数
  • 父级
  • 位置
  • 引用
  • 相对引用
  • 临时存储
  • 站点
  • 存储
上次更新时间:2024 年 11 月 23 日:澄清短代码序号方法 (ebbd2e851)
改进此页面
由 Hugo 作者
Hugo Logo
  • 提交问题
  • 获取帮助
  • @GoHugoIO
  • @spf13
  • @bepsays

Netlify badge

 

Hugo 赞助商

贵公司?
 

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

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

  • 新闻
  • 文档
  • 主题
  • 社区
  • GitHub
  • 关于
  • 安装
  • 入门
  • 快速参考
  • 内容管理
  • 模板
  • 函数
  • 方法
  • 渲染钩子
  • 短代码
  • Hugo 模块
  • Hugo Pipes
  • 命令行界面
  • 问题排查
  • 开发者工具
  • 托管和部署
  • 贡献
  • 维护