文档章节

Menu entry 方法

在菜单模板中使用这些方法:名字、链接、层级与装饰。

难度
参考
预计用时
15 分钟

开始之前,你需要

  • 读过 Menu 方法 一章,知道 site.Menus.main 是菜单、循环里的 . 是条目。
  • 知道菜单条目可以在项目配置、页面前置元数据里定义,也可以由页面自动生成;不熟先看菜单。

读完之后你能

  • 在菜单模板里取对值:显示名用 .Name,链接用 .URL,页面对象用 .Page;
  • 按分组找到需要的方法,而不是一个个翻:文字与标识 / 链接与页面 / 层级 / 顺序与自定义数据 / 装饰;
  • 判断哪个方法可能拿不到值(.Page 可能是 nil、.Identifier 可能是空字符串),并用 with 包住;
  • 用 .HasChildren 加 .Children 渲染二级菜单,用 .Params 给条目挂自定义数据。

接着读:Menu · 菜单模板 · 菜单

本章导读

菜单条目(menu entry,就是菜单循环里的 .)是菜单模板的主角。一次 {{ range site.Menus.main }} 里,.Name 是显示文字、.URL 是填进 href 的地址、.Page 是它指向的页面对象。

条目从哪里来不影响取法——项目配置里的 [[menus.main]]、页面前置元数据里的 menus、Hugo 自动生成的条目,暴露的是同一组方法;差别只在「属性没写时回退到什么」,每张叶子页都会写清楚。

分类 方法
文字与标识 Name、Title、Identifier、KeyName、Menu
链接与页面 URL、Page、PageRef
层级 Children、HasChildren、Parent
顺序与自定义数据 Weight、Params
装饰 Pre、Post

阅读顺序

先读 URL 和 Name——菜单模板里最常用的两个;再读 Page,分清「指向页面的条目」与「外链条目」;然后读 HasChildren 与 Children 做嵌套菜单。Identifier 与 KeyName 主要服务多语言翻译表,可以最后看。

完整可复制的菜单模板见菜单模板。

本章内容

  • Children 返回给定菜单条目下的子菜单条目集合(如果有)。 (今天)
  • HasChildren 报告给定菜单条目是否有子菜单条目。 (今天)
  • Identifier 返回给定菜单条目的 `identifier` 属性。 (今天)
  • KeyName 返回给定菜单条目的 `identifier` 属性,若不存在则回退到其 `name` 属性。 (今天)
  • Menu 返回包含给定菜单条目的菜单标识符。 (今天)
  • Name 返回给定菜单条目的 `name` 属性。 (今天)
  • Page 返回与给定菜单条目关联的 Page 对象。 (今天)
  • PageRef 返回给定菜单条目的 `pageRef` 属性。 (今天)
  • Params 返回给定菜单条目的 `params` 属性。 (今天)
  • Parent 返回给定菜单条目的 `parent` 属性。 (今天)
  • Post 返回给定菜单条目的 `post` 属性。 (今天)
  • Pre 返回给定菜单条目的 `pre` 属性。 (今天)
  • Title 返回给定菜单条目的 `title` 属性。 (今天)
  • URL 返回与给定菜单条目关联的页面的相对永久链接,否则返回其 `url` 属性。 (今天)
  • Weight 返回给定菜单条目的 `weight` 属性。 (今天)