From mboxrd@z Thu Jan 1 00:00:00 1970 From: Eric Abrahamsen Subject: Re: function for inserting a block Date: Fri, 20 Oct 2017 11:04:08 -0700 Message-ID: <87k1zp4rxj.fsf@ericabrahamsen.net> References: <877exghblx.fsf@ericabrahamsen.net> <87efromccg.fsf@nicolasgoaziou.fr> <87ziabepxt.fsf@ericabrahamsen.net> <87bmml2fb0.fsf@ericabrahamsen.net> <87fubuzpsa.fsf@nicolasgoaziou.fr> <874lsabdop.fsf@ericabrahamsen.net> <87vak1l11m.fsf@nicolasgoaziou.fr> <87r2uoc4q7.fsf@ericabrahamsen.net> <87bmllk5xy.fsf@nicolasgoaziou.fr> <878tgmwwsa.fsf@ericabrahamsen.net> <87po9q2e8k.fsf@nicolasgoaziou.fr> <87tvyyvpst.fsf@ericabrahamsen.net> <87fuaiz069.fsf@nicolasgoaziou.fr> <87lgk9eo4d.fsf@ericabrahamsen.net> <87fuahxxvs.fsf@nicolasgoaziou.fr> <87r2u1cuwj.fsf@ericabrahamsen.net> <87infdctzq.fsf@ericabrahamsen.net> <87k1zsbizs.fsf@ericabrahamsen.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:50750) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1e5bgW-0000LJ-Ak for emacs-orgmode@gnu.org; Fri, 20 Oct 2017 14:06:17 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1e5bgT-0005fh-IS for emacs-orgmode@gnu.org; Fri, 20 Oct 2017 14:06:16 -0400 Received: from [195.159.176.226] (port=34732 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1e5bgT-0005fA-50 for emacs-orgmode@gnu.org; Fri, 20 Oct 2017 14:06:13 -0400 Received: from list by blaine.gmane.org with local (Exim 4.84_2) (envelope-from ) id 1e5bg6-0007OD-Gu for emacs-orgmode@gnu.org; Fri, 20 Oct 2017 20:05:50 +0200 List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: emacs-orgmode@gnu.org --=-=-= Content-Type: text/plain Carsten Dominik writes: > Hi Eric, > > On Wed, Oct 18, 2017 at 4:58 PM, Eric Abrahamsen wrote: > > Carsten Dominik 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 --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-New-function-org-insert-structure-template.patch >From cb6f1815259094f7f9b68459dcded5dce14d3154 Mon Sep 17 00:00:00 2001 From: Eric Abrahamsen 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 --=-=-=--