From 3395f41bd133a0b21a9b2e29cb62d865871cc86c Mon Sep 17 00:00:00 2001 From: pennae Date: Mon, 2 Jan 2023 21:28:53 +0100 Subject: [PATCH] nixos/input-method: convert manual chapter to MD --- nixos/modules/i18n/input-method/default.md | 158 +++++++ nixos/modules/i18n/input-method/default.nix | 2 + nixos/modules/i18n/input-method/default.xml | 488 ++++++++++---------- 3 files changed, 395 insertions(+), 253 deletions(-) create mode 100644 nixos/modules/i18n/input-method/default.md diff --git a/nixos/modules/i18n/input-method/default.md b/nixos/modules/i18n/input-method/default.md new file mode 100644 index 000000000000..05ae12065c34 --- /dev/null +++ b/nixos/modules/i18n/input-method/default.md @@ -0,0 +1,158 @@ +# Input Methods {#module-services-input-methods} + +Input methods are an operating system component that allows any data, such as +keyboard strokes or mouse movements, to be received as input. In this way +users can enter characters and symbols not found on their input devices. +Using an input method is obligatory for any language that has more graphemes +than there are keys on the keyboard. + +The following input methods are available in NixOS: + + - IBus: The intelligent input bus. + - Fcitx: A customizable lightweight input method. + - Nabi: A Korean input method based on XIM. + - Uim: The universal input method, is a library with a XIM bridge. + - Hime: An extremely easy-to-use input method framework. + - Kime: Korean IME + +## IBus {#module-services-input-methods-ibus} + +IBus is an Intelligent Input Bus. It provides full featured and user +friendly input method user interface. + +The following snippet can be used to configure IBus: + +``` +i18n.inputMethod = { + enabled = "ibus"; + ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ]; +}; +``` + +`i18n.inputMethod.ibus.engines` is optional and can be used +to add extra IBus engines. + +Available extra IBus engines are: + + - Anthy (`ibus-engines.anthy`): Anthy is a system for + Japanese input method. It converts Hiragana text to Kana Kanji mixed text. + - Hangul (`ibus-engines.hangul`): Korean input method. + - m17n (`ibus-engines.m17n`): m17n is an input method that + uses input methods and corresponding icons in the m17n database. + - mozc (`ibus-engines.mozc`): A Japanese input method from + Google. + - Table (`ibus-engines.table`): An input method that load + tables of input methods. + - table-others (`ibus-engines.table-others`): Various + table-based input methods. To use this, and any other table-based input + methods, it must appear in the list of engines along with + `table`. For example: + + ``` + ibus.engines = with pkgs.ibus-engines; [ table table-others ]; + ``` + +To use any input method, the package must be added in the configuration, as +shown above, and also (after running `nixos-rebuild`) the +input method must be added from IBus' preference dialog. + +### Troubleshooting {#module-services-input-methods-troubleshooting} + +If IBus works in some applications but not others, a likely cause of this +is that IBus is depending on a different version of `glib` +to what the applications are depending on. This can be checked by running +`nix-store -q --requisites | grep glib`, +where `` is the path of either IBus or an +application in the Nix store. The `glib` packages must +match exactly. If they do not, uninstalling and reinstalling the +application is a likely fix. + +## Fcitx {#module-services-input-methods-fcitx} + +Fcitx is an input method framework with extension support. It has three +built-in Input Method Engine, Pinyin, QuWei and Table-based input methods. + +The following snippet can be used to configure Fcitx: + +``` +i18n.inputMethod = { + enabled = "fcitx"; + fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ]; +}; +``` + +`i18n.inputMethod.fcitx.engines` is optional and can be +used to add extra Fcitx engines. + +Available extra Fcitx engines are: + + - Anthy (`fcitx-engines.anthy`): Anthy is a system for + Japanese input method. It converts Hiragana text to Kana Kanji mixed text. + - Chewing (`fcitx-engines.chewing`): Chewing is an + intelligent Zhuyin input method. It is one of the most popular input + methods among Traditional Chinese Unix users. + - Hangul (`fcitx-engines.hangul`): Korean input method. + - Unikey (`fcitx-engines.unikey`): Vietnamese input method. + - m17n (`fcitx-engines.m17n`): m17n is an input method that + uses input methods and corresponding icons in the m17n database. + - mozc (`fcitx-engines.mozc`): A Japanese input method from + Google. + - table-others (`fcitx-engines.table-others`): Various + table-based input methods. + +## Nabi {#module-services-input-methods-nabi} + +Nabi is an easy to use Korean X input method. It allows you to enter +phonetic Korean characters (hangul) and pictographic Korean characters +(hanja). + +The following snippet can be used to configure Nabi: + +``` +i18n.inputMethod = { + enabled = "nabi"; +}; +``` + +## Uim {#module-services-input-methods-uim} + +Uim (short for "universal input method") is a multilingual input method +framework. Applications can use it through so-called bridges. + +The following snippet can be used to configure uim: + +``` +i18n.inputMethod = { + enabled = "uim"; +}; +``` + +Note: The [](#opt-i18n.inputMethod.uim.toolbar) option can be +used to choose uim toolbar. + +## Hime {#module-services-input-methods-hime} + +Hime is an extremely easy-to-use input method framework. It is lightweight, +stable, powerful and supports many commonly used input methods, including +Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet, +etc... + +The following snippet can be used to configure Hime: + +``` +i18n.inputMethod = { + enabled = "hime"; +}; +``` + +## Kime {#module-services-input-methods-kime} + +Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing + +The following snippet can be used to configure Kime: + +``` +i18n.inputMethod = { + enabled = "kime"; +}; +``` diff --git a/nixos/modules/i18n/input-method/default.nix b/nixos/modules/i18n/input-method/default.nix index 07fb86bcc25e..987e5be28330 100644 --- a/nixos/modules/i18n/input-method/default.nix +++ b/nixos/modules/i18n/input-method/default.nix @@ -66,6 +66,8 @@ in meta = { maintainers = with lib.maintainers; [ ericsagnes ]; + # Don't edit the docbook xml directly, edit the md and generate it: + # `pandoc default.md -t docbook --top-level-division=chapter --extract-media=media -f markdown-smart --lua-filter ../../../../doc/build-aux/pandoc-filters/myst-reader/roles.lua --lua-filter ../../../../doc/build-aux/pandoc-filters/docbook-writer/rst-roles.lua > default.xml` doc = ./default.xml; }; diff --git a/nixos/modules/i18n/input-method/default.xml b/nixos/modules/i18n/input-method/default.xml index ba621baf4417..c6fda9a7c57d 100644 --- a/nixos/modules/i18n/input-method/default.xml +++ b/nixos/modules/i18n/input-method/default.xml @@ -1,291 +1,273 @@ - - Input Methods - - Input methods are an operating system component that allows any data, such as - keyboard strokes or mouse movements, to be received as input. In this way - users can enter characters and symbols not found on their input devices. - Using an input method is obligatory for any language that has more graphemes - than there are keys on the keyboard. - - - The following input methods are available in NixOS: - - - - - IBus: The intelligent input bus. - - - - - Fcitx: A customizable lightweight input method. - - - - - Nabi: A Korean input method based on XIM. - - - - - Uim: The universal input method, is a library with a XIM bridge. - - - - - Hime: An extremely easy-to-use input method framework. - - - + + Input Methods + + Input methods are an operating system component that allows any + data, such as keyboard strokes or mouse movements, to be received as + input. In this way users can enter characters and symbols not found + on their input devices. Using an input method is obligatory for any + language that has more graphemes than there are keys on the + keyboard. + + + The following input methods are available in NixOS: + + + + + IBus: The intelligent input bus. + + + + + Fcitx: A customizable lightweight input method. + + + + + Nabi: A Korean input method based on XIM. + + + + + Uim: The universal input method, is a library with a XIM bridge. + + + + + Hime: An extremely easy-to-use input method framework. + + + + + Kime: Korean IME + + + +
+ IBus - Kime: Korean IME + IBus is an Intelligent Input Bus. It provides full featured and + user friendly input method user interface. - - -
- IBus - - - IBus is an Intelligent Input Bus. It provides full featured and user - friendly input method user interface. - - - - The following snippet can be used to configure IBus: - - - + + The following snippet can be used to configure IBus: + + i18n.inputMethod = { - enabled = "ibus"; + enabled = "ibus"; ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ]; }; - - - i18n.inputMethod.ibus.engines is optional and can be used - to add extra IBus engines. - - - - Available extra IBus engines are: - - - - - Anthy (ibus-engines.anthy): Anthy is a system for - Japanese input method. It converts Hiragana text to Kana Kanji mixed text. + i18n.inputMethod.ibus.engines is optional and + can be used to add extra IBus engines. - - - Hangul (ibus-engines.hangul): Korean input method. + Available extra IBus engines are: - - - - m17n (ibus-engines.m17n): m17n is an input method that - uses input methods and corresponding icons in the m17n database. - - - - - mozc (ibus-engines.mozc): A Japanese input method from - Google. - - - - - Table (ibus-engines.table): An input method that load - tables of input methods. - - - - - table-others (ibus-engines.table-others): Various - table-based input methods. To use this, and any other table-based input - methods, it must appear in the list of engines along with - table. For example: - + + + + Anthy (ibus-engines.anthy): Anthy is a + system for Japanese input method. It converts Hiragana text to + Kana Kanji mixed text. + + + + + Hangul (ibus-engines.hangul): Korean input + method. + + + + + m17n (ibus-engines.m17n): m17n is an input + method that uses input methods and corresponding icons in the + m17n database. + + + + + mozc (ibus-engines.mozc): A Japanese input + method from Google. + + + + + Table (ibus-engines.table): An input method + that load tables of input methods. + + + + + table-others (ibus-engines.table-others): + Various table-based input methods. To use this, and any other + table-based input methods, it must appear in the list of + engines along with table. For example: + + ibus.engines = with pkgs.ibus-engines; [ table table-others ]; + + + + To use any input method, the package must be added in the + configuration, as shown above, and also (after running + nixos-rebuild) the input method must be added + from IBus' preference dialog. - - - - - To use any input method, the package must be added in the configuration, as - shown above, and also (after running nixos-rebuild) the - input method must be added from IBus' preference dialog. - - - - Troubleshooting - - If IBus works in some applications but not others, a likely cause of this - is that IBus is depending on a different version of glib - to what the applications are depending on. This can be checked by running - nix-store -q --requisites <path> | grep glib, - where <path> is the path of either IBus or an - application in the Nix store. The glib packages must - match exactly. If they do not, uninstalling and reinstalling the - application is a likely fix. - - -
-
- Fcitx - - - Fcitx is an input method framework with extension support. It has three - built-in Input Method Engine, Pinyin, QuWei and Table-based input methods. - - - - The following snippet can be used to configure Fcitx: - - - +
+ Troubleshooting + + If IBus works in some applications but not others, a likely + cause of this is that IBus is depending on a different version + of glib to what the applications are + depending on. This can be checked by running + nix-store -q --requisites <path> | grep glib, + where <path> is the path of either IBus + or an application in the Nix store. The glib + packages must match exactly. If they do not, uninstalling and + reinstalling the application is a likely fix. + +
+
+
+ Fcitx + + Fcitx is an input method framework with extension support. It has + three built-in Input Method Engine, Pinyin, QuWei and Table-based + input methods. + + + The following snippet can be used to configure Fcitx: + + i18n.inputMethod = { - enabled = "fcitx"; + enabled = "fcitx"; fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ]; }; - - - i18n.inputMethod.fcitx.engines is optional and can be - used to add extra Fcitx engines. - - - - Available extra Fcitx engines are: - - - - - Anthy (fcitx-engines.anthy): Anthy is a system for - Japanese input method. It converts Hiragana text to Kana Kanji mixed text. + i18n.inputMethod.fcitx.engines is optional and + can be used to add extra Fcitx engines. - - - Chewing (fcitx-engines.chewing): Chewing is an - intelligent Zhuyin input method. It is one of the most popular input - methods among Traditional Chinese Unix users. + Available extra Fcitx engines are: - - + + + + Anthy (fcitx-engines.anthy): Anthy is a + system for Japanese input method. It converts Hiragana text to + Kana Kanji mixed text. + + + + + Chewing (fcitx-engines.chewing): Chewing is + an intelligent Zhuyin input method. It is one of the most + popular input methods among Traditional Chinese Unix users. + + + + + Hangul (fcitx-engines.hangul): Korean input + method. + + + + + Unikey (fcitx-engines.unikey): Vietnamese + input method. + + + + + m17n (fcitx-engines.m17n): m17n is an input + method that uses input methods and corresponding icons in the + m17n database. + + + + + mozc (fcitx-engines.mozc): A Japanese input + method from Google. + + + + + table-others (fcitx-engines.table-others): + Various table-based input methods. + + + +
+
+ Nabi - Hangul (fcitx-engines.hangul): Korean input method. + Nabi is an easy to use Korean X input method. It allows you to + enter phonetic Korean characters (hangul) and pictographic Korean + characters (hanja). - - - Unikey (fcitx-engines.unikey): Vietnamese input method. + The following snippet can be used to configure Nabi: - - - - m17n (fcitx-engines.m17n): m17n is an input method that - uses input methods and corresponding icons in the m17n database. - - - - - mozc (fcitx-engines.mozc): A Japanese input method from - Google. - - - - - table-others (fcitx-engines.table-others): Various - table-based input methods. - - - -
-
- Nabi - - - Nabi is an easy to use Korean X input method. It allows you to enter - phonetic Korean characters (hangul) and pictographic Korean characters - (hanja). - - - - The following snippet can be used to configure Nabi: - - - + i18n.inputMethod = { - enabled = "nabi"; + enabled = "nabi"; }; -
-
- Uim - - - Uim (short for "universal input method") is a multilingual input method - framework. Applications can use it through so-called bridges. - - - - The following snippet can be used to configure uim: - - - +
+
+ Uim + + Uim (short for "universal input method") is a + multilingual input method framework. Applications can use it + through so-called bridges. + + + The following snippet can be used to configure uim: + + i18n.inputMethod = { - enabled = "uim"; + enabled = "uim"; }; - - - Note: The option can be - used to choose uim toolbar. - -
-
- Hime - - - Hime is an extremely easy-to-use input method framework. It is lightweight, - stable, powerful and supports many commonly used input methods, including - Cangjie, Zhuyin, Dayi, Rank, Shrimp, Greek, Korean Pinyin, Latin Alphabet, - etc... - - - - The following snippet can be used to configure Hime: - - - + + Note: The + option can be used to choose uim toolbar. + +
+
+ Hime + + Hime is an extremely easy-to-use input method framework. It is + lightweight, stable, powerful and supports many commonly used + input methods, including Cangjie, Zhuyin, Dayi, Rank, Shrimp, + Greek, Korean Pinyin, Latin Alphabet, etc... + + + The following snippet can be used to configure Hime: + + i18n.inputMethod = { - enabled = "hime"; + enabled = "hime"; }; -
-
- Kime - - - Kime is Korean IME. it's built with Rust language and let you get simple, safe, fast Korean typing - - - - The following snippet can be used to configure Kime: - - - +
+
+ Kime + + Kime is Korean IME. it's built with Rust language and let you get + simple, safe, fast Korean typing + + + The following snippet can be used to configure Kime: + + i18n.inputMethod = { - enabled = "kime"; + enabled = "kime"; }; -
+