From: Eric Abrahamsen <eric@ericabrahamsen.net>
To: emacs-orgmode@gnu.org
Subject: Re: function for inserting a block
Date: Fri, 20 Oct 2017 11:04:08 -0700 [thread overview]
Message-ID: <87k1zp4rxj.fsf@ericabrahamsen.net> (raw)
In-Reply-To: CADn3Z2JDdrFnMimdUk+wwNT_KqS4jNwNtviTDmG_2b5MTTgeEA@mail.gmail.com
[-- Attachment #1: Type: text/plain, Size: 1064 bytes --]
Carsten Dominik <dominik@uva.nl> writes:
> Hi Eric,
>
> On Wed, Oct 18, 2017 at 4:58 PM, Eric Abrahamsen <eric@ericabrahamsen.net> wrote:
>
> Carsten Dominik <dominik@uva.nl> writes:
>
> > Dear all,
> >
> > this is great added functionality that I have missed a lot myself. Thanks for this! Also, I like the key binding.
>
> I do too, though I also notice it conflicts with inlinetask insertion.
>
> Ooops. I overlooked that. Hmmm, that is not ideal.
>
> Maybe then C-c C-x w would be better, w can stand for "wrap".
>
>
> > One improvement I can think of it to read the block type with completion (but still allow any word to be used).
>
> I'd be happy to do that. There would be a tiny bit of redundancy with
> `org-structure-template-alist', but nothing too terrible.
>
> I agree. You could pull it would of the alist, but I am not sure it is worth it.
Okay, here's another version, with a new keybinding and completion. The
completion strings are uppercase, which might not always be the right
thing, but probably more often than not.
Eric
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-New-function-org-insert-structure-template.patch --]
[-- Type: text/x-diff, Size: 7894 bytes --]
From cb6f1815259094f7f9b68459dcded5dce14d3154 Mon Sep 17 00:00:00 2001
From: Eric Abrahamsen <eric@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 | 47 +++++++++++++++++++++++++++++++++++++++++++++++
testing/lisp/test-org.el | 42 ++++++++++++++++++++++++++++++++++++++++++
4 files changed, 108 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..e1cf14cae 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,45 @@ 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-equal (downcase type) "example")
+ (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 +19698,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
next prev parent reply other threads:[~2017-10-20 18:06 UTC|newest]
Thread overview: 104+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-09-03 0:25 function for inserting a block Eric Abrahamsen
2017-09-03 2:21 ` Adam Porter
2017-09-03 3:06 ` Kaushal Modi
2017-09-03 3:34 ` Eric Abrahamsen
2017-09-03 8:10 ` Nicolas Goaziou
2017-09-03 8:19 ` Adam Porter
2017-09-03 8:23 ` Nicolas Goaziou
2017-09-03 15:56 ` Eric Abrahamsen
2017-09-03 18:31 ` Josiah Schwab
2017-09-03 19:28 ` Eric Abrahamsen
2017-09-03 20:26 ` Josiah Schwab
2017-09-03 20:44 ` Eric Abrahamsen
2017-09-08 18:52 ` Eric Abrahamsen
2017-09-10 12:44 ` Nicolas Goaziou
2017-09-10 18:39 ` Eric Abrahamsen
2017-09-29 20:09 ` Nicolas Goaziou
2017-09-30 20:26 ` Eric Abrahamsen
2017-10-05 14:47 ` Nicolas Goaziou
2017-10-07 20:03 ` Eric Abrahamsen
2017-10-14 10:52 ` Nicolas Goaziou
2017-10-16 19:46 ` Eric Abrahamsen
2017-10-16 19:59 ` Eric Abrahamsen
2017-10-17 7:46 ` Nicolas Goaziou
2017-10-17 16:27 ` Eric Abrahamsen
2017-10-17 21:33 ` Nicolas Goaziou
2017-10-17 21:43 ` Eric Abrahamsen
2017-10-17 22:03 ` Eric Abrahamsen
2017-10-18 6:45 ` Carsten Dominik
2017-10-18 14:58 ` Eric Abrahamsen
2017-10-19 15:47 ` Carsten Dominik
2017-10-20 18:04 ` Eric Abrahamsen [this message]
2017-10-20 18:39 ` Kaushal Modi
2017-10-20 19:02 ` Kaushal Modi
2017-10-20 21:15 ` Eric Abrahamsen
2017-10-20 21:13 ` Eric Abrahamsen
2017-10-20 21:43 ` Kaushal Modi
2017-10-21 11:30 ` Xebar Saram
2017-10-21 11:59 ` Marco Wahl
2017-10-21 13:32 ` Xebar Saram
2017-10-21 15:56 ` Eric Abrahamsen
2017-10-23 10:52 ` Kaushal Modi
2017-10-23 14:00 ` Carsten Dominik
2017-10-23 14:46 ` Kaushal Modi
2017-10-23 15:11 ` Eric Abrahamsen
2017-10-23 16:55 ` Nicolas Goaziou
2017-10-24 0:18 ` Eric Abrahamsen
2017-10-24 0:20 ` Eric Abrahamsen
2017-10-24 12:10 ` Nicolas Goaziou
2017-10-28 22:27 ` Eric Abrahamsen
2017-10-30 11:05 ` Nicolas Goaziou
2017-10-30 15:08 ` Eric S Fraga
2017-10-30 16:22 ` Eric Abrahamsen
2017-10-30 17:57 ` Eric Abrahamsen
2017-11-05 9:06 ` Nicolas Goaziou
2017-11-05 14:24 ` Kaushal Modi
2017-11-05 14:37 ` Kaushal Modi
2017-11-06 13:48 ` Nicolas Goaziou
2017-11-06 16:23 ` Kaushal Modi
2017-11-05 21:25 ` Eric Abrahamsen
2017-12-10 9:36 ` Thorsten Jolitz
2017-10-22 9:54 ` Nicolas Goaziou
2017-10-22 17:49 ` Eric Abrahamsen
2017-11-08 11:20 ` Bastien
2017-11-08 11:44 ` Nicolas Goaziou
2017-11-08 12:14 ` Bastien
2017-11-08 12:25 ` Restore old easy template feature (Re: function for inserting a block) Kaushal Modi
2017-11-08 12:43 ` Kaushal Modi
2017-11-08 14:08 ` Bastien Guerry
2017-12-18 22:07 ` Matt Price
2017-12-19 1:44 ` Eric Abrahamsen
2017-12-19 10:04 ` Rasmus
2017-12-19 17:49 ` Matt Price
2017-11-08 13:35 ` Nicolas Goaziou
2017-11-08 13:34 ` function for inserting a block Nicolas Goaziou
2017-11-08 14:34 ` Bastien Guerry
2017-11-08 16:01 ` Eric Abrahamsen
2017-11-08 16:33 ` William Denton
2017-11-08 14:07 ` Rasmus
2017-11-08 17:09 ` Berry, Charles
2017-11-08 17:28 ` Nicolas Goaziou
2017-11-08 18:24 ` Thomas S. Dye
2017-11-08 18:51 ` Takaaki Ishikawa
2017-11-08 20:10 ` Eric Abrahamsen
2017-11-08 22:28 ` Nicolas Goaziou
2017-11-09 4:31 ` Thomas S. Dye
2017-11-09 7:55 ` Carsten Dominik
2017-11-12 4:35 ` Matt Lundin
2017-11-12 6:08 ` numbchild
2017-11-09 14:46 ` Rasmus
2017-11-09 16:11 ` Rasmus
2017-11-09 16:50 ` Eric Abrahamsen
2017-11-10 9:31 ` Rasmus
2017-11-10 17:27 ` Eric Abrahamsen
2017-11-11 16:51 ` Thomas S. Dye
2017-11-14 21:36 ` Eric Abrahamsen
2017-11-15 13:13 ` numbchild
2017-11-15 16:24 ` Eric Abrahamsen
2017-11-17 16:19 ` numbchild
2017-11-17 19:14 ` Eric Abrahamsen
2017-11-18 0:09 ` numbchild
2017-11-20 13:40 ` Rasmus
2017-11-20 16:49 ` Eric Abrahamsen
2017-11-11 4:13 ` stardiviner
[not found] <mailman.107.1510246818.12116.emacs-orgmode@gnu.org>
2017-11-10 4:19 ` James Harkins
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=87k1zp4rxj.fsf@ericabrahamsen.net \
--to=eric@ericabrahamsen.net \
--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).