diff options
author | Sandro <sandro.jaeckel@gmail.com> | 2021-03-21 05:35:04 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-03-21 05:35:04 +0100 |
commit | faa954116589117b2f566c9c1f47e45a3748d313 (patch) | |
tree | e522a7765ec6de98ae4f06ffd5b1d96287246ec2 /doc | |
parent | f1151658182e6f602b59fbc35280f17ac984afa2 (diff) | |
parent | 8bb00cfb6bb78b3313d57ea4b112062244ab1e41 (diff) |
Merge pull request #108921 from bryanasdev000/doc-ibus
ibus: Update doc to use CommonMark
Diffstat (limited to 'doc')
-rw-r--r-- | doc/builders/packages/ibus.section.md | 38 | ||||
-rw-r--r-- | doc/builders/packages/ibus.xml | 57 | ||||
-rw-r--r-- | doc/builders/packages/index.xml | 2 |
3 files changed, 39 insertions, 58 deletions
diff --git a/doc/builders/packages/ibus.section.md b/doc/builders/packages/ibus.section.md new file mode 100644 index 000000000000..2ce85467bb86 --- /dev/null +++ b/doc/builders/packages/ibus.section.md @@ -0,0 +1,38 @@ +# ibus-engines.typing-booster {#sec-ibus-typing-booster} + +This package is an ibus-based completion method to speed up typing. + +## Activating the engine {#sec-ibus-typing-booster-activate} + +IBus needs to be configured accordingly to activate `typing-booster`. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the [upstream docs](https://mike-fabian.github.io/ibus-typing-booster/documentation.html). + +On NixOS you need to explicitly enable `ibus` with given engines before customizing your desktop to use `typing-booster`. This can be achieved using the `ibus` module: + +```nix +{ pkgs, ... }: { + i18n.inputMethod = { + enabled = "ibus"; + ibus.engines = with pkgs.ibus-engines; [ typing-booster ]; + }; +} +``` + +## Using custom hunspell dictionaries {#sec-ibus-typing-booster-customize-hunspell} + +The IBus engine is based on `hunspell` to support completion in many languages. By default the dictionaries `de-de`, `en-us`, `fr-moderne` `es-es`, `it-it`, `sv-se` and `sv-fi` are in use. To add another dictionary, the package can be overridden like this: + +```nix +ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; } +``` + +_Note: each language passed to `langs` must be an attribute name in `pkgs.hunspellDicts`._ + +## Built-in emoji picker {#sec-ibus-typing-booster-emoji-picker} + +The `ibus-engines.typing-booster` package contains a program named `emoji-picker`. To display all emojis correctly, a special font such as `noto-fonts-emoji` is needed: + +On NixOS it can be installed using the following expression: + +```nix +{ pkgs, ... }: { fonts.fonts = with pkgs; [ noto-fonts-emoji ]; } +``` diff --git a/doc/builders/packages/ibus.xml b/doc/builders/packages/ibus.xml deleted file mode 100644 index 2ed37903a273..000000000000 --- a/doc/builders/packages/ibus.xml +++ /dev/null @@ -1,57 +0,0 @@ -<section xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xml:id="sec-ibus-typing-booster"> - <title>ibus-engines.typing-booster</title> - - <para> - This package is an ibus-based completion method to speed up typing. - </para> - - <section xml:id="sec-ibus-typing-booster-activate"> - <title>Activating the engine</title> - - <para> - IBus needs to be configured accordingly to activate <literal>typing-booster</literal>. The configuration depends on the desktop manager in use. For detailed instructions, please refer to the <link xlink:href="https://mike-fabian.github.io/ibus-typing-booster/documentation.html">upstream docs</link>. - </para> - - <para> - On NixOS you need to explicitly enable <literal>ibus</literal> with given engines before customizing your desktop to use <literal>typing-booster</literal>. This can be achieved using the <literal>ibus</literal> module: -<programlisting>{ pkgs, ... }: { - i18n.inputMethod = { - enabled = "ibus"; - ibus.engines = with pkgs.ibus-engines; [ typing-booster ]; - }; -}</programlisting> - </para> - </section> - - <section xml:id="sec-ibus-typing-booster-customize-hunspell"> - <title>Using custom hunspell dictionaries</title> - - <para> - The IBus engine is based on <literal>hunspell</literal> to support completion in many languages. By default the dictionaries <literal>de-de</literal>, <literal>en-us</literal>, <literal>fr-moderne</literal> <literal>es-es</literal>, <literal>it-it</literal>, <literal>sv-se</literal> and <literal>sv-fi</literal> are in use. To add another dictionary, the package can be overridden like this: -<programlisting>ibus-engines.typing-booster.override { - langs = [ "de-at" "en-gb" ]; -}</programlisting> - </para> - - <para> - <emphasis>Note: each language passed to <literal>langs</literal> must be an attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis> - </para> - </section> - - <section xml:id="sec-ibus-typing-booster-emoji-picker"> - <title>Built-in emoji picker</title> - - <para> - The <literal>ibus-engines.typing-booster</literal> package contains a program named <literal>emoji-picker</literal>. To display all emojis correctly, a special font such as <literal>noto-fonts-emoji</literal> is needed: - </para> - - <para> - On NixOS it can be installed using the following expression: -<programlisting>{ pkgs, ... }: { - fonts.fonts = with pkgs; [ noto-fonts-emoji ]; -}</programlisting> - </para> - </section> -</section> diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index fac82180b260..e1e2fef3f16a 100644 --- a/doc/builders/packages/index.xml +++ b/doc/builders/packages/index.xml @@ -12,7 +12,7 @@ <xi:include href="emacs.section.xml" /> <xi:include href="firefox.section.xml" /> <xi:include href="fish.section.xml" /> - <xi:include href="ibus.xml" /> + <xi:include href="ibus.section.xml" /> <xi:include href="kakoune.section.xml" /> <xi:include href="linux.section.xml" /> <xi:include href="locales.section.xml" /> |