From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rasmus Subject: [patch] structure snippet completions Date: Mon, 04 Dec 2017 17:20:34 +0100 Message-ID: <87wp22a2i5.fsf@gmx.us> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:47864) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eLtUC-0003BO-OR for emacs-orgmode@gnu.org; Mon, 04 Dec 2017 11:20:54 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eLtU9-0003EJ-86 for emacs-orgmode@gnu.org; Mon, 04 Dec 2017 11:20:52 -0500 Received: from [195.159.176.226] (port=52870 helo=blaine.gmane.org) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eLtU8-0003Dp-QD for emacs-orgmode@gnu.org; Mon, 04 Dec 2017 11:20:49 -0500 Received: from list by blaine.gmane.org with local (Exim 4.84_2) (envelope-from ) id 1eLtTz-0003Vk-3U for emacs-orgmode@gnu.org; Mon, 04 Dec 2017 17:20:39 +0100 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 Cc: eric@ericabrahamsen.net --=-=-= Content-Type: text/plain Hi, The attached patch adds expansions of "From d5e3eacea38d3777f541f5abddebed04171650b6 Mon Sep 17 00:00:00 2001 From: Rasmus Date: Thu, 9 Nov 2017 16:47:13 +0100 Subject: [PATCH 1/2] org-tempo.el: New file for expansion of templates * lisp/org-tempo.el: New file. * doc/org.texi (Structure templates): * etc/ORG-NEWS: Document new library. * lisp/org.el (org-modules): Add org-tempo. --- doc/org.texi | 9 ++++ etc/ORG-NEWS | 4 +- lisp/org-tempo.el | 133 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ lisp/org.el | 1 + 4 files changed, 146 insertions(+), 1 deletion(-) create mode 100644 lisp/org-tempo.el diff --git a/doc/org.texi b/doc/org.texi index 5becb0175..17092ecbe 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -17396,6 +17396,15 @@ the key is @key{TAB}, the user is prompted to enter a type. Available structure types are defined in @code{org-structure-template-alist}, see the docstring for adding or changing values. +@vindex org-tempo +@vindex org-tempo-keywords-alist +@code{org-tempo} can be used to expand snippets to structures defined in +@code{org-structure-template-alist} and @code{org-tempo-keywords-alist}. For +example, @code{org-tempo} makes @kbd{<} @kbd{s} @kbd{@key{TAB}} expand to a +@samp{src} code block. Enable it by customizing @code{org-modules} or add +@code{(require 'org-tempo)} to your Emacs init file@footnote{For more +information, please refer to the commentary section in @code{org-tempo.el}}. + @multitable @columnfractions 0.2 0.8 @item @kbd{c} @tab @samp{#+BEGIN_CENTER} @item @kbd{C} @tab @samp{#+BEGIN_COMMENT} diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 66865ffe1..9d6c91ef3 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -72,6 +72,8 @@ document, use =shrink= value instead, or in addition to align: #+END_EXAMPLE ** New features +*** ~org-tempo~ may used for snippet expansion of structure template. +See manual and commentary in ~org-tempo.el~ for details. *** Exclude unnumbered headlines from table of contents Set their =UNNUMBERED= property to the special =notoc= value. See manual for details. @@ -167,7 +169,7 @@ See docstring for details. ** Removed functions *** ~org-try-structure-completion~ - +=org-tempo= may be used as a replacement. ** Removed variables *** org-babel-use-quick-and-dirty-noweb-expansion diff --git a/lisp/org-tempo.el b/lisp/org-tempo.el new file mode 100644 index 000000000..666954e1b --- /dev/null +++ b/lisp/org-tempo.el @@ -0,0 +1,133 @@ +;;; org-tempo.el --- template expansion for org structures -*- lexical-binding: t; -*- + +;; Copyright (C) 2017 Free Software Foundation, Inc. +;; +;; Author: Rasmus Pank Roulund +;; Keywords: outlines, hypermedia, calendar, wp +;; Homepage: http://orgmode.org +;; +;; This file is part of GNU Emacs. +;; +;; GNU Emacs is free software: you can redistribute it and/or modify +;; it under the terms of the GNU General Public License as published by +;; the Free Software Foundation, either version 3 of the License, or +;; (at your option) any later version. + +;; GNU Emacs is distributed in the hope that it will be useful, +;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;; GNU General Public License for more details. + +;; You should have received a copy of the GNU General Public License +;; along with GNU Emacs. If not, see . +;; +;;; Commentary: +;; +;; org-tempo reimplements completions of structure template before +;; point like `org-try-structure-completion' in Org v9.1 and earlier. +;; For example, strings like " (length keys) + (length (delete-dups keys))) + (user-error + "Duplicated keys in `org-structure-template-alist' and `org-tempo-keywords-alist'")) + (mapcar (lambda (key) + (if (assoc-string key org-tempo-tags) + (setq org-tempo-tags + (delete (assoc-string key org-tempo-tags) + org-tempo-tags)))) + keys) + (mapcar 'org-tempo-add-block org-structure-template-alist) + (mapcar 'org-tempo-add-keyword org-tempo-keywords-alist))) + +(defun org-tempo-add-block (entry) + "Add block entry from `org-structure-template-alist'." + (let* ((key (format "<%c" (car entry))) + (name (cdr entry))) + (tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name)) + `(,(format "#+begin_%s " name) p '> n n + ,(format "#+end_%s" (car (org-split-string name " "))) + >) + key + (format "Insert a %s block" name) + 'org-tempo-tags))) + +(defun org-tempo-add-keyword (entry) + "Add keyword entry from `org-tempo-keywords-alist'." + (let* ((key (format "<%c" (car entry))) + (name (cdr entry))) + (tempo-define-template (format "org-%s" (replace-regexp-in-string " " "-" name)) + `(,(format "#+%s: " name) p '>) + key + (format "Insert a %s keyword" name) + 'org-tempo-tags))) + +;;; Additional keywords + +(tempo-define-template "org-include" + '("#+include: " + (ignore-errors + (format "\"%s\" " (file-relative-name (read-file-name "Include file: ")))) + p >) + "