Org source block babel expansion stopped working #11798

RockyRoad29 · 2019-01-05T10:48:21Z

Description

DISCLAIMER -- This report may seem wordy or redundant, but I hope it would add
a few keywords to help users facing a similar issue.

According to "Easy-templates" section in orgmode manual

"< s TAB expands to a ‘src’ code block. "

When I do that, nothing happends anymore. No other template either 2

Reproduction guide 🪲

Start Emacs
Create a new file in org-mode, say /tmp/t.org
Type an "easy template", like "<s"
Press TAB to expand

Observed behaviour: 👀 💔
Not expansion, indentation instead.

Expected behaviour: ❤️ 😄
Replacement of "<s" with:

# +BEGIN_SRC

# +END_SRC

Investigations

Thanks to good documentation, it is rather easy:

In *Messages* you may read:

  File mode specification error: (wrong-type-argument stringp (#+BEGIN_NOTES
  ?
  #+END_NOTES))

and also an explanation in a *Warnings* buffer.

The customizable variable org-structure-template-alist is altered somewhere with a "NOTES" entry.

  - help:org-structure-template-alist

Displays the following:

  Hide org-structure-template-alist:
  '(("n" "#+BEGIN_NOTES\n?\n#+END_NOTES")
    ("a" . "export ascii")
    ("c" . "center")
    ("C" . "comment")
    ("e" . "example")
    ("E" . "export")
    ("h" . "export html")
    ("l" . "export latex")
    ("q" . "quote")
    ("s" . "src")
    ("v" . "verse"))
      State : CHANGED outside Customize. (mismatch**
    An alist of keys and block types

The "n" entry is absent from source definition (~/.emacs.d/elpa/26.1/develop/org-plus-contrib-20181230/org.el)

Suppressing the first entry (e.g. in customize) solves the problem.

Solution : PR in ox-reveal

This is related to a recent change in org-plus-contrib :
https://orgmode.org/Changes.html#outline-container-org1b5e967 .

For me, the responsible appears to be 'ox-reveal' .

It is actually added in
/.emacs.d/elpa/develop/ox-reveal-20161027.226/ox-reveal.el.

This is easy to fix:

@@ -1185,7 +1185,7 @@ Return output file name."
 ;; Register auto-completion for speaker notes.
 (when org-reveal-note-key-char
   (add-to-list 'org-structure-template-alist
-               (list org-reveal-note-key-char "#+BEGIN_NOTES\n\?\n#+END_NOTES")))
+               (cons org-reveal-note-key-char "notes")))

I was about to build a PR but somebody has already submitted an identical one which currently pending.
yjwen/org-reveal@21b1750

Workaround : fix the value in dotfile

To patiently wait until the PR is applied upstream, I tried this, in user-config():

  (with-eval-after-load 'ox-reveal
    (let ((entry (assoc "n" org-structure-template-alist)))
      (when (and entry  (string-match-p "BEGIN" (cdr tmp:entry)))
        (setcdr entry "notes")
      )
    )
  )

Unfortunately, though the inner code is working (fixes the problem in current session), with-eval-after-load doesn't seem
to be the way to do it. I also tried to wrap it in use-package :config and
in configure-layers org stanza, with no more success.

System Info 💻

OS: gnu/linux
Emacs: 26.1
Spacemacs: 0.300.0
Spacemacs branch: develop (rev. 2c28c7d)
Graphic display: t
Distribution: spacemacs
Editing style: vim
Completion: helm
Layers:

(auto-completion c-c++ csv
                 (dash :variables helm-dash-docset-newpath "~/.local/share/Zeal/Zeal/docsets")
                 docker emacs-lisp erc git graphviz gtags ...
                 (org :variables org-enable-reveal-js-support t org-reveal-root "file:///usr/local/src/reveal.js")
                 ...

System configuration features: XPM JPEG TIFF GIF PNG RSVG IMAGEMAGICK SOUND GPM DBUS GSETTINGS NOTIFY ACL GNUTLS LIBXML2 FREETYPE M17N_FLT LIBOTF XFT ZLIB TOOLKIT_SCROLL_BARS GTK3 X11 MODULES THREADS LIBSYSTEMD LCMS2

The text was updated successfully, but these errors were encountered:

dqdinh · 2019-01-09T22:00:16Z

This temp workaround worked for me - yjwen/org-reveal#340 (comment)

Add the following to dotspacemacs/user-config:

(setq org-reveal-note-key-char nil)

Afterwords, one can use C-c C , s to insert a src block.

dqdinh · 2019-01-14T18:11:36Z

FYI - this has been fixed. So if you added the work around above, you'll need to remove it.

BobCromwell · 2019-01-15T02:08:38Z

FYI - this has been fixed. So if you added the work around above, you'll need to remove it.

Which branch? I update develop branch and still meet the same issue.

yssource · 2019-01-15T06:19:09Z

(setq org-reveal-note-key-char nil), does not work for me.
But,
comment out org-enable-reveal-js-support t in org layer, works for me.

dqdinh · 2019-01-15T17:37:13Z

I am using the stable branch and updated my layers. This resolved the issue I had.

srgkoshelev · 2019-01-16T17:46:25Z

The template expansion works in master (stable) and doesn't work in develop branch.
Blindly adding

  (with-eval-after-load 'ox-reveal
    (setq org-reveal-note-key-char nil)
  )

to user-config didn't help.

agirdler-sonder · 2019-01-16T21:05:16Z

@srgkoshelev
On develop it seems the version of org-mode has templating separated and org-tempo module is not loaded. I was able to resolve this by adding the following lines to my dotfile to load org-tempo for version of org >= 9.2 (the abstraction seems to be a part of the 9.2 release):

  (when (version<= "9.2" (org-version))
    (require 'org-tempo))

BobCromwell · 2019-01-17T06:54:37Z

on develop branch disable ox-reveal makes C-c C-, works
org-enable-reveal-js-support nil

srgkoshelev · 2019-01-21T16:16:34Z

@agirdler-sonder Thank you, it works!

igor-kupczynski · 2019-01-23T10:41:04Z

I'm on develop. Adding the snippet suggested by @agirdler-sonder works for me:

  ;; FIXME: workaround
  ;; https://github.com/syl20bnr/spacemacs/issues/11798
  (when (version<= "9.2" (org-version))
    (require 'org-tempo))

By works I mean that I can use < s TAB.

With (setq org-reveal-note-key-char nil) < s TAB wasn't working for me, but C-c C-, s worked.

Anton-Latukha · 2019-02-19T18:24:37Z

Instead of <s[TAB} you can also use Spacemacs menu SPC m i b s (for current develop branch / Org-mode >= 9.2).

Special thanks for submission of so informative bug report and having so good discussion here.

rdbeni0 · 2019-02-19T18:46:01Z

it seems that we need to use (require 'org-tempo)

please check at
https://orgmode.org/Changes.html
"Change in the structure template expansion"

so this is official change in org template system. And now <sTAB is optional, but it is still working

btw. i am also fan of "good old" templates and i am using (require 'org-tempo). But from consistence point of view, it will be better for emacs to leave org templates/snippets to common and centralized mechanism like company-mode or/and yasnippets

practicalli-johnny · 2019-03-11T21:05:06Z

I upgraded org-reveal package to org-re-reveal package using the basic instructions in the issue:
#11935

If you do not wish to use org-reveal, you can simply set org-enable-reveal-js-support to nil to nil in the org layer or remove it as a variable.

pnyccz · 2019-03-13T13:42:51Z

I have the same problem, or-re-reveal package has helped, however, it broke org-mode-agenda completely.

Using Linux, Emacs 26.1, Spacemacs 0.200.13.

shanesveller · 2019-04-01T18:53:32Z

@pnyccz what sort of problems are you seeing with org-agenda, so I know what to look out for after I switched to org-re-reveal?

pnyccz · 2019-04-02T07:39:54Z

@shanesveller Agenda and clocking stopped working. Report tables for time spent on various tasks also stopped working. I don't recall seeing other issues.

ColeWunderlich · 2019-05-09T07:07:16Z

I am on the stable branch and this is still broken for me.

xx299x · 2019-06-23T10:44:01Z

I am on the stable branch and this is still broken for me.

@ColeWunderlich

Adding (require 'org-tempo) to user-config solves the problem of <s <TAB> not working

xx299x · 2019-06-23T10:55:33Z

You can also use Spacemacs menu SPC m i b s instead of <s[TAB}.

Special thanks for submission of so informative bug report and having so good discussion here.

@Anton-Latukha
I don't think I found this shortcut in my evil-org-mode

Anton-Latukha · 2019-06-23T12:11:54Z

@ColeWunderlich @ZythonNera
collector1871 in answer #11798 (comment) already gave a full quality report&response&solution. I personally asked him to post it here, and he did. Please read the thread, or at least look at most liked responses in thread before writing. This issue open for people to see the solution and read the explanation.

@ColeWunderlich
Since everything seems provided: docs, explanation & simple solution - you can real easy fix it in your stable, integrate fix & submit the changes to stable upstream to show that you appreciate people back.
I provided some additional info that can be helpful for you right below.

@ZythonNera
In Emacs "Org major mode" - SPC m i b - org-insert-structure-template "is an interactive Lisp closure in org.el", since 9.2 Org-mode.
Which means it is present in new Org-mode, and in Spacemasc develop branch.

Since there seems to be duality of understanding of my old comment, updated it with precise info, and by-the-way created an issue.

…s TAB for inserting source blocks - see: syl20bnr/spacemacs#11798

github-actions · 2020-06-22T12:34:13Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Please let us know if this issue is still valid!

RockyRoad29 · 2020-06-22T20:43:33Z

Well, it's over a year now I'm trying to get used to "the new way" e.g. to insert a source block : [SPC m i b s] . I still find it less convenient than [< s TAB]. So as a user, I'd prefer to see org-tempo style staying around if possible.

Anton-Latukha · 2020-06-22T20:47:20Z

The real solution is mentioned in the 1 year ago, I am using it in that timespan.

Anton-Latukha · 2020-06-22T20:48:55Z

It is #11798 (comment).

Since the cause is Org-mode change, it became obvious it is not a Spacemacs question.
So official Org-mode now does not include <s ways. So it is even debatable should org-tempo be included in Spacemacs org layer.
If someone wants the <s to return by default - it is Org-mode mail list discussion, or org layer discussion.

maxsatula · 2020-08-06T18:25:34Z

There seems to be a problem with C-, combination. While it works fine in

GNOME terminal
GUI non-terminal version of Emacs

It does not work (either simple comma entered or nothing happens) on

lxterminal
any terminal over ssh
in PuTTY

I know, that is not Emacs problem, but I'm not sure about whether it is a good idea to assign troublesome keys in default configuration.

RockyRoad29 mentioned this issue Jan 5, 2019

Fix the way that we set up the Org template for notes. yjwen/org-reveal#327

Closed

caioaao added a commit to caioaao/emacs.d that referenced this issue Feb 13, 2019

add workaround to syl20bnr/spacemacs#11798

3cd5d15

tko mentioned this issue Feb 24, 2019

org-insert-structure-template not working since easy-template refactoring. #12012

Closed

fosskers mentioned this issue May 27, 2019

Indentation added to yasnippet in org mode #9822

Closed

syl20bnr added - Bug tracker - Key Bindings Org labels Jun 9, 2019

Anton-Latukha mentioned this issue Jun 23, 2019

Org-mode layer documentation seems to not have some key bindings. #12464

Closed

strawberryjello added a commit to strawberryjello/dotfiles that referenced this issue Aug 24, 2019

spacemacs: added org-tempo to re-enable the old easy templates, eg < …

5d968f5

…s TAB for inserting source blocks - see: syl20bnr/spacemacs#11798

github-actions bot added the stale marked as a stale issue/pr (usually by a bot) label Jun 22, 2020

github-actions bot closed this as completed Nov 4, 2020

vincentarelbundock mentioned this issue Apr 5, 2021

A few thoughts on the presentation (feel free to ignore) ess-intro/presentation-org-mode#3

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Org source block babel expansion stopped working #11798

Org source block babel expansion stopped working #11798

RockyRoad29 commented Jan 5, 2019

dqdinh commented Jan 9, 2019

dqdinh commented Jan 14, 2019

BobCromwell commented Jan 15, 2019

yssource commented Jan 15, 2019

dqdinh commented Jan 15, 2019 •

edited

Loading

srgkoshelev commented Jan 16, 2019

agirdler-sonder commented Jan 16, 2019

BobCromwell commented Jan 17, 2019

srgkoshelev commented Jan 21, 2019

igor-kupczynski commented Jan 23, 2019

Anton-Latukha commented Feb 19, 2019 •

edited

Loading

rdbeni0 commented Feb 19, 2019 •

edited

Loading

practicalli-johnny commented Mar 11, 2019 •

edited

Loading

pnyccz commented Mar 13, 2019

shanesveller commented Apr 1, 2019

pnyccz commented Apr 2, 2019

ColeWunderlich commented May 9, 2019

xx299x commented Jun 23, 2019 •

edited

Loading

xx299x commented Jun 23, 2019 •

edited

Loading

Anton-Latukha commented Jun 23, 2019 •

edited

Loading

github-actions bot commented Jun 22, 2020

RockyRoad29 commented Jun 22, 2020 •

edited

Loading

Anton-Latukha commented Jun 22, 2020 •

edited

Loading

Anton-Latukha commented Jun 22, 2020 •

edited

Loading

maxsatula commented Aug 6, 2020

Org source block babel expansion stopped working #11798

Org source block babel expansion stopped working #11798

Comments

RockyRoad29 commented Jan 5, 2019

Description

Reproduction guide 🪲

Investigations

Solution : PR in ox-reveal

Workaround : fix the value in dotfile

System Info 💻

dqdinh commented Jan 9, 2019

dqdinh commented Jan 14, 2019

BobCromwell commented Jan 15, 2019

yssource commented Jan 15, 2019

dqdinh commented Jan 15, 2019 • edited Loading

srgkoshelev commented Jan 16, 2019

agirdler-sonder commented Jan 16, 2019

BobCromwell commented Jan 17, 2019

srgkoshelev commented Jan 21, 2019

igor-kupczynski commented Jan 23, 2019

Anton-Latukha commented Feb 19, 2019 • edited Loading

rdbeni0 commented Feb 19, 2019 • edited Loading

practicalli-johnny commented Mar 11, 2019 • edited Loading

pnyccz commented Mar 13, 2019

shanesveller commented Apr 1, 2019

pnyccz commented Apr 2, 2019

ColeWunderlich commented May 9, 2019

xx299x commented Jun 23, 2019 • edited Loading

xx299x commented Jun 23, 2019 • edited Loading

Anton-Latukha commented Jun 23, 2019 • edited Loading

github-actions bot commented Jun 22, 2020

RockyRoad29 commented Jun 22, 2020 • edited Loading

Anton-Latukha commented Jun 22, 2020 • edited Loading

Anton-Latukha commented Jun 22, 2020 • edited Loading

maxsatula commented Aug 6, 2020

dqdinh commented Jan 15, 2019 •

edited

Loading

Anton-Latukha commented Feb 19, 2019 •

edited

Loading

rdbeni0 commented Feb 19, 2019 •

edited

Loading

practicalli-johnny commented Mar 11, 2019 •

edited

Loading

xx299x commented Jun 23, 2019 •

edited

Loading

xx299x commented Jun 23, 2019 •

edited

Loading

Anton-Latukha commented Jun 23, 2019 •

edited

Loading

RockyRoad29 commented Jun 22, 2020 •

edited

Loading

Anton-Latukha commented Jun 22, 2020 •

edited

Loading

Anton-Latukha commented Jun 22, 2020 •

edited

Loading