docs: add note about RTL text in chatbufs

Fixes #421
zevlg · Aug 8, 2023 · ce21c3b · ce21c3b
1 parent c9d51f2
commit ce21c3b
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 15 deletions.
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/telega-manual.org b/docs/telega-manual.org
@@ -1,5 +1,5 @@
 #+options: timestamp:nil \n:t num:nil ellit-cid:t
-#+title: Telega Manual (v0.8.150)
+#+title: Telega Manual (v0.8.151)
 #+author: Zajcev Evgeny
 #+startup: showall
 
@@ -1828,6 +1828,13 @@ to send.  Press
 @@html:<kbd>@@i@@html:</kbd>@@, @@html:<kbd>@@<down-mouse-3> <describe>@@html:</kbd>@@ (~telega-describe-message~) to
 get detailed description of the message at point.
 
+Note for
+[[https://en.wikipedia.org/wiki/Right-to-left_script][RTL]] users:
+unlike rootbuf, chatbufs disables bidirectional display reordering
+by default, so RTL text will look reversed in chatbufs.  To enable
+bidi in chatbufs customize your
+~telega-chat-bidi-display-reordering~ user option.
+
 Important customizable options:
 - User Option: ~telega-chat-fill-column~ 
 

diff --git a/telega-chat.el b/telega-chat.el
@@ -26,6 +26,13 @@
 ;; to send.  Press
 ;; {{{where-is(telega-describe-message,telega-msg-button-map)}}} to
 ;; get detailed description of the message at point.
+;; 
+;; Note for
+;; [[https://en.wikipedia.org/wiki/Right-to-left_script][RTL]] users:
+;; unlike rootbuf, chatbufs disables bidirectional display reordering
+;; by default, so RTL text will look reversed in chatbufs.  To enable
+;; bidi in chatbufs customize your
+;; ~telega-chat-bidi-display-reordering~ user option.
 
 ;;; Code:
 (require 'cl-lib)