Nicolas Goaziou <m...@nicolasgoaziou.fr> writes:
> Hello,
>
> Eric Abrahamsen <e...@ericabrahamsen.net> writes:
>
>> Kaushal Modi <kaushal.m...@gmail.com> writes:
>
>>> I just tried it out, and it works great!
>>>
>>> I have a comment about
>>>
>>> (when (string-equal (downcase type) "example")
>>> (org-escape-code-in-region s e))
>>>
>>> I have never needed to escape org in example, blocks, but I *have* needed
>>> to do that in org src blocks.
>>>
>>> Should type string be also matched with "src org"?
>>>
>>> Actually should the type string be matched only with "src org"? Because I
>>> see the Org example blocks as <pre> <code> blocks in HTML with no syntax
>>> highlighting.. so
>>> those can contain code from any language.
>>>
>>> Also as this is part of org and emacs, org-structure-predefined-blocks
>>> deserves "SRC org" and "SRC emacs-lisp" too? :)
>>
>> The template really only inserts the block type, not anything specific
>> like the source language or export backend. I think prompting for
>> "second-level" information like that might be a little overkill.
>>
>> As for what should be escaped and what shouldn't, I defer to Nicolas,
>> let's see what he says.
>
> "src" (not only with "org" language), "example" and "export", i.e.,
> verbatim, blocks need to be escaped.
>
> You should probably use something like
>
> (when (string-prefix-p (regexp-opt '("example" "export" "src")) type t)
> ...)
string-prefix-p doesn't appear to work with regular expressions, so I
used string-match-p.
>From 1ef3404310f516d1f762501b2bb974220a61da1d Mon Sep 17 00:00:00 2001
From: Eric Abrahamsen <e...@ericabrahamsen.net>
Date: Sat, 7 Oct 2017 13:01:14 -0700
Subject: [PATCH] New function org-insert-structure-template
* lisp/org.el (org-insert-structure-template): New function for
wrapping region (or element at point) in a begin/end block.
(org-structure-predefined-blocks): New option holding predefined
blocks, for completion.
* doc/org.texi (Structure of code blocks, Easy templates): And in
manual.
* testing/lisp/test-org.el (test-org/insert-template): New test.
---
doc/org.texi | 21 +++++++++++++++------
etc/ORG-NEWS | 4 ++++
lisp/org.el | 49 ++++++++++++++++++++++++++++++++++++++++++++++++
testing/lisp/test-org.el | 42 +++++++++++++++++++++++++++++++++++++++++
4 files changed, 110 insertions(+), 6 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index c54f2615a..6ad9d1c15 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -15242,12 +15242,13 @@ A @samp{src} block conforms to this structure:
#+END_SRC
@end example
-Org mode's templates system (@pxref{Easy templates}) speeds up creating
-@samp{src} code blocks with just three keystrokes. Do not be put-off by
-having to remember the source block syntax. Org also works with other
-completion systems in Emacs, some of which predate Org and have custom
-domain-specific languages for defining templates. Regular use of templates
-reduces errors, increases accuracy, and maintains consistency.
+Do not be put off by having to remember the source block syntax. Org mode
+offers two ways of speeding up the creation of src code blocks: a template
+system that can create a new block with just three keystrokes, and a command
+for wrapping existing text in a block (@pxref{Easy templates}). Org also
+works with other completion systems in Emacs, some of which predate Org and
+have custom domain-specific languages for defining templates. Regular use of
+templates reduces errors, increases accuracy, and maintains consistency.
@cindex source code, inline
An inline code block conforms to this structure:
@@ -17418,6 +17419,14 @@ Org comes with these pre-defined easy templates:
More templates can added by customizing the variable
@code{org-structure-template-alist}, whose docstring has additional details.
+@findex org-insert-structure-template
+@kindex C-c C-x w
+Easy templates are ideal when writing new content, but sometimes it is
+necessary to mark up existing content. For these cases, Org provides the
+function @code{org-insert-structure-template}, which prompts for a block
+type, and wraps either the active region or the current Org element in that
+block. This command is bound to @kbd{C-c C-x w} by default.
+
@node Speed keys
@section Speed keys
@cindex speed keys
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 1076dd970..190a6b8bc 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -109,6 +109,10 @@ you should expect to see something like:
#+END_EXAMPLE
** New functions
+*** ~org-insert-structure-template~
+
+This function can be used to wrap existing text of Org elements in
+a #+BEGIN_FOO/#+END_FOO block. Bound to C-c C-x w by default.
*** ~org-export-excluded-from-toc-p~
diff --git a/lisp/org.el b/lisp/org.el
index 54687abc7..552dd7ec4 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -12117,6 +12117,13 @@ keywords relative to each registered export back-end."
"PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
"TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
+(defcustom org-structure-predefined-blocks
+ '("SRC" "EXAMPLE" "QUOTE" "VERSE" "VERBATIM" "CENTER" "COMMENT" "EXPORT")
+ "Block structure completion names."
+ :group 'org-completion
+ :type '(repeat string)
+ :package-version '(Org . "9.1.3"))
+
(defcustom org-structure-template-alist
'(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
@@ -12189,6 +12196,47 @@ expands them."
(insert rpl)
(when (re-search-backward "\\?" start t) (delete-char 1))))
+(defun org-insert-structure-template (&optional type)
+ "Insert a block structure of the type #+BEGIN_FOO/#+END_FOO.
+Prompts for a block type, and inserts the block. With an active
+region, wrap the region in the block. With an element under
+point, wrap the element in the block. Otherwise, insert an empty
+block."
+ (interactive)
+ (setq type (or type (completing-read "Block type: "
+ org-structure-predefined-blocks)))
+ (unless (use-region-p)
+ (when (org-element-at-point)
+ (org-mark-element)))
+ (let ((s (if (use-region-p)
+ (region-beginning)
+ (point)))
+ (e (copy-marker (if (use-region-p)
+ (region-end)
+ (point))
+ t))
+ column)
+ (when (string-match-p (concat "\\`"
+ (regexp-opt '("example" "export" "src")))
+ type)
+ (org-escape-code-in-region s e))
+ (goto-char s)
+ (setq column (current-indentation))
+ (beginning-of-line)
+ (indent-to column)
+ (insert (format "#+BEGIN_%s\n" type))
+ (goto-char e)
+ (if (bolp)
+ (progn
+ (skip-chars-backward " \n\t")
+ (forward-line))
+ (end-of-line)
+ (insert "\n"))
+ (indent-to column)
+ (insert (format "#+END_%s\n"
+ type))
+ (set-marker e nil)))
+
;;;; TODO, DEADLINE, Comments
(defun org-toggle-comment ()
@@ -19652,6 +19700,7 @@ COMMANDS is a list of alternating OLDDEF NEWDEF command names."
(org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
(org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
(org-defkey org-mode-map "\C-c\C-xi" 'org-columns-insert-dblock)
+(org-defkey org-mode-map "\C-c\C-xw" 'org-insert-structure-template)
(org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
(org-defkey org-mode-map "\C-c\C-x." 'org-timer)
diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el
index f94079b7e..84924eb23 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -4033,6 +4033,48 @@ Text.
(org-next-block 1 nil "^[ \t]*#\\+BEGIN_QUOTE")
(looking-at "#\\+begin_quote")))))
+(ert-deftest test-org/insert-template ()
+ "Test `org-insert-structure-template'."
+ ;; Test in empty buffer.
+ (should
+ (string= "#+BEGIN_FOO\n#+END_FOO\n"
+ (org-test-with-temp-text ""
+ (org-insert-structure-template "FOO")
+ (buffer-string))))
+ ;; Test with text in buffer, but no region set.
+ (should
+ (string= "#+BEGIN_FOO\nI'm a paragraph\n#+END_FOO\n\nI'm a second paragraph"
+ (org-test-with-temp-text "I'm a paragraph\n\nI'm a second paragraph"
+ (org-insert-structure-template "FOO")
+ (buffer-string))))
+ ;; Test with text in buffer, no region, no final newline.
+ (should
+ (string= "#+BEGIN_FOO\nI'm a paragraph.\n#+END_FOO\n"
+ (org-test-with-temp-text "I'm a paragraph."
+ (org-insert-structure-template "FOO")
+ (buffer-string))))
+ ;; Test with text in buffer and region set.
+ (should
+ (string= "#+BEGIN_FOO\nI'm a paragraph\n\nI'm a second paragrah\n#+END_FOO\n"
+ (org-test-with-temp-text "I'm a paragraph\n\nI'm a second paragrah"
+ (goto-char (point-min))
+ (set-mark (point))
+ (goto-char (point-max))
+ (org-insert-structure-template "FOO")
+ (buffer-string))))
+ ;; Test with example escaping.
+ (should
+ (string= "#+BEGIN_EXAMPLE\n,* Heading\n#+END_EXAMPLE\n"
+ (org-test-with-temp-text "* Heading"
+ (org-insert-structure-template "EXAMPLE")
+ (buffer-string))))
+ ;; Test with indentation.
+ (should
+ (string= " #+BEGIN_FOO\n This is a paragraph\n #+END_FOO\n"
+ (org-test-with-temp-text " This is a paragraph"
+ (org-insert-structure-template "FOO")
+ (buffer-string)))))
+
(ert-deftest test-org/previous-block ()
"Test `org-previous-block' specifications."
;; Regular test.
--
2.14.2
