ARTICLE DETAIL

资讯详情

深耕网站视觉设计与运营推广的一线实战洞察。

PX4-Autopilot 文档翻译协作指南:基于 Crowdin 的多语言维护全流程

PX4-Autopilot 文档翻译协作指南:基于 Crowdin 的多语言维护全流程 嵌入式物联网机器人自动驾驶智能硬件【免费下载链接】PX4-AutopilotPX4 Autopilot Software项目地址https://gitcode.com/gh_mirrors/px/PX4-Autopilot点击查看免费下载PX4-Autopilot 的用户指南、QGroundControl 界面与 PX4 元数据参数/事件描述均通过 Crowdin 在线平台进行多语言协作翻译。本文以仓库中的 translation.md 为核心结合仓库内的 Crowdin 配置文件与多语言目录结构系统讲解翻译项目如何组织、如何加入翻译团队、翻译过程中的格式约束以及新增语言与获取支持的具体路径帮助你快速上手并正确参与 PX4 生态的本地化工作。为什么 PX4 用 Crowdin 管理翻译PX4 文档仓库本身是英文单语的所有源文档只存放在docs/en/下翻译语种目录docs/ko/、docs/uk/、docs/zh/等并不由译者直接在仓库中编辑而是由 Crowdin 在线工具自动导入、分发与回写。这一设计带来的直接好处是翻译紧贴源文档Crowdin 自动从 GitHub 拉取源主题把新增或变更的字符串推送给译者进行翻译或审校approval读者不会被陈旧过时的翻译误导回写以 PR 形式进行Crowdin 将翻译完成的内容导出回 GitHub 时以 Pull Request 形式提交由开发团队定期评审并合并未翻译字符串自动回退英文导出的产物是源文档 已翻译且已批准的字符串替换某个字符串若未翻译或已变更最终页面仍会显示英文保证文档永远不出现半翻译坏链。参与翻译只需一个免费的 Crowdin 账号crowdin.com/join无需直接操作 PX4 代码仓库。仓库侧的翻译配置文件翻译流程的自动化配置就存放在仓库根目录下的 docs/crowdin_docs.yml它是理解整个翻译管道的最佳切入点project_id_env: CROWDIN_PROJECT_ID api_token_env: CROWDIN_PERSONAL_TOKEN base_path: ../ preserve_hierarchy: true files: [ { source: docs/en/**/*.md, ignore: [/docs/en/_sidebar.md,docs/en/advanced_config/parameter_reference.md], translation: docs/%two_letters_code%/**/%original_file_name% } ]逐项拆解这份配置的含义配置项值说明project_id_envCROWDIN_PROJECT_ID从环境变量读取 Crowdin 项目 ID避免把项目凭据写死在仓库中api_token_envCROWDIN_PERSONAL_TOKEN从环境变量读取个人 API Token用于 Crowdin 与 GitHub 之间同步base_path../所有相对路径的基准目录即仓库根目录preserve_hierarchytrue保持源目录层级使目标语言目录与docs/en/一一对应sourcedocs/en/**/*.md只把英文源文档作为翻译源其他语种目录不会再次被导入ignore_sidebar.md、parameter_reference.md侧边栏文件与自动生成的参数参考页被排除在翻译范围外translationdocs/%two_letters_code%/**/%original_file_name%输出到对应两字母语言代码目录文件名与原文件保持一致最后一行%two_letters_code%解释了仓库中翻译目录命名的由来docs/ko/韩语、docs/uk/乌克兰语、docs/zh/中文等目录名正是由该占位符按两字母语言代码展开生成的。从源码结构看docs/zh/contribute/translation.md 这类译文文件与英文原文保持完全相同的相对路径与文件名正是preserve_hierarchy与%original_file_name%共同作用的结果。加入翻译团队完整步骤按 translation.md 的流程加入 PX4 翻译团队只需以下五步注册 Crowdin 账号访问 https://crowdin.com/join 完成免费注册打开要加入的翻译项目PX4 生态目前有六个并行维护的翻译项目QGroundControl —— QGroundControl 界面与硬编码字符串PX4-Metadata-Translations —— QGroundControl 中显示的 PX4 参数与事件描述PX4 User Guide —— PX4 用户指南即本文档仓库的主体QGroundControl Developer Guide —— QGroundControl 开发者指南QGroundControl User Guide —— QGroundControl 用户指南MAVLink Guide —— MAVLink 协议指南选择你想要翻译的语言在项目页面点击Join按钮该按钮紧邻You must join the translators team to be able to participate in this project提示文字申请被接受后你会收到通知开始翻译。加入后你的翻译工作流通常是Crowdin 自动同步 GitHub 上的英文源 → 你在网页端翻译或审校 → 已批准的译文随下次导出回到 GitHub 的 PR 中 → 维护团队定期合入。翻译格式红线不要改动:::前缀文本PX4 文档采用带提醒框admonition的 Markdown 扩展语法用:::标记 note、tip、warning 等提示框的开始与结束。原文档给出的示例如下:::tip The text for the tip. ::::::tip、:::warning等前缀文本本身绝不能翻译或修改因为它决定了提示框的渲染样式与颜色。翻译时只应翻译冒号标记之后的正文内容。这一点在文档风格指南中同样被强调参见 docs.md 的样式规范不要翻译info、tip、warning声明中用于标识类型的文本。从仓库现状看文档构建工具链已由早期 GitBookdocs/book.json 中可见其历史配置演进为 Vitepress见 docs/package.json 中的vitepress依赖但提醒框语法的使用惯例被保留了下来翻译时对这一格式约束需要始终如一地遵守。新增语言先找齐人手再申请如果你要翻译的语言在 Crowdin 项目中尚不存在需要通过各项目主页上的联系链接向项目所有者提出申请。需要注意其中的警告维护一门翻译非常辛苦。在请求创建新语言之前请先找到几位愿意一起参与翻译的伙伴否则单独一人很难长期维持译文与英文源文档的同步质量。这是 PX4 团队对新语言申请设置的实际门槛也是保证译文长期可用的现实考量。获取帮助与社区支持Crowdin 的翻译界面本身非常直观自解释性很强如需更深入的用法说明可以查阅 Crowdin 官方知识库support.crowdin.com。此外还可以通过 Dronecode 社区的支持渠道向其他译者和开发者求助具体入口见 support.md社区的完整协作入口汇总在 contribute/index.md其中与翻译直接相关的条目会链接回本页。翻译在仓库中的落地形态理解翻译的最终去向有助于在本地检查译文质量。仓库根目录下各语言文档树与docs/en/严格镜像docs/ ├── en/ # 英文源文档唯一可直接编辑的语种 ├── ko/ # 韩语翻译 ├── uk/ # 乌克兰语翻译 └── zh/ # 中文翻译按 docs.md 的说明英文版本的文件才能直接在源仓库中编辑其他语种目录如ko、zh的内容由 Crowdin 工具管理不应直接手工修改否则会在下次 Crowdin 回写时被覆盖或产生冲突。这也解释了为什么向仓库提交文档修改时应只针对docs/en/下的文件操作。对于只想为文档做小改动错别字、语法修正的贡献者docs.md 还提供了两条路径一是直接使用页面底部的Edit on GitHub链接在网页端修改并提交 PR二是克隆仓库后用 Vitepress 本地构建验证yarn install、yarn start、yarn docs:build。需要提醒的是无论走哪条路径都不应改动翻译语种目录翻译工作请始终回到 Crowdin 完成。小结PX4-Autopilot 的多语言维护是一套英文源文档 Crowdin 在线协作 PR 回写的成熟流水线仓库侧通过 crowdin_docs.yml 定义了源范围、忽略项与目标语言目录的映射规则译者侧只需注册 Crowdin 账号、申请加入对应项目、按格式约束翻译即可。理解这套机制既能让你正确参与翻译贡献也能避免误改翻译目录导致的冲突是进入 PX4 社区协作的重要一步。赞分享嵌入式物联网机器人自动驾驶智能硬件【免费下载链接】PX4-AutopilotPX4 Autopilot Software项目地址https://gitcode.com/gh_mirrors/px/PX4-Autopilot点击查看免费下载相关推荐ent 文档多语言翻译指南基于 Crowdin 的协作翻译与发布流程ent 文档多语言翻译指南基于 Crowdin 的协作翻译与发布流程 ent 官方通过 Crowdin 平台发起了文档翻译计划目标是让官网全部文档以中文、日后端ORM代码生成Element Plus 文档翻译贡献指南基于 Crowdin 的自动化多语言协作流程Element Plus 文档翻译贡献指南基于 Crowdin 的自动化多语言协作流程 Element Plus 作为一套面向全球开发者的 Vue 3 组件库前端UI组件Tinyauth多语言文档维护协作翻译与更新流程Tinyauth多语言文档维护协作翻译与更新流程 在全球化应用开发中多语言支持是提升用户体验的关键环节。Tinyauth作为轻量级身份验证解决方案通过系统认证鉴权后端API网关创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表