方法
持续时间
将这些方法与 time.Duration 值一起使用。
- Abs
- 返回给定 time.Duration 值的绝对值。
- Hours
- 以浮点数形式返回 time.Duration 值的小时数。
- Microseconds
- 以整数微秒计数返回 time.Duration 值。
- Milliseconds
- 以整数毫秒计数返回 time.Duration 值。
- Minutes
- 以浮点数形式返回 time.Duration 值的分钟数。
- Nanoseconds
- 以整数纳秒计数返回 time.Duration 值。
- Round
- 返回将 DURATION1 四舍五入到最接近 DURATION2 倍数的结果。
- Seconds
- 以浮点数形式返回 time.Duration 值的秒数。
- Truncate
- 返回将 DURATION1 向零舍入到 DURATION2 倍数的结果。
菜单
在遍历菜单项时使用这些方法。
- ByName
- 返回给定菜单，其条目按名称排序。
- ByWeight
- 返回给定菜单，其条目按权重排序，然后按名称排序，然后按标识符排序。
- Limit
- 返回给定菜单，仅限前 N 个条目。
- Reverse
- 返回给定菜单，反转其条目的排序顺序。
菜单项
在菜单模板中使用这些方法。
- Children
- 返回给定菜单项下的子菜单项的集合（如果有）。
- HasChildren
- 报告给定菜单项是否具有子菜单项。
- Identifier
- 返回给定菜单项的
identifier属性。 - KeyName
- 返回给定菜单项的
identifier属性，回退到其name属性。 - 菜单
- 返回包含给定菜单项的菜单的标识符。
- Name
- 返回给定菜单项的
name属性。 - 页面
- 返回与给定菜单项关联的页面对象。
- PageRef
- 返回给定菜单项的
pageRef属性。 - Params
- 返回给定菜单项的
params属性。 - Parent
- 返回给定菜单项的
parent属性。 - Post
- 返回给定菜单项的
post属性。 - Pre
- 返回给定菜单项的
pre属性。 - Title
- 返回给定菜单项的
title属性。 - URL
- 返回与给定菜单项关联的页面的相对永久链接，否则返回其
url属性。 - Weight
- 返回给定菜单项的
weight属性。
页面
将这些方法与页面对象一起使用。
- Aliases
- 返回在前言中定义的 URL 别名。
- AllTranslations
- 返回给定页面的所有翻译，包括当前语言。
- AlternativeOutputFormats
- 返回 OutputFormat 对象的一个切片，排除当前输出格式，每个对象都代表为给定页面启用的输出格式之一。
- Ancestors
- 返回页面对象的集合，给定页面的每个祖先章节对应一个对象。
- BundleType
- 返回给定页面的包类型，如果该页面不是页面包，则返回空字符串。
- CodeOwners
- 返回给定页面的代码所有者的切片，该切片来自项目目录根目录中的 CODEOWNERS 文件。
- Content
- 返回给定页面的呈现内容。
- ContentWithoutSummary
- 返回给定页面的呈现内容，排除内容摘要。
- CurrentSection
- 返回给定页面所在的章节的页面对象。
- Data
- 为每种页面类型返回一个唯一的数据对象。
- Date
- 返回给定页面的日期。
- Description
- 返回在前言中定义的给定页面的描述。
- Draft
- 报告给定页面是否是在前言中定义的草稿。
- Eq
- 报告两个页面对象是否相等。
- ExpiryDate
- 返回给定页面的过期日期。
- File
- 对于由文件支持的页面，返回给定页面的文件信息。
- 第一部分
- 返回给定页面所属的顶层部分的页面对象。
- 片段
- 返回给定页面中片段的数据结构。
- 模糊字数
- 返回给定页面内容中的单词数，向上取整到最接近的 100 的倍数。
- 获取页面
- 从给定路径返回一个页面对象。
- 获取术语
- 返回给定页面上在给定分类法中定义的术语页面集合，并按照它们在前言中出现的顺序排序。
- Git 信息
- 返回与给定页面的最后一次提交相关的 Git 信息。
- 有当前菜单
- 报告给定的页面对象是否与给定菜单中给定菜单项下的子菜单项关联的页面对象匹配。
- 有短代码
- 报告给定的短代码是否被给定的页面调用。
- 已过滤标题
- 返回与给定页面相关的每个页面的标题切片。
- 在部分中
- 报告给定的页面是否在给定的部分中。
- 是祖先
- 报告 PAGE1 是否是 PAGE2 的祖先。
- 是后代
- 报告 PAGE1 是否是 PAGE2 的后代。
- 是主页
- 报告给定的页面是否是主页。
- 是当前菜单
- 报告给定的页面对象是否与给定菜单中给定菜单项关联的页面对象匹配。
- 是节点
- 报告给定的页面是否是节点。
- 是页面
- 报告给定的页面是否是常规页面。
- 是部分
- 报告给定的页面是否是部分页面。
- 已翻译
- 报告给定的页面是否有一个或多个翻译版本。
- 关键词
- 返回在前言中定义的关键词切片。
- 类型
- 返回给定页面的类型。
- 语言
- 返回给定页面的语言对象。
- 最后修改时间
- 返回给定页面的最后修改日期。
- 布局
- 返回给定页面在前言中定义的布局。
- 长度
- 返回给定页面的渲染内容的长度（以字节为单位）。
- 链接标题
- 返回给定页面的链接标题。
- 下一个
- 返回站点常规页面集合中相对于当前页面的下一个页面。
- 在部分中的下一个
- 返回一个部分中相对于给定页面的下一个常规页面。
- 输出格式
- 返回一个输出格式对象切片，每个对象代表为给定页面启用的输出格式之一。
- 页面
- 返回给定页面的页面对象。
- 页面.存储
- 在给定页面上返回一个持久的“暂存区”，用于存储和操作数据。
- 页面
- 返回当前部分中的常规页面集合，以及直接后代部分的 section 页面。
- 分页
- 对页面集合进行分页。
- 分页器
- 对上下文中接收到的常规页面集合进行分页。
- 参数
- 返回具有给定键的页面参数，如果存在，则回退到站点参数。
- Params
- 返回在给定页面的前言中定义的自定义参数映射。
- Parent
- 返回给定页面的父部分的页面对象。
- 路径
- 返回给定页面的逻辑路径。
- 永久链接
- 返回给定页面的永久链接。
- 纯文本
- 返回给定页面的渲染内容，删除所有 HTML 标签。
- 纯文本单词
- 调用纯文本方法，将结果拆分为单词切片，并返回该切片。
- 上一个
- 返回站点常规页面集合中相对于当前页面的上一个页面。
- 在部分中的上一个
- 返回一个部分中相对于给定页面的上一个常规页面。
- 发布日期
- 返回给定页面的发布日期。
- 原始内容
- 返回给定页面的原始内容。
- 阅读时间
- 返回给定页面的估计阅读时间（以分钟为单位）。
- 引用
- 返回具有给定路径、语言和输出格式的页面的绝对 URL。
- 常规页面
- 返回当前部分中的常规页面集合。
- 递归常规页面
- 返回当前部分中的常规页面集合，以及所有后代部分中的常规页面。
- 相对永久链接
- 返回给定页面的相对永久链接。
- 相对引用
- 返回具有给定路径、语言和输出格式的页面的相对 URL。
- 渲染
- 使用给定的页面作为上下文渲染给定的模板。
- 渲染短代码
- 渲染给定页面内容中的所有短代码，保留周围的标记。
- 渲染字符串
- 将标记渲染为 HTML。
- 资源
- 返回页面资源集合。
- 暂存
- 在给定页面上返回一个“暂存区”，用于存储和操作数据。
- 部分
- 返回给定页面所在的顶层部分的名称。
- 章节
- 返回 section 页面集合，每个页面对应给定页面的一个直接后代部分。
- 站点
- 返回站点对象。
- 站点地图
- 返回给定页面的站点地图设置（如前言中所定义），如果前言中未定义，则回退到站点配置中定义的站点地图设置。
- 站点
- 返回所有站点对象的集合，每个语言一个，并按语言权重排序。
- 别名
- 返回给定页面在前言中定义的 URL 别名。
- 摘要
- 返回给定页面的摘要。
- 目录
- 返回给定页面的目录。
- Title
- 返回给定页面的标题。
- 翻译键
- 返回给定页面的翻译键。
- 翻译
- 返回给定页面的所有翻译版本，不包括当前语言。
- 截断
- 报告内容长度是否超过摘要长度。
- 类型
- 返回给定页面的内容类型。
- Weight
- 返回给定页面在前言中定义的权重。
- 字数统计
- 返回给定页面内容中的单词数。
分页器
在为分页列表页构建导航时，将这些方法与分页器对象一起使用。
- 第一个
- 返回分页器集合中的第一个分页器。
- 有下一个
- 报告当前分页器之后是否有分页器。
- 有上一个
- 报告当前分页器之前是否有分页器。
- 最后一个
- 返回分页器集合中的最后一个分页器。
- 下一个
- 下一个
- 元素数量
- 返回当前分页器中的页面数。
- 页面组
- 返回当前分页器中的页面组。
- 页码
- 返回当前分页器在分页器集合中的编号。
- 分页器
- 返回分页器集合。
- 分页器大小
- 返回每个分页器的页面数。
- 页面
- 页面
- 页面大小
- 返回每个分页器的页面数。
- 上一个
- 返回分页器集合中的上一个分页器。
- 总元素数量
- 返回分页器集合中的页面数。
- 总页数
- 返回分页器集合中的分页器数。
- URL
- 返回当前分页器相对于站点根目录的 URL。
页面
将这些方法与页面对象集合一起使用。
- 按日期
- 返回按日期升序排序的给定页面集合。
- 按过期日期
- 返回按过期日期升序排序的给定页面集合。
- 按语言
- 返回按语言升序排序的给定页面集合。
- 按最后修改时间
- 返回按最后修改日期升序排序的给定页面集合。
- 按长度
- 返回按内容长度升序排序的给定页面集合。
- 按链接标题
- 返回按链接标题升序排序的给定页面集合，如果未定义链接标题，则回退到标题。
- 按参数
- 返回按给定参数升序排序的给定页面集合。
- 按发布日期
- 返回按发布日期升序排序的给定页面集合。
- 按标题
- 返回按标题升序排序的给定页面集合。
- ByWeight
- 返回按权重升序排序的给定页面集合。
- 分组依据
- 返回按给定字段升序分组的给定页面集合。
- 按日期分组
- 返回按日期降序分组的给定页面集合。
- 按过期日期分组
- 返回按过期日期降序分组的给定页面集合。
- 按最后修改时间分组
- 返回按最后修改日期降序分组的给定页面集合。
- 按参数分组
- 返回按给定参数升序分组的给定页面集合。
- 按参数日期分组
- 返回按给定日期参数降序分组的给定页面集合。
- 按发布日期分组
- 返回按发布日期降序分组的给定页面集合。
- 长度
- 返回给定页面集合中的页面数。
- Limit
- 返回给定页面集合中的前 N 个页面。
- 下一个
- 返回页面集合中相对于给定页面的下一个页面。
- 上一个
- 返回页面集合中相对于给定页面的上一个页面。
- 相关
- 返回与给定页面相关的页面集合。
- Reverse
- 返回反向排序的给定页面集合。
资源
将这些方法与全局、页面和远程资源对象一起使用。
- 颜色
- 适用于图像，使用简单的直方图方法返回最主要的颜色切片。
- Content
- 返回给定资源的内容。
- 裁剪
- 适用于图像，返回裁剪为给定尺寸而不调整大小的图像资源。
- Data
- 适用于 resources.GetRemote 函数返回的资源，返回 HTTP 响应中的信息。
- 错误
- 适用于 resources.GetRemote 函数返回的资源，如果 HTTP 请求失败，则返回错误消息；否则返回 nil。
- Exif
- 适用于 JPEG、PNG、TIFF 和 WebP 图像，返回包含图像元数据的 EXIF 对象。
- 填充
- 适用于图像，返回裁剪并调整大小到给定尺寸的图像资源。
- 滤镜
- 适用于图像，将一个或多个图像滤镜应用于给定的图像资源。
- 适应
- 适用于图像，返回缩放以适应给定尺寸同时保持纵横比的图像资源。
- 高度
- 适用于图像，返回给定资源的高度。
- MediaType
- 返回给定资源的媒体类型对象。
- Name
- 返回给定资源的名称，该名称可以定义在前言中，如果前言中未定义，则返回其文件路径。
- Params
- 返回在前言中定义的资源参数的映射。
- 永久链接
- 发布给定资源并返回其永久链接。
- Process
- 适用于图像，返回使用给定规范处理的图像资源。
- Publish
- 发布给定资源。
- 相对永久链接
- 发布给定资源并返回其相对永久链接。
- Resize
- 适用于图像，返回调整为给定宽度和/或高度的图像资源。
- ResourceType
- 返回给定资源媒体类型的主要类型。
- Title
- 返回给定资源的标题，该标题可以定义在前言中，如果前言中未定义，则根据资源类型返回相对路径或哈希文件名。
- Width
- 适用于图像，返回给定资源的宽度。
短代码
在您的短代码模板中使用这些方法。
- Get
- 返回给定参数的值。
- Inner
- 返回开始和结束短代码标签之间的内容，当短代码调用包含结束标签时适用。
- InnerDeindent
- 返回开始和结束短代码标签之间的内容，并删除缩进，当短代码调用包含结束标签时适用。
- IsNamedParams
- 报告短代码调用是否使用命名参数。
- Name
- 返回短代码文件名，不包括文件扩展名。
- Ordinal
- 返回短代码相对于其父级的从零开始的序号。
- 页面
- 返回调用短代码的页面对象。
- Params
- 返回短代码参数的集合。
- Parent
- 返回嵌套短代码中的父短代码上下文。
- Position
- 返回调用短代码的文件名和位置。
- 引用
- 返回具有给定路径、语言和输出格式的页面的绝对 URL。
- 相对引用
- 返回具有给定路径、语言和输出格式的页面的相对 URL。
- 暂存
- 返回一个限定于短代码的“暂存区”，用于存储和操作数据。
- 站点
- 返回站点对象。
- Store
- 返回一个限定于短代码的“存储区”，用于存储和操作数据。
站点
将这些方法与站点对象一起使用。多语言项目将有两个或多个站点，每个语言一个。
- AllPages
- 返回所有语言的所有页面的集合。
- BaseURL
- 返回站点配置中定义的基本 URL。
- BuildDrafts
- 报告当前构建是否包含草稿页面。
- Config
- 返回站点配置的子集。
- Copyright
- 返回站点配置中定义的版权声明。
- Data
- 返回由数据目录中的文件组成的数据结构。
- 获取页面
- 从给定路径返回一个页面对象。
- Home
- 返回给定站点的首页对象。
- IsMultiLingual
- 报告是否配置了两种或多种语言。
- 语言
- 返回给定站点的语言对象。
- LanguagePrefix
- 返回给定站点的 URL 语言前缀（如果有）。
- Languages
- 返回所有站点的语言对象集合，按语言权重排序。
- LastChange
- 返回站点内容的最后修改日期。
- 最后修改时间
- 返回站点内容的最后修改日期。
- MainSections
- 返回站点配置中定义的主部分名称的切片，如果未定义，则返回页面最多的顶级部分。
- 菜单
- 返回给定站点的菜单对象集合。
- 页面
- 返回所有页面的集合。
- 参数
- 返回具有给定键的站点参数。
- Params
- 返回站点配置中定义的自定义参数的映射。
- 常规页面
- 返回所有常规页面的集合。
- 章节
- 返回第一级部分页面的集合。
- site.Store
- 返回给定站点上的持久性“暂存区”，用于存储和操作数据。
- 站点
- 返回所有站点对象的集合，每个语言一个，按默认内容语言排序，然后按语言权重排序。
- 分类法
- 返回包含站点分类对象、每个分类对象中的术语以及分配了术语的页面的数据结构。
- Title
- 返回站点配置中定义的标题。
分类
将这些方法与分类对象一起使用。
- Alphabetical
- 返回已排序的分类，按术语字母顺序排序。
- ByCount
- 返回已排序的分类，按与每个术语关联的页面数排序。
- Count
- 返回已分配给给定术语的加权页面数。
- Get
- 返回已分配给给定术语的加权页面的切片。
- 页面
- 如果分类没有术语，则返回分类页面或 nil。
时间
将这些方法与 time.Time 值一起使用。
- Add
- 返回给定时间加上给定持续时间。
- AddDate
- 返回将给定年数、月数和天数添加到给定 time.Time 值后对应的时间。
- After
- 报告 TIME1 是否晚于 TIME2。
- Before
- 报告 TIME1 是否早于 TIME2。
- Day
- 返回给定 time.Time 值的月份中的日期。
- Equal
- 报告 TIME1 是否等于 TIME2。
- Format
- 返回根据布局字符串格式化的 time.Time 值的文本表示形式。
- Hour
- 返回给定 time.Time 值的一天中的小时数，范围为 [0, 23]。
- IsDST
- 报告给定 time.Time 值是否处于夏令时。
- IsZero
- 报告给定 time.Time 值是否表示零时间瞬间，即公元 1 年 1 月 1 日 00:00:00 UTC。
- Local
- 返回位置设置为本地时间的给定 time.Time 值。
- Minute
- 返回给定 time.Time 值的一小时内的分钟偏移量，范围为 [0, 59]。
- Month
- 返回给定 time.Time 值的年份中的月份。
- Nanosecond
- 返回给定 time.Time 值的一秒内的纳秒偏移量，范围为 [0, 999999999]。
- Round
- 返回将 TIME 四舍五入到自公元 1 年 1 月 1 日 00:00:00 UTC 以来的最接近 DURATION 的倍数的结果。
- Second
- 返回给定 time.Time 值的一分钟内的秒偏移量，范围为 [0, 59]。
- Sub
- 返回通过从 TIME1 中减去 TIME2 计算出的持续时间。
- Truncate
- 返回将 TIME 向下舍入到自公元 1 年 1 月 1 日 00:00:00 UTC 以来的 DURATION 的倍数的结果。
- 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
- 返回位置设置为 UTC 的给定 time.Time 值。
- Weekday
- 返回给定 time.Time 值的一周中的星期几。
- Year
- 返回给定 time.Time 值的年份。
- YearDay
- 返回给定 time.Time 值的一年中的日期，在非闰年中的范围为 [1, 365]，在闰年中的范围为 [1, 366]。