JSONC

コメントを文脈のヒントとして活用し、コメント付きカタログを翻訳。翻訳後の出力にどのコメントが残るかも確認できます。

JSONCでは、メッセージとその説明をまとめて管理できます。jsoncファイルハンドラーは、文字列の前にあるコメントを翻訳のヒントとして読み取り、JSONと同じパスに沿って、入れ子になった文字列の値を翻訳します。

これらのコメントはソースカタログで管理してください。再構築される翻訳先ファイルは、半角スペース2つでインデントされ、末尾に改行が入ります。@orphanマークはソースと同じ項目に保持されますが、それ以外のコメントはすべて削除されます。そのため、読み込み側でほかのメタデータが必要な場合は、別の方法で保持する必要があります。

対象の値のすぐそばに文脈を記述する#

このカタログでは、「戻る」が読み手にどのような操作を求めるのかを説明しています。

jsonc
{
  /* @context Button that returns to the previous checkout step */
  "back": "Back",
  "product": "Acme",
}

コメントは、次にある文字列の値に適用されます。その値を含むオブジェクト配下のすべての要素に適用されるわけではありません。間に数値、真偽値、またはヌル値があると、適用待ちのヒントはクリアされます。コメントは説明対象の文字列の直前に置き、固定の識別子は、使用するインターフェースの設定で保護してください。

@contextがある場合は、その行の残りの部分がヒントになります。ない場合はコメント全体がヒントになるため、文字列の前に置かれた空でないコメントは、どれも翻訳処理に渡されます。文字列の前に複数のコメントがある場合は、それ以前のコメントに@contextがあっても、最後の空でないヒントが使われます。@orphanはカタログのメタデータを示しますが、その文字列も引き続きファイル翻訳の対象に選択できます。

ファイル翻訳とReactカタログ#

Reactカタログの抽出では、各項目にメタデータを付けたフラットなJSONCカタログが書き出されます。その読み取り処理は@context、@src、@orphanを認識します。抽出時にはこれらのフィールドを使い、ソース内の位置を管理し、見つからなくなったメッセージにマークを付けます。これはカタログ管理のワークフローであり、任意のJSONCドキュメントを翻訳する処理とは別のものです。

抽出したメッセージを管理する場合は、Reactカタログと型を参照してください。通常のファイル出力で再生成されると考えて、ソースカタログのメタデータを削除しないでください。

ファイル翻訳を設定する#

CLIは.jsoncからjsoncを推定します。GitHub Appは、設定されたファイルの種類を受け付けます。CLI設定またはGitHub設定で、ソースと翻訳先のパスを選択してください。

必要な値を保持する#

差分比較、パスのロック・保持・無視、ロケールの挿入には、JSONファイルハンドラーと同じ処理の区別が適用されます。ロックはソースのデータをコピーし、保持は翻訳先のデータを残し、無視はパスを削除します。これらを同じ除外処理として扱わず、優先順位や対象範囲を一部に限定した場合の影響をJSONで確認してください。

再構築されたファイルのキーと保護対象の値を確認してから、アプリケーションのカタログ読み取り機能で翻訳先ファイルを読み込んでください。Reactカタログでは、抽出時にソースのメタデータを利用できる状態に保ってください。翻訳先には@orphanは保持されますが、@contextと@srcは保持されません。

翻訳ワークフローでは、引数の変更や欠落も含め、対応しているプレースホルダーとICUの構造を検証します。報告された警告や失敗を確認したうえで、検証を通過したテンプレートにアプリケーションが渡す値を使って表示してください。こうした構造のチェックとあわせて、意味の正確さや内容に漏れがないかもレビューしてください。