about_Script_Internationalization

[アーティクル]
04/13/2023

簡単な説明

スクリプトの国際化機能について説明します。スクリプトは、ユーザーインターフェイス (UI) 言語でユーザーにメッセージや指示を簡単に表示できます。

長い説明

PowerShell スクリプトの国際化機能を使用すると、ユーザーの言語でヘルプとユーザーメッセージを表示することで、世界中のユーザーにより適切なサービスを提供できます。

スクリプトの国際化機能は、実行中にオペレーティングシステムの UI カルチャを照会し、適切な翻訳されたテキスト文字列をインポートしてユーザーに表示します。 [データ] セクションでは、コードとは別のテキスト文字列を格納して、簡単に識別および抽出できるようにします。新しいコマンドレットは、 ConvertFrom-StringData翻訳を容易にするために、テキスト文字列を辞書のようなハッシュテーブルに変換します。

国際ヘルプテキストをサポートするために、PowerShell には次の機能が含まれています。

テキスト文字列をコード命令から分離する Data セクション。 [データ] セクションの詳細については、「 about_Data_Sections」を参照してください。
新しい自動変数、 $PSCulture および $PSUICulture. $PSCulture は、日付、時刻、通貨などの要素に対してシステムで使用される UI 言語の名前を格納します。変数には $PSUICulture 、メニューやテキスト文字列などのユーザーインターフェイス要素にシステムで使用される UI 言語の名前が格納されます。
翻訳を容易にするために、 ConvertFrom-StringDataテキスト文字列を辞書のようなハッシュテーブルに変換するコマンドレット。詳細については、「 ConvertFrom-StringData」を参照してください。
翻訳されたテキスト文字列を格納する新しいファイルの種類 .psd1。ファイルは .psd1 、スクリプトディレクトリの言語固有のサブディレクトリに格納されます。
指定した言語の翻訳されたテキスト文字列を実行時にスクリプトにインポートするコマンドレット Import-LocalizedData。このコマンドレットは、Windows でサポートされている任意の言語の文字列を認識してインポートします。詳細については、「 Import-LocalizedData」を参照してください。

[データ] セクション: 既定の文字列を格納する

スクリプトの Data セクションを使用して、テキスト文字列を既定の言語で格納します。キーと値のペアの文字列をここの文字列に配置します。各キーと値のペアは、個別の行に配置する必要があります。コメントを含める場合、コメントは別々の行に配置する必要があります。

コマンドレットは ConvertFrom-StringData 、ここの文字列内のキーと値のペアを、Data セクション変数の値に格納されている辞書のようなハッシュテーブルに変換します。

次の例では、スクリプトの World.ps1 Data セクションに、スクリプトのプロンプトメッセージのEnglish-United States (en-US) セットが含まれています。コマンドレットは ConvertFrom-StringData 、文字列をハッシュテーブルに変換し、変数に $msgtable 格納します。

$msgTable = Data {
    #culture="en-US"
    ConvertFrom-StringData @'
    helloWorld = Hello, World.
    errorMsg1 = You cannot leave the user name field blank.
    promptMsg = Please enter your user name.
'@
}

here-strings の詳細については、 about_Quoting_Rulesを参照してください。

PSD1 ファイル: 翻訳された文字列を格納する

各 UI 言語のスクリプトメッセージを、スクリプトと同じ名前とファイル名拡張子を持つ個別のテキストファイルに .psd1 保存します。次の形式のカルチャの名前を持つスクリプトディレクトリのサブディレクトリにファイルを格納します。

<language>-<region>

例: de-DE、ar-SA、および zh-Hans

たとえば、スクリプトが World.ps1 ディレクトリに C:\Scripts 格納されている場合は、次のようなファイルディレクトリ構造を作成します。

C:\Scripts
C:\Scripts\World.ps1
C:\Scripts\de-DE\World.psd1
C:\Scripts\ar-SA\World.psd1
C:\Scripts\zh-CN\World.psd1
...

World.psd1スクリプトディレクトリの de-DE サブディレクトリ内のファイルには、次のステートメントが含まれる場合があります。

ConvertFrom-StringData -StringData @'
helloWorld = Hallo, Welt.
errorMsg1 = Das Feld Benutzername darf nicht leer sein.
promptMsg = Geben Sie Ihren Benutzernamen ein.
'@

同様に、スクリプトディレクトリの World.psd1 ar-SA サブディレクトリ内のファイルには、次のステートメントが含まれている場合があります。

ConvertFrom-StringData -StringData @'
helloWorld = مرحبًا أيها العالَم
errorMsg1 = لا يمكنك ترك حقل اسم المستخدم فارغًا
promptMsg = يرجى إدخال اسم المستخدم الخاص بك
'@

Import-LocalizedData: 翻訳された文字列の動的取得

現在のユーザーの UI 言語で文字列を取得するには、コマンドレットを Import-LocalizedData 使用します。

Import-LocalizedData は、自動変数の値を $PSUICulture 検索し、その値に一致するサブディレクトリ内の <script-name>.psd1 ファイルの内容を $PSUICulture インポートします。次に、 BindingVariable パラメーターの値で指定された変数に、インポートされたコンテンツを保存します。

Import-LocalizedData -BindingVariable msgTable

たとえば、スクリプトにImport-LocalizedDataC:\Scripts\World.ps1コマンドが表示され、値$PSUICultureが "ar-SA" の場合、Import-LocalizedData次のファイルが検索されます。

C:\Scripts\ar-SA\World.psd1

次に、ファイルからアラビア語のテキスト文字列を変数にインポートし、スクリプトの $msgTable Data セクションで定義される可能性がある既定の文字列を World.ps1 置き換えます。

その結果、スクリプトが変数を $msgTable 使用してユーザーメッセージを表示すると、メッセージはアラビア語で表示されます。

たとえば、次のスクリプトでは、アラビア語で "ユーザー名を入力してください" というメッセージが表示されます。

if (!($username)) { $msgTable.promptMsg }

の値$PSUIcultureと.psd1一致するファイルが見つからない場合Import-LocalizedData、値$msgTableは置き換えられず、フォールバック en-US 文字列を表示する$msgTable.promptMsg呼び出しが表示されます。

例

この例では、スクリプトの国際化機能を使用して、コンピューターに設定されている言語のユーザーに曜日を表示する方法を示します。

Sample1.ps1 スクリプトファイルの完全な一覧を次に示します。

スクリプトは、コマンドを含む Day ($Day) という名前の ConvertFrom-StringData Data セクションで始まります。送信される ConvertFrom-StringData 式は、キーと値のペアの既定の UI カルチャ (en-US) の曜日名を含む here 文字列です。コマンドレットは ConvertFrom-StringData 、here-string 内のキーと値のペアをハッシュテーブルに変換し、変数の $Day 値に保存します。

このコマンドは Import-LocalizedData 、自動変数の .psd1 値に一致するディレクトリ内のファイルの内容を $PSUICulture インポートし、それを変数に $Day 保存し、[データ] セクションで定義されている値 $Day を置き換えます。

残りのコマンドは、文字列を配列に読み込んで表示します。

$Day = Data {
#culture="en-US"
ConvertFrom-StringData -StringData @'
    messageDate = Today is
    d0 = Sunday
    d1 = Monday
    d2 = Tuesday
    d3 = Wednesday
    d4 = Thursday
    d5 = Friday
    d6 = Saturday
'@
}

Import-LocalizedData -BindingVariable Day

#Build an array of weekdays.
$a = $Day.d0, $Day.d1, $Day.d2, $Day.d3, $Day.d4, $Day.d5, $Day.d6

# Get the day of the week as a number (Monday = 1).
# Index into $a to get the name of the day.
# Use string formatting to build a sentence.

"{0} {1}" -f $Day.messageDate, $a[(Get-Date -UFormat %u)] | Out-Host

スクリプトをサポートするファイルは .psd1 、値と一致する名前を持つスクリプトディレクトリのサブディレクトリに $PSUICulture 保存されます。

次の完全な一覧を次に .\de-DE\sample1.psd1示します。

# culture="de-DE"
ConvertFrom-StringData @'
    messageDate = Heute ist
    d0 = Sonntag
    d1 = Montag
    d2 = Dienstag
    d3 = Mittwoch
    d4 = Donnerstag
    d5 = Freitag
    d6 = Samstag
'@

その結果、値 $PSUICulture が de-DE であるシステムでSample.ps1を実行すると、スクリプトの出力は次のようになります。

Heute ist Freitag