Ubuntu – How to toggle input modes with Mozc

18.04gnome-shelljapanesemozc

I'm using Gnome with an international keyboard and I configured it to use ~~fcitx~~ IBus. I also installed Google_Japanese_Input in Windows, where it behaves as expected:

Alt + Shift switch between languages (IMEs)

Ctrl + Caps Lock switch to Hiragana

Alt + Caps Lock if in alphanumeric mode change to Hiragana, then switch to Katakana

Shift + Caps Lock switch between full-width Hiragana ↔ full-width alphanumeric (romaji)

Alt + ` (Grave Accent) switch between kana ↔ half-width alphanumeric (romaji)

Alt + ~ (Tilde) toggle kana/direct input

These keyboard shortcuts do not work in Gnome. I have to select the modes manually from the menu.

I understand that Alt + ` interferes with the application switcher shortcut but I doubt that I'm the only user using Gnome and trying to get it to work like an average user would do on any other platform. If there was a serious issue with the existing keyboard mappings there should at least be some kind of best practice or recommendation how to create a useful mapping instead of everyone starting from scratch rolling her/his own? I'm not convinced by existing answers (1, 2) and I could not find any good resources how a Linux user is supposed to configure and use Mozc (1, 2) efficiently.

So my question I'd like to have a complete answer here is:

What is the recommended Japanese input method for Ubuntu 18.04 and later? (I assume it is Mozc.)
- Which packages need to be installed?
- How is the input method configured in Gnome? (A Windows user just downloads and installs the Google software for comparison. It just works.)
How to set up the input method itself?
- How to set up switching of input modes?
- Are there any conflicts with keyboard shortcuts? How to resolve?
- Are there any conflicts with other IMEs or software components (like UIM, IBus)? How to resolve?
Is there any useful documentation how to use the IME? (Or typical Japanese IME in general.)
- Would be useful to verify that it is working correctly.
- Understanding how the software is supposed to be used by average users. There seem to be a lot of shortcuts and additional functionality to tweak but also to make your experience worse than instead of going with the default where possible.

Update:

After a few reboots I find that fcitx does not work when I set the mode to Hiragana and type in Gedit. Trying to reconstruct the behavior I must have been using Ibus at the time. When I try Ibus it works.

I had reset my keyboard shortcuts on this computer when I moved from Unity to Gnome, thus running the defaults except for the take screenshot key which I have disabled. I previously had setup custom compose keys (1, 2), but I disabled export GTK_IM_MODULE="uim" and export QT_IM_MODULE="uim" in my .profile when moving to Gnome with Wayland due to a bug. Sequences like Compose+.+. and Compose+→+→ do work though.

When running fcitx I get the following output:

$ printenv | grep -i im_module 
CLUTTER_IM_MODULE=xim
QT4_IM_MODULE=fcitx
QT_IM_MODULE=fcitx
GTK_IM_MODULE=fcitx

When running ibus I get the following output:

$ printenv | grep -i im_module 
CLUTTER_IM_MODULE=xim
QT4_IM_MODULE=xim
QT_IM_MODULE=ibus
GTK_IM_MODULE=ibus

Update 2:

Okay as far as I understand fcitx does not integrate well with Gnome at the moment. I try to go with IBus since I don't want fcitx to interfere with keyboards and configure keyboards in Gnome and fcitx (across several desktops and laptops). While I have no problems using Ctrl + Caps Lock and Alt + Caps Lock in Windows, Mozc on Linux has the Japanese keys in it's mapping and the Alt and Eisu keys don't seem to be supported. There is an entry on the Arch Wiki regarding X tools (I'm not sure about Wayland) and some Japanese users seem to have found their ways, but this is way too much for me right now.

Update 3:

While users on Arch use a custom AUR package I found a simple quilt patch for easy applying and recompiling to the latest version. I hope this can be included in Ubuntu one way or another while the Linux version has no documented way of making the quoted shortcuts work like on other OSes. With this annoyance gone I consider my issue almost solved. Lets see what happens with the bug report or upstream in the mean time.

Best Answer

What is the recommended Japanese input method for Ubuntu 18.04 and later? (I assume it is Mozc.)

The IMF is IBUS (comes installed from Ubuntu's ISO). The IME is MOZC (most commented here in Askubuntu) followed by Anthy.

But it is so subjective. Install all of them! And try each one!

Which packages need to be installed?

On Ubuntu 18.04, you need to install 3 kinds of packages:

Language

You need to install the japanese language (to get the base packages). Following the instructions in Writing Japanese with Ubuntu 18.04 LTS Bionic Beaver and Japanese Input:

In system settings, select Region & Language.
Click Manage Installed Languages.
In the Language Support window, click on Install / Remove Languages....
In the Installed Languages window, check Japanese, click Apply.
Log out of your Ubuntu profile to get effect.

IMFs packages

You can install one (or both) IMFs. Ubuntu comes with ibus installed. To install, type:

ibus: sudo apt install ibus
fcitx: sudo apt install fcitx.

IMEs packages

You need to install japanese IME(s) for each installed IMF. For example, Ubuntu comes with ibus IMF. So you can install one (or more) of these japanese IMEs:

mozc: sudo apt install ibus-mozc
Anthy: sudo apt install ibus-anthy.
KKC: sudo apt install ibus-kkc.
SKK: sudo apt install ibus-skk.

And if you installed fctix IMF, you will need to install at least one of its specific japanese IMEs:

mozc: sudo apt install fcitx-mozc
Anthy: sudo apt install fcitx-anthy.
KKC: sudo apt install fcitx-kkc.
SKK: sudo apt install fcitx-skk.

How is the input method configured in Gnome? (A Windows user just downloads and installs the Google software for comparison. It just works.)

First install: japanese language, one IMF, and one japanese IME.

After that, you only need to click on GNOME Status Menu (Gnome's top-right bar) > IBus menu (i.e. keyboard/input language selector) > Select your desired input method.

Gnome and japanese input methods

Or use the shortcut: hold Super and press Space.

enter image description here

How to set up the input method itself?

Each IMF and each IME have their configurations, menus, windows and so on.

How to set up switching of input modes?

To switch between japanese input modes (e.g. hiragana, katakana etc) is a important requirement. Each IME comes with their own:

shortcuts or binding keys to switch japanese modes.
plus that, has graphical submenus at GNOME Status Menu to switch between japanese modes and access its configurations.

Are there any conflicts with keyboard shortcuts? How to resolve?

No. Each IME has their keymap editor. So you can edit any conflict, if exists.

Are there any conflicts with other IMEs or software components (like UIM, IBus)? How to resolve?

I don't thing so.

Is there any useful documentation how to use the IME? (Or typical Japanese IME in general)

Installation: see Writing Japanese with Ubuntu 18.04 LTS Bionic Beaver and Japanese Input.
Questions and answer: https://askubuntu.com/ and https://japanese.stackexchange.com/
IME official sites: mozc, Anthy, KKC, SKK.
and google/youtube/reddit.

Would be useful to verify that it is working correctly.

Only install all packages, select the IME from GNOME Status Menu and type in any text field.

Understanding how the software is supposed to be used by average users. There seem to be a lot of shortcuts and additional functionality to tweak but also to make your experience worse than instead of going with the default where possible.

After select the installed japanese IME, you will need to know the shortcuts to change the japanese input mode. For example, you can see all ibus-mozc keymap and its romaji-hiragana table.

TLDR

Abstract

Steps to create the Japanese Mozc key bindings, to switch the input modes:

Open a text editor (e.g. Gedit).
Click on Gnome Status menu (Gnome's top-left bar) > IBus menu (i.e. keyboard/input language selector) > Select Japanese Mozc input method.
Again, click on Gnome Status Menu > IBuz > tools > Properties > Mozc Settings window.
From Keymap style section > click on customize button (first one).
Create new entries with your personal shortcuts to duplicate the japanese keys binding: hankaku/zenhankaku, muhenkan, eisu.
If messed things up, click on reset to defaults button from Mozc Settings window.

That's all!

Graphical abstract

Steps to create the key bindings to toggle Japanese syllabaries input mode.

Graphical Abstract to set up MOZC keys

Introduction:

The problem: how to type Japanese using a non-Japanese keyboard?

In Japanese (日本語, nihongo), you need to write using a lot of different symbols-sets. A informal categorization of these sets can be like:

all ~~alphabets~~ syllabaries (ひらがな hiragana, かたかな katakana, 漢字 kanji, ローマ字 romaji),
(han)dakuten, contractions, combinations and variants (e.g. ゜maru, ゛tenten, uppercase, lowercase, full-width, half-width etc),
symbols in Japanese style (e.g. Japanese period。, 「Japanese quote」, Japaneseーhiphen etc).

So, dedicated keys exists on Japanese keyboards to toggle between them. An analogy with occidental keyboard are the Capslock key to upper/lower-case or, Shift key to insert symbols. But the occidental keyboard hasn't these Japanese keys. So how to type in Japanese using a non-Japanese keyboard?

Solutions

Basically, two solutions can be listed:

install a Japanese keyboard or,
binding Japanese keys, by software level, in your non-Japanese keyboard.

Solution 1: Install a Japanese keyboard

Easiest solution so far. Acquire one Japanese keyboard, install and configure on your Operation System. But you need access to one, maybe buying one (with international credit card, taxes, waiting for shipping and so on).

Solution 2: Binding Japanese keys in your non-Japanese keyboard.

It is a cheap solution and you can use it in any keyboard you have. But you need to install software, configure, and memorize MANY key combinations. It is basically "a sea of shortcuts" to emulate the Japanese keyboard. Linux have some software to simulate a Japanese keyboard for using a non-Japanese keyboard.

Let's implement the solution 2.

Theoretical background

Linux input software layers

Our computer can receive inputs from many talked/typed languages and hardware (i.e. different keyboards and layouts). So it needs to organize the configurations and permit to the user choice between different languages. For example, a user can type one document in Italian AND English languages, at alternating times. So the software needs to show the user a way to change the language to be inputted.

The Linux user have 2 layers of software to configure the input method by keyboard:

Input Method Framework (IMF): a class of software that organize the inputs (from keyboard, mouse etc), send to the correct destination (software, systems etc), and configure them.
Input Method Editor/Engine (IME): a class of software that receives the inputted characters (from a keyboard), translate them to the desired input (i.e. idiom, language) and, send them to the Input Method Framework (IMF) to handle them. Basically, we have: from keyboard > (typed/inputted keys) > IME (receives and translate them) > (translated inputted keys) > IMF (handle translated inputted keys to destinations).

For the Linux user, an example o IMF is IBus; an a example of IME is MOZC. The first one will switch between all installed IMEs and switch between all idioms/languages installed too. The second one, if selected, will send to the IMF only Japanese keys, even if you typed in a non-Japanese keyboard. About Japanese IMEs, you can read more about here, and visualize the states/events in these diagrams:

Diagram 1:

Diagram 2:

Japanese keyboard

Layout

The Japanese keyboard layout (キーボード) is established by Japanese International Standard (JIS). First of all, let's contemplate the Japanese keyboard! Watch an open box video. You can see the vector draw bellow, showing clearly the Japanese keys:

Japanese keyboard layout

Finally, some real pictures bellow:

Japanese keyboard layout 1 Japanese keyboard layout 2

Try to identify each key, slowly.

We have:

Roman letter (QWERTY).
Hiragana symbols.
Small hiragana symbols.
Han-dakuten symbols (maru, tenten).
Arithmetic symbols.
Capslock, shift, super, alt, tab, Ctrl, Enter, Backspace.
Punctuation with Japanese style (period, quotes etc).
and some special keys with Japanese words:
- muhenkan 無変換: don't convert kana to kanji.
- henkan 変換: convert kana to kanji.
- hiragana/Katakana/romaji カタカナ / ひらがな / ローマ字:
- hankaku/zenkaku 半角 / 全角: switch between half-width or full-width
- kanji 半角 / 全角 / 漢字: switch between kanji or English characters.
- eisū 英数: switch to alphanumeric characters.

You can have more description of these specific keys here. And read about the text frequency of hiragana, katakana e kanji and here.

Typing

How a Japanese user type on this keyboard?

Answer 1: type phonetically, using romaji mode. Yes, they use romaji!
Answer 2: it can type in kana mode, too, using hiragana keys.

For example, lets type "kakikukeko" in romaji mode:

First, select romaji mode.
Typing, in a QWERTY keyboard:
1. type k, outputs: ｋ.
2. type a, outputs: か (ka).
3. type k, outputs: かｋ.
4. type i, outputs: かき (kaki).
5. type k, outputs: かきｋ.
6. type u, outputs: かきく (kakiku).
7. type k, outputs: かきくｋ.
8. type e, outputs: かきくけ (kakikuke).
9. type k, outputs: かきくけｋ.
10. type o, outputs: かきくけこ (kakikukeko).
11. type ENTER, outputs: かきくけこ (kakikukeko ).

Another example, type "kakikukeko" in hiragana mode.

First, select kana mode.
Typing, in a QWERTY keyboard:
1. type t, outputs: か (ka).
2. type g, outputs: かき (kaki).
3. type k, outputs: かきく (kakiku).
4. type :, outputs: かきくけ (kakikuke).
5. type b, outputs: かきくけこ (kakikukeko).
6. type ENTER, outputs: かきくけこ (kakikukeko ).

And to convert to katakana or kanji is the same thing. You can toggle to katakana mode or kanji mode and type on romaji or hiragana. And the computer will pop up an autocomplete window to you select your desired word.

Method

Now, we will use software to type Japanese in a non-Japanese keyboard. My system when I create this text was:

My OS: Ubuntu 18.04.4 LTS
My Japanese IME: Mozc 2.20.2673.102
My IMF: Ibus 1.5.17
My keyboard: Latin keyboard (with ç, ~, ^ and so on).

Install

Ubuntu came with the IMF IBus (like a built in). But if you need to install IBus:

sudo apt install ibus

Next, let's install our Japanese IME MOZC:

sudo apt install ibus-mozc

Observation: look at the name of the package ibus-mozc. Its our IMF + IME names. So, in future we can search on APT repositories for IMF and Japanese IME alternatives, like ibus-*, or *-mozc.

Installations completed!

Configurations

A Japanese keyboard has many different keys, to switch:

It is necessary to edit and memorize the Japanese input software's (binding) shortcut keys. Hiragana, katakana, kanji, romaji, upper/lower-case, full/half-width, Japanese symbols (period, quote, maru, tenten etc). So, you need to memorize/edit the keys to (des)activate the switches.

See the screenshots from before to get a hint of where the MOZC keymap is. To edit/read these keys on your Mozc:

Open a text editor (e.g. Gedit) and stay with it in foreground.
Select Mozc input mode: Hold Super and press Space as many times as to select Mozc option. Or click on: IBus (at GNOME Status Menu) > Japanese (Mozc).
To read/edit these Japanese key bindings, click on: IBus (at GNOME Status Menu) > Tools > Properties.
After Mozc Setting window popped up, click on: General tab > Keymap section (at bottom) > Keymap Style customize button (first one).
After Mozc keymap editor window popped up, click on: Scroll up and down to memorize and edit the Japanese keymap (bindings).
Probably, you may will toggle between all Mozc's input modes (hiragana, katakana, romaji etc) if you duplicate and edit these binding keys for your chosen shortcuts. Basically, to switch between syllabaries using MOZC, you need to memorize/edit/press:

hankaku/zenhankaku key: to turn IME on/off.
muhenkan key: to toggle kana syllabaries.
eisu key (or shift+muhenkan keys) to toggle latin input (i.e. romaji).

From MOZC's source-code, see the table with all matches to the Japanese JIS special keys, as bellow:

...
Composition Eisu    ToggleAlphanumericMode
Conversion  Eisu    ToggleAlphanumericMode
DirectInput Eisu    IMEOn
Precomposition  Eisu    ToggleAlphanumericMode
...
Composition Hankaku/Zenkaku IMEOff
Conversion  Hankaku/Zenkaku IMEOff
DirectInput Hankaku/Zenkaku IMEOn
Precomposition  Hankaku/Zenkaku IMEOff
...
Composition Muhenkan    SwitchKanaType
Conversion  Muhenkan    SwitchKanaType
Precomposition  Muhenkan    InputModeSwitchKanaType
...

You can consider to study/test other MOZC keys too, like:

...
DirectInput F13 IMEOn
...
Composition Ctrl i  ConvertToFullKatakana
Conversion  Ctrl i  ConvertToFullKatakana
...
Composition Ctrl o  ConvertToHalfWidth
Conversion  Ctrl o  ConvertToHalfWidth
Composition Ctrl p  ConvertToFullAlphanumeric
Conversion  Ctrl p  ConvertToFullAlphanumeric
...
Composition Ctrl t  ConvertToHalfAlphanumeric
Conversion  Ctrl t  ConvertToHalfAlphanumeric
Composition Ctrl u  ConvertToHiragana
Conversion  Ctrl u  ConvertToHiragana
...
Composition F10 ConvertToHalfAlphanumeric
Conversion  F10 ConvertToHalfAlphanumeric
DirectInput F13 IMEOn
Composition F2  ConvertWithoutHistory
Composition F6  ConvertToHiragana
Conversion  F6  ConvertToHiragana
Composition F7  ConvertToFullKatakana
Conversion  F7  ConvertToFullKatakana
Composition F8  ConvertToHalfWidth
Conversion  F8  ConvertToHalfWidth
Composition F9  ConvertToFullAlphanumeric
Conversion  F9  ConvertToFullAlphanumeric
...
Composition Henkan  Convert
Conversion  Henkan  ConvertNext
DirectInput Henkan  Reconvert
Precomposition  Henkan  Reconvert
...
Composition Hiragana    InputModeHiragana
Conversion  Hiragana    InputModeHiragana
DirectInput Hiragana    IMEOn
Precomposition  Hiragana    InputModeHiragana
...
Composition Katakana    InputModeFullKatakana
Conversion  Katakana    InputModeFullKatakana
DirectInput Katakana    IMEOn
Precomposition  Katakana    InputModeFullKatakana
...
Composition Shift Muhenkan  ConvertToFullAlphanumeric
Conversion  Shift Muhenkan  ConvertToFullAlphanumeric
Precomposition  Shift Muhenkan  ToggleAlphanumericMode
...
Composition Kanji   IMEOff
Composition OFF IMEOff
Composition ON  IMEOn
Conversion  Kanji   IMEOff
Conversion  OFF IMEOff
Conversion  ON  IMEOn
DirectInput Kanji   IMEOn
DirectInput ON  IMEOn
Precomposition  ASCII   InsertCharacter
Precomposition  Kanji   IMEOff
Precomposition  OFF IMEOff
Precomposition  ON  IMEOn
...

So, we need to create new shortcuts similar with these, like bellow (these are my shortcut sugestions):

...
Composition Ctrl j  IMEOff
Conversion  Ctrl j  IMEOff
DirectInput Ctrl j  IMEOn
Precomposition  Ctrl j  IMEOff
Composition Ctrl b  SwitchKanaType
Conversion  Ctrl b  SwitchKanaType
Composition Ctrl y  ToggleAlphanumericMode
Conversion  Ctrl y  ToggleAlphanumericMode
DirectInput Ctrl y  IMEOn
Precomposition  Ctrl y  ToggleAlphanumericMode
...

If you are interested, you can read MOZC's romaji-hiragana conversion table.

If you mess the things, click on reset to defauts button at Mozc setting window (opened in Step 3).

If you edit these shortcuts, please consider conflicts with your existing shortcuts from:

Operating system shortcuts (Ubuntu).
Graphical shell shortcuts (Gnome, KDE).
App shortcuts (firefox, gedit, libreoffice, gimp).
Personalized shortcuts (your personal shortcuts).

With these key bindings you can type very well in a non-japanese keyboard. We didn't binding the others japanese keys to let you study the subject.

Alternative solutions

Similar softwares

Im using IBus to be my input method editor (IME). But you can switch to other IMF/IME if you desire. Others IMEs are:

Anthy: sudo apt install ibus-anthy.
KKC: sudo apt install ibus-kkc.
SKK: sudo apt install ibus-skk.

The same as to input method framework (IMF), like:

Fcitx: sudo apt install fcitx.
- and you need to change the IME when installing like:
  - sudo apt install fcitx-mozc.
  - sudo apt install fictx-kkc.
  - sudo apt install fictx-skk.

A list of IMF can be found List of input methods for Unix platforms and Linux input method framework brief summary.

Edit keymap file by a text editor

You can manage the keymap saving, editing, import/export and so on. To do that, read the file at source-code. If you wanna, you can download this file and edit it to be imported into your MOZC software.

So, to import/export the keymap file:

At GNOME Status Menu, select MOZC input method.
Again at GNOME Status Menu, select Tools > Properties.
After Mozc Setting window popped up, click on: General tab > Keymap section (at bottom) > Keymap Style customize button (first one).
And after Mozc keymap editor window popped up, click on: Edit button menu (at bottom) > click import from file... or export from file.... With that you can save (export) your keymap editions. And you can to insert a new keymap edited by importing it.