Tolk项目技术文档

1. 安装指南

在开始使用Tolk之前，请确保您的项目兼容Rails 4或5。安装Tolk的步骤如下：

首先，在您的Gemfile中添加以下代码：

gem 'tolk'

接下来，您需要添加kaminari或will_paginate中的一个：

gem 'kaminari'
# 或者
gem 'will_paginate'

完成上述操作后，运行以下命令来设置Tolk：

$ rake tolk:setup

并按照指引完成设置。

2. 项目使用说明

Tolk将I18n.default_locale视为翻译的源语言。如果需要将源语言设置为除I18n.default_locale之外的语言，可以通过设置Tolk::Locale.primary_locale_name来实现。

开发人员应只在主语言文件（默认为en.yml）中更改内容，并将所有其他locale.yml文件视为只读。

由于Tolk将所有键和翻译字符串存储在数据库中，因此需要运行以下命令来更新数据库：

$ rake tolk:sync

此命令将从en.yml文件中获取所有新键，并将其放入数据库中。此外，它还会从数据库中删除已删除的键，并反映任何更新的翻译。

如果您的非主要语言文件中已有数据，您需要运行以下命令一次性导入这些数据：

$ rake tolk:import

访问http://your_app.com/tolk后，您将看到不同的选项，如创建新的语言或为现有语言提供翻译。

3. 项目API使用文档

在完成所有翻译后，您可以将新的语言保存到文件系统中。有以下两个选项：

• 使用以下命令为指定语言生成单个yml文件：

$ rake tolk:dump_yaml["目标语言"]

• 使用以下命令为所有非主要语言生成yml文件：

$ rake tolk:dump_all

您还可以使用Tolk::Locale.dump_all方法，并传递目录路径作为参数，以将生成的文件放在不同的位置：

$ rails runner "Tolk::Locale.dump_all('/路径/)"

您甚至可以通过在语言URL后附加.yaml来使用Tolk web界面下载yml文件，例如http://your_app.com/tolk/locales/de.yaml。

4. 项目安装方式

请参考上述“安装指南”部分，以获取详细的安装步骤。简要概述如下：

• 在Gemfile中添加tolk依赖。
• 选择并添加kaminari或will_paginate。
• 运行rake tolk:setup来设置Tolk。