クラス: TranslationFilter

クラス: TranslationFilter

TranslationFilter

new TranslationFilter ()

OCEアセットから翻訳可能な文字列を抽出し、翻訳された文字列でアセットを再結合するフィルタ。
ソース:

メンバー

constraints

翻訳結果に制約を適用
翻訳結果が有効であることを確認してください。
たとえば、アセットの"name"属性は64文字を超えることはできません。 これらの正規表現は、小文字に変換された完全なプロパティ・パスに適用されます。
たとえば、アセットには次のものがあります:
{
  fields: {
        Category: 'one',
        Title: 'a simple example'
    }
}
文字列に対して制約が適用されます:
  • "fields"
  • "fields.category"
  • "fields.title"
ソース:

フィルタ

文書から翻訳可能フィールドをフィルタで除外
各アセット・タイプに「含む」および「除外」フィルタのセットを指定します。

これらの正規表現は、小文字に変換された完全なプロパティ・パスに適用されます。

たとえば、アセットには次のものがあります:
{
  fields: {
        Category: 'one',
        Title: 'a simple example'
    }
}
フィルタリングは文字列に対して適用されます:
  • "fields"
  • "fields.category"
  • "fields.title"
ソース:

メソッド

applyTranslation(document, translatedDocument, constraintType) → {object}

翻訳されたフィルタされたフィールドを元のドキュメントと再び結合します。
パラメータ:
名前 タイプ 説明
document object フィルタを適用するJSONドキュメント。
translatedDocument object 翻訳された文字列を含むJSONドキュメント
constraintType "assets" | "site" ドキュメントに適用するTranslationFilter.constraintsの制約タイプ。
ソース:
戻り値:
翻訳済文字列が適用されたベース文書のコピーであるJSONオブジェクト。
タイプ
object

getTranslatableProperties(document, filterType, includes) → {object}

基本ドキュメントから翻訳可能な文字列を取得します。
パラメータ:
名前 タイプ 説明
document object フィルタを適用するJSONドキュメント。
filterType "assets" | "site" ドキュメントに適用するTranslationFilter.filtersのフィルタ・タイプ。
includes object フィールド名に含めるフィールドの配列。
ソース:
戻り値:
指定されたドキュメントの翻訳可能な文字列のみを含む新しいJSONオブジェクト。
タイプ
object

mergeProperties(args)

ソース・オブジェクトのプロパティを宛先オブジェクトに深くマージします。
パラメータ:
名前 タイプ 説明
args object "mergeProperties"関数で使用される引数。
プロパティ
名前 タイプ 属性 説明
source object プロパティのコピー元となるソースJSONオブジェクト。
dest object 宛先JSONオブジェクトは、プロパティを次の場所にコピーします。
path string <optional>
ソース・ファイル内の現在のオブジェクトへのプロパティ・パスを表す文字列。 例えば: " fields.title ". 最初のコールでは、これは提供されず、コピーの再帰時に構築されます。
filter Array.<RegEx> <optional>
プロパティのコピー時にパスに適用する必要がある正規表現フィルタ。 指定しない場合、すべてのプロパティがコピーされます。
ソース: