Re: [O] [patch] structure snippet completions

[Rasmus]

"Berry, Charles"  writes:

>> On Dec 8, 2017, at 1:20 PM, Rasmus  wrote:
>> 
>
>>> 
>>> A minor gotcha: if you `(require 'org-tempo)' after an org buffer has
>>> been created you will need to (org-mode-restart) the buffer to enable
>>> completions.  I got stuck trying to add custom templates until I
>>> realized this.
>> 
>> It shouldn’t do that since this is near the bottom of org-tempo:
>> 
>>(when (eq major-mode 'org-mode) (org-tempo-setup))
>> 
>> On my system it works in the first buffer where I require org-tempo, even
>> without reloading.
>
>
> Yes. It does that for me, too. But this only affects the buffer from which I 
> `(require 'org-tempo)'.

I hadn’t thought of that, but that is rather annoying.  Requiring Org
Tempo now runs ‘org-tempo-setup’ on all active Org buffers (commit
3efb000739362).

Thanks,
Rasmus

-- 
Hooray!

Re: [O] [patch] structure snippet completions

[Berry, Charles]

> On Dec 8, 2017, at 1:20 PM, Rasmus  wrote:
> 
>> 
>> A minor gotcha: if you `(require 'org-tempo)' after an org buffer has
>> been created you will need to (org-mode-restart) the buffer to enable
>> completions.  I got stuck trying to add custom templates until I
>> realized this.
> 
> It shouldn’t do that since this is near the bottom of org-tempo:
> 
>(when (eq major-mode 'org-mode) (org-tempo-setup))
> 
> On my system it works in the first buffer where I require org-tempo, even
> without reloading.


Yes. It does that for me, too. But this only affects the buffer from which I 
`(require 'org-tempo)'.

If there are already org buffers already open, I have to eval (org-tempo-setup) 
or (org-mode-restart) each one to enable to enable org-tempo in them. Of 
course, buffers opened later run the org-mode-hooks, so that isn't a problem.

This isn't likely to affect many users, but if someone tries to debug by 
starting `emacs -Q', opening an org buffer, and then requiring org-tempo from 
another buffer, s/he could get stuck.  

My init file creates a buffer called org-scratch.org in which I doodle and try 
things out.  I was stuck with org-tempo till I moved it below the (require 
'org-tempo). 

So maybe add a comment that will warn that (require 'org-tempo) only affects 
the buffer from which it is run and buffers subsequently opened or restarted.

> 
> Which version of Emacs are you using?


25.2.1

Chuck

Re: [O] [patch] structure snippet completions

[Rasmus]

"numbch...@gmail.com"  writes:

> error report when I `(require 'org-tempo)`

Because your org-structure-template-alist is mal-formatted:

("Q" "#+BEGIN_SRC
sql-mode ?\n\n#+END_SRC" "#+BEGIN_SRC sql-mode ?\n\n#+END_SRC")

Rasmus

-- 
The right to be left alone is a human right

Re: [O] [patch] structure snippet completions

[numbch...@gmail.com]

error report when I `(require 'org-tempo)`

Debugger entered--Lisp error: (error "Format specifier doesn’t match
argument type")
  format("<%c" "Q")
  (closure (t) (pair) (format "<%c" (car pair)))(("Q" "#+BEGIN_SRC sql-mode
?\n\n#+END_SRC" "#+BEGIN_SRC sql-mode ?\n\n#+END_SRC"))
  mapcar((closure (t) (pair) (format "<%c" (car pair))) (("Q" "#+BEGIN_SRC
sql-mode ?\n\n#+END_SRC" "#+BEGIN_SRC sql-mode ?\n\n#+END_SRC") ("n"
"#+BEGIN_NOTES\n?\n#+END_NOTES") (116 . "translate") (97 . "export ascii")
(99 . "center") (67 . "comment") (101 . "example") (69 . "export") (104 .
"export html") (108 . "export latex") (113 . "quote") (115 . "src") (118 .
"verse") (76 . "latex") (72 . "html") (65 . "ascii") (105 . "index")))
  (let ((keys (mapcar (function (lambda (pair) (format "<%c" (car pair
(append org-structure-template-alist org-tempo-keywords-alist (if (>
(length keys) (length (delete-dups keys))) (progn (warn "Duplicated keys in
`org-structure-template-alist' and `org-tempo-keywords-alist'"))) (mapc
(function (lambda (key) (if (assoc-string key org-tempo-tags) (setq
org-tempo-tags (delete (assoc-string key org-tempo-tags)
org-tempo-tags) keys) (mapc (function org-tempo-add-block)
org-structure-template-alist) (mapc (function org-tempo-add-keyword)
org-tempo-keywords-alist))
  org-tempo-add-templates()
  org-tempo-setup()
  (progn (org-tempo-setup))
  (if (eq major-mode 'org-mode) (progn (org-tempo-setup)))
  eval-buffer(# nil
"/home/stardiviner/Code/Emacs/org-mode/lisp/org-tempo.el" nil t)  ; Reading
at buffer position 5019

load-with-code-conversion(#1="/home/stardiviner/Code/Emacs/org-mode/lisp/org-tempo.el"
#1# nil t)
  require(org-tempo)


[stardiviner] GPG key ID: 47C32433
IRC(freeenode): stardiviner Twitter:  @numbchild
Key fingerprint = 9BAA 92BC CDDD B9EF 3B36  CB99 B8C4 B8E5 47C3 2433
Blog: http://stardiviner.github.io/

On Sat, Dec 9, 2017 at 5:20 AM, Rasmus  wrote:

> "Berry, Charles"  writes:
>
> >> On Dec 7, 2017, at 3:37 PM, Rasmus  wrote:
> >>
> >> I have also pushed the code.  " >> enabled by requiring org-tempo.
> >>
> >
> > Thanks. I was in a deep funk without " now.
>
> I am happy that I am able to help you for once!
>
> >> Let me know about any issues.
> >>
> >
> > Maybe make `tempo-match-finder' be "^ *\\(<[[:word:]]+\\)" so it will
> > match things like " > the user customize it.
>
> At the moment snippets with more than one character isn’t supported.  Note
> that the car of org-structure-template-alist elements is now a character.
> "Snippet-strings" (like "la") will be re-added soon cf. the email from
> Eric earlier on in this thread.
>
>
> > A minor gotcha: if you `(require 'org-tempo)' after an org buffer has
> > been created you will need to (org-mode-restart) the buffer to enable
> > completions.  I got stuck trying to add custom templates until I
> > realized this.
>
> It shouldn’t do that since this is near the bottom of org-tempo:
>
> (when (eq major-mode 'org-mode) (org-tempo-setup))
>
> On my system it works in the first buffer where I require org-tempo, even
> without reloading.
>
> Which version of Emacs are you using?
>
> Rasmus
>
> --
> A clever person solves a problem. A wise person avoids it
>
>
>

Re: [O] [patch] structure snippet completions

[Rasmus]

"Berry, Charles"  writes:

>> On Dec 7, 2017, at 3:37 PM, Rasmus  wrote:
>> 
>> I have also pushed the code.  "> enabled by requiring org-tempo.
>> 
>
> Thanks. I was in a deep funk without "> Let me know about any issues.
>> 
>
> Maybe make `tempo-match-finder' be "^ *\\(<[[:word:]]+\\)" so it will
> match things like " the user customize it.

At the moment snippets with more than one character isn’t supported.  Note
that the car of org-structure-template-alist elements is now a character.
"Snippet-strings" (like "la") will be re-added soon cf. the email from
Eric earlier on in this thread.


> A minor gotcha: if you `(require 'org-tempo)' after an org buffer has
> been created you will need to (org-mode-restart) the buffer to enable
> completions.  I got stuck trying to add custom templates until I
> realized this.

It shouldn’t do that since this is near the bottom of org-tempo:

(when (eq major-mode 'org-mode) (org-tempo-setup))

On my system it works in the first buffer where I require org-tempo, even
without reloading.

Which version of Emacs are you using?

Rasmus

-- 
A clever person solves a problem. A wise person avoids it

Re: [O] [patch] structure snippet completions

[Berry, Charles]

> On Dec 7, 2017, at 3:37 PM, Rasmus  wrote:
> 
> I have also pushed the code.  " enabled by requiring org-tempo.
> 

Thanks. I was in a deep funk without " Let me know about any issues.
> 

Maybe make `tempo-match-finder' be "^ *\\(<[[:word:]]+\\)" so it will match 
things like "

Re: [O] [patch] structure snippet completions

[Rasmus]

Kaushal Modi  writes:

> On Thu, Dec 7, 2017 at 6:51 PM Rasmus  wrote:
>
>> Rasmus  writes:
>> One possible "bug" that I discovered is illustrated by the following
>> example.
>>
>> * foo
>>   suggested indention
>> >
>>   When I tab at point ("|") extra indention will be stripped.  I don’t
>>   know if this is something that should be fixed.
>>
>
> That's does look like a bug. The preservation of indentation is especially
> useful if you want source block in nested lists.
>
> #+BEGIN_EXAMPLE
> Outside list
> #+END_EXAMPLE
>
> - list level 1
>
>   #+BEGIN_EXAMPLE
>   At level 1
>   #+END_EXAMPLE
>
>   - list level 2
>
> #+BEGIN_EXAMPLE
> At level 2
> #+END_EXAMPLE

In that example everything would work fine, though.  For it not to work
you’d have alter your example to something like this:

#+BEGIN_EXAMPLE
Outside list
#+END_EXAMPLE

- list level 1

   #+BEGIN_EXAMPLE
   example with extra indention
   #+END_EXAMPLE

Rasmus

-- 
Lasciate ogni speranza, voi che leggete questo.

Re: [O] [patch] structure snippet completions

[Kaushal Modi]

On Thu, Dec 7, 2017 at 6:51 PM Rasmus  wrote:

> Rasmus  writes:
> One possible "bug" that I discovered is illustrated by the following
> example.
>
> * foo
>   suggested indention
> 
>   When I tab at point ("|") extra indention will be stripped.  I don’t
>   know if this is something that should be fixed.
>

That's does look like a bug. The preservation of indentation is especially
useful if you want source block in nested lists.

#+BEGIN_EXAMPLE
Outside list
#+END_EXAMPLE
- list level 1
  #+BEGIN_EXAMPLE
  At level 1
  #+END_EXAMPLE
  - list level 2
#+BEGIN_EXAMPLE
At level 2
#+END_EXAMPLE

-- 

Kaushal Modi

Re: [O] [patch] structure snippet completions

[Rasmus]

Rasmus  writes:

> Hi,
>
> Nicolas Goaziou  writes:
>
>> It looks like a typo, but the two lines above are commented.
>
> Indeed.  Thanks.
>
>> Also, would it make sense to add a few tests?
>
> I never feel very creative about tests but I have added some.
>
> I have also pushed the code.  " enabled by requiring org-tempo.
>
> Let me know about any issues.

One possible "bug" that I discovered is illustrated by the following
example.

* foo
  suggested indention

Re: [O] [patch] structure snippet completions

[Rasmus]

Hi,

Nicolas Goaziou  writes:

> It looks like a typo, but the two lines above are commented.

Indeed.  Thanks.

> Also, would it make sense to add a few tests?

I never feel very creative about tests but I have added some.

I have also pushed the code.  "

Re: [O] [patch] structure snippet completions

[Nicolas Goaziou]

Hello,

Rasmus  writes:

> +@cindex Tempo
> +@cindex Template expansion
> +@cindex template insertion
> +@cindex insertion, of templates
> +@vindex org-tempo-keywords-alist
> +@vindex org-structure-template-alist
> +Org Tempo expands snippets to structures defined in
> +@c @code{org-structure-template-alist} and @code{org-tempo-keywords-alist}.  
> For
> +@c example, @code{org-tempo} expands @kbd{< s @key{TAB}} to a code block.

It looks like a typo, but the two lines above are commented.

Also, would it make sense to add a few tests?

Regards,

-- 
Nicolas Goaziou

Re: [O] [patch] structure snippet completions

[Eric Abrahamsen]

Rasmus  writes:

> Eric Abrahamsen  writes:
>
>> Rasmus  writes:
>>
>>> Hi,
>>>
>>> The attached patch adds expansions of ">> would like to include this in the next version of Org in anticipation of
>>> the changes to the template system.
>>
>> Cool! We were talking about shifting the alist keys to strings, do we
>> want to do that all at once, in both places, or let this land first?
>
> I’m indifferent.  If you make a shift to strings in the part of the code
> you know I can alter this code. 

On second thought, maybe it would be better to put this in first. A
separate change could do string keys, and also make some of the other
changes people have been asking for (different keybinding, etc), all at
once.

Re: [O] [patch] structure snippet completions

[Rasmus]

Eric Abrahamsen  writes:

> Rasmus  writes:
>
>> Hi,
>>
>> The attached patch adds expansions of "> would like to include this in the next version of Org in anticipation of
>> the changes to the template system.
>
> Cool! We were talking about shifting the alist keys to strings, do we
> want to do that all at once, in both places, or let this land first?

I’m indifferent.  If you make a shift to strings in the part of the code
you know I can alter this code. 

>>> +(mapcar 'org-tempo-add-block org-structure-template-alist)
>>
>> #'org-tempo-add-block
>>
>>> +(mapcar 'org-tempo-add-keyword org-tempo-keywords-alist)))
>
> And `mapc'!

Fair enough.

Rasmus

-- 
This space is left intentionally blank

Re: [O] [patch] structure snippet completions

[Rasmus]

Hi,

Thanks for the comments.  I have attached a new version that addresses the
issues you raised.

I think Org Tempo should pretty much work as this point, but of course
additional testing would be great.  And more cool key expansions of
course.

>> +@vindex org-tempo
>
> Is it worth mentioning the _variable_ `org-tempo'?

No. 

> Also,
>
> @cindex Tempo
> @cindex Template expansion
> @cindex ... whatever ...

Good idea.

>> +@vindex org-tempo-keywords-alist
>
> Is 
>
> @vindex org-structure-template-alist
>
> missing?

Perhaps.  Added.


>> +@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
>
> For example, Org Tempo makes @kbd(< s @key{TAB}) expand to a code block.

That was taken from an old revision of the manual, but I am happy to use
the more clear form.

>> +@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}}.
>
> ... @file{org-tempo.el}.}.

So much texinfo syntax...


>> +(user-error
>> + "Duplicated keys in `org-structure-template-alist' and
>> `org-tempo-keywords-alist'"))
>
> Is is an issue?

I guess if "> +(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
>
> Why `ignore-errors'?

In case the file selection is quit.  But I have re-done the include
keyword in a better way.

>> +  ;; Simple test if `org-tempo-setup' has been run.
>> +  ;; May not be the case if `org-tempo' was loaded
>> +  ;; after Org.
>> +  (unless (cl-member "> +(org-tempo-setup))
>
> (unless (assoc "
> But wouldn't calling 
>
>   (org-tempo-setup)
>
> at top level in "org-tempo.el" solve the issue?

Good idea.  I call it if we’re in an Org buffer.  Perhaps people use Tempo
in other modes so it would be potentially disruptive to call it in other
modes.

Rasmus

-- 
You people at the NSA are becoming my new best friends!
>From d645c92381420203d42c0397269122de06ee76d9 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):
* lisp/org.el (org-modules): Add org-tempo.
---
 doc/org.texi  |  13 +
 etc/ORG-NEWS  |   4 +-
 lisp/org-tempo.el | 164 ++
 lisp/org.el   |   1 +
 4 files changed, 181 insertions(+), 1 deletion(-)
 create mode 100644 lisp/org-tempo.el

diff --git a/doc/org.texi b/doc/org.texi
index 5becb0175..e6e6706cb 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -17396,6 +17396,19 @@ 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.
 
+@cindex Tempo
+@cindex Template expansion
+@cindex template insertion
+@cindex insertion, of templates
+@vindex org-tempo-keywords-alist
+@vindex org-structure-template-alist
+Org Tempo expands snippets to structures defined in
+@c @code{org-structure-template-alist} and @code{org-tempo-keywords-alist}.  For
+@c example, @code{org-tempo} expands @kbd{< s @key{TAB}} to a 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 @file{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= 

Re: [O] [patch] structure snippet completions

[Eric Abrahamsen]

Rasmus  writes:

> Hi,
>
> The attached patch adds expansions of " would like to include this in the next version of Org in anticipation of
> the changes to the template system.

Cool! We were talking about shifting the alist keys to strings, do we
want to do that all at once, in both places, or let this land first?

[...]

>> +(mapcar 'org-tempo-add-block org-structure-template-alist)
>
> #'org-tempo-add-block
>
>> +(mapcar 'org-tempo-add-keyword org-tempo-keywords-alist)))

And `mapc'!

Re: [O] [patch] structure snippet completions

[Nicolas Goaziou]

Hello,

Rasmus  writes:

> The attached patch adds expansions of " would like to include this in the next version of Org in anticipation of
> the changes to the template system.

Thank you. Some, mostly cosmetics, comments follow.
>
> In at least emacs-git it "just works" after requiring org-tempo.
>
> Since it currently uses with-eval-after-load it would require Emacs 24.4,
> but this could be changed to eval-after-load if necessary.

We officially support Emacs 24.3, even though some tests fail. IOW, you
need to use `eval-after-load'.

> * lisp/org-tempo.el: New file.
> * doc/org.texi (Structure templates):
> * etc/ORG-NEWS: Document new library.

No need to document ORG-NEWS changes.

> +@vindex org-tempo

Is it worth mentioning the _variable_ `org-tempo'?

Also,

@cindex Tempo
@cindex Template expansion
@cindex ... whatever ...

> +@vindex org-tempo-keywords-alist

Is 

@vindex org-structure-template-alist

missing?

> +@code{org-tempo} can be used to expand snippets to structures defined
> in

Org Tempo expands snippets...

> +@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

For example, Org Tempo makes @kbd(< s @key{TAB}) expand to a code block.

> +@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}}.

... @file{org-tempo.el}.}.

> +;;; org-tempo.el --- template expansion for org structures -*- 
> lexical-binding: t; -*-

Template expansion for Org structures

> +;; org-tempo reimplements completions of structure template before

Org Tempo implements...

> +(defvar org-tempo-tags nil
> +  "Tempo tags for org-mode")

"Tempo tags for Org mode."

> +(defcustom org-tempo-keywords-alist
> +  '((?L . "latex")
> +(?H . "html")
> +(?A . "ascii")
> +(?i . "index"))
> +  "Keyword templates like `org-structure-template-alist'."

IMO, the docstring doesn't say much for someone discovering the feature.

> +  :group 'org-tempo

You didn't define the `org-tempo' group, did you?

> +  :type '(repeat
> +   (cons (character :tag "Key")
> + (string :tag "Template")))
> +  :package-version '(Org . "9.2"))
> +
> +(defun org-tempo-setup ()
> +  (org-tempo-add-templates)
> +  (tempo-use-tag-list 'org-tempo-tags)
> +  (setq-local tempo-match-finder "^ *\\(<[[:word:]]\\)\\="))
> +
> +(defun org-tempo-add-templates ()
> +  "Update all org-tempo templates.

"Update all Org Tempo templates."

> +Goes through `org-structure-template-alist' and
> +`org-tempo-keywords-alist'."
> +  (let ((keys (mapcar (apply-partially 'format "<%c")

#'format

> +   (mapcar 'car (append org-structure-template-alist
> +org-tempo-keywords-alist)

#'car

but I think the following is simpler:

(mapcar (lambda (pair) (format "<%s" (car pair)))
(append org-structure-template-alist
org-tempo-keywords-alist))

> +(if (> (length keys)
> +   (length (delete-dups keys)))

`when'

> + (user-error
> +  "Duplicated keys in `org-structure-template-alist' and
> `org-tempo-keywords-alist'"))

Is is an issue?

> +(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)

#'org-tempo-add-block

> +(mapcar 'org-tempo-add-keyword org-tempo-keywords-alist)))

#'org-tempo-add-keyword

> +
> +(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 " 
> ")))
> +  >)

`org-split-string' -> `split-string'

> +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"
> +