-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
input-methods: add documentation #14602
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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> |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I didn't notice this one; this won't work, because you didn't actually change the option name (it is independent of the folder name).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@joachifm Should I make a new PR to fix that or can it be fixed by amending the commit?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I pushed a hotfix, no worries
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This really is the kind of error that travis should pick up on ... oh well
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!