6.4 KiB
:input bidi
Description unfold
This module improves support for bidirectional text (bidi). Enable it if you regularly write with languages that read right-to-left. As bidi support is exceptionally user-specific, read on for additional instructions to customize it to your needs.
Maintainers
Module Flags
This module has no flags.
Packages
This module doesn't install any packages.
Hacks
No hacks documented for this module.
Installation
Enable this module in your doom! block.
This module has no external requirements.
Usage
This module provides +bidi-mode, a minor mode that improves the display of RTL
text by right-aligning lines that start with an RTL language, on a per-line
basis. Since exact use cases vary, turning on this mode is left to the user.
It also provides easy font configuration for Hebrew and Arabic-derived scripts
(Arabic, Persian, Urdu, etc.) in +bidi-hebrew-font and +bidi-arabic-font.
See /emenel/doomemacs/src/commit/a2814629a0f0a21214c532698dbd2e774012c0b4/modules/input/bidi/Fonts for more information. If you use an RTL language that isn't covered by
these characters, open an issue requesting support for it.
To resize fonts, don't include a :size parameter in +bidi-hebrew-font or
+bidi-arabic-font, set +bidi-hebrew-font-scale or +bidi-arabic-font-scale
instead, or add an entry to face-font-rescale-alist for your font. E.g.
;;; Add to $DOOMDIR/config.el
(setq +bidi-arabic-font-scale 1.5)
;; or
(setq +bidi-hebrew-font-scale 2.5)
;; or
(add-to-list 'face-font-rescale-alist '("DejaVu Sans" . 1.2))Configuration
Using +bidi-mode
+bidi-mode is a local minor mode, meaning it has to be turned on a per-buffer
basis.
If you want to have it on for all buffers, use +bidi-global-mode:
;; in $DOOMDIR/config.el
(+bidi-global-mode 1)If you only need it for specific purposes, e.g. editing LaTeX documents, you probably want to enable it through a hook:
(add-hook 'TeX-mode-hook #'+bidi-mode)
This is also useful for adding specific functionality for when +bidi-mode is on.
Force RTL text alignment
By default, +bidi-mode will align paragraphs by the first character with
strong directionality. If you want to force all paragraphs to be aligned
right-to-left when +bidi-mode is on, add the following to your config:
(setq +bidi-paragraph-direction 'right-to-left) Do not do this if you are using
+bidi-global-mode, it will mess up all of the buffers in Emacs that use English, including things like theM-xbuffer.
Input Methods
If bidi support is needed, it's likely that you want to easily switch between English and your favorite RTL language. To do this without losing access to all of the keybindings require English letters, you should use input methods to switch languages instead of changing the system keyboard language. If you use a non-qwerty layout, you will need extra configuration to keep the input method consistent, see here for an example for dvorak.
Toggling the input method bound to C-\. It prompts you to choose an input method the first time you do this in a session, but you bypass this by setting the default input method:
(setq default-input-method "hebrew")Fonts
Many good English fonts lack good coverage for RTL languages, especially for
Hebrew and monospace fonts. To this end, we provide var:+bidi-hebrew-font and
var:+bidi-arabic-font as an easy way to override the default fonts, but only for
Hebrew and Arabic characters. They are set by default to DejaVu Sans, since it
has decent looking Hebrew and Arabic character support.
If you are writing in an Arabic-derived script, such as Persian, Urdu, or Pashto, you may want to change
+bidi-arabic-fontto one specific to your language, especially if you want your script to be written in the Nastaliq style.
If you use an RTL language the script of which isn't covered by the hebrew or
arabic unicode blocks, you can set a font override manually. For example:
(add-hook! 'after-setting-font-hook :append
(set-fontset-font t 'syriac (font-spec :family "DejaVu Sans")))Make sure to use the correct unicode block name, see the documentation of fn:set-fontset-font for more details.
Smart Fontify
Since good bidi fonts are often not monospace (as is the default DejaVu Sans),
It usually looks better to have the surrounding spaces and punctuation in the
use the bidi font as well. This is the default behaviour, but you can turn this
off by setting:
(setq +bidi-want-smart-fontify nil)Change Dictionary Language On Bidi Buffers
If you only use +bidi-mode in specific buffers, you might want to
automatically change the dictionary language there. For example:
(add-hook! '+bidi-mode-hook
(ispell-change-dictionary (if +bidi-mode "hebrew" "default")))Troubleshooting
Nastaliq font display bug
If Emacs is having trouble properly displaying a Nastaliq font, try using one of these two fonts for var:+bidi-arabic-font.
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
This module has no appendix yet. Write one?