Localization Key(ローカル化キー)

LocalizationKey コールアウトを追加して、プレイグラウンド内のクイックヘルプコンテンツが異なる言語に適応できるようにします。

以下の物で動作します

✓ プレイグラウンド

シンボルの文書

文法

* | + | - LocalizationKey:

注意

他のコールアウトとは異なり、LocalizationKey はクイックヘルプで表示されるコンテンツを変更しますが、それ自体は表示されません。

LocalizationKey コールアウトは、ローカライズされた文字列リソースの対応するキー値のペアにマッピングする一意の識別子を提供します。実行時に、シンボルのクイックヘルプの内容は、ローカライズされた文字列リソースのこのキーの値に置き換えられます。言語のローカライズされた文字列リソースが対応するキー値のペアを提供しない場合、ローカライズされていない内容が使用されます。

必要条件

プレイグラウンド内でクイックヘルプのローカル化を有効にするには、含まれるページ、章、または本の PrivateResources ディレクトリで、サポートされている各ロケールの QuickHelp.strings ファイルを提供します。

QuickHelp.strings は、"プレーンテキスト" の文字列ファイルまたはプロパティリストのいずれかです。

"プレーンテキスト" の文字列ファイルには、キー値のペアのリストと、各キー値のペアの目的を説明するオプションのコメントが含まれています。キー値の文字列は等号 (=) で区切られ、エントリ全体はセミコロン文字 (;) で終了しなければなりません。慣例により、コメントは C スタイルのコメント区切り文字 (/* および */) で囲まれ、コメントが記述するエントリの直前に配置されます。

/* */

""="";

プロパティリストの文字列ファイルには、文字列値を持つキーを含むトップレベルの辞書が含まれています。

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com

/DTDs/PropertyList-1.0.dtd">

<dict>

</dict>

</plist>

詳細については、リソースプログラミングガイド の文字列のリソース を参照してください。

プレイグラウンドの例

 1    /**
 2     Flips a table
 3     - Parameter times: Number of times to flip a table
 4     - LocalizationKey: my-playground-flip-table
 5     */
 6    func flipTable(times: Int = 1) {
 7        let minTimes = max(times, 1)
 8        for _ in 0 ..< minTimes {
 9            print("(╯°□°)╯( ┻━┻") }
10    }
11    }

リスト 35-1 BookName.playgroundbook/PrivateResources/es.lproj/QuickHelp.strings

 1    <?xml version="1.0" encoding="UTF-8"?>
 2    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com
      /DTDs/PropertyList-1.0.dtd">
 3    <plist version="1.0">
 4        <dict>
 5            <key>my-playground-flip-table</key>
 6            <string>Voltea la mesa
 7    - Parameter times: Número de veces para voltear una mesa
 8            </string>
 9        </dict>
10    </plist>

英語圏のロケールに設定されたデバイスでクイックヘルプを参照すると、元のコンテンツが表示されます。

MFR_symbol_section_localizization_key_en_2x

スペイン語圏のロケールに設定されたデバイスでクイックヘルプを参照すると、ローカライズされたコンテンツが表示されます。

MFR_symbol_section_localizization_key_es_2x

前：Invariant(不変な) 次：Note(注意)

トップへ

トップへ

トップへ

トップへ

トップへ

XCode 11.1 日本語化計画：Markup Formatting Reference

Localization Key(ローカル化キー)

文法

必要条件

プレイグラウンドの例