菜单

国际化

相关源文件

目的与范围

本文档解释了 Apollo-11 仓库中使用的国际化 (i18n) 系统。重点在于如何翻译文档文件,以使这份历史悠久的代码库能够被全球受众访问。本页涵盖了翻译文件结构、可用语言以及贡献新翻译的指南。

概述

Apollo-11 仓库提供主要文档文件(README 和 CONTRIBUTING)的多种语言翻译,以使讲不同语言的用户能够与代码库互动。这些翻译存储在 Translations 目录中,并遵循一致的命名模式。

翻译文件结构

文档翻译架构

来源: Translations/README.az.md Translations/CONTRIBUTING.az.md

翻译遵循简单而有效的组织方式

apollo-11/
├── README.md                # Original English README
├── CONTRIBUTING.md          # Original English contributing guidelines
└── Translations/
    ├── README.az.md         # Azerbaijani README
    ├── CONTRIBUTING.az.md   # Azerbaijani contributing guidelines
    ├── README.fr.md         # French README
    ├── CONTRIBUTING.fr.md   # French contributing guidelines
    └── ...                  # Other language files

可用翻译

此仓库文档已被翻译成多种语言。每种语言都有其自己的 README 和 CONTRIBUTING 文件版本。

可用语言

语言代码语言名称
ar阿拉伯语
as_in阿萨姆语
az阿塞拜疆语
bd_bn孟加拉语
be白俄罗斯语
ca加泰罗尼亚语
cz捷克语
da丹麦语
de德语
es西班牙语
fa波斯语
fr法语
gl加利西亚语
gr希腊语
hi_in印地语
id印度尼西亚语
it意大利语
ja日语
ko_kr韩语
ku库尔德语
lt立陶宛语
mm缅甸语
mn蒙古语
ne尼泊尔语
nl荷兰语
no挪威语
pl波兰语
pt_br葡萄牙语(巴西)
ro罗马尼亚语
ru俄语
sv瑞典语
tr土耳其语
uk乌克兰语
vi越南语
zh_cn中文(简体)
zh_tw中文(繁体)

来源: Translations/README.az.md9-45

语言选择机制

跨语言导航系统

来源: Translations/README.az.md8-45 Translations/README.az.md47-83

每个 README 和 CONTRIBUTING 文件都包含一个语言选择器部分,该部分在文档顶部以🌐表情符号标记。此部分提供了所有可用翻译的链接,允许用户轻松在不同语言版本之间切换。

语言选择系统采用两部分机制

  1. 语言列表:每个文件顶部都有一个带有链接引用的语言名称列表

    🌐
    [Azerbaijani][AZ],
    [bahasa Indonesia][ID],
    [Català][CA],
    ...
    
  2. 链接定义:每个文件底部都有将语言代码映射到文件路径的定义

    [AZ]:README.az.md
    [ID]:README.id.md
    [CA]:README.ca.md
    ...
    

英文版 README 指向根目录,而所有其他语言版本指向 Translations 目录中的文件

[EN]:../README.md  # From any translated file

来源: Translations/README.az.md56

贡献翻译

要贡献新翻译或改进现有翻译

  1. 为您的翻译工作创建一个新分支
  2. 如果创建新翻译
    • 将英文版 README.md 复制到 Translations/README.xx.md(将 xx 替换为语言代码)
    • 将英文版 CONTRIBUTING.md 复制到 Translations/CONTRIBUTING.xx.md
  3. 翻译内容时保留原始结构和格式
  4. 在所有现有 README 和 CONTRIBUTING 文件中添加指向您的新翻译的链接
  5. 提交拉取请求以供审查

翻译一致性要求

为了保持翻译之间的一致性

  • 保留原始结构和格式
  • 保持所有链接功能,并根据需要更新文件路径
  • 确保技术术语的准确翻译
  • 添加新翻译时,更新所有文件中的语言选择器部分

CONTRIBUTING 指南强调了保持文件精确格式和结构的重要性,尤其是在以下方面

  • 制表符缩进(8 个空格宽度)
  • 正确的行尾符
  • 注释中的正确间距

来源: Translations/CONTRIBUTING.az.md65-108

翻译更新流程

翻译贡献流程

来源: Translations/CONTRIBUTING.az.md110-168

当贡献新翻译时,需要更新多个文件

  1. 新翻译文件本身
  2. 所有现有 README 文件,以便在语言选择器中包含新语言
  3. 所有现有 CONTRIBUTING 文件,以便在语言选择器中包含新语言

这确保了无论用户当前正在查看哪个翻译,都可以在所有语言之间进行导航。

与仓库维护的关系

国际化系统是仓库维护结构的一部分。它有助于使 Apollo-11 代码库对全球受众更易于访问,同时保留原始源代码的历史准确性。

仓库环境中的国际化

来源: Translations/README.az.md Translations/README.ja.md Translations/README.es.md

通过提供文档的翻译,该仓库使得这份具有历史意义的代码库能够被全球的开发者和爱好者访问,无论他们的母语是什么。