Provides the abstract models that give a phonetic reading (カナ / ふりがな) to a model -- of its name, or of any other field -- and the setting that chooses the kana format readings are stored in.
A reading is stored in a canonical form, so the same pronunciation matches however it was typed: kana take the configured format, full-width ASCII and digits fold to half-width (ＡＢＣショウジ is stored as ABCショウジ), and spacing collapses to single half-width spaces. A search term goes through the same normalization before it is compared.
This module adds no field to any model of its own; the readings live in the modules that apply the mixins to a model.
auto_awesome What this module does
AI-generated from the code · Odoo 20.0Adds a setting that chooses how Japanese phonetic readings (kana) are stored, and provides reusable building blocks so other modules can give any record a normalized kana reading of its name that is also searchable.
This module is a foundation for Japanese localization: it does not add any field to standard Odoo screens by itself, but it supplies the mechanism other modules use to store and search phonetic readings (furigana) of names.
What users get: - A new "Japanese Kana" section in the Settings app with a "Kana Format" option. Users choose whether readings are kept as full-width katakana, half-width katakana or hiragana. Full-width katakana is the default. - The chosen format applies to readings saved from then on; readings already stored keep their old format until they are saved again. - A specific model can be given its own format through a system parameter, which then overrides the general setting.
Automatic behaviour: - Whenever a reading is saved, it is cleaned up: full-width letters and digits are folded to half-width, extra spaces are reduced to single spaces, and the text is converted to the selected kana style. A reading made only of spaces is stored as empty. - Search terms typed in a kana field are cleaned the same way before matching, so the same pronunciation finds the record however it was typed. - When a model uses the name-reading mixin, searching by the normal display name also looks at the kana reading, so a record can be found by its pronunciation. - An invalid format value is rejected with an error message.
Areas touched: the settings screen, system parameters (ir.config_parameter), and the abstract mixins kana.mixin and name.kana.mixin that other modules apply to their models.
Depends on
Required by other modules
Models and fields (4)
- kana.mixin · new model
- name.kana.mixin · new modelname_kana (Name (Kana)), name_kana_search (Name (Kana) Search)
- ir.config_parameter · extends an existing model
- res.config.settings · extends an existing modelkana_format
Text generated by AI (DeepSeek) from reading the Odoo 20.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub
Availability by version
Reviewed: 2026-11-03Confirmation status: 2 confirmed, 7 with no information of 9 versions.
Sources · Odoo 19.0
Confirmed on 2026-11-03 in branch 19.0 of OCA/l10n-japan.
terminal Installation and usage
OCA documentation · Odoo 20.0Configuration
Source · Odoo 20.0Select the kana format under Settings > General Settings > Japanese Kana. Full-width katakana is the default; half-width katakana and hiragana are the alternatives.
A single model can depart from that, for the case where personal furigana is kept in hiragana while contacts and products stay in katakana. This is rare, so it has no setting of its own: add a system parameter under Settings > Technical > System Parameters whose key is the model name appended to the global one, and whose value is one of full_width_katakana, half_width_katakana or hiragana.
| Key | Applies to | |---|---| | l10n_jp_kana.format | every model with a reading | | l10n_jp_kana.format.res.partner | contacts | | l10n_jp_kana.format.hr.employee | employees | | l10n_jp_kana.format.product.template | products and their variants |
An empty or absent per-model key means the model follows the global format.
Changing a format affects only the readings saved afterwards -- see Known Issues.
Usage
Source · Odoo 20.0Install the module that carries the reading to the model you need:
l10n_jp_kana_partner_name-- contactsl10n_jp_kana_product_name-- productsl10n_jp_kana_hr_employee_name-- employees
To give another model a reading of its name, inherit kana.mixin and name.kana.mixin alongside the model and add the name_kana field to the form and list views. In the search view, use name_kana_search rather than name_kana: a search view compares the term to the column as typed, and that field is what normalizes the term first. Readings are then normalized on create and write, and a term typed into the model's lookup finds the record whichever kana form it is in.
For a reading of something other than the name -- an address, say -- inherit kana.mixin alone and declare the Char fields with kana=True. They are normalized on create and write like a name reading; add an onchange on them if the form should show the stored form before saving.
On a model that delegates to another one (_inherits, as a product variant does to its template), inherit kana.mixin there as well. The reading is stored on the parent, and the child would otherwise keep the value as it was typed until the record is read from the database again.
name.kana.mixin needs kana.mixin beside it, which is where the normalization lives. Neither derives from the other, so a module extending kana.mixin reaches every model that took it.
No verified information in OCA: Installation.
Installation instructions, the distribution package, dependencies and configuration steps are not shown because they have not yet been verified in the module documentation for any version.
Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.