文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载本文围绕 tldr 社区约定的 See also另请参阅提示机制展开完整说明其设计意图、在页面头部中的使用规范单命令、多命令与子命令三种形态、官方多语言翻译模板 的 40 种语言完整清单以及仓库配套的 set-see-also.py 自动同步脚本的源码级实现原理。读完本文你将能够为 tldr 页面正确撰写相关命令引用理解翻译模板的占位符替换机制并掌握用脚本批量维护全部翻译页面中 See also 段落的完整流程。为什么需要 See also 提示在 tldr 页面体系中很多命令之间存在着密切关联有的是需要搭配使用的工具如挂载辅助工具有的则是功能相似、互为替代的命令。此时如果在当前命令页的头部留一句提示用户就能顺藤摸瓜找到相关的其他页面。文档 see-also-mentions.md 中给出了一个经典案例top页面适合提及atop、glances、btop、btm等替代工具。通过一个简短提示告知用户这些页面也存在既不影响主页面内容的简洁性又显著提升了浏览体验。这种提示统一放置在**基础命令的描述区域header**中并以固定的句式呈现从而保证整个仓库数万条页面风格一致、机器可解析。See also 在页面头部的规范用法仓库的 style-guide.md 在 See also section 小节L286-L317对写法做了精确定义与翻译模板文档互为补充单命令引用引用一个相关命令或子命令时使用 See also: command.实际页面示例可见 pages/common/age.md See also: age-keygen, age-inspect.多命令引用引用多个相关命令或子命令时用逗号分隔 See also: command1, command2, command3.例如 pages/common/age-keygen.md 与 pages/common/age-inspect.md 互为引用pages/common/age.md 同时引用age-keygen和age-inspect。Windows 与 Android 平台同样适用如 pages/android/pm-install-commit.md 中 See also: \pm install-create, pm install-write.。子命令页引用当一个命令拥有无法在主页中展开的子命令页面时使用专门的句式注意这里只列出子命令名不带命令 子命令的完整形式 Some subcommands such as commit, add, branch, switch, push, etc. have their own usage documentation.仓库中有大量真实范例例如 pages/linux/b4.md Some subcommands such as am, shazam, prep, send have their own usage documentation.描述区的顺序约束See also 在页面描述区中不是随意放置的。style-guide 明确要求头部各行遵循如下顺序L306-L317 Short description of the functionality. Further clarification of the functionality. Note: Any note for the usage. Some subcommands such as subcommand1, subcommand2 have their own usage documentation. See also: command. More information: https://example.com.即功能简介 → 补充说明 → 使用注意 → 子命令提示 → 相关命令提示 → 更多信息链接。翻译模板文档本身就是这种顺序约束的直接配套产物——它只负责提供每一种语言下对应句式的标准翻译供翻译者套用。翻译模板文档的结构与语言覆盖see-also-mentions.md 位于 contributing-guides/translation-templates/ 目录下与 subcommand-mention.md、common-descriptions.md、alias-pages.md、more-info-link.md、common-arguments.md 并列共同构成 tldr 多语言维护的基础设施。文档开头先交代该提示的用途Oftentimes when you have related commands... we put a little notice in the base commands description随后以目录锚点列出全部支持语言再按### 语言代码的二级标题逐一给出模板。每个模板都是一个 Markdown 引用块占位符统一为example翻译者在实际页面中需要将其替换为真实的命令名。下表完整收录了该文档定义的 40 种语言模板以仓库文件实际内容为准语言代码模板原文en See also: \example.ar انظر أيضًا: \example.bg Виж също: \example.bn আরও দেখুন: \example।bs Pogledajte isto: \example.ca Vegeu també: \example.cs Viz také: \example.da Se også: \example.de Siehe auch: \example.el Δείτε επίσης: \example.es Vea también: \example.fa همچنین : \example.fi Katso myös: \example.fr Voir aussi : \example.hi यह भी देखें: \example।id Lihat juga: \example.it Vedi anche: \example.ja 参照: \example。ko 관련 항목: \example.lo ເບິ່ງຕື່ມ: \example.ml ഇതും കാണുക: \example.nb Se også: \example.ne हेर्नुहोस् पनि: \example।nl Zie ook: \example.no Se også: \example.pl Zobacz także: \example.pt_BR Veja também: \example.pt_PT Veja também: \example.ro Vezi și: \example.ru Смотрите также: \example.si මෙයද බලන්න: \example.sr Такође погледајте: \example.sv Se även: \example.ta மேலும் காண்க: \example.th ดูเพิ่มเติม: \exampletr Ayrıca bakınız: \example.uk Дивіться також: \example.uz Shuningdek qarang: \example.zh 另请参阅\example。zh_TW 另請參閱\example。模板使用要点占位符统一所有模板都使用example占位符翻译时只需整体替换为实际命令名多个命令用逗号分隔。标点差异部分语言bn、hi、ja、zh、zh_TW使用全角句号或全角标点需要按模板原样保留th 模板末尾没有句点。fa 模板中冒号前后带有空格همچنین :这是该文档的既定格式翻译时应照搬。中文页面中的真实落地示例模板在实际翻译页面中的应用完全遵循占位符替换逻辑。例如简体中文页面 pages.zh/common/!.md 另请参阅^。[pages.zh/common/.md 和 pages.zh/common/^.md 也分别以另请参阅\test。和另请参阅!。 互相引用。这与英文页面 pages/common/!.md、pages/common/^.md 形成一一对应验证了英文页确定引用关系、翻译页套用本地化模板的协作模式。自动同步脚本 set-see-also.py 源码解析为了让 See also 段落在数百种翻译页面间保持一致仓库提供了 scripts/set-see-also.py 自动化工具。该脚本与翻译模板文档直接联动它在运行时通过get_templates(root, see-also-mentions.md)读取本模板文件L235把每种语言的模板作为写入目标句式的来源。核心流程一set_see_also —— 单页写入set_see_also() 负责往单个页面写入 See also 段落其逻辑要点先确定该页面的 locale若模板中不存在该语言或用户指定了-l语言但与此页不符则跳过返回空状态。扫描以开头的行定位描述区的起止行号desc_start/desc_end。将模板中的example替换为传入的命令列表new_line config.templates[locale].replace(\example, see_also)从而生成目标句式。若描述区倒数第二行已是该句式则无需改动若该行以^.*[:]\s*结尾即已是某种引用提示则覆盖更新否则在描述区末尾插入新行。核心流程二get_see_also —— 读取英文页引用关系get_see_also() 从英文页面提取已有的 See also 内容用正则^ See also:匹配描述区最后一行再通过([^\])抽取出全部反引号包裹的命令名归一化为\a, b 的规范格式返回。这一步是批量同步的数据源。核心流程三sync —— 跨语言同步sync() 遍历所有语言页面目录如page.fr/common、page.zh/common等对每个command路径调用set_see_also()把英文页中的引用关系同步进每种语言并收集发生变更的页面供后续 git stage 使用。命令行用法脚本支持以下常用操作详见 脚本文档字符串# 为指定页面设置 See also可指定多个命令逗号分隔 python3 scripts/set-see-also.py -p common/bash zsh,! # 读取所有英文页面将 See also 段落同步到全部翻译页面 python3 scripts/set-see-also.py -S # 只同步巴西葡萄牙语页面 python3 scripts/set-see-also.py -S -l pt_BR # 同步并暂存修改需在 git 仓库内运行 python3 scripts/set-see-also.py -Ss # 预演模式只展示将要发生的修改不写文件 python3 scripts/set-see-also.py -Sn其中的-s/--stage、-n/--dry-run等选项由 scripts/_common.py 提供的create_argument_parser与get_tldr_root等公共函数统一支撑后者用于在未知目录下运行脚本时通过TLDR_ROOT环境变量定位仓库根目录。维护流程小结综合模板文档与配套脚本tldr 仓库中维护 See also 引用的标准流程是在英文页面pages/ 目录中按 style-guide 规定的句式手工添加 See also: \命令1, 命令2.运行python3 scripts/set-see-also.py -S脚本读取 see-also-mentions.md 中各语言模板自动为所有翻译页面生成对应的本地化提示如简体中文的 另请参阅\命令1, 命令2。如需新增一种尚未覆盖的语言则先向本模板文档补充该语言的标准句式同步脚本即可自动识别并使用。这一模板文档 自动化脚本的组合使得数万条多语言页面的相关命令引用始终保持结构一致这正是 tldr 协作式速查表能够在四十余种语言间高效维护的关键机制之一。赞分享文档教程知识库【免费下载链接】tldrCollaborative cheatsheets for console commands .项目地址https://gitcode.com/GitHub_Trending/tl/tldr点击查看免费下载相关推荐如何防御子进程参数注入book-to-skill路径绝对化设计背后的安全教训如何防御子进程参数注入book to skill路径绝对化设计背后的安全教训 book to skill 是一款把技术书籍PDF、EPUB、DOCX 等转文档教程知识库tldr-pages交叉引用相关命令链接网络tldr pages交叉引用相关命令链接网络 tldr pages作为命令行工具的简明指南不仅提供单条命令的使用示例更通过精心设计的交叉引用系统将分散的文档教程知识库tldr 项目 More information 链接多语言模板全解析从规范到自动化维护tldr 项目 More information 链接多语言模板全解析从规范到自动化维护 tldr 是一个协作式的控制台命令速查手册仓库每一条命令页面都在描文档教程知识库上一篇PL-2303 Win10驱动快速配置指南让停产旧芯片在Windows 10重获新生下一篇电视浏览器体验笔记把TV Bro装进客厅遥控器终于不只是用来换台创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考