文本操作速查表

Agenda 中的操作让你可以输入简短的命令，输入完成后这些命令会被动态转换并展开为纯文本，或者触发某项操作（例如将笔记标记为"简达"）。你可以把它当作触发某个操作的快捷方式，比如输入 \remind 插入提醒事项，或输入 \date 插入当前日期。

操作以反斜杠字符（\）作为前缀，它会唤出一个自动补全菜单，显示可用的操作；你可以继续输入所需操作的前几个字符来进一步筛选。

**提示：**在没有连接硬件键盘的 iPhone 和 iPad 上，输入反斜杠字符可能有些麻烦。这时你只需轻点并按住键盘上方的加号按钮，即可唤出操作菜单。非常方便！

同样地，在某些键盘上（例如中文或日文键盘），输入反斜杠字符也比较困难，因此在所有显示反斜杠字符的地方，你也可以使用两个反引号（``）或两个中间点字符（··）。

许多操作都可以在圆括号内接受所谓的 参数（类似于你可以为标签添加值参数的方式，详见 标签、人物、文本操作和链接 一章），以进一步细化这些操作的行为。例如，\date(in: 2 weeks) 会插入两周后的日期，而不是当前日期。

标记为 默认 的参数是在未提供参数时所采用的默认参数。例如，\tag(important) 与 \tag(name: important) 效果相同。

大多数操作在模版中同样可用；此外，模版还支持一些仅在模版中生效的操作，相关概览请参见 创建和使用模版 一章。

以下是 Agenda 当前支持的全部操作的完整概览。

插入

\tag

• 在笔记正文中插入标签令牌
• 同义词：#、\insert-tag

参数

• name - 标签的名称 - 默认，必填
• color - 标签颜色的名称或十六进制值 - 高级版
• value、text、string - 可选的文本值 - 第二默认
• day、on、after、before、until、from、in - 可选的日期值
• date、at - 可选的日期时间值
• int、integer、number、level - 可选的整数值
• float、double - 可选的浮点数值

示例

• \tag(name: important) - 创建标签 #important，与 \tag(important) 相同
• \tag(important, color: blue) - 创建蓝色的标签 #important
• \tag(important, color: #333) - 创建十六进制颜色为 #333 的标签 #important
• \tag(priority, value: high) - 创建标签 #priority(high)，与 \tag(priority, high) 相同
• \tag(due, day: tomorrow) - 创建标签 #due(6 April 2022)
• \tag(due, in: 3 weeks) - 创建标签 #due(26 April 2022)
• \tag(deadline, at: 17 oct 2022 13pm) - 创建标签 #deadline(17 Oct 2022 at 13.00)
• \tag(priority, int: 1, color: red) - 创建红色的标签 #priority(1)
• \tag(version, float: 2.1) - 创建标签 #version(2.1)

\person

• 在笔记正文中插入人物令牌
• 同义词：@、\insert-person、contact

参数

• name、alias、nickname - 人物的名称 - 默认，必填

示例

• \person(name: Tom G) - 创建人物 @(Tom G)，与 \person(Tom G) 相同

\reminder

• 在"提醒事项" App 中插入并安排一个提醒事项
• 同义词：\remind、\insert-reminder

参数

• none - 插入一个未安排时间的占位提醒事项
• due-date - 表示未来某个日期的自然语言字符串 - 默认
• title - 要安排的提醒事项的标题
• list - 在"提醒事项" App 中用于安排该提醒事项的列表
• all-day - 将提醒事项安排为全天提醒事项

示例

• \reminder - 创建一个未安排时间的提醒事项并打开编辑浮层
• \reminder(today) - 安排一个 30 分钟后的今日提醒事项
• \reminder(today at 6pm) - 安排今天 6 点的提醒事项
• \reminder(tomorrow evening) - 安排明天 6 点的提醒事项
• \reminder(in 3 weeks) - 安排 21 天后的提醒事项
• \reminder(25 dec 2020, at 8pm)` - 安排 2020 年 12 月 25 日 8 点的提醒事项
• \reminder(today at 6pm, list: important) - 在名为"important"的提醒事项列表中安排今天 6 点的提醒事项
• \reminder(all-day: tomorrow) - 安排明天的全天提醒事项

\star

• 在笔记正文中当前段落的末尾插入一个星标
• 同义词：#star、\insert-star、\flag

参数

• none - 在段落末尾插入一个星标

示例

• \star - 在段落末尾创建一个星标，与 #star 相同

\date

• 在笔记标题或正文中插入当前日期
• 同义词：\insert-date

参数

• none - 以默认格式插入当前日期
• full、long、medium、short - 采用相应形式的标准日期格式 - 默认
• format - 自定义格式的日期，参见下方的提示和注意事项
• locale - 用于格式化日期的地区
• timezone - 用于格式化日期的时区
• in、for、offset - 今天以外的其他日期
• default-format - 将 \date 的默认格式设置为所提供的自定义格式

示例

• \date - 22-07-20
• \date(full) - Wednesday, July 22, 2020
• \date(short) - 7/22/20
• \date(format: dd-MM-yy) - 22-07-20
• \date(full, locale: no) - onsdag 22. juli 2020
• \date(for: tomorrow) - 23-07-20
• \date(in: 2 days) - 24-07-20
• \date(offset: 3 weeks) - 12-08-20
• \date(default-format: dd-MM-yy) - 22-07-20（并将此格式设为默认）

提示：有关所支持日期格式的完整概览，请参见 http://www.unicode.org/reports/tr35/tr35-31/tr35-dates.html#Date_Format_Patterns 。举例来说：\date(EEE\, MMM d\, ''yy) 会得到 Wed, Jul 22, ‘20。请注意，格式中的逗号需要用斜杠转义，否则会被视为下一个参数。冒号也是如此，例如：\time(format: HH\:MM)，结果为 18:34。

重要：当以参数形式提供某种格式时——无论是自定义格式，还是 full、long、medium、short 之一——它同时也会成为你此后仅输入 \date 而省略参数时所用的默认格式。若要将格式恢复为 medium，可以输入一次 \date(default)。

\time

• 在笔记标题或正文中插入当前时间

参数

• none - 以默认格式插入当前时间
• full、long、medium、short - 采用相应形式的标准时间格式 - 默认
• format - 自定义格式的时间，参见上方的提示和注意事项
• locale - 用于格式化时间的地区
• timezone - 用于格式化时间的时区
• default-format - 将 \time 的默认格式设置为所提供的自定义格式

示例

• \time - 12:27
• \time(full) - 12:27:15 PM Western European Summer Time
• \time(short) - 12:27
• \time(format: HH\\:mm\\:ss) - 12:27:33
• \time(medium, locale: en_US_POSIX) - 12:27:15 PM

**提示：**有关地区的完整列表，请参见 https://gist.github.com/jacobbubu/1836273 ；有关时区标识符的列表，请参见 https://apphelp.readdle.com/calendars/index.php?pg=kb.page&id=588

\now

• 在笔记标题或正文中插入当前的日期和时间
• 同义词：\timestamp

参数

• none - 以默认格式插入当前的日期和时间
• full、long、medium、short - 采用相应形式的标准时间格式 - 默认
• format - 自定义格式的时间，参见上方的提示和注意事项
• locale - 用于格式化日期和时间的地区
• timezone - 用于格式化日期和时间的时区
• default-format - 将 \now 的默认格式设置为所提供的自定义格式

示例

• \now - 22-07-20 02:30
• \now(full) - Wednesday, July 22, 2020 at 2:29:53 AM Western European Summer Time
• \now(short) - 7/22/20, 2:30 AM
• \now(format: dd-MM-yy HH\\:mm\\:ss) - 22-07-20 02:30:30
• \now(medium, locale: en_US_POSIX) - Jul 22, 2020 at 2:31:03 AM

\expression

• 在笔记正文中插入某个表达式的计算结果
• 同义词：\formula、\insert-expression、\math

参数

• math - 待计算的数学表达式 - 默认
• sum、add、total - 以逗号分隔的一组数值，用于求和
• count - 以逗号分隔的一组数值，用于计数
• min、minimum - 以逗号分隔的一组数值，从中取最小值
• max、maximum - 以逗号分隔的一组数值，从中取最大值
• average、avg - 以逗号分隔的一组数值，用于求平均值
• median、med - 以逗号分隔的一组数值，用于求中位数
• stddev、standard-deviation、stdev - 以逗号分隔的一组数值，用于求标准差
• sqrt、square-root - 需要求平方根的数值
• log、lg、logarithm - 需要求对数的数值
• ln、natural-logarithm - 需要求自然对数的数值
• random、rdm - 介于 0 和所提供数字之间的随机值

示例

• \expression(5 * 8) - 40
• \expression(sum: 2, 5, 7) - 14
• \expression(count: 2, 5, 7) - 3
• \expression(min: 2, 5, 7) - 2
• \expression(max: 2, 5, 7) - 7
• \expression(average: 2, 5, 7) - 4.666…
• \expression(median: 2, 5, 7) - 5
• \expression(stddev: 2, 5, 7) - 2.0548…
• \expression(sqrt: 9) - 3
• \expression(log: 9) - 0.9542…
• \expression(ln: 9) - 2.197…
• \expression(random: 9) - 7
• \expression(random: 1.0) - 0.598

\horizontal-rule

• 在笔记正文中插入一条水平分隔线
• 同义词：\rule、\insert-horizontal-rule、\hr

示例

• \rule - 插入一条水平分隔线

\table

• 在笔记正文中插入表格
• 同义词：\insert-table、\tb

参数

• none - 插入标准的 2x2 表格
• size、dimensions - 以"列数 x 行数"格式表示的目标表格尺寸 - 默认
• columns、c - 表格应有的列数
• rows、r - 表格应有的行数

示例

• \table - 插入标准的 2x2 表格
• \table(3x4) - 插入一个 3 列 4 行的表格
• \table(columns: 4) - 插入一个 4 列 2 行的表格
• \table(rows: 4) - 插入一个 2 列 4 行的表格
• \table(r: 3, c: 4) - 插入一个 4 列 3 行的表格

\link

• 在笔记正文中插入网页链接，或指向某个项目或笔记的链接
• 同义词：\url、\insert-link、\ref、\href、[[
• 简写：\project、\note

参数

• url - 要插入链接的网址 默认
• description、dimensions - 链接的描述文本 - 第二默认
• project、project-title、to - 链接应指向的项目名称
• note、note-title - 链接应指向的笔记标题

示例

• \link(apple.com, apple website) - 插入文本 apple website，并链接到 apple.com
• \link(url: http://microsoft.com, description: microsoft) - 插入文本 microsoft，并链接到 microsoft.com
• \link(project: Developing Yak App, description: YakApp) - 插入文本 YakApp，并链接到名为 Developing Yak App 的项目
• \link(note-title: Meeting the developers) - 插入一个指向标题为 Meeting the developers 的笔记的链接

**提示：**除了使用 \link，你也可以使用快捷方式 [[ 来插入指向另一个项目或笔记的链接。你甚至可以输入 [[recent 来查看所有近期编辑过、可供链接的笔记列表。

\summary

• 在所选内容或光标所在位置向笔记正文中插入摘要
• 同义词：\summarize、\insert-summary

参数

• none - 插入所有未勾选列表项的摘要
• list - 根据以下条件之一插入列表项的摘要： - 默认
  • checked - 所有已勾选的项目
  • unchecked - 所有未勾选的列表项
  • starred - 所有带星标的段落
  • tagged - 所有包含标签的段落
  • assigned - 所有包含人物令牌的段落
• tag - 要汇总的标签名称
• person - 要汇总的人物名称

示例

• \summary - 插入笔记中所有未勾选列表项的摘要
• \summary(list: checked) - 插入笔记中所有已勾选列表项的摘要
• \summary(starred) - 插入所有带星标段落的摘要
• \summary(tag: urgent) - 插入所有带有名为 urgent 标签的段落的摘要
• \summary(tag: priority[1]) - 插入所有带有名为 priority、值为 1 的标签的段落的摘要（请注意此处使用方括号而非圆括号）
• \summary(person: tom) - 插入所有包含名为 tom 的人物的段落的摘要

\attachment

• 在笔记正文中插入附件，会弹出打开文件对话框以选取要附加的文件
• 同义词：\attach、\file、\insert-attachment

参数

• none - 打开文件选取器以选择要插入的附件
• description、title、name - 作为所导入附件文件描述的文本 - 默认

示例

• \attach - 打开文件选取器
• \attach(My File) - 打开文件选取器，导入后以 My File 作为该附件的描述

\drawing

• 在笔记正文中插入绘图，会显示绘图画布 - 仅限 iOS 和 iPadOS
• 同义词：\draw、\insert-drawing

参数

• none - 显示一块新的绘图画布
• description、title、name - 作为该绘图描述的文本 - 默认

示例

• \draw - 打开一块新的绘图画布
• \draw(My Drawing) - 打开一块新的绘图画布，并以 My Drawing 作为该绘图的描述

\template

• 在插入点将模版的内容插入笔记正文，或替换所选内容
• 同义词：\insert-template

参数

• name - 要使用的模版名称 - 默认，必填
• input - 用于替换模版中输入占位符的文本

示例

• \template(Book Review) - 插入 Book Review 模版的内容
• \template(Book Review, input: The title of this book) - 插入 Book Review 模版的内容，并将 \input 占位符替换为文本 The title of this book。

段落样式

\body

• 将段落样式重置为普通正文文本
• 同义词：\p

示例

• \body - 重置所有格式，使输入时的段落样式设为正文文本

\heading

• 将段落样式设为标题
• 简写：\heading1、\h1、\heading2、\h2、subheading、\heading3、\h3、\heading4、\h4

参数

• level - 要使用的标题级别 - 默认

示例

• \heading - 将样式改为标题，等同于 \heading1 和 \h1
• \heading(level: 2) - 将样式改为副标题，等同于 \heading2、\h2 和 \subheading
• \h3 - 将样式改为次级标题

\preformatted

• 将段落样式设为预格式化文本
• 同义词：\pre

示例

• \pre - 将样式改为预格式化文本，等同于 \preformatted

\list

• 将段落样式设为短划线或项目符号（取决于你的偏好设置）的无序列表
• 同义词：\ul、\dashed、\bulleted

示例

• \list - 将样式改为短划线列表，等同于 \ul， 也等同于输入短划线、星号或项目符号后跟一个空格

\numbered

• 将段落样式设为编号（有序）列表
• 同义词：\ol

参数

• none - 将样式设为从 1 开始的编号列表
• start、from - 列表的起始编号

示例

• \numbered - 将样式改为从 1 开始的编号列表， 等同于输入 1. 后跟一个空格
• \numbered(start: 5) - 将样式改为从 5 开始的编号列表， 等同于输入 5. 后跟一个空格

\checklist

• 将段落样式设为核对清单列表
• 同义词：\cl

示例

• \checklist - 将样式改为核对清单列表，等同于 \cl

列表操作

\check

• 勾选当前行的核对清单项

参数

• none - 勾选当前行的核对清单项
• all - 勾选当前行所属列表中的所有核对清单项

示例

• \check - 勾选当前行的核对清单项
• \check(all) - 勾选列表中的所有核对清单项

\check-all

• 勾选当前行所属列表中的所有核对清单项
• 同义词：\all

示例

• \all - 勾选当前列表中的所有核对清单项

\uncheck

• 取消勾选当前行的核对清单项

参数

• none - 取消勾选当前行的核对清单项
• all - 取消勾选当前行所属列表中的所有核对清单项

示例

• \uncheck - 取消勾选当前行的核对清单项
• \uncheck(all) - 取消勾选列表中的所有核对清单项

\reset

• 取消勾选当前行所属列表中的所有核对清单项

示例

• \reset - 取消勾选当前列表中的所有核对清单项

\sort

• 对当前行所属的核对清单进行排序，将已勾选的列表项移到底部

示例

• \sort - 将当前列表中已勾选的项目移到底部

格式

\bold

• 切换粗体格式
• 同义词：\b

示例

• \b - 切换粗体格式，等同于 \bold

\italic

• 切换斜体格式
• 同义词：\i

示例

• \i - 切换斜体格式，等同于 \italic

\underline

• 切换下划线格式
• 同义词：\u

示例

• \u - 切换下划线格式，等同于 \underline

\fixed-width

• 切换等宽格式
• 同义词：\fixed

示例

• \fixed - 切换等宽格式，等同于 \fixed-width

\strikethrough

• 切换删除线格式
• 同义词：\strike

示例

• \strikethrough - 切换删除线格式，等同于 \strike

\superscript

• 切换上标格式
• 同义词：\sup

示例

• \sup - 切换上标格式，等同于 \superscript

\subscript

• 切换下标格式
• 同义词：\sub

示例

• \sub - 切换下标格式，等同于 \subscript

\color

• 切换文本颜色格式
• 同义词：\text-color

参数

• color - 要使用的颜色名称 - 默认，必填

示例

• \text-color(color: green) - 切换为绿色文本颜色，等同于 \color(green)
• \color(#333) - 切换为十六进制颜色 #333 的文本颜色

\highlight

• 切换文本高亮格式

参数

• color - 要使用的颜色名称 - 默认，必填

示例

• \highlight(color: blue) - 切换为蓝色文本高亮，等同于 \highlight(blue)
• \highlight(#333) - 切换为十六进制颜色 #333 的文本高亮

\clear

• 移除所有格式，恢复为纯文本
• 同义词：\c

示例

• \clear - 重置所有行内样式格式

笔记操作

\on-the-agenda

• 将笔记标记为"简达"；若当前已标记，则取消该标记
• 同义词：\ota、\ontheagenda、\agenda

示例

• \ota - 将笔记标记为"简达"，等同于 \on-the-agenda

\done

• 将笔记标记为已完成

示例

• \done - 将笔记标记为已完成

\undone

• 取消笔记的已完成标记

示例

• \undone - 取消笔记的已完成标记

\pin

• 将笔记置顶到项目顶部

示例

• \pin - 置顶该笔记

\footnote

• 将笔记变为脚注，固定在项目底部

示例

• \footnote - 将笔记变为脚注

\unpin

• 将已置顶的笔记或脚注恢复为普通笔记

示例

• \unpin - 将已置顶的笔记或脚注恢复为普通笔记

\assign-date

• 将所提供的日期指定给当前笔记
• 同义词：\assign
• 简写：\today、\tomorrow、\yesterday、\monday、\tuesday、\wednesday、\thursday、\friday、\saturday、\sunday

参数

• day、on、after、before、until、from、in - 以自然语言表示的、要指定的日期 - 默认
• date、at - 以自然语言表示的、要指定的日期时间

示例

• \assign(17 oct 2022) - 将笔记指定到 2022 年 10 月 17 日
• \assign(in: 3 weeks) - 将笔记指定到今天之后的 3 周
• \assign(tomorrow) - 将笔记指定到明天
• \assign(next Wednesday) - 将笔记指定到下周三
• \today - 将笔记指定到今天
• \friday - 将笔记指定到本周五

\link-event

• 将所提供的事件链接到当前笔记
• 同义词：\event

参数

• day、on、after、before、until、from、in - 以自然语言表示的、用于搜索事件的日期 - 默认
• date、at - 以自然语言表示的、用于搜索事件的日期时间
• calendar - 搜索应限定的日历

示例

• \event(17 oct 2022) - 显示 10 月 17 日可供笔记链接的日历事件
• \event(calendar: Work, 17 oct 2022) - 显示 10 月 17 日 Work 日历中可供笔记链接的事件

\new

在 Agenda 15 中新增

• 在当前笔记之后添加一条新笔记

参数

• none- 在当前笔记之后添加一条新笔记
• title - 所创建笔记的标题 - 默认
• template- 新笔记要使用的模版

示例

• \new - 在你当前所在笔记之后创建一条新笔记
• \new(Part Two) - 创建一条标题为 Part Two 的新笔记
• \new(title: 15 Dec, template: Daily Meeting) - 使用 Daily Meeting 模版创建一条标题为 15 Dec 的新笔记。

\split

• 在插入点处拆分当前笔记

参数

• none- 在插入点处拆分当前笔记 - 默认
• title - 从当前笔记拆分出来的笔记的标题

示例

• \split - 在插入点处拆分当前笔记
• \split(title: Part Two) - 在插入点处将当前笔记拆分为一条标题为 Part Two 的新笔记

\duplicate

• 复制当前笔记

参数

• none- 复制当前笔记 - 默认
• title - 副本笔记的标题

示例

• \duplicate - 在插入点处拆分当前笔记，等同于 \new
• \duplicate(title: Part Two) - 创建当前笔记的副本，标题为 Part Two

\move

• 将当前笔记移到另一个项目

参数

• project、project-title、to - 笔记应移动到的项目标题 - 默认，必填

示例

• \move(to: Developing Yak App) - 将当前笔记移到项目 Developing Yak App

\print

• 打印当前笔记

示例

• \print - 打印该笔记

转义

操作

如果你不希望某个操作被执行，而是希望它保留为文本，可以在该操作前再加一个反斜杠字符，例如：\\tag(name: Alex)。这样该操作就不会创建标签 Alex，而是保留为 \tag(name: Alex)。此外，你也可以将段落样式改为"预格式化"，或将行内样式改为等宽，以阻止操作被执行。

参数

在操作的参数列表中，冒号和逗号具有特殊含义；如果某个参数的实参需要包含这两个字符之一，可以使用反斜杠字符对其进行转义。

例如，未经转义的 \date(format: YYYY, dd-MM) 会被错误解析，只显示年份 2022；改用 \date(format: YYYY\, dd-MM) 则可显示 2022, 07-04

同样，未经转义的 \split(Newsflash: ABC) 无法被正确解析，而 \split(Newsflash\: ABC) 则可以。

本地化

请注意，所有操作和参数都应根据 App 的语言进行相应的本地化。此时你既可以使用上述英文形式，也可以使用翻译后的形式。请注意，虽然这些操作可能包含重音符号和/或大写字母，但输入时无需键入它们；例如在法语版的 Agenda 中，输入以下任意一项都能得到编号列表：

• \numérotée
• \numerotee
• \Numérotée
• \numbered