-
Notifications
You must be signed in to change notification settings - Fork 34
Extension Overview
Magento Community Engineering is happy to present the Japanese Localization extension - a collaboration between Magento Community Engineering and Veriteworks Inc. This combination of modules implements basic modifications required to make a Magento 2 installation compatible with Japanese locales with full Japanese translations.
These features provide Hiragana and Katakana name support, Japanese address formats and prefectures, automatic populating of address information for entered postal codes, Japanese fonts for PDF generation, currency support, and much more. Payment provider integration is not included in this extension.
The modifications are intentionally basic to give extension builders and solution providers an opportunity to extend features and a base for developing truly sublime experiences.
After installation, Japanese translations of all standard text strings will be applied to the Admin and Storefront, including necessary changes in data and the UI to accommodate local standards and formatting.
The extension provides the following features to support Japanese stores.
| Feature | Description |
|---|---|
| Japanese translations | Japanese translation of field names, messages, on-screen instructions for the Admin and Storefront |
| Japanese system configuration | Additional fields and options to configure for Japanese stores and markets |
| Support for proper Japanese names | Customer name fields can support Hiragana, Katakana, or both to specify correct spelling names |
| Japanese address order | Form and field order to properly save Japanese addresses |
| Japanese prefecture list | List of prefectures in order of north to south available for entering addresses |
| Country in address | Display the country field as part of the address |
| Automatic address population | Automatic population of prefecture, city, and street for entered postal codes |
| Require address as registration | Configuration option for requiring addresses for new customer accounts |
| Japanese fonts for PDFs | Japanese fonts to properly generate PDFs |
| Japanese Yen formats | Currency formatting for traditional and local formats |
| Japanese currency precision | Handle currencies without subunits or with subunits that are not 1/100 from major currency |
The extension includes the following modules.
| Modules | Description |
|---|---|
| Magento_JapaneseDefaultConfig | Provides common configurations to apply Japanese stores such as locale, time zone, measurement units, currency, etc. |
| Magento_JapaneseName | Extends customer contact and address forms, address forms at checkout and admin panel with fields that accept Hiragana, Katakana, or both to specify correct spelling of customer name |
| Magento_JapaneseRegion | Adds and displays a list of Japanese prefectures in a traditional order |
| Magento_JapanesePostalCode | Automatically populates address fields based on the entered postal code |
| Magento_JapaneseAddress | Adds updates to addresses forms and display formats for Japanese traditional address formatting and order |
| Magento_JapaneseStoreAddress | Adds support for traditional Japanese address formatting |
| Magento_ConfigurablePdfFont | Allows you to change fonts for Admin PDF generation |
| Magento_FontSourceHanSansJapanese | Adds Adobe Source Han Sans Japanese (used by default) fonts |
| Magento_FontIpa | Adds IPA fonts |
| Magento_CurrencyPrecision | Adds improvements to handle currencies without subunits or with subunits that are not 1/100 from major currency |
| Magento_JapaneseYenFormatting | Adds option to set international (￥123) or local (123 円) |
| Magento_JapaneseUrlRewrite | Provides the capability to transliterate Katakana and Hiragana names and use Kanji names in URLs |
| Magento_Kuromoji | Configures Elasticsearch to use a proper tokenizer |
All text strings for field names, messages, on-screen instructions, and more are translated fully for Magento Open Source installations. If this package is installed in Magento Commerce, some screens and options are not translated.
All translations are completed through contributions in the Magento CrowdIn project. As we receive additional translations, those will be made available through extension updates.
The extension provides multiple features for addresses.
- Kana support for address forms and entered data. Japanese names usually written with Kanji do not provide enough information for addressing customers in conversations. Hiragana and Katakana adds phonetic information about customer names. Customer name fields can support Hiragana, Katakana, or both to specify correct spelling names.
- Templates available for configuring Japanese addresses
- All address forms in the Admin and Storefront use a traditional Japanese order to correctly save and display addresses.
- Provides a full list of Japanese prefectures in a traditional order from north to south.
- As you enter postal codes, Magento automatically populates addresses fields including prefectures, city, and street based on the entered postal code.
- Configuration options are available for requiring addresses when registering a store account and displaying the country as part of the address.
The extension adds fonts and options through the store configuration to correctly generate PDFs with proper Japanese characters. These fonts include Adobe Source Han Sans Japanese (used by default) and IPA fonts.
The Japanese Yen has several formats. Configure how the amounts display in your store using international (￥123) or local (123 円) formats.
The extension also handles currencies without subunits or with subunits that are not 1/100 from major currency. The implementation uses the ICU library and does not require additional configuration.
The options include:
- Up — round away from zero.
- Ceiling — round towards positive infinity.
- Down — round towards zero. (default)
- Floor — round towards negative infinity.
- Half Down — round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
- Half Even — round towards "nearest neighbor" unless both neighbors are equidistant, in which case round towards the even neighbor.
- Half Up — round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.
The default Elasticsearch tokenizer used by Magento is unable to parse Japanese texts and leads to incorrect search results. The extension configures Elasticsearch to use a proper tokenizer. To use this module, your system administrator should also install Japanese (kuromoji) Analysis Plugin for Elasticsearch.
Elasticsearch with installed Kuromoji plugin is recommended search engine for Japanese merchants. Yet, it is possible to use MySQL search. But in this case MySQL 5.7 or above should be used with installed MeCab Full-Text Parser Plugin.
Magento applies special rules to transform titles of products, product categories, and CMS pages to default URLs. As part of transformation, all text is transliterated to ASCII symbols.
With Japanese text, transformations can be complicated and difficult to define conventional transliteration rules for Kanji. To solve this limitation, the extension provides the capability to transliterate Katakana and Hiragana names and use Kanji names in URLs. All modern browsers correctly handle national symbols in URLs, and the user sees the correct text in a browser bar instead of URL encoded symbols.
This extension is developed, maintained, and supported by the Magento Community Engineering team. Support SLA is not offered for this extension. If you have high support requirements, please make sure your development team is able to cover additional support.
We would like to thank our friends at Veriteworks Inc and Hirokazu Nishi personally for contributing their code that became the basis of this extension, as well as for providing help and ongoing support in refactoring it and getting it to a stable and shippable state. Arigato, Nishi-san!
Please use the GitHub repository to track the ongoing development of the extension or submit reproducible issues.
To connect with Magento and the Community, join us on the Magento Community Engineering Slack and the #japanese-localization channel. If you are interested in joining Slack, or a specific channel, send us request at [email protected] or self signup.