From: Ihor Radchenko <yantar92@posteo.net>
To: Greg Minshall <minshall@umich.edu>
Cc: emacs-orgmode@gnu.org
Subject: Re: [BUG] bug in 'ox-man?
Date: Sun, 14 Apr 2024 11:20:28 +0000 [thread overview]
Message-ID: <87cyqsry0z.fsf@localhost> (raw)
In-Reply-To: <2997747.1643675130@apollo2.minshall.org>
[-- Attachment #1: Type: text/plain, Size: 753 bytes --]
Greg Minshall <minshall@umich.edu> writes:
>> #+begin_src bash :results output :exports code :eval never-export
>> echo 'lf "\n"'
>> #+end_src
>
> it seems that `.man` files are in troff(1) format, which uses backslash
> escapes up the wazoo (however that is spelled). it seems that (one way)
> to getting a backslash character through troff is representing it as
> "\e".
>
> for my *particular* instance, where the backslash is in an org src
> block, the below modification to `(org-man-src-block)` may work.
>
> presumably one might have backslash sequences in example blocks, or in
> the main text, or ...? i don't know enough to have any idea if there is
> some general mechanism that might solve all those.
See the attached tentative patch.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-ox-man-Escape-backslash-characters-in-verbatim-examp.patch --]
[-- Type: text/x-patch, Size: 3791 bytes --]
From ef3fa244d1a32c2cce3616a6dffc9c3dcafd4e34 Mon Sep 17 00:00:00 2001
Message-ID: <ef3fa244d1a32c2cce3616a6dffc9c3dcafd4e34.1713093571.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Sun, 14 Apr 2024 14:05:59 +0300
Subject: [PATCH] ox-man: Escape backslash characters in verbatim examples
* lisp/ox-man.el (org-man--protect-example): New helper function
protecting special escape characters inside literal examples.
(org-man-example-block):
(org-man-inline-src-block):
(org-man-src-block):
(org-man-table): Protect contents that is intended to be rendered
verbatim.
Reported-by: Greg Minshall <minshall@umich.edu>
Link: https://orgmode.org/list/2924644.1643637646@apollo2.minshall.org
---
lisp/ox-man.el | 24 ++++++++++++++++--------
1 file changed, 16 insertions(+), 8 deletions(-)
diff --git a/lisp/ox-man.el b/lisp/ox-man.el
index 958740da8..cdd4fea7d 100644
--- a/lisp/ox-man.el
+++ b/lisp/ox-man.el
@@ -293,6 +293,13 @@ (defun org-man--protect-text (text)
"Protect minus and backslash characters in string TEXT."
(replace-regexp-in-string "-" "\\-" text nil t))
+(defun org-man--protect-example (text)
+ "Escape necessary characters for verbatim TEXT."
+ ;; See man groff_man_style; \e must be used to render backslash.
+ ;; Note that groff's .eo (disable backslash) and .ec (re-enable
+ ;; backslash) cannot be used as per the same man page.
+ (replace-regexp-in-string "\\\\" "\\e" text nil t))
+
\f
;;; Template
@@ -400,7 +407,7 @@ (defun org-man-example-block (example-block _contents info)
(org-man--wrap-label
example-block
(format ".RS\n.nf\n%s\n.fi\n.RE"
- (org-export-format-code-default example-block info))))
+ (org-man--protect-example (org-export-format-code-default example-block info)))))
;;; Export Block
@@ -529,11 +536,11 @@ (defun org-man-inline-src-block (inline-src-block _contents info)
(delete-file out-file)
code-block)
(format ".RS\n.nf\n\\fC\\m[black]%s\\m[]\\fP\n.fi\n.RE\n"
- code))))
+ (org-man--protect-example code)))))
;; Do not use a special package: transcode it verbatim.
(t
- (concat ".RS\n.nf\n" "\\fC" "\n" code "\n"
+ (concat ".RS\n.nf\n" "\\fC" "\n" (org-man--protect-example code) "\n"
"\\fP\n.fi\n.RE\n")))))
@@ -749,7 +756,7 @@ (defun org-man-src-block (src-block _contents info)
contextual information."
(if (not (plist-get info :man-source-highlight))
(format ".RS\n.nf\n\\fC%s\\fP\n.fi\n.RE\n\n"
- (org-export-format-code-default src-block info))
+ (org-man--protect-example (org-export-format-code-default src-block info)))
(let* ((tmpdir temporary-file-directory)
(in-file (make-temp-name (expand-file-name "srchilite" tmpdir)))
(out-file (make-temp-name (expand-file-name "reshilite" tmpdir)))
@@ -772,7 +779,7 @@ (defun org-man-src-block (src-block _contents info)
(delete-file in-file)
(delete-file out-file)
code-block)
- (format ".RS\n.nf\n\\fC\\m[black]%s\\m[]\\fP\n.fi\n.RE" code)))))
+ (format ".RS\n.nf\n\\fC\\m[black]%s\\m[]\\fP\n.fi\n.RE" (org-man--protect-example code))))))
;;; Statistics Cookie
@@ -836,9 +843,10 @@ (defun org-man-table (table contents info)
(format ".nf\n\\fC%s\\fP\n.fi"
;; Re-create table, without affiliated keywords.
- (org-trim
- (org-element-interpret-data
- `(table nil ,@(org-element-contents table))))))
+ (org-man--protect-example
+ (org-trim
+ (org-element-interpret-data
+ `(table nil ,@(org-element-contents table)))))))
;; Case 2: Standard table.
(t (org-man-table--org-table table contents info))))
--
2.44.0
[-- Attachment #3: Type: text/plain, Size: 224 bytes --]
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2024-04-14 11:21 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-31 14:00 [BUG] bug in 'ox-man? Greg Minshall
2022-02-01 0:25 ` Greg Minshall
2024-04-14 11:20 ` Ihor Radchenko [this message]
2024-04-26 9:45 ` Ihor Radchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87cyqsry0z.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=minshall@umich.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).