From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id 8MBuAzTKb2fRowAAqHPOHw:P1 (envelope-from ) for ; Sat, 28 Dec 2024 09:51:48 +0000 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0.migadu.com with LMTPS id 8MBuAzTKb2fRowAAqHPOHw (envelope-from ) for ; Sat, 28 Dec 2024 10:51:48 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=breatheoutbreathe.in header.s=key1 header.b="bfRXspM/"; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=quarantine) header.from=breatheoutbreathe.in ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1735379508; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=LjLFKE+0O+nEZXn2w3NoVYfhgJzEZvsLLydOCt1NrF4=; b=qsXjYjXgbbBv9QAGWRSM/aB63YBn2BnmmmqcfDAheb7ykqInEJzbZBOdcrZLlRFSC6mh6/ NTobOfabqrs3MOc8x9l6055mDFKOTY1RGTZCNq9vmRAi8QVM9gEuuAIpk3C1fikWPF2Z1D oNpXeET+PJnVK+FW7Olwb5/EVcjuws1FgWRE78s+NcjIV+kRgj2GrryfthGGb47AnWuI/l 443Sqp/AMmvXvg0ayvGhvJ6PxQBCIFJVgxKatJAHyGHu9qUI4g7uAEHtbXv7QUlofKvSW+ yHGlOL+KODmLL2/CLxSr2pilIzA3HOh24uqMc3DLZ/ImAzG7fFa7qmvpr8QGIQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=breatheoutbreathe.in header.s=key1 header.b="bfRXspM/"; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=quarantine) header.from=breatheoutbreathe.in ARC-Seal: i=1; s=key1; d=yhetil.org; t=1735379508; a=rsa-sha256; cv=none; b=qr06k9JxuPOWXYdkvJ5lC+xvubd8+AmuCcVz041/kpVDGCbg3BEUeMm++aDLqm8nXWSJnt sFFn5W6WRlGLehkM2BjDgPfDBDirk/lTNe/Heiq4chb/+Yg32UmfuR6g5Vs9uCuwlMLR9R qiNzrqLQh55hLhazMBKfIkqjrlkXAuNKznrLFUDPGHpCz3JBarU3v6/2r5v3VsE5cKy0lu EFKS7rvFbnkndv794JeUbLRqpWqi2xyvn6aGvTdy6pkoYo+2UvGSsZYk5yjs0L5O7EOeK4 v9cPWwnxzT9lsi1y5B/bgbQagv4HbQ+RciMIg4CpYwDX3/8ULWlW0iTe4BwqCw== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 1FAB526104 for ; Sat, 28 Dec 2024 10:51:45 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tRTT1-0000ov-Gu; Sat, 28 Dec 2024 04:50:43 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tRTT0-0000oi-BO for emacs-orgmode@gnu.org; Sat, 28 Dec 2024 04:50:42 -0500 Received: from out-186.mta1.migadu.com ([95.215.58.186]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tRTSx-0008SV-LV for emacs-orgmode@gnu.org; Sat, 28 Dec 2024 04:50:41 -0500 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=breatheoutbreathe.in; s=key1; t=1735379436; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=LjLFKE+0O+nEZXn2w3NoVYfhgJzEZvsLLydOCt1NrF4=; b=bfRXspM/O692XG1ucAE1mNG/DZcwxpXFVzxheoaRsJm1x1gn/lLMrLuJlbEM+F8MlUFU45 SkzKZDchkWWs5KuEPXbBDHUVAmqG/m4K3j1Fa33yAHH8n4oniDz+3NCpEYGgv7iYnUYTs7 lvAWv+CpilXtC06eBDhGRe10g+A0i0Y= From: Joseph Turner To: Ihor Radchenko Cc: Christian Moe , Org Mode Mailing List , Bohong Huang Subject: Re: Form feed characters break odt export In-Reply-To: <871pxs438i.fsf@localhost> (Ihor Radchenko's message of "Sat, 28 Dec 2024 08:32:29 +0000") References: <87ed21hkmi.fsf@breatheoutbreathe.in> <87ikrajoe4.fsf@localhost> <87o711l4u4.fsf@christianmoe.com> <87jzbpgocm.fsf@localhost> <878qs4oyyh.fsf@breatheoutbreathe.in> <87plld5svl.fsf@localhost> <87jzbk503b.fsf@breatheoutbreathe.in> <871pxs438i.fsf@localhost> Date: Sat, 28 Dec 2024 01:50:32 -0800 Message-ID: <87frm8kufr.fsf@breatheoutbreathe.in> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Received-SPF: pass client-ip=95.215.58.186; envelope-from=joseph@breatheoutbreathe.in; helo=out-186.mta1.migadu.com X-Spam_score_int: -27 X-Spam_score: -2.8 X-Spam_bar: -- X-Spam_report: (-2.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -2.53 X-Spam-Score: -2.53 X-Migadu-Queue-Id: 1FAB526104 X-TUID: B3HXW5j3dKov Ihor Radchenko writes: > Joseph Turner writes: > >> From ce506caa0bffbd243a2aba384f75f7aaac7fdc4b Mon Sep 17 00:00:00 2001 >> From: Ihor Radchenko >> Date: Fri, 27 Dec 2024 10:21:02 +0000 >> Subject: [PATCH] ox-odt: Avoid putting forbidden characters into ODT xml > > Thanks for helping with the patch! > I modified it further, adding ORG-NEWS entry announcing the new export > option. > > From 89901da3a0d00598c5ac40cddb2f6dec7c7047cf Mon Sep 17 00:00:00 2001 > Message-ID: <89901da3a0d00598c5ac40cddb2f6dec7c7047cf.1735374641.git.yant= ar92@posteo.net> > From: Ihor Radchenko > Date: Fri, 27 Dec 2024 10:21:02 +0000 > Subject: [PATCH v3] ox-odt: Avoid putting forbidden characters into ODT x= ml > > * lisp/ox-odt.el (org-odt-with-forbidden-chars): New export option to > control how to handle forbidden XML characters. > (org-odt--remove-forbidden): New filter removing/replacing forbidden > characters. > * etc/ORG-NEWS (ox-odt: New export option > ~org-odt-with-forbidden-chars~): Announce the new option. > > Co-authored-by: Joseph Turner > Link: https://orgmode.org/list/87o711l4u4.fsf@christianmoe.com > --- > etc/ORG-NEWS | 16 ++++++++++++++++ > lisp/ox-odt.el | 51 +++++++++++++++++++++++++++++++++++++++++++++++++- > 2 files changed, 66 insertions(+), 1 deletion(-) > > diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS > index d26813c983..a56e105481 100644 > --- a/etc/ORG-NEWS > +++ b/etc/ORG-NEWS > @@ -182,6 +182,22 @@ now be pasted as an Org table using ~yank-media~. > # adding new customizations, or changing the interpretation of the > # existing customizations. > > +*** ox-odt: New export option ~org-odt-with-forbidden-chars~ > + > +The new export option controls how to deal with characters that are forb= idden > +inside ODT documents during export. > + > +The ODT documents must follow XML1.0 specification and cannot contain > +certain unicode characters. For example, form feed characters like ^L > +are disallowed. > + > +By default, =3Dox-odt=3D will strip such characters and display warning. > +You may return to the previous behaviour by setting > +~org-odt-with-forbidden-chars~ to t. > + > +Note that Emacs warnings can always be suppressed by clicking on =E2=9B= =94 > +symbol or by customizing ~warning-suppress-types~. > + > *** New option ~org-edit-keep-region~ > > Since Org 9.7, structure editing commands do not deactivate region > diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el > index ec81637ef0..960bab286a 100644 > --- a/lisp/ox-odt.el > +++ b/lisp/ox-odt.el > @@ -94,7 +94,8 @@ (org-export-define-backend 'odt > . (org-odt--translate-latex-fragments > org-odt--translate-description-lists > org-odt--translate-list-tables > - org-odt--translate-image-links))) > + org-odt--translate-image-links)) > + (:filter-final-output . org-odt--remove-forbidden)) > :menu-entry > '(?o "Export to ODT" > ((?o "As ODT file" org-odt-export-to-odt) > @@ -108,6 +109,7 @@ (org-export-define-backend 'odt > (:keywords "KEYWORDS" nil nil space) > (:subtitle "SUBTITLE" nil nil parse) > ;; Other variables. > + (:odt-with-forbidden-chars nil nil org-odt-with-forbidden-chars) > (:odt-content-template-file nil nil org-odt-content-template-file) > (:odt-display-outline-level nil nil org-odt-display-outline-level) > (:odt-fontify-srcblocks nil nil org-odt-fontify-srcblocks) > @@ -170,6 +172,14 @@ (defconst org-odt-special-string-regexps > ("\\.\\.\\." . "…")) ; hellip > "Regular expressions for special string conversion.") > > +(defconst org-odt-forbidden-char-re > + (rx (not (in ?\N{U+9} ?\N{U+A} ?\N{U+D} > + (?\N{U+20} . ?\N{U+D7FF}) > + (?\N{U+E000} . ?\N{U+FFFD}) > + (?\N{U+10000} . ?\N{U+10FFFF})))) > + "Regexp matching forbidden XML1.0 characters. > +https://www.w3.org/TR/REC-xml/#charsets") > + > (defconst org-odt-schema-dir-list > (list (expand-file-name "./schema/" org-odt-data-dir)) > "List of directories to search for OpenDocument schema files. > @@ -364,6 +374,19 @@ (defgroup org-export-odt nil > :tag "Org Export ODT" > :group 'org-export) > > +(defcustom org-odt-with-forbidden-chars "" > + "String to replace forbidden XML characters. > +When set to t, forbidden characters are left as-is. > +When set to nil, an error is thrown. > +See `org-odt-forbidden-char-re' for the list of forbidden characters > +that cannot occur inside ODT documents. > + > +You may also consider export filters to perform more fine-grained > +replacements. See info node `(org)Advanced Export Configuration'." > + :package-version '(Org . "9.8") > + :type '(choice (const :tag "Leave forbidden characters as-is" t) > + (const :tag "Err when forbidden characters encountered"= nil) > + (string :tag "Replacement string"))) > > ;;;; Debugging > > @@ -2892,6 +2915,32 @@ (defun org-odt--encode-tabs-and-spaces (line) > (format " " (1- (length s))))) > line)) > > +(defun org-odt--remove-forbidden (text _backend info) > + "Remove forbidden and discouraged characters from TEXT. > +INFO is the communication plist" > + (pcase-exhaustive (plist-get info :odt-with-forbidden-chars) > + ((and (pred stringp) rep) > + (let ((replacements (make-hash-table :test 'equal))) > + (with-temp-buffer > + (insert text) > + (goto-char (point-min)) > + (while (re-search-forward org-odt-forbidden-char-re nil t) > + (cl-incf (gethash (match-string 0) replacements 0)) > + (replace-match rep)) > + (cl-loop for forbidden being the hash-keys of replacements > + using (hash-values count) > + do (display-warning > + '(ox-odt ox-odt-with-forbidden-chars) > + (format "Replaced forbidden character '%s' with '%= s' %d times" > + forbidden rep count))) > + (buffer-string)))) > + (`nil > + (if (string-match org-odt-forbidden-char-re text) > + (error "Forbidden character '%s' found. See `org-odt-with-forb= idden-chars'" > + (match-string 0 text)) > + text)) > + ('t text))) > + > (defun org-odt--encode-plain-text (text &optional no-whitespace-filling) > (dolist (pair '(("&" . "&") ("<" . "<") (">" . ">"))) > (setq text (replace-regexp-in-string (car pair) (cdr pair) text t t)= )) > -- > 2.47.1 LGTM! TIL about clicking on =E2=9B=94 and warning-suppress-types. Thank y= ou! Joseph