- 文档
- 教程
- 知识库
【免费下载链接】tldr
Collaborative cheatsheets for console commands 📚.
本文聚焦 tldr 协作速查表仓库中的「子命令提及（Mentioning sub-commands）」机制：当某个命令存在独立成页的子命令时，如何在基础命令页的头部向用户提示这些子命令页面的存在。通过本指南，你将完整掌握 subcommand-mention 提示语的放置规则、英文模板的精确格式、仓库中 git / go / btrfs 等真实页面的应用范例，以及覆盖 39 种语言的官方翻译模板，可直接套用于日常贡献、审阅与本地化翻译工作。
一、什么是「子命令提及」及其存在意义
在 tldr 仓库的页面体系中，一个命令如果拥有无法在基础页中完整覆盖的子命令，子命令会单独成页。最典型的例子是git：它拥有git-commit、git-push等一系列独立页面。
为了让用户知道这些子命令页面确实存在，仓库约定：在基础命令的描述中放置一行简短提示，这就叫「子命令提及」（Mentioning sub-commands）。该提示语的完整翻译模板收录在 contributing-guides/translation-templates/subcommand-mention.md 中，它是翻译各语言页面时必须参考的官方规范文件。
该提示的核心价值在于导航：tldr 客户端渲染页面时，用户读完基础命令后，如果知道还有git-commit这类更细分的页面，就能进一步查阅更精准的用法，而不是在基础页里堆叠所有子命令内容。
二、提示语的标准放置位置与 Markdown 语法
提示语以 Markdown引用块（blockquote）形式书写，以>开头，统一放在命令描述与More information行之间。以仓库真实页面 pages/common/git.md 为例，其头部结构如下：
# git > Distributed version control system. > Some subcommands such as `commit`, `add`, `branch`, `switch`, `push`, etc. have their own usage documentation. > More information: <https://git-scm.com/docs/git>.可见其排列顺序为：
- 首行
# git：命令名标题； - 描述行：
> Distributed version control system.； - 子命令提及行：
> Some subcommands such as ... have their own usage documentation.（本文主题）； - 信息链接行：
> More information: <...>。
写作时需注意：模板中的`example`是占位符，实际使用时必须替换为真实存在的子命令名（可用逗号列出多个），例如 git 页面列举了commit、add、branch、switch、push等。
三、英文模板与仓库真实应用范例
英文标准模板（源自关联文档 en 小节）：
> Some subcommands such as `example` have their own usage documentation.以下均为仓库中已实际落地的应用示例：
- pages/common/git.md：
> Some subcommands such as \commit`, `add`, `branch`, `switch`, `push`, etc. have their own usage documentation.` —— 单页提示多个子命令的代表； - pages/common/go.md：
> Some subcommands such as \build` have their own usage documentation.` —— 单子命令提示的简洁形态； - pages/common/brew.md：
> Some subcommands such as \install` have their own usage documentation.`； - pages/linux/btrfs.md：
> Some subcommands such as \device` have their own usage documentation.`。
由此可以提炼出两个替换要点：
- 占位符替换：
example必须换成该命令真实存在的子命令名，不能保留字面 "example"； - 数量弹性：既可以只列一个子命令，也可以用逗号 +
etc.列举多个，但列举的每一个都应当确实存在对应的独立页面。
四、子命令如何独立成页：命名与文件组织
关联文档明确指出：当子命令无法在原始页面中覆盖时，就获得自己的页面。仓库的实践是采用命令名-子命令名的连字符命名方式，例如git-commit、git-push（详见关联文档第 4 行）。对应在仓库中的文件组织可见 pages/common/ 目录下同时存在git.md与git-commit.md、git-push.md等子命令页；aws系列页面也遵循同一模式（如aws-s3.md、aws-ec2.md等）。
因此，一条完整的子命令提及提示语，实际意味着：
- 基础页（如
git.md）头部出现提示行； - 每个被提及的子命令都存在独立页面（如
git-commit.md）； - 提示语中列出的子命令名，与独立页面文件名保持一一对应。
五、全语言翻译模板速查表（39 种语言完整收录）
关联文档按语言分节收录了全部翻译模板，这是翻译各语言页面时必须逐字对照的权威内容。以下完整列出，可直接复制使用（所有占位符`example`均需按上文规则替换为真实子命令名）：
| 语言 | 模板 |
|---|---|
| en（英语） | > Some subcommands such as \example` have their own usage documentation.` |
| ar（阿拉伯语） | > بعض الأوامر الفرعية لديها توثيقات الاستخدام الخاصة بها مثل: \example`.` |
| bg（保加利亚语） | > Някои подкоманди като \example` имат собствена документация за употреба.` |
| bn（孟加拉语） | > কিছু সাবকমান্ড যেমন \example` – এর নিজস্ব ব্যবহারসংক্রান্ত ডকুমেন্টেশন রয়েছে।` |
| bs（波斯尼亚语） | > Neke podnaredbe kao što je \example` imaju vlastitu dokumentaciju o korištenju.` |
| ca（加泰罗尼亚语） | > Alguns subcomandaments com \example` tenen la seva pròpia documentació.` |
| cs（捷克语） | > Některé dílčí příkazy jako je \example` mají svou vlastní dokumentaci.` |
| da（丹麦语） | > Visse underkommandoer såsom \example` har sin egen dokumentation.` |
| de（德语） | > Manche Unterbefehle wie \example` sind separat dokumentiert.` |
| el（希腊语） | > Μερικές υποεντολές όπως \example` έχουν τα δικά τους εγχειρίδια χρήσης.` |
| es（西班牙语） | > Algunos subcomandos, como \example`, tienen su propia documentación de uso.` |
| fa（波斯语） | > برخی از دستورات فرعی مانند \example` سند استفاده خاص خودشون رو دارند.` |
| fi（芬兰语） | > Joillakin alikomennoilla, kuten \example`, on omat käyttöoppaansa.` |
| fr（法语） | > Certaines sous-commandes comme \example` ont leur propre documentation.` |
| hi（印地语） | > कुछ कमांड्स जैसे की \example`, उनके अपने उपयोग प्रलेखन हैं।` |
| id（印尼语） | > Beberapa subperintah seperti \example` mempunyai dokumentasi terpisah.` |
| it（意大利语） | > Alcuni comandi aggiuntivi, come \example`, hanno la propria documentazione.` |
| ja（日语） | > \example` などの一部のサブコマンドには、独自のドキュメントがあります。` |
| ko（韩语） | > \example`과 같은 일부 하위 명령어는 별도의 도움말을 참고하세요.` |
| lo（老挝语） | > ບາງຄໍາສັ່ງຍ່ອຍເຊັ່ນ \example` ມີເອກະສານການນໍາໃຊ້ຂອງຕົນເອງ.` |
| ml（马拉雅拉姆语） | > \example` പോലുള്ള ചില ഉപകമാൻഡുകൾക്ക് അവരുടേതായ ഉപയോഗ ഡോക്യുമെന്റേഷൻ ഉണ്ട്.` |
| nb（书面挪威语） | > Noen underkommandoer som \example` har sin egen bruksdokumentasjon.` |
| ne（尼泊尔语） | > केही उपादेशहरु जस्तै \example` को आफ्नै प्रयोग कागजात हुन्छ।` |
| nl（荷兰语） | > Sommige subcommando's zoals \example` hebben hun eigen documentatie.` |
| no（挪威语） | > Noen underkommandoer som \example` har sin egen bruksdokumentasjon.` |
| pl（波兰语） | > Niektóre podkomendy takie jak \example` mają osobną dokumentację.` |
| pt_BR（巴西葡萄牙语） | > Alguns subcomandos como \example` têm sua própria documentação de uso.` |
| pt_PT（欧洲葡萄牙语） | > Alguns subcomandos, como \example`, tem a sua própria documentação de uso.` |
| ro（罗马尼亚语） | > Unele subcomenzi precum \example` au propria lor documentație de utilizare.` |
| ru（俄语） | > Некоторые подкоманды, такие как \example`, имеют собственную документацию по использованию.` |
| si（僧伽罗语） | > \example` වැනි ඇතැම් අනු විධාන සඳහා, එය සඳහාම වූ ලේඛන පවතී.` |
| sr（塞尔维亚语） | > Неке подкоманде као што је \example` имају своју документацију о коришћењу.` |
| sv（瑞典语） | > En del underkommandon som t.ex: \example` har sin egen användningsdokumentation.` |
| ta（泰米尔语） | > \example` போன்ற சிலச் சார்கட்டளைகளுக்குத் தனித்தனி பயன்பாட்டு ஆவணங்கள் உள்ளன.` |
| th（泰语） | > คำสั่งย่อยบางคำสั่ง เช่น \example` มีเอกสารการใช้งานของตัวเอง` |
| tr（土耳其语） | > \example` gibi bazı alt komutların kendi kullanım dokümantasyonu vardır.` |
| uk（乌克兰语） | > Певна підкоманда, як от \example`, що має свою власну документацію.` |
| uz（乌兹别克语） | > \example` kabi baʼzi kichik buyruqlar oʻzlarining foydalanish hujjatlariga ega.` |
| zh（简体中文） | > 此命令也有关于其子命令的文件，例如：\example`.` |
| zh_TW（繁体中文） | > 此命令也有關於其子命令的文件，例如：\example`.` |
注：以上模板均来自 contributing-guides/translation-templates/subcommand-mention.md 的对应语言分节；格式上建议保留英文模板句末的
.或对应语言的终结标点，保持与源文件完全一致。
六、简体中文与繁体中文模板的落地示例
简体中文（zh）与繁体中文（zh_TW）的提示语在措辞上略有差异：简体使用「文件」，繁体使用「檔案」；两者都以句号结尾。中文仓库页面中已有多处落地实例，例如：
- pages.zh/windows/choco.md：Windows 包管理器页面；
- pages.zh/common/docker.md、pages.zh/common/npm.md、pages.zh/common/adb.md：常见 CLI 工具；
- pages.zh/common/go.md、pages.zh/common/magick.md、pages.zh/linux/btrfs.md：开发与系统命令。
这些页面均采用了「此命令也有关于其子命令的文件，例如：`子命令名`.」的句式，与 zh 模板保持一致。繁体中文贡献者则应使用 zh_TW 模板的「檔案」措辞。
七、与「相关页面提及（See also）」模板的区分
tldr 的翻译模板体系中还有一个容易混淆的配套模板：「相关页面提及（Mentioning related pages）」，收录于 contributing-guides/translation-templates/see-also-mentions.md。两者的核心区别如下：
| 对比维度 | 子命令提及（subcommand-mention） | 相关页面提及（see-also-mentions） |
|---|---|---|
| 提示对象 | 当前命令的子命令独立页面 | 与当前命令相关/相似的其他命令页面 |
| 典型场景 | git提示存在git-commit、git-push | top提示可替代/相伴使用的atop、glances、btop、btm |
| 英文模板 | > Some subcommands such as \example` have their own usage documentation.|> See also: `example`.` | |
| 中文模板 | > 此命令也有关于其子命令的文件，例如：\example`.|> 另请参阅：`example`。` |
判断标准：如果提及的对象是同一命令名称前缀下的细分页面（如git→git-commit），用子命令提及；如果是命令族或功能相近的独立命令（如top→btop），则用 See also 模板。两者都放在页面头部的描述区域，但语义与链接目标不同，混用会导致读者导航困惑。
八、贡献与审阅实操清单
在向仓库提交新页面或翻译时，可按以下清单核对子命令提及的合规性（关联文档与 contributing-guides/style-guide.md 共同构成审阅依据）：
- 必要性：只有当命令确实存在无法在基础页内完整覆盖的子命令、且子命令已独立成页时，才添加提示行；
- 位置：提示行位于描述行之后、
More information之前，且以>引用块格式书写； - 占位符替换：
`example`必须替换为真实子命令名，且被列出的子命令都存在对应独立页面（如git-commit.md）； - 语言一致：页面的提示语必须使用对应语言分节中的官方模板，不得自行改写措辞；
- 标点完整：保留模板原有的句号/终结标点；
- 不与其他模板混用：子命令提示与 See also 提示严格区分，见上文第七节。
完成上述核对后，配合仓库的 CONTRIBUTING.md 与脚本目录中的检查工具（如 scripts/test.sh、scripts/check-errors.sh）运行本地检查，即可提交包含正确子命令提及提示语的新页面或翻译。
九、结语
子命令提及虽只是一行简短的引用块，却是 tldr 多级速查体系的关键导航枢纽：它把「基础命令页」与「子命令独立页」串联成一个可逐步深入的查询链路。掌握 subcommand-mention.md 中的英文模板、39 种语言的翻译对照以及真实页面的落地写法，无论是写新页面、做本地化翻译，还是审阅 PR，都能确保提示语的规范与准确。
- 文档
- 教程
- 知识库
【免费下载链接】tldr
Collaborative cheatsheets for console commands 📚.
相关推荐
tldr 页面的 See also 相关命令引用规范：多语言翻译模板与自动同步实现
tldr 页面的 See also 相关命令引用规范：多语言翻译模板与自动同步实现 本文围绕 tldr 社区约定的 "See also"（另请参阅）提示机制展开
文档教程知识库tldr 翻译模板指南：common-descriptions.md 通用描述术语的多语言维护实践
tldr 翻译模板指南：common descriptions.md 通用描述术语的多语言维护实践 本篇指南围绕 tldr 仓库的 common descrip
文档教程知识库tldr 阿拉伯语页面编写与翻译规范：从页面模板到 linter 校验的完整实践
tldr 阿拉伯语页面编写与翻译规范：从页面模板到 linter 校验的完整实践 本篇指南基于 tldr 仓库中的 阿拉伯语样式指南（style guide.a
文档教程知识库
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
