From 311c215a043cb572d771152bc8bc7c4276d61b59 Mon Sep 17 00:00:00 2001 From: iyear Date: Mon, 9 Oct 2023 10:21:11 +0800 Subject: [PATCH] docs(zh): add tools --- docs/content/en/guide/tools/_index.md | 1 + docs/content/zh/guide/download.md | 4 +- docs/content/zh/guide/login.md | 2 +- docs/content/zh/guide/tools/_index.md | 5 + docs/content/zh/guide/tools/export-members.md | 45 +++++++ .../content/zh/guide/tools/export-messages.md | 125 ++++++++++++++++++ docs/content/zh/guide/tools/filter.md | 12 ++ docs/content/zh/guide/tools/list-chats.md | 40 ++++++ docs/content/zh/more/cli/_index.md | 4 +- 9 files changed, 233 insertions(+), 5 deletions(-) create mode 100644 docs/content/zh/guide/tools/_index.md create mode 100644 docs/content/zh/guide/tools/export-members.md create mode 100644 docs/content/zh/guide/tools/export-messages.md create mode 100644 docs/content/zh/guide/tools/filter.md create mode 100644 docs/content/zh/guide/tools/list-chats.md diff --git a/docs/content/en/guide/tools/_index.md b/docs/content/en/guide/tools/_index.md index 855bc308e6..1706fb86bc 100644 --- a/docs/content/en/guide/tools/_index.md +++ b/docs/content/en/guide/tools/_index.md @@ -1,4 +1,5 @@ --- +title: "Tools" bookCollapseSection: true weight: 60 --- diff --git a/docs/content/zh/guide/download.md b/docs/content/zh/guide/download.md index 7b1091a6da..44dfa464c1 100644 --- a/docs/content/zh/guide/download.md +++ b/docs/content/zh/guide/download.md @@ -30,7 +30,7 @@ tdl dl -u https://t.me/tdl/1 -u https://t.me/tdl/2 {{< tabs "json" >}} {{< tab "tdl" >}} -请参考 [导出消息](/guide/tools/export-messages) +请参考 [导出消息](/zh/guide/tools/export-messages) {{< /tab >}} {{< tab "桌面客户端" >}} @@ -138,7 +138,7 @@ tdl dl -u https://t.me/tdl/1 -e mp4,flv 使用自定义文件名模板下载： -请参考 [模板指南](/guide/template) 了解更多。 +请参考 [模板指南](/zh/guide/template) 了解更多。 {{< command >}} tdl dl -u https://t.me/tdl/1 \ diff --git a/docs/content/zh/guide/login.md b/docs/content/zh/guide/login.md index 28d384e380..83498cb634 100644 --- a/docs/content/zh/guide/login.md +++ b/docs/content/zh/guide/login.md @@ -2,7 +2,7 @@ type: "docs" title: "登录" weight: 20 -bookHref: "/getting-started/quick-start/#login" +bookHref: "/zh/getting-started/quick-start/#login" --- # Login diff --git a/docs/content/zh/guide/tools/_index.md b/docs/content/zh/guide/tools/_index.md new file mode 100644 index 0000000000..99d9b47b8c --- /dev/null +++ b/docs/content/zh/guide/tools/_index.md @@ -0,0 +1,5 @@ +--- +title: "工具" +bookCollapseSection: true +weight: 60 +--- diff --git a/docs/content/zh/guide/tools/export-members.md b/docs/content/zh/guide/tools/export-members.md new file mode 100644 index 0000000000..f664ea7a13 --- /dev/null +++ b/docs/content/zh/guide/tools/export-members.md @@ -0,0 +1,45 @@ +--- +title: "导出成员" +weight: 20 +--- + +# 导出成员 + +导出聊天成员/订阅者、管理员、机器人等。 + +{{< hint info >}} +需要聊天管理员权限。 +{{< /hint >}} + +{{< details title="CHAT 示例" open=false >}} + +- `@iyear` +- `iyear` +- `123456789` (ID) +- `https://t.me/iyear` +- `+1 123456789` (电话号码) + {{< /details >}} + +## 默认 + +将所有用户导出为 `tdl-users.json` + +{{< command >}} +tdl chat users -c CHAT +{{< /command >}} + +## 自定义路径 + +指定文件路径进行导出 + +{{< command >}} +tdl chat users -c CHAT -o /path/to/export.json +{{< /command >}} + +## 原始数据 + +导出 Telegram MTProto 原始用户结构，用于调试。 + +{{< command >}} +tdl chat users -c CHAT --raw +{{< /command >}} diff --git a/docs/content/zh/guide/tools/export-messages.md b/docs/content/zh/guide/tools/export-messages.md new file mode 100644 index 0000000000..586e54899f --- /dev/null +++ b/docs/content/zh/guide/tools/export-messages.md @@ -0,0 +1,125 @@ +--- +title: "导出消息" +weight: 30 +--- + +# 导出消息 + +以 JSON 格式导出聊天、频道、群组等中的媒体消息。 + +{{< details title="CHAT 示例" open=false >}} + +- `@iyear` +- `iyear` +- `123456789` (ID) +- `https://t.me/iyear` +- `+1 123456789` (电话号码) + {{< /details >}} + +## 所有消息 + +将包含媒体的所有消息导出到 `tdl-export.json` + +{{< command >}} +tdl chat export -c CHAT +{{< /command >}} + +## 从主题/回复中导出 + +从特定主题导出媒体消息： +{{< hint info >}} +获取主题 ID 的方式： + +1. 消息链接：`https://t.me/c/1492447836/251011/269724`（`251011` 是主题 ID） +2. `tdl chat ls` 命令 + {{< /hint >}} + +{{< command >}} +tdl chat export -c CHAT --topic TOPIC_ID +{{< /command >}} + +从特定频道帖子的回复中导出媒体消息： + +{{< command >}} +tdl chat export -c CHAT --reply POST_ID +{{< /command >}} + +## 自定义路径 + +指定输出文件路径进行导出。默认：`tdl-export.json`。 + +{{< command >}} +tdl chat export -c CHAT -o /path/to/output.json +{{< /command >}} + +## 自定义类型 + +### 时间范围 + +根据特定的时间戳范围进行导出。默认：`1970-01-01` - `当前` + +{{< command >}} +tdl chat export -c CHAT -T time -i 1665700000,1665761624 +{{< /command >}} + +`time` 也是 `-T` 选项的默认值，因此您可以省略它 + +{{< command >}} +tdl chat export -c CHAT -i 1665700000,1665761624 +{{< /command >}} + +### ID 范围 + +根据特定的消息 ID 范围进行导出。默认：`0` - `最新` + +{{< command >}} +tdl chat export -c CHAT -T id -i 100,500 +{{< /command >}} + +### 最新 + +导出最后 100 条媒体文件： + +{{< command >}} +tdl chat export -c CHAT -T last -i 100 +{{< /command >}} + +## 过滤 + +请参考[过滤指南](/zh/guide/tools/filter)以获取有关过滤器的基本知识。 + +列出所有可用的过滤字段： + +{{< command >}} +tdl chat export -c CHAT -f - +{{< /command >}} + +导出最后的 10 个媒体文件，其中 `大小 > 5MiB` 且 `查看次数 > 200`： + +{{< command >}} +tdl chat export -c CHAT -T last -i 10 -f "Views>200 && Media.Name endsWith '.zip' && Media.Size > 5*1024*1024" +{{< /command >}} + +## 包含内容 + +附带消息内容： + +{{< command >}} +tdl chat -c CHAT --with-content +{{< /command >}} + +## 原始数据 + +导出 Telegram MTProto 原始消息结构，用于调试。 + +{{< command >}} +tdl chat export -c CHAT --raw +{{< /command >}} + +## 非媒体消息 + +导出包括非媒体消息的所有消息，用于调试/备份。 + +{{< command >}} +tdl chat export -c CHAT --all +{{< /command >}} diff --git a/docs/content/zh/guide/tools/filter.md b/docs/content/zh/guide/tools/filter.md new file mode 100644 index 0000000000..dd0f336c5e --- /dev/null +++ b/docs/content/zh/guide/tools/filter.md @@ -0,0 +1,12 @@ +--- +title: "过滤器指南" +bookHidden: true +--- + +# 过滤器指南 + +过滤器由 [expr](https://github.com/antonmedv/expr) 引擎提供支持，它是一个简单、轻量但功能强大的表达式引擎。 + +表达式引擎文档：https://expr.medv.io/docs/Language-Definition + +它功能强大，但对于新用户来说可能有些难以理解。如果您对表达式引擎有任何疑问，请随时提出 ISSUE。 diff --git a/docs/content/zh/guide/tools/list-chats.md b/docs/content/zh/guide/tools/list-chats.md new file mode 100644 index 0000000000..0c60cd30fd --- /dev/null +++ b/docs/content/zh/guide/tools/list-chats.md @@ -0,0 +1,40 @@ +--- +title: "列出聊天" +weight: 10 +--- + +# 列出聊天 + +## 列出所有聊天 + +{{< command >}} +tdl chat ls +{{< /command >}} + +## JSON 格式 + +{{< command >}} +tdl chat ls -o json +{{< /command >}} + +## 过滤器 + +请参考 [过滤器指南](/zh/guide/tools/filter) 以获取有关过滤器的基本知识。 + +列出所有可用的过滤字段： + +{{< command >}} +tdl chat ls -f - +{{< /command >}} + +列出名字包含 "Telegram" 的频道： + +{{< command >}} +tdl chat ls -f "Type contains 'channel' && VisibleName contains 'Telegram'" +{{< /command >}} + +列出具有主题的群组： + +{{< command >}} +tdl chat ls -f "len(Topics)>0" +{{< /command >}} diff --git a/docs/content/zh/more/cli/_index.md b/docs/content/zh/more/cli/_index.md index bd45f16a86..be3d47af3f 100644 --- a/docs/content/zh/more/cli/_index.md +++ b/docs/content/zh/more/cli/_index.md @@ -1,5 +1,5 @@ --- -title: "CLI" +title: "命令行" weight: 10 -bookHref: "/more/cli/tdl" +bookHref: "/zh/more/cli/tdl" ---