From: Max Nikulin <manikulin@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org.el: Warning for unsupported markers in `org-set-emphasis-alist'
Date: Wed, 24 Nov 2021 00:05:04 +0700 [thread overview]
Message-ID: <snj702$15ms$1@ciao.gmane.io> (raw)
In-Reply-To: <87pmqtj09r.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 1989 bytes --]
On 21/11/2021 17:01, Ihor Radchenko wrote:
> Max Nikulin writes:
>
>> My draft version is attached. Ihor, thank you for inspiration. Feel free
>> to improve it. I hope, it makes problem more apparent to user who tries
>> to customize markers.
A patch is attached. I have dropped changes in documentation since I am
not the author of them.
For init file (entries may be in arbitrary order)
(custom-set-variables
'(org-emphasis-alist
(quote
(
("*" bold)
("_" underline)
("=" org-verbatim verbatim)
("/" italic)
("~" org-code verbatim)
("!" org-todo) ;; does not work
("+" (:strike-through t)))))
)
emacs --eval "(customize-variable 'org-emphasis-alist)"
looks as the following
Hide Org Emphasis Alist:
[INS] [DEL] :
Marker: [Value Menu] *Bold*
Font: [Value Menu] Face: (sample) bold
[ ] verbatim
[INS] [DEL] :
Marker: [Value Menu] _Underline_
Font: [Value Menu] Face: (sample) underline
[ ] verbatim
[INS] [DEL] :
Marker: [Value Menu] =Verbatim=
Font: [Value Menu] Face: (sample) org-verbatim
[X] verbatim
[INS] [DEL] :
Marker: [Value Menu] /Italic/
Font: [Value Menu] Face: (sample) italic
[ ] verbatim
[INS] [DEL] :
Marker: [Value Menu] ~Code~
Font: [Value Menu] Face: (sample) org-code
[X] verbatim
[INS] [DEL] :
Marker: [Value Menu] Unsupported ignored character: !
Font: [Value Menu] Face: (sample) org-todo
[ ] verbatim
[INS] [DEL] :
Marker: [Value Menu] +Strike-through+
Font: [Value Menu] Property list:
[INS] [DEL] :
Key: :strike-through
Value: t
[INS]
[ ] verbatim
[INS]
[ State ]: SAVED and set.
[-- Attachment #2: 0001-org.el-Warning-for-unsupported-markers-in-org-set-em.patch --]
[-- Type: text/x-patch, Size: 3361 bytes --]
From 1ee52f7ffc1039fd442775e9267403f1dca86b88 Mon Sep 17 00:00:00 2001
From: Max Nikulin <manikulin@gmail.com>
Date: Mon, 22 Nov 2021 23:56:15 +0700
Subject: [PATCH] org.el: Warning for unsupported markers in
`org-set-emphasis-alist'
* lisp/org.el (org-emphasis-alist, org-set-emphasis-alist): Change
custom variable type definition and add :set parameter to warn users
that non-standard marker characters are ignored.
Attempts to introduce new markers have been discussed enough times to
add some code that should prevent wasting of time.
Unfortunately there is no way to issue warning for e.g. `setq'.
---
lisp/org.el | 47 +++++++++++++++++++++++++++++++++++++++++------
1 file changed, 41 insertions(+), 6 deletions(-)
diff --git a/lisp/org.el b/lisp/org.el
index df3d139c7..1a65b6db8 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -3771,6 +3771,25 @@ newline The maximum number of newlines allowed in an emphasis exp.
You need to reload Org or to restart Emacs after setting this.")
+(defun org-set-emphasis-alist (var value)
+ "Set VAR (`org-emphasis-alist') to VALUE and check it for ignored characters.
+Warn user that Org syntax can not be extended with new emphasis markers
+if such attempt is detected. The function is intended for :set argument
+of `defcustom'."
+ (set var value)
+ (let ((unsupported
+ (delq nil
+ (mapcar
+ (lambda (entry)
+ (let ((marker (car entry)))
+ (unless (member marker '("*" "/" "_" "=" "~" "+")) marker)))
+ value))))
+ (when unsupported
+ (message "Warning! Unsupported markup characters '%s' detected in `%s'"
+ (mapconcat #'identity unsupported " ")
+ (symbol-name var))))
+ value)
+
(defcustom org-emphasis-alist
'(("*" bold)
("/" italic)
@@ -3784,18 +3803,34 @@ for example *bold*, _underlined_ and /italic/. This variable sets the
marker characters and the face to be used by font-lock for highlighting
in Org buffers.
+Do not change the characters and do not add new ones to use custom
+markers for existing styles or to introduce new styles. Org syntax is
+not meant to be configurable and such modifications will not work with
+export.
+
You need to reload Org or to restart Emacs after customizing this."
:group 'org-appearance
:set 'org-set-emph-re
:version "24.4"
:package-version '(Org . "8.0")
+ :set #'org-set-emphasis-alist
:type '(repeat
- (list
- (string :tag "Marker character")
- (choice
- (face :tag "Font-lock-face")
- (plist :tag "Face property list"))
- (option (const verbatim)))))
+ (group
+ (choice
+ :tag "Marker"
+ (const :tag "*Bold*" "*")
+ (const :tag "/Italic/" "/")
+ (const :tag "_Underline_" "_")
+ (const :tag "+Strike-through+" "+")
+ (const :tag "=Verbatim=" "=")
+ (const :tag "~Code~" "~")
+ ;; To warn users that it does not work.
+ (string :tag "Unsupported ignored character"))
+ (choice
+ :tag "Font"
+ (face :tag "Face")
+ (plist :tag "Property list"))
+ (option (const verbatim)))))
(defvar org-protecting-blocks '("src" "example" "export")
"Blocks that contain text that is quoted, i.e. not processed as Org syntax.
--
2.25.1
next prev parent reply other threads:[~2021-11-23 17:06 UTC|newest]
Thread overview: 41+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-15 0:53 c47b535bb origin/main org-element: Remove dependency on ‘org-emphasis-regexp-components’ Ihor Radchenko
2021-11-15 9:56 ` Nicolas Goaziou
2021-11-15 15:20 ` Ihor Radchenko
2021-11-15 16:25 ` Max Nikulin
2021-11-16 7:43 ` Ihor Radchenko
2021-11-16 21:56 ` Samuel Wales
2021-11-16 22:16 ` Samuel Wales
2021-11-17 16:44 ` Max Nikulin
2021-11-17 22:44 ` Samuel Wales
2021-11-18 12:25 ` Ihor Radchenko
2021-11-18 12:35 ` Nicolas Goaziou
2021-11-18 12:55 ` Ihor Radchenko
2021-11-19 8:18 ` Nicolas Goaziou
2021-11-19 11:38 ` [PATCH] " Ihor Radchenko
2021-11-19 12:37 ` Nicolas Goaziou
2021-11-19 13:53 ` Ihor Radchenko
2021-11-20 18:25 ` Nicolas Goaziou
2021-11-21 9:28 ` Ihor Radchenko
2021-11-22 18:44 ` Nicolas Goaziou
2021-11-23 14:28 ` Ihor Radchenko
2021-11-27 12:16 ` org parser and priorities of inline elements Max Nikulin
2021-11-27 19:02 ` Nicolas Goaziou
2023-07-17 11:51 ` Org markup and non-ASCII punctuation (was: org parser and priorities of inline elements) Ihor Radchenko
2023-07-18 0:03 ` Tom Gillespie
2023-07-18 5:07 ` Ihor Radchenko
2023-07-18 5:40 ` Tom Gillespie
2023-07-18 9:45 ` Ihor Radchenko
2021-11-19 16:34 ` c47b535bb origin/main org-element: Remove dependency on ‘org-emphasis-regexp-components’ Max Nikulin
2021-11-20 12:02 ` Max Nikulin
2021-11-21 10:01 ` Ihor Radchenko
2021-11-21 16:36 ` Max Nikulin
2021-11-23 17:05 ` Max Nikulin [this message]
2022-11-04 6:53 ` [PATCH] org.el: Warning for unsupported markers in `org-set-emphasis-alist' Ihor Radchenko
2022-11-04 12:31 ` Max Nikulin
2022-11-05 8:21 ` Ihor Radchenko
2023-02-02 10:53 ` [PATCH v5] " Ihor Radchenko
2023-02-06 15:11 ` Max Nikulin
2023-02-06 16:49 ` Max Nikulin
2023-02-07 10:47 ` Should we obsolete org-emphasis-alist? (was: [PATCH v5] org.el: Warning for unsupported markers in `org-set-emphasis-alist') Ihor Radchenko
2023-02-07 12:22 ` Timothy
2023-02-09 12:11 ` Max Nikulin
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='snj702$15ms$1@ciao.gmane.io' \
--to=manikulin@gmail.com \
--cc=emacs-orgmode@gnu.org \
/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).