WOVN の Rubyライブラリ(WOVN.rb) についての導入・設定方法です
目次
動作要件
別紙記載のライブラリ方式動作要件を確認してください。
ライブラリ方式の動作概要
ライブラリ方式の動作概要はこちらからご確認下さい。
インストール手順
WOVN Ruby ライブラリは、Gem をインストールし、設定ファイルに WOVN に関する内容を追記するだけで完了します。
- Gem をダウンロード
Ruby アプリケーションの Gemfile に以下の行を挿入してください。gem 'wovnrb', '>= 2.2.2'
WOVN.rb の最新バージョンは、WOVN.rbの最新バージョンを確認してください。
- 下記コマンドを実行して、WOVN Ruby ライブラリをインストールしてください。
bundle install
- 設定ファイルに WOVN の設定を追記する
- Ruby on Rails の場合
config/application.rb または config/environments/ に挿入します```ruby
config.wovnrb = {:user_token => ‘xxxxxx’,
:url_pattern => ‘path’,
:default_lang => ‘ja’,(元言語が日本語の場合),
:supported_langs => ['ja', 'en'] (元言語が日本語で、英語に翻訳する場合)
}
``` - Sinatra の場合
config.ru ファイルに挿入します```ruby
require 'wovnrb'
use Wovnrb::Interceptor, {
:project_token => 'EnS!t3',
:default_lang => 'en',
:supported_langs => ['en'],
:url_pattern => 'path'
}
```
- Ruby on Rails の場合
設定オプション
WOVN.rb で使用するパラメーターは下記の通りです。詳細な説明は表より下部を確認してください。
パラメータ名 | 必須 | デフォルト設定 |
---|---|---|
project_token | はい | '' |
default_lang | はい | 'en' |
supported_langs | はい | ['en'] |
url_pattern | はい | 'path' |
lang_param_name | 'wovn' | |
query | [] | |
ignore_class | [] | |
translate_fragment | true | |
ignore_paths | [] |
project_token
WOVN.io アカウントのプロジェクトトークンを設定します。対象プロジェクトの「プロジェクト情報」タブ画面に記載された「Project token」の値をコピーして使用してください。
※このパラメータは必須です。
default_lang
Ruby アプリケーションの言語を設定してください。初期値は英語 ('en') です。
デフォルト言語のページへパラメータ付きでアクセスがあった場合、ライブラリは翻訳前の URL にリダイレクトします。default_lang はこの処理に使用されます。
default_lang が 'en' で下記 URL にリクエストがあった場合、
https://wovn.io/en/contact
ライブラリには、次の URL にリダイレクトされます。
https://wovn.io/contact
supported_langs
WEBサイトで利用する言語を、元言語含めてライブラリに指定させます。この設定により、SEOに関連するHTMLメタデータをライブラリが自動的に挿入します。
例えばあなたのWEBサイトが英語で作られていて、日本語を翻訳で提供する場合は、以下の様に記載します。
:supported_langs => ['ja', 'en']
url_pattern
ライブラリは Ruby アプリケーションに対し、翻訳ページ用の新しい URL を追加します。url_pattern パラメータでは、この URL のタイプを設定できます。URL のタイプには下記の3種類があります。
lang_param_name
このパラメーターは、url_pattern の値が query の場合にのみ使用します。
WOVN が言語を切り替えるときに、URL末尾に付加するクエリパラメーターの名前を指定します。
初期設定では、クエリパラメーターは 'wovn' に設定されています。
その場合、言語切替時の URL は下記の通りです。
https://example.com/index?wovn=en
パラメーターを 'lang' にしたい場合は、言語切替時のURLはこの様に変わります。
https://my-website.com/index?lang=en
query
WOVN では翻訳ページの識別の際にクエリパラメータを無視します。クエリパラメータを翻訳ページの URL に含めたい場合、query パラメータで設定する必要があります。(WOVN 側の設定も必要です)
https://wovn.io/ja/contact?os=mac&keyboard=us
defualt_lang が 'en' で、query が [] (未設定)の場合、上記の URL は下記のように変換されて、翻訳ページを探します。
https://wovn.io/contact
default_lang が 'en' で、query が ['os'] の場合、上記の URL は下記のように変換されて、翻訳ページを探します。
https://wovn.io/contact?os=mac
ignore_class
対象HTMLクラスに対して WOVN.rb が処理を行わない様になります。
特定の HTMLクラスを持つ要素配下は元言語とし、WOVN による HTML の置き換えやレポートの送信を行いたくない場合に使います。
translate_fragment
このオプションにより、部分的な HTMLコンテンツの翻訳を無効にすることができます。
初期設定では、部分的な HTMLコンテンツは翻訳されますが、ウィジェットスニペットは追加されません。 translate_fragment をf alse に設定して、部分的な HTMLコンテンツの翻訳を防ぎます。
ignore_paths
対象ディレクトリに対して WOVN.rb が翻訳処理を行わないように制御します。
指定するディレクトリは、URLパスの先頭一致するようにしてください。
例えば、あなたのWebサイトの管理画面が /admin/ から始まる URL で、これらのページを翻訳しない場合は下記の通り指定します。
'ignore_paths' => ['/admin/']
動作不具合に関するお問い合わせ
WOVN.rb をご利用の上でご不明な点や、動作しない点がある場合は、WOVNカスタマーサポートチームへお問い合わせください。