pyrox.dev
doc/builders/packages/ibus.xml: Convert to markdown
Signed-off-by: Bryan A. S <bryanasdev000@gmail.com>
+38
doc/builders/packages/ibus.section.md
+38
doc/builders/packages/ibus.section.md
···
1
+
# ibus-engines.typing-booster {#sec-ibus-typing-booster}
2
+
3
+
This package is an ibus-based completion method to speed up typing.
4
+
5
+
## Activating the engine {#sec-ibus-typing-booster-activate}
6
+
7
+
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).
8
+
9
+
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:
10
+
11
+
```nix
12
+
{ pkgs, ... }: {
13
+
i18n.inputMethod = {
14
+
enabled = "ibus";
15
+
ibus.engines = with pkgs.ibus-engines; [ typing-booster ];
16
+
};
17
+
}
18
+
```
19
+
20
+
## Using custom hunspell dictionaries {#sec-ibus-typing-booster-customize-hunspell}
21
+
22
+
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:
23
+
24
+
```nix
25
+
ibus-engines.typing-booster.override { langs = [ "de-at" "en-gb" ]; }
26
+
```
27
+
28
+
_Note: each language passed to `langs` must be an attribute name in `pkgs.hunspellDicts`._
29
+
30
+
## Built-in emoji picker {#sec-ibus-typing-booster-emoji-picker}
31
+
32
+
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:
33
+
34
+
On NixOS it can be installed using the following expression:
35
+
36
+
```nix
37
+
{ pkgs, ... }: { fonts.fonts = with pkgs; [ noto-fonts-emoji ]; }
38
+
```
-57
doc/builders/packages/ibus.xml
-57
doc/builders/packages/ibus.xml
···
1
-
<section xmlns="http://docbook.org/ns/docbook"
2
-
xmlns:xlink="http://www.w3.org/1999/xlink"
3
-
xml:id="sec-ibus-typing-booster">
4
-
<title>ibus-engines.typing-booster</title>
5
-
6
-
<para>
7
-
This package is an ibus-based completion method to speed up typing.
8
-
</para>
9
-
10
-
<section xml:id="sec-ibus-typing-booster-activate">
11
-
<title>Activating the engine</title>
12
-
13
-
<para>
14
-
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>.
15
-
</para>
16
-
17
-
<para>
18
-
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:
19
-
<programlisting>{ pkgs, ... }: {
20
-
i18n.inputMethod = {
21
-
enabled = "ibus";
22
-
ibus.engines = with pkgs.ibus-engines; [ typing-booster ];
23
-
};
24
-
}</programlisting>
25
-
</para>
26
-
</section>
27
-
28
-
<section xml:id="sec-ibus-typing-booster-customize-hunspell">
29
-
<title>Using custom hunspell dictionaries</title>
30
-
31
-
<para>
32
-
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:
33
-
<programlisting>ibus-engines.typing-booster.override {
34
-
langs = [ "de-at" "en-gb" ];
35
-
}</programlisting>
36
-
</para>
37
-
38
-
<para>
39
-
<emphasis>Note: each language passed to <literal>langs</literal> must be an attribute name in <literal>pkgs.hunspellDicts</literal>.</emphasis>
40
-
</para>
41
-
</section>
42
-
43
-
<section xml:id="sec-ibus-typing-booster-emoji-picker">
44
-
<title>Built-in emoji picker</title>
45
-
46
-
<para>
47
-
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:
48
-
</para>
49
-
50
-
<para>
51
-
On NixOS it can be installed using the following expression:
52
-
<programlisting>{ pkgs, ... }: {
53
-
fonts.fonts = with pkgs; [ noto-fonts-emoji ];
54
-
}</programlisting>
55
-
</para>
56
-
</section>
57
-
</section>
+1
-1
doc/builders/packages/index.xml
+1
-1
doc/builders/packages/index.xml
···
12
12
<xi:include href="emacs.section.xml" />
13
13
<xi:include href="firefox.section.xml" />
14
14
<xi:include href="fish.section.xml" />
15
-
<xi:include href="ibus.xml" />
15
+
<xi:include href="ibus.section.xml" />
16
16
<xi:include href="kakoune.section.xml" />
17
17
<xi:include href="linux.section.xml" />
18
18
<xi:include href="locales.section.xml" />