From mboxrd@z Thu Jan 1 00:00:00 1970 From: Eric Abrahamsen Subject: Re: function for inserting a block Date: Sat, 30 Sep 2017 13:26:56 -0700 Message-ID: <87r2uoc4q7.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> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:58850) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dyOLt-0006tW-85 for emacs-orgmode@gnu.org; Sat, 30 Sep 2017 16:27:10 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dyOLq-0002ZL-B5 for emacs-orgmode@gnu.org; Sat, 30 Sep 2017 16:27:09 -0400 Received: from [195.159.176.226] (port=56772 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dyOLq-0002Ud-2A for emacs-orgmode@gnu.org; Sat, 30 Sep 2017 16:27:06 -0400 Received: from list by blaine.gmane.org with local (Exim 4.84_2) (envelope-from ) id 1dyOLg-0001j2-2U for emacs-orgmode@gnu.org; Sat, 30 Sep 2017 22:26:56 +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 Nicolas Goaziou 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? Eric --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-New-function-org-insert-structure-template.patch >From b8636d918e9ff79cac320003361c5a16846f156c Mon Sep 17 00:00:00 2001 From: Eric Abrahamsen Date: Sat, 30 Sep 2017 13:23:05 -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. --- doc/org.texi | 21 +++++++++++++++------ etc/ORG-NEWS | 5 +++++ lisp/org.el | 25 +++++++++++++++++++++++++ 3 files changed, 45 insertions(+), 6 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 1c79d8330..2274e584a 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 7c69efa89..1a3aa9e92 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 1ffea80fe..fe7bfd1c5 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -12199,6 +12199,30 @@ 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." + (interactive "sBlock type: ") + (unless (use-region-p) + (org-mark-element)) + (let ((s (copy-marker (min (point) (mark)))) + (e (copy-marker (max (point) (mark))))) + (when (string-equal (downcase type) "example") + (org-escape-code-in-region s e)) + (goto-char s) + (beginning-of-line) + (insert (format "#+BEGIN_%s" type)) + (newline-and-indent) + (goto-char e) + (unless (bolp) + (end-of-line) + (newline-and-indent)) + (insert (format "#+END_%s" type)) + (newline-and-indent) + (set-marker s nil) + (set-marker e nil)))) + ;;;; TODO, DEADLINE, Comments (defun org-toggle-comment () @@ -19660,6 +19684,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) -- 2.14.2 --=-=-=--