#+title:    :input chinese
#+subtitle: Spend your 3 hours a week in Emacs
#+created:  May 13, 2019
#+since:    21.12.0

* Description :unfold:
This module adds support for traditional Chinese script by introducing two input
methods: Pinyin and Wubi.

** Maintainers
*This module needs a maintainer.* [[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
- +rime ::
  Enables the [[https://rime.im/][rime]] backend for pyim.
- +childframe ::
  Display pyim candidates in a [[https://www.gnu.org/software/emacs/manual/html_node/elisp/Child-Frames.html][child frame]] rather than overlay or tooltip.

** Packages
- [[doom-package:ace-pinyin]]
- [[doom-package:chinese-wbim]] if [[doom-module:+wubi]]
- [[doom-package:evil-pinyin]] if [[doom-module::editor evil +everywhere]]
- [[doom-package:fcitx]]
- [[doom-package:liberime]] if [[doom-module:+rime]]
- [[doom-package:pangu-spacing]]
- [[doom-package:posframe]] if [[doom-module:+childframe]]
- [[doom-package:pyim]] unless [[doom-module:+wubi]]

** Hacks
- ~org-html-paragraph~ has been modified to join consecutive Chinese lines into
  a single long line without wanted spaced (when exporting org-mode to html).

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* TODO Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

#+begin_quote
 󱌣 This module is missing install instructions. [[doom-contrib-module:][Write some?]]
#+end_quote

If you want to use rime as the input method engine:
- Emacs must be built with dynamic module support, i.e. compiled with the
  =--with-modules= option.
- You need =librime= installed on your system.
- You need =make=, =cmake= and a C compiler such as =gcc= so that liberime can
  build =liberime-core.so=.

* TODO Usage
#+begin_quote
 󱌣 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* TODO Configuration
#+begin_quote
 󱌣 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote

** Using fcitx5
Modify ~fcitx-remote-command~ to change the default:

#+begin_src emacs-lisp
;; in $DOOMDIR/config.el
(setq fcitx-remote-command "fcitx5-remote")
#+end_src

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote
