For English users: English

WOVN.io Rubyライブラリは、翻訳を提供するためにWOVN.ioを利用したライブラリです。
WOVN.io Ruby ライブラリは Rack Middleware としてパッケージ化されています。

このドキュメントでは、WOVN.io Rubyをインストールするまでの手順や、セットアップ・設定の流れを説明しています。

WOVN.io Ruby Libraryを利用するには、WOVN.ioのアカウントが必要です。
アカウントをお持ちでない方は、まずはWOVN.ioに登録してください。

WOVN.ioにログイン後、翻訳したいページを追加します。

WOVN.io Ruby ライブラリを使用するには、以下の行を Ruby アプリケーションの Gemfile に挿入します。
WOVN.ioは現在、バージョン2.0.1以上をサポートしています。

gem 'wovnrb', '>= 2.0.1'

以上の設定を行った後、以下のコマンドを実行して、WOVN.io Rubyライブラリをインストールします。

bundle install

ライブラリをインストールしたら、Rubyアプリケーションの設定ファイルに以下を挿入します。

• Ruby on Rails を使っている場合

config/application.rb または config/environments/ に以下を挿入します。

...

config.wovnrb = {
  :project_token => 'EnS!t3',
  :default_lang => 'ja',
  :supported_langs => ['ja', en'],
  :url_pattern => 'path'
}

...

• Sinatra を使っている場合

アプリケーション・ファイルまたは config.ru のいずれかに以下を挿入します。

...

require 'wovnrb'

use Wovnrb::Interceptor, {
  :project_token => 'EnS!t3',
  :default_lang => 'ja',
  :supported_langs => ['ja', 'en'],
  :url_pattern => 'path'
}

...

セットアップが完了したら、Rubyアプリケーションを起動し、WOVN.ioライブラリが正常に動作していることを確認します。

以下に、WOVN.io Ruby ライブラリの有効なパラメータの一覧を示します。

WOVN.ioアカウントのプロジェクトトークンを設定します。このパラメータは必須です。

これはRubyアプリケーションのデフォルト言語を設定します。デフォルト値は英語（'en'）です。

リクエストされたページで、デフォルトの言語パラメータが URL に含まれている場合、リクエストは翻訳前にリダイレクトされます。
このために default_lang パラメータを使用します。

default_lang が 'en' に設定されている時に、以下のURLへのリクエストを受信した場合。

https://wovn.io/en/contact

ライブラリは以下のURLにリダイレクトされます。

https://wovn.io/contact

これは、ウェブサイトで使用されている言語（翻訳元を含む）をライブラリに伝えます。
この設定では、SEO（検索エンジン最適化）に必要なメタデータを挿入することができます。

ウェブサイトが英語で、WOVN.ioを使って日本語にローカライズしている場合は、以下の設定にしてください。

:supported_langs => ['en', 'ja']

注意: 配列の言語の順番は関係ありません。

ライブラリはRubyアプリケーションの中で、翻訳されるURLを新たに追加することで動作します。
urlの種類は url_pattern パラメータで設定できます。設定できるタイプは3種類。

※ 上記は、以下のURLを使用してライブラリが翻訳したURLの例です。

https://wovn.io/contact

このパラメータは url_pattern が query に設定されている場合のみ有効です。

ページの言語を指定するためのクエリパラメータ名を設定することができます。

この設定のデフォルト値は wovn であり、翻訳された英語のページのURLが https://my-website.com/index.php?wovn=en という形式になります。
代わりに lang に値を設定すると、URLの例は https://my-website.com/index.php?lang=en という形式になります。

WOVN.ioは翻訳されたページを検索する際にクエリパラメータを無視します。
翻訳ページのURLにクエリパラメータを追加したい場合は、query パラメータを設定する必要があります。(WOVN.ioも設定する必要があります)

https://wovn.io/ja/contact?os=mac&keyboard=us

default_lang が en でクエリが空に設定されている場合、上記のURLは以下のURLに変更され、ページの翻訳を検索するようになります。

https://wovn.io/contact

default_lang が en でクエリが os に設定されている場合、上記のURLは以下のURLに変更され、ページの翻訳を検索するようになります。

https://wovn.io/contact?os=mac

これは「無視するクラス」を設定し、WOVNがこの配列に含まれるクラスを持つHTML要素を変換できないようにします。

このオプションでは、部分的なHTMLコンテンツの翻訳を無効にすることができます。
デフォルトでは、部分的なHTMLコンテンツは翻訳されますが、ウィジェットのスニペットは追加されません。
translate_fragment を false に設定すると、HTMLの一部が翻訳されないようになります。

このパラメータは、WOVN.rbが指定されたディレクトリ内のコンテンツをローカライズしないように指示します。
指定されたディレクトリは、URLパスの先頭にのみマッチします。
例えば、ウェブサイトの管理者ディレクトリをローカライズしたくない場合は、WOVN.rbの設定に次のように追加します。

'ignore_paths' => ['/admin/']