方法
菜单
使用这些方法在遍历菜单项时。
- ByName
- 返回给定菜单，并按名称排序其条目。
- ByWeight
- 返回按权重，名称，标识符排序的给定菜单。
- Reverse（反转）
- 返回给定菜单，反转其条目的排序顺序。
- 限制
- 返回给定菜单，限制为前N个条目。
菜单项
在菜单模板中使用这些方法。
- HasChildren
- 判断给定的菜单项是否有子菜单项。
- KeyName
- 返回给定菜单条目的
identifier属性，如无则返回name属性。 - Name（名称）
- 返回给定菜单项的
name属性。 - Params
- 返回给定菜单项的
params属性。 - Parent
- 返回给定菜单条目的
parent属性。 - Pre
- 返回给定菜单项的
pre属性。 - URL
- 返回与给定菜单项关联的页面的相对永久链接，否则返回其
url属性。 - Weight
- 返回给定菜单项的
weight属性。 - 标识符
- 返回给定菜单项的
identifier属性。 - 标题
- 返回给定菜单项的
title属性。 - 菜单
- 返回包含给定菜单项的菜单的标识符。
- 文章（Post）
- 返回给定菜单项的
post属性。 - 页面
- 返回与给定菜单项关联的页面对象。
- 子菜单
- 返回给定菜单项下的子菜单项集合（如果有）。
持续时间
使用这些方法来处理 time.Duration 值。
- Abs
- 返回给定时间间隔(time.Duration)值的绝对值。
- Round (四舍五入)
- 返回将 DURATION1 四舍五入到最接近 DURATION2 的倍数的结果。
- 分钟
- 将时间间隔值转换为浮点数分钟。
- 毫秒
- 将 time.Duration 值转换为整数毫秒计数。
- 截断
- 将 DURATION1 向零舍入为 DURATION2 的倍数，并返回结果。
- 秒
- 将time.Duration值作为浮点型的秒数返回。
- 纳秒
- 将time.Duration值以整数纳秒计数返回。
- 微秒
- 以整数微秒计数返回time.Duration值。
- 小时
- 返回时间
Duration值的浮点数小时数。
短代码
在您的短代码模板中使用这些方法。
- InnerDeindent
- 返回在短代码开始和结束标签之间的内容，并去除缩进，适用于包含闭合标签的短代码调用。
- IsNamedParams
- 返回一个值，指示 shortcode 调用是否指定了命名参数或位置参数。
- Name
- 返回 shortcode 文件名，不包括文件扩展名。
- Ordinal（序数）
- 返回shortcode相对于其父元素的从零开始计算的序数。
- Params
- 返回一个短代码参数集合。
- Scratch
- 创建一个“scratch pad”（临时存储区）来存储和操作数据。
- 父级
- 返回嵌套短代码中的父级短代码上下文。
- 获取
- 返回给定参数的值
- 内部
- 返回在短代码标签之间的内容，仅适用于短代码调用包含闭合标签的情况。
- 位置
- 返回调用短代码的文件名和位置。
- 页面
- 返回调用短代码的页面对象。
分类法
使用这些方法来处理分类法对象。
- ByCount
- 返回一个按页面数量排序的有序分类法。
- Count（计数）
- 返回给定术语被分配的有权重页面的数量。
- 按字母顺序排列
- 返回按术语按字母顺序排列的有序分类系统。
- 获取
- 返回给定术语被分配到的加权页面的切片。
时间
使用这些方法与 time.Time 值一起使用。
- Add
- 返回给定时间加上给定持续时间后的结果。
- AddDate
- 返回给定time.Time值加上给定年、月和日后的时间。
- Before
- 判断 TIME1 是否在 TIME2 之前。
- Day
- 返回给定 time.Time 值的日期的日期。
- Equal
- 判断TIME1是否等于TIME2。
- IsDST
- 报告给定的 time.Time 值是否处于夏令时。
- IsZero
- 判断给定的time.Time值是否表示零时间点，即公元1年1月1日00:00:00 UTC。
- Local（本地）
- 将给定的 time.Time 值的位置设置为本地时间并返回。
- Second（秒）
- 返回给定 time.Time 值在分钟内的第二个偏移量，范围为 [0, 59]。
- Sub
- 返回通过从TIME1中减去TIME2计算得到的持续时间。
- Unix
- 返回给定的 time.Time 值，表示自1970年1月1日UTC开始经过的秒数。
- UnixMicro
- 返回给定的
time.Time值，表示自1970年1月1日UTC起经过的微秒数。 - UnixMilli
- 返回给定的 time.Time 值表示自1970年1月1日UTC以来经过的毫秒数。
- UnixNano
- 返回给定的time.Time值表示从1970年1月1日UTC开始经过的纳秒数。
- UTC
- 将给定的 time.Time 值的位置设置为 UTC 并返回。
- YearDay
- 返回给定time.Time值所对应的年份的天数，对于非闰年来说，在范围[1, 365]内，对于闰年来说，在范围[1, 366]内。
- 分钟
- 返回给定时间.Time值在小时内的分钟偏移量，范围为[0, 59]。
- 格式化
- 返回格式化的 time.Time 值。
- 工作日
- 返回给定时间值的星期几。
- 后
- 报告TIME1是否在TIME2之后。
- 纳秒
- 返回给定 time.Time 值在秒内的纳秒偏移，范围在 [0, 999999999]。
- 年份
- 返回给定时间点的年份值。
- 小时
- 返回给定时间.Time值在一天之中的小时数，范围为[0, 23]。
- 月份
- 返回给定 time.Time 值的年份的月份。
网站
使用这些方法与网站对象一起使用。对于多语言项目，每种语言都会有两个或更多的网站。
- BaseURL
- 返回在站点配置中定义的基本 URL。
- GetPage
- 从给定的路径返回一个 Page 对象。
- IsMultiLingual
- 报告站点是否支持多语言。
- LanguagePrefix
- 返回给定网站的语言前缀（如果有）的URL。
- LastChange（修改时间）
- 返回站点内容的最后修改日期。
- MainSections
- 返回一个主要部分名称的切片，这些名称在站点配置中定义，如果未定义，则回退到具有最多页面的顶级部分。
- Params
- 返回自定义参数的映射，如在网站配置中定义。
- RegularPages
- 返回所有普通页面的集合。
- 版权
- 返回在网站配置中定义的版权声明。
- 标题
- 返回在站点配置中定义的标题。
- 菜单
- 返回给定网站的菜单对象集合。
- 分类法
- 返回一个包含网站分类对象、每个分类对象中的术语以及分配给术语的页面的数据结构。
- 构建草稿
- 报告当前构建是否包括草稿页面。
- 配置
- 返回网站配置的子集。
- 全部页面
- 返回所有语言中的所有页面集合。
- 首页
- 返回给定网站的首页对象。
- 数据
- 返回由数据目录中的文件组成的数据结构。
- 页面
- 返回所有页面的集合。
- 语言
- 返回给定站点的语言对象。
- 语言
- 返回按语言权重排序的所有站点的语言对象集合。
- 站点
- 返回所有语言的Site对象的集合，按语言权重排序。
- 章节
- 返回一组一级章节页面。
页面
使用这些方法与页面对象配合使用。
- AllTranslations
- 返回给定页面的所有翻译，包括给定的页面本身。
- AlternativeOutputFormats（备选输出格式）
- 返回一个
OutputFormat对象的切片，不包括当前输出格式，每个对象表示给定页面启用的一个输出格式。 - BundleType（束类型）
- 返回给定页面的束类型，如果页面不是页面束，则返回空字符串。
- CodeOwners（代码所有者）
- 返回给定页面的代码所有者片段，从项目目录根目录中的CODEOWNERS文件中获取。
- CurrentSection
- 返回给定页面所在的部分的页面对象。
- Eq
- 判断两个Page对象是否相等。
- ExpiryDate（过期日期）
- 返回给定页面的过期日期。
- FuzzyWordCount（模糊字数统计）
- 返回给定页面内容中的字数，以100的倍数向上取整。
- GetPage
- 返回给定路径的Page对象。
- GetTerms
- 返回给定页面上给定分类法中定义的术语页面的集合，按照在frnt matter中出现的顺序排序。
- GitInfo
- 返回与给定页面的最后提交相关的Git信息。
- HasMenuCurrent
- 判断给定的页面对象是否与给定菜单中给定菜单项下关联的页面对象匹配。
- HasShortcode
- 判断给定页面是否调用了给定的短代码。
- HeadingsFiltered
- 返回与给定页面相关的每个页面的标题列表。
- InSection
- 判断给定页面是否在给定的部分中。
- IsAncestor
- 报告PAGE1是否是PAGE2的祖先。
- IsDescendant
- 报告PAGE1是否是PAGE2的子孙页面。
- IsHome
- 判断给定页面是否为主页。
- IsMenuCurrent
- 判断给定的页面对象是否与给定菜单中的菜单条目所关联的页面对象匹配。
- IsNode
- 判断给定页面是否为节点。
- IsPage
- 报告给定页面是否为普通页面。
- IsSection
- 判断给定页面是否为章节页面。
- IsTranslated
- 判断给定页面是否有一个或多个翻译版本。
- Kind
- 返回给定页面的类型。
- Lastmod
- 返回给定页面的最后修改日期。
- Next
- 返回给定页面在全局页面集合中的下一页。
- NextInSection
- 返回给定页面相对于所在部分的下一个页面。
- OutputFormats
- 返回一个表示给定页面启用的输出格式之一的OutputFormat对象组成的切片。
- Paginator
- 对接收到的常规页面集合进行分页处理。
- Param
- 返回具有给定键的页面参数，如果有，则回退到站点参数。
- Params
- 返回给定页面前置元数据中定义的自定义参数映射。
- Plain
- 返回给定页面的渲染内容，移除所有HTML标签。
- PlainWords
- 调用 Plain 方法，将结果拆分为单词切片，并返回该切片。
- Prev
- 返回给定页面在全局页面集合中的上一页。
- PrevInSection
- 返回给定页面相对于所在部分的前一页。
- PublishDate
- 返回给定页面的发布日期。
- RawContent
- 返回给定页面的原始内容。
- Ref
- 返回给定页面的绝对 URL，包括给定路径、语言和输出格式。
- RegularPages
- 返回当前部分中的常规页面集合。
- RegularPagesRecursive
- 返回当前部分内的常规页面集合，以及所有后代部分内的常规页面。
- RelPermalink
- 返回给定页面的相对永久链接。
- RelRef
- 返回给定页面的相对URL，带有给定的路径、语言和输出格式。
- RenderShortcodes
- 渲染给定页面内容中的所有短代码，保留周围的标记。
- RenderString
- 将标记渲染为HTML。
- Scratch
- 在给定页面上创建一个“scratch pad”，用于存储和操作数据。
- Section
- 返回给定页面所属的顶级部分的名称。
- Slug（网页链接）
- 返回在开头信息中设定的给定页面的URL网址链接。
- TranslationKey
- 返回给定页面的翻译键。
- WordCount
- 返回给定页面内容中的单词数量。
- 标题
- 返回给定页面的标题。
- 别名
- 返回在正文元数据中定义的URL别名。
- 布局
- 返回在前置元数据中定义的给定页面的布局。
- 草稿
- 判断给定页面是否为草稿，根据前置元数据进行定义。
- 存储
- 在给定页面上创建一个可持久化的“草稿本”，用于存储和操作数据。
- 第一节
- 返回给定页面所属顶级节的Page对象。
- 翻译
- 返回给定页面的所有翻译，不包括当前语言。
- 分页
- 对页面集合进行分页处理。
- 父级
- 返回给定页面的父级部分的页面对象。
- 关键词
- 返回在前置元数据中定义的关键词切片。
- 截断
- 汇报内容长度是否超过摘要长度。
- 类型
- 返回给定页面的内容类型。
- 链接标题
- 返回给定页面的链接标题。
- 描述
- 根据前置数据中定义的描述，返回给定页面的描述。
- 目录
- 返回给定页面的目录。
- 内容
- 返回给定页面的渲染内容。
- 片段
- 返回给定页面中的片段的数据结构。
- 日期
- 返回给定页面的日期。
- 数据
- 返回每种页面类型的唯一数据对象。
- 网站
- 返回网站对象。
- 网站地图
- 返回给定页面中在前置元数据中定义的网站地图设置，如果没有定义则返回网站配置定义的网站地图设置。
- 文件
- 对于由文件支持的页面，返回给定页面的文件信息。
- 渲染
- 使用给定页面作为上下文来渲染给定的模板。
- 页面
- 返回给定页面的Page对象。
- 页面
- 返回当前部分内的常规页面集合，以及子代部分的部分页面。
- 永久链接
- 返回给定页面的永久链接。
- 语言
- 返回给定页面的语言对象。
- 阅读时间
- 返回给定页面的估计阅读时间（以分钟为单位）。
- 摘要
- 返回给定页面的内容摘要。
- 站点
- 返回所有站点对象的集合，每个语言一个对象，并按语言权重排序。
- 章节
- 返回一个页面集合，其中包含给定页面的每个直接子级章节的页面。
- 重量
- 返回前置元数据中定义的给定页面的权重。
- 资源
- 返回一个页面资源集合。
- 祖先
- 返回给定页面的每个祖先部分的Page对象集合。
页面
使用这些方法与一组页面对象一起使用。
- ByDate
- 返回按日期升序排序的给定页面集合。
- ByLastmod
- 返回按照最后修改日期升序排序的给定页面集合。
- ByParam
- 返回给定页面集合，按照给定参数以升序排序。
- GroupBy
- 按给定字段将给定页面集合分组并按升序排列。
- GroupByDate
- 返回给定页面集合按日期降序分组。
- GroupByExpiryDate
- 根据到期日期将给定的页面集合进行分组，并按降序排列。
- GroupByLastmod
- 返回按最后修改日期倒序分组的页面集合。
- GroupByParam
- 按照给定的参数以升序返回给定的页面集合。
- GroupByParamDate
- 按给定的日期参数对给定的页面集合进行分组，按降序排列。
- GroupByPublishDate
- 返回按发布日期对给定页面集合进行分组的结果，按降序排列。
- Len
- 返回给定页面集合中的页面数量。
- Next
- 返回给定页面在本地页面集合中的下一页。
- Prev
- 返回给定页面在本地页面集合中的上一个页面。
- 按标题排序
- 按标题以升序返回给定页面集合。
- 按发布日期排序
- 返回给定页面集合按发布日期升序排序的结果。
- 按权重排序
- 按照给定的页面集合以权重升序返回结果。
- 按语言排序
- 返回以升序排列的给定页面集合，按照语言排序。
- 按长度排序
- 以升序返回给定的页面集合，按内容长度排序。
- 反向
- 以反向顺序返回给定页面集合。
- 通过过期日期排序
- 返回给定页面集合，按照过期日期升序排序。
- 通过链接标题排序
- 返回按链接标题升序排列的给定页面集合，如果链接标题未定义，则回退到标题。
- 限制
- 返回给定页面集合中的前N个页面。
- 相关页面
- 返回与给定页面相关的页面集合。
资源
使用这些方法与全局、页面和远程资源对象。
- Err
- 适用于由 resources.GetRemote 函数返回的资源，如果 HTTP 请求失败，则返回错误消息，否则返回 nil。
- Exif
- 适用于图片，返回一个包含图片元数据的 EXIF 对象。
- Key
- 返回给定资源的唯一键，等同于其发布路径。
- MediaType
- 返回给定资源的媒体类型对象。
- Params
- 返回一个以前置元数据定义的资源参数的映射。
- RelPermalink
- 发布给定的资源并返回其相对永久链接。
- ResourceType
- 返回给定资源的媒体类型的主要类型。
- 标题
- 根据资源类型，返回给定资源的标题，可选地从前置元数据返回，否则返回相对路径或根据资源类型返回散列文件名。
- 裁剪
- 适用于图像，返回裁剪到指定尺寸但不改变大小的图像资源。
- 处理
- 适用于图像，返回使用指定规格处理后的图像资源。
- 调整大小
- 适用于图像，返回一个按给定宽度和/或高度调整大小的图像资源。
- 发布
- 发布给定的资源。
- 高度
- 适用于图像，返回给定资源的高度。
- 过滤器
- 适用于图像，将一个或多个图像过滤器应用于给定的图像资源。
- 宽度
- 适用于图像，返回给定资源的宽度。
- 名称
- 返回给定资源的名称，可选择在正文中定义，或者根据资源类型返回相对路径或哈希文件名。
- 内容
- 返回给定资源的内容。
- 适合
- 适用于图像，返回按比例缩小以适应给定尺寸的图像资源。
- 数据
- 适用于 resources.GetRemote 函数返回的资源，返回来自 HTTP 响应的信息。
- 填充
- 适用于图像，返回一个按给定尺寸裁剪和调整大小的图像资源。
- 颜色
- 适用于图像，使用简单的直方图方法返回最主要的颜色切片。
- 永久链接
- 发布给定的资源并返回其永久链接。