Nicolas Goaziou <m...@nicolasgoaziou.fr> writes:
> Hello,
>
> Eric Abrahamsen <e...@ericabrahamsen.net> writes:
>
>> Nicolas Goaziou <m...@nicolasgoaziou.fr> writes:
>>
>>
>> [...]
>>
>>> C-c C-x t is free, tho.
>>
>> Oops, I think that's what I meant to type. Here's the latest version of
>> the patch -- I removed the bit fooling with the location of point at the
>> end, as it seemed simpler was better. How's this look?
>
> `newline-and-indent' and `mark' shouldn't be used in the function.
This must be a personal record for number of screw-ups in a single
commit... That was an old version from a different computer.
But still, I'm not entirely confident about the indentation handling.
This is my best guess -- it seems to work, and doesn't get confused by
`org-indent-mode'.
> Otherwise, it looks good. Could you provide some tests for that in
> "test-org.el"?
How does this look?
Eric
>From d859c241053aef2dd2f2a9b04f4030de54eb330d 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.
* etc/ORG-NEWS: Mention in news.
* 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 | 5 +++++
lisp/org.el | 40 ++++++++++++++++++++++++++++++++++++++++
testing/lisp/test-org.el | 36 ++++++++++++++++++++++++++++++++++++
4 files changed, 96 insertions(+), 6 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index fd26d9790..fd537ded4 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -15215,12 +15215,14 @@ 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 @samp{src} code blocks: a
+templates 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:
@@ -17391,6 +17393,13 @@ 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
+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 t} by default.
+
@node Speed keys
@section Speed keys
@cindex speed keys
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 53d604b8c..ed487b20f 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -105,6 +105,11 @@ you should expect to see something like:
,#+STARTUP: shrink
#+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 t by default.
** Miscellaneous
*** ~org-publish-resolve-external-link~ accepts a new optional argument.
diff --git a/lisp/org.el b/lisp/org.el
index 5a60e34cb..f888af09c 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -12199,6 +12199,45 @@ expands them."
(insert rpl)
(when (re-search-backward "\\?" start t) (delete-char 1))))
+(defun org-insert-structure-template (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 "sBlock type: ")
+ (unless (use-region-p)
+ (when (org-element-at-point)
+ (org-mark-element)))
+ (let ((s (copy-marker (if (use-region-p)
+ (region-beginning)
+ (point))))
+ (e (copy-marker (if (use-region-p)
+ (region-end)
+ (point))
+ t))
+ column)
+ (when (string-equal (downcase type) "example")
+ (org-escape-code-in-region s e))
+ (goto-char s)
+ (setq column (current-indentation))
+ (back-to-indentation)
+ (insert (format "#+BEGIN_%s\n"
+ type))
+ (indent-to column)
+ (goto-char e)
+ (if (bolp)
+ (progn
+ (skip-chars-backward " \n\t")
+ (forward-char))
+ (end-of-line)
+ (insert "\n"))
+ (indent-to column)
+ (insert (format "#+END_%s\n"
+ type))
+ (set-marker s nil)
+ (set-marker e nil)))
+
;;;; TODO, DEADLINE, Comments
(defun org-toggle-comment ()
@@ -19662,6 +19701,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-xt" '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 a185cff1f..35bcfa309 100644
--- a/testing/lisp/test-org.el
+++ b/testing/lisp/test-org.el
@@ -4022,6 +4022,42 @@ 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 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
