Lingua

Documentation

Lingua

Lingua 是一款旨在简化 iOS 和 Android 平台本地化流程的工具。它为从单一来源 Google Sheets 生成本地化文件提供了统一的解决方案。

使用该工具有以下几个好处

设置 Google 表格

为了设置 Google 表格,我们需要完成两个步骤。第一步是创建一个具有预定义结构的表格,第二步是获取 API 密钥和表格 ID。

a. 表格文档

我们为您准备了一个表格结构的模板。您需要做的就是打开以下链接并复制一份 文件 > 制作副本

移动端本地化模板 - Google 表格

表格结构:有关 Lingua 本地化工具中使用的表格结构的详细信息,请参阅 表格结构文档

重要提示:请务必将应用程序中现有的 API 密钥替换为新生成的密钥。此外,请确保您尝试访问的 Google 表格已配置共享设置,允许任何拥有链接的人访问。您可以通过点击 Google 表格右上角的“共享”,然后选择“任何拥有链接的人”来完成此操作。

b. 获取表格 ID

在您创建文档模板的副本后,可以很容易地从 URL 中获取表格 ID。

https://docs.google.com/spreadsheets/d/ 1GpaPpO4JMleZPd8paSW4qPBQxjImm2xD8yJhvZOP-8w

c. 获取 API 密钥

以下是启用 Google Sheets API 并创建 API 密钥的步骤

  1. 访问 https://console.cloud.google.com/

  2. 如果您尚未创建项目,请创建一个新项目或选择一个现有项目。

  3. 在左侧边栏中,点击 “APIs & Services”

  4. 点击页面顶部的 “+ ENABLE APIS AND SERVICES”。

  5. 在搜索栏中,输入 “Google Sheets API” 并从列表中选择它。

  6. 点击 “ENABLE” 以启用您项目的 Google Sheets API。

  7. 启用 API 后,返回 “APIs & Services” > “Credentials” 页面。

  8. 点击页面顶部的 “CREATE CREDENTIALS”。

  9. 在下拉菜单中,选择 “API key”

稍等片刻,直到密钥生成,并显示一条消息为 API key created 的信息弹窗。

用法

1. macOS 应用程序

Lingua macOS 应用程序提供了一个用户友好的界面,用于无缝管理您的本地化流程。您可以直接从应用程序配置您的设置并启动翻译过程。

安装

您可以从 App Store 下载 macOS 应用程序。按照页面上提供的安装指南开始使用该应用程序。

功能和用法

2. macOS 终端应用程序

对于那些喜欢使用终端或需要脚本解决方案的用户,Lingua 提供了一个终端应用程序,允许您直接从命令行管理和启动翻译。

安装

目前我们支持通过 Homebrew 安装该工具

$ brew tap poviolabs/lingua
$ brew install lingua

3. Linux 终端应用程序

Lingua 也可以在 Linux 上运行。

安装

  1. 根据您的机器,从 GitHub Releases 下载最新的 Lingua_Linux 版本,可以是 Lingua_Linux_x86_64Lingua_Linux_arm64

  2. 使二进制文件可执行

    $ chmod +x /path/to/Lingua_Linux_x86_64
    $ mv Lingua_Linux lingua
    $ sudo mv /path/to/lingua /usr/local/bin

终端用法

请按照以下说明在终端中使用 Lingua。

配置文件

创建一个配置文件作为起点,以适应您的需求,可以是 lingua_config.json 或任何其他 `.json` 文件。

要创建一个示例配置文件作为起点以适应您的需求,请运行 lingua config init。该工具将在您运行 Lingua 工具的目录中创建一个名为 lingua_config.json 的文件。

然后在创建的配置文件中,您需要提供您的数据,如下所示

{
   "localization": {
        "apiKey": "<google_api_key>",
        "sheetId": "<google_spreadsheet_id>",
        "outputDirectory": "path/to/Resources/Localization"
    }
}
输出目录

输出目录属性应该是您希望工具创建本地化文件的路径。

iOS 特定

由于 iOS 没有内置功能来安全地访问本地化,我们使用 Lingua 工具使其成为可能。在配置文件中,您必须提供存储默认语言字符串的路径以及您想要创建 Swift 文件的位置。这样,该工具将创建一个 Lingua.swift 文件,其中包含一个枚举,以便在您的应用程序中轻松访问本地化。

{
   "localization": {
        "apiKey": "<google_api_key>",
        "sheetId": "<google_spreadsheet_id>",
        "outputDirectory": "path/to/Resources/Localization",
        "swiftCode": {
           "stringsDirectory": "path/to/Resources/Localization/en.lproj",
           "outputSwiftCodeFileDirectory": "path/to/Resources/Localization"
        }
    }
}

现在您可以在终端中运行该工具,切换到您的项目目录并运行

iOS

$ lingua ios /path/to/lingua_config.json

Android

$ lingua android /path/to/lingua_config.json

最佳使用实践

为了确保您在本地和 CICD 环境中都能最佳地利用该工具,我们建议您深入研究我们的 最佳使用实践指南