Skip to content

Latest commit

 

History

History
135 lines (87 loc) · 4.76 KB

README_ja.md

File metadata and controls

135 lines (87 loc) · 4.76 KB

English

Batch Translator

Batch Translator はテキストファイルを翻訳する CLI ツールです。 想定する主な利用者は、README やドキュメントを翻訳する必要のある OSS 開発プロジェクトメンバーです。 主な使用方法は以下の通りです。

  • 1 つのファイルの翻訳 (README.md など)
  • ディレクトリ以下の特定の拡張子を持ったファイルの一括翻訳 (AsciiDoctorを使ったドキュメントなど)

利用者向け

実行環境

Batch Translator を実行するには以下のソフトウェアが必要です。

  • Java 17+
  • Maven 3.6+ (Maven Plugin として使用する場合)

使用方法

Batch Translator は Java コマンド、または Maven Plugin として実行します。

  1. [API Key の作成](#API Key の作成)
  2. [Java コマンドで実行](Java コマンドで実行) or [Maven Plugin として実行](Maven Plugin として実行)

API Key の作成

Batch Translator は翻訳エンジンに「みんなの自動翻訳＠TexTra®」「Amazon Translate」「Cloud Translation API」を使用しています。翻訳機能を使用するには以下のいずれかのサイトでアカウントを作成してください。

みんなの自動翻訳＠TexTra® を使用する場合

https://mt-auto-minhon-mlt.ucri.jgn-x.jp/

アカウントを作成したら設定ページにあるユーザー ID、API KEY、API SECRET を batch-translator.properties ファイルに保存します。

batch-translator.properties ファイルはユーザーホームディレクトリ以下に.aulait という名前のディレクトリを作成し、そこに保存してください。

  • Windows
mkdir %USERPROFILE%\.aulait
notepad %USERPROFILE%\.aulait\batch-translator.properties
  • macOs
mkdir ~/.aulait
nano ~/.aulait/batch-translator.properties
  • batch-translator.properties
api_key=your_api_key
api_secret=your_api_secret
name=your_user_name
Amazon Translate を使用する場合

https://portal.aws.amazon.com/billing/##/start

アカウントを作成したらユーザガイドを参考に、aws_access_key_id と aws_secret_access_key を credentials ファイルに保存します。

credentials ファイルは、ホームディレクトリ の .awsフォルダ の配下に作成してください。

Ex. ~/.aws/credentials

[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
Cloud Translation API を使用する場合

https://console.cloud.google.com/getting-started

アカウントを作成したらAPIの有効化を参考に、Cloud Translation APIを有効化します。

次にGoogle アカウントで ADC を構成するを参考にADCを構成します。

Cloud Translation APIの料金についてはこちらを参照してください。

Java コマンドで実行

curl -o batch-translator-core-1.1.jar https://repo1.maven.org/maven2/dev/aulait/bt/batch-translator-core/1.1/batch-translator-core-1.1.jar

java -jar batch-translator-core-1.1.jar -m Mode -s Source -t Target -e Engine(minhon or aws)

例 1) README_ja.md を日本語から英語に翻訳し README.md に出力するコマンド

java -jar batch-translator-core-1.1.jar -m ja2en -s README_ja.md -t README.md -e aws

例 2) docs ディレクトリ以下の拡張子が adoc である全ファイルを日本語から英語に翻訳し、docs/en ディレクトリに出力するコマンド

java -jar batch-translator-core-1.1.jar -m ja2en -p *.adoc -s docs -t docs/en -e aws

Maven Plugin として実行

pom.xml に Batch Traslator の Maven Plugin を追加します。

  • pom.xml
<bulid>
  <plugins>
    <plugin>
      <groupId>dev.aulait.bt</groupId>
      <artifactId>batch-translator-maven-plugin</artifactId>
      <version>1.1</version>
    </plugin>
  </plugins>
</build>
mvn batch-translator:translate -Dbt.source=README_ja.md -Dbt.target=README.md -Dbt.mode=ja2en -Dbt.filePattern=*.adoc -Dbt.engine=aws

バグ報告、機能要望

Batch Translator に関するバグや機能要望がある場合は当 GitHub プロジェクトの Issues に Issue を起票してください。

ライセンス

Batch Translator は Apache Lisence 2.0 で公開しています。