diff options
author | Eric Sagnes <eric.sagnes@gmail.com> | 2016-04-12 01:02:30 +0900 |
---|---|---|
committer | Eric Sagnes <eric.sagnes@gmail.com> | 2016-04-12 19:50:16 +0900 |
commit | de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c (patch) | |
tree | 1bdc755f9a87a2676dd6a669985f72faf518d63c | |
parent | 62baa5df29966ef39fe1cc445a86d1b5f85c46a5 (diff) | |
download | nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.tar nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.tar.gz nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.tar.bz2 nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.tar.lz nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.tar.xz nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.tar.zst nixlib-de78fe8f2d78a5ef20d0d355c5dbe9d21b4be22c.zip |
manual: add chapter on input methods
-rw-r--r-- | nixos/doc/manual/configuration/configuration.xml | 1 | ||||
-rw-r--r-- | nixos/doc/manual/default.nix | 1 | ||||
-rw-r--r-- | nixos/modules/i18n/inputMethod/default.xml | 131 |
3 files changed, 133 insertions, 0 deletions
diff --git a/nixos/doc/manual/configuration/configuration.xml b/nixos/doc/manual/configuration/configuration.xml index caba8fb1f4ad..fb3f1498a9b7 100644 --- a/nixos/doc/manual/configuration/configuration.xml +++ b/nixos/doc/manual/configuration/configuration.xml @@ -28,6 +28,7 @@ effect after you run <command>nixos-rebuild</command>.</para> <xi:include href="postgresql.xml" /> <xi:include href="gitlab.xml" /> <xi:include href="acme.xml" /> +<xi:include href="input-methods.xml" /> <!-- Apache; libvirtd virtualisation --> diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix index 746ddc071b6a..89a95f3b3564 100644 --- a/nixos/doc/manual/default.nix +++ b/nixos/doc/manual/default.nix @@ -58,6 +58,7 @@ let cp ${../../modules/services/databases/postgresql.xml} configuration/postgresql.xml cp ${../../modules/services/misc/gitlab.xml} configuration/gitlab.xml cp ${../../modules/security/acme.xml} configuration/acme.xml + cp ${../../modules/i18n/inputMethod/default.xml} configuration/input-methods.xml ln -s ${optionsDocBook} options-db.xml echo "${version}" > version ''; diff --git a/nixos/modules/i18n/inputMethod/default.xml b/nixos/modules/i18n/inputMethod/default.xml new file mode 100644 index 000000000000..c55ac1ec2456 --- /dev/null +++ b/nixos/modules/i18n/inputMethod/default.xml @@ -0,0 +1,131 @@ +<chapter xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + version="5.0" + xml:id="module-services-input-methods"> + +<title>Input Methods</title> + +<para>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.</para> + +<para>The following input methods are available in NixOS:</para> + +<itemizedlist> + <listitem><para>IBus: The intelligent input bus.</para></listitem> + <listitem><para>Fcitx: A customizable lightweight input + method.</para></listitem> + <listitem><para>Nabi: A Korean input method based on XIM.</para></listitem> + <listitem><para>Uim: The universal input method, is a library with a XIM + bridge.</para></listitem> +</itemizedlist> + +<section><title>IBus</title> + +<para>IBus is an Intelligent Input Bus. It provides full featured and user + friendly input method user interface.</para> + +<para>The following snippet can be used to configure IBus:</para> + +<programlisting> +i18n.inputMethod = { + enabled = "ibus"; + ibus.engines = with pkgs.ibus-engines; [ anthy hangul mozc ]; +}; +</programlisting> + +<para><literal>i18n.inputMethod.ibus.engines</literal> is optional and can be + used to add extra IBus engines.</para> + +<para>Available extra IBus engines are:</para> + +<itemizedlist> + <listitem><para>Anthy (<literal>ibus-engines.anthy</literal>): Anthy is a + system for Japanese input method. It converts Hiragana text to Kana Kanji + mixed text.</para></listitem> + <listitem><para>Hangul (<literal>ibus-engines.hangul</literal>): Korean input + method.</para></listitem> + <listitem><para>m17n (<literal>ibus-engines.m17n</literal>): m17n is an input + method that uses input methods and corresponding icons in the m17n + database.</para></listitem> + <listitem><para>mozc (<literal>ibus-engines.mozc</literal>): A Japanese input + method from Google.</para></listitem> + <listitem><para>Table (<literal>ibus-engines.table</literal>): An input method + that load tables of input methods.</para></listitem> + <listitem><para>table-others (<literal>ibus-engines.table-others</literal>): + Various table-based input methods.</para></listitem> +</itemizedlist> +</section> + +<section><title>Fcitx</title> + +<para>Fcitx is an input method framework with extension support. It has three + built-in Input Method Engine, Pinyin, QuWei and Table-based input + methods.</para> +<para>The following snippet can be used to configure Fcitx:</para> + +<programlisting> +i18n.inputMethod = { + enabled = "fcitx"; + fcitx.engines = with pkgs.fcitx-engines; [ mozc hangul m17n ]; +}; +</programlisting> + +<para><literal>i18n.inputMethod.fcitx.engines</literal> is optional and can be + used to add extra Fcitx engines.</para> + +<para>Available extra Fcitx engines are:</para> + +<itemizedlist> + <listitem><para>Anthy (<literal>fcitx-engines.anthy</literal>): Anthy is a + system for Japanese input method. It converts Hiragana text to Kana Kanji + mixed text.</para></listitem> + <listitem><para>Chewing (<literal>fcitx-engines.chewing</literal>): Chewing is + an intelligent Zhuyin input method. It is one of the most popular input + methods among Traditional Chinese Unix users.</para></listitem> + <listitem><para>Hangul (<literal>fcitx-engines.hangul</literal>): Korean input + method.</para></listitem> + <listitem><para>m17n (<literal>fcitx-engines.m17n</literal>): m17n is an input + method that uses input methods and corresponding icons in the m17n + database.</para></listitem> + <listitem><para>mozc (<literal>fcitx-engines.mozc</literal>): A Japanese input + method from Google.</para></listitem> + <listitem><para>table-others (<literal>fcitx-engines.table-others</literal>): + Various table-based input methods.</para></listitem> +</itemizedlist> +</section> + +<section><title>Nabi</title> + +<para>Nabi is an easy to use Korean X input method. It allows you to enter + phonetic Korean characters (hangul) and pictographic Korean characters + (hanja).</para> +<para>The following snippet can be used to configure Nabi:</para> + +<programlisting> +i18n.inputMethod = { + enabled = "nabi"; +}; +</programlisting> +</section> + +<section><title>Uim</title> + +<para>Uim (short for "universal input method") is a multilingual input method + framework. Applications can use it through so-called bridges.</para> +<para>The following snippet can be used to configure uim:</para> + +<programlisting> +i18n.inputMethod = { + enabled = "uim"; +}; +</programlisting> + +<para>Note: The <literal>i18n.inputMethod.uim.toolbar</literal> option can be + used to choose uim toolbar.</para> + +</section> +</chapter> |