文档章节

方法

在模板中使用这些方法:Page、Site、Pages、Resource、Menu 等对象上的方法。

难度
参考
预计用时
按需查阅;通读约 30 分钟

开始之前,你需要

  • 知道 Go 模板的基本语法与「上下文」($、.)的含义;不确定先读模板简介。
  • 手边有一个能构建的站点,可以把方法直接放进模板里试。

读完之后你能

  • 分清方法与函数:$page.Title 是方法,strings.Truncate 是函数;
  • 按对象(Page、Site、Pages、Resource、Menu…)找到需要的方法,而不是靠翻页;
  • 判断某个对象可能为 nil(例如 .Next、.Parent),并用 with 包住再取方法;
  • 看懂链式写法 site.Home.Sections.ByWeight 每一步返回的是什么。

接着读:函数 · 简介 · Page

本章导读

模板里的能力分两半:函数是独立的工具(如 strings.Truncate),方法挂在某个对象上(如 $page.Title)。本章按对象分组收录 Hugo 内建的全部方法:Page、Site、Pages、Resource、Menu、Taxonomy 等。

方法的调用写法是「对象点方法」:

go-html-template
{{ .Title }}              {{/* 当前页面的标题 */}}
{{ site.Home.Sections }}  {{/* 站点的全部一级章节 */}}

链式调用从左到右逐层取值:上面第二行先取 site,再取它的 Home,最后取 Sections。中间任何一环是 nil,后面就会报 nil pointer 一类错误,所以常见做法是用 with 先确认:

go-html-template
{{ with .Next }}
  <a href="{{ .RelPermalink }}">{{ .Title }}</a>
{{ end }}

函数与方法的对照、以及命名空间(hugo.、site.、strings.)的含义,见函数一章。

本章内容

  • Duration 方法 在 time.Duration 值上使用这些方法。 (今天)
  • Menu 方法 在遍历菜单条目时使用这些方法:排序、反转、限量。 (今天)
  • Menu entry 方法 在菜单模板中使用这些方法:名字、链接、层级与装饰。 (今天)
  • Output format 方法 在 OutputFormat 对象上使用这些方法。 (今天)
  • Page 方法 在 Page 对象上使用这些方法。 (今天)
  • Pager 方法 为分页列表页构建导航时,在 Pager 对象上使用这些方法。 (今天)
  • Pages 方法 在 Page 对象集合上使用这些方法。 (今天)
  • Resource 方法 在全局资源、页面资源或远程资源对象上使用这些方法。 (今天)
  • Shortcode 方法 在你的短代码模板中使用这些方法。 (今天)
  • Site 方法 在 Site 对象上使用这些方法。 (今天)
  • Taxonomy 方法 在 Taxonomy 对象上使用这些方法。 (今天)
  • Time 方法 在 time.Time 值上使用这些方法。 (今天)