emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: TRS-80 <lists.trs-80@isnotmyreal.name>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org-footnote: fix inserting new footnote mangling drawers (was: Re: Bug: inserting footnote when Footnotes heading has property drawer [9.3.6 (9.3.6-23-g01ee25-elpaplus @ /home/user/.emacs.d/elpa/org-plus-contrib-20200309/)])
Date: Sat, 09 Jan 2021 12:12:47 -0500	[thread overview]
Message-ID: <e46f88534b9ccc889f7517638aeaf4ec@isnotmyreal.name> (raw)
In-Reply-To: <1e98d0e48139cfb9cc98460dbf7ffccd@isnotmyreal.name>

[-- Attachment #1: Type: text/plain, Size: 2181 bytes --]

On 2021-01-03 16:27, TRS-80 wrote:
> Hello!
> 
> I seem to have come across a bug today in org-footnote.
> 
> I had just learned about the variable org-footnote-auto-adjust and set
> it to t.  Then I tried to test it by invoking org-footnote-new in my
> Org file in between existing footnotes 2 and 3.
> 
> N.B., my Footnotes heading, prior to doing above also had a CUSTOM_ID
> property set:
> 
> #+begin_src org
>   ,** Footnotes
>      :PROPERTIES:
>      :CUSTOM_ID:            footnotes
>      :END:
> 
>   [fn:1] original footnote 1
> 
>   [fn:2] original footnote 2
> 
>   [fn:3] original footnote 3
> 
>   [fn:4] original footnote 4
> 
> #+end_src
> 
> The new footnote seems to get inserted into correct place, however 
> there
> appears to be a problem if there is a property drawer:
> 
> #+begin_src org
>   ,** Footnotes
> 
>   [fn:1] original footnote 1
> 
>   [fn:2] original footnote 2
> 
>   [fn:3] new footnote
>      :PROPERTIES:
>      :CUSTOM_ID:            footnotes
>      :END:
> 
>   [fn:4] original footnote 3
> 
>   [fn:5] original footnote 4
> 
> #+end_src
> 
> Since I was just studying the org-footnote code anyway, I will attempt
> to further diagnose the issue, and perhaps even send a patch.
> 
> As I was filling out bug report I realized I am on slightly dated
> version of Orgmode.  So I went ahead and cloned latest version and did 
> a
> diff on org-footnote.el between my affected version here locally and
> latest, and the only change I saw was the copyright date.
> 
> So with that out of the way, I will start digging and see what I can
> come up with.
> 
> Cheers,
> TRS-80
> 
> 
> Emacs  : GNU Emacs 26.3 (build 2, x86_64-pc-linux-gnu, GTK+ Version 
> 3.24.20)
>  of 2020-05-16, modified by Debian
> Package: Org mode version 9.3.6 (9.3.6-23-g01ee25-elpaplus @
> /home/user/.emacs.d/elpa/org-plus-contrib-20200309/)

Attached please find a very simple (one line) patch that I believe
should fix this issue.

This patch is of course based on latest git (not my personal outdated
version) and also maint branch.  I think I've got that right?

However as it will be my first patch to Orgmode, any feedback would be
welcomed.

Cheers,
TRS-80

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-footnote-fix-inserting-new-footnote-mangling-dra.patch --]
[-- Type: text/x-diff; name=0001-org-footnote-fix-inserting-new-footnote-mangling-dra.patch, Size: 1077 bytes --]

From cf7111a87645262c68214a03ca88f72bb0710049 Mon Sep 17 00:00:00 2001
From: TRS-80 <lists.trs-80@isnotmyreal.name>
Date: Sat, 9 Jan 2021 11:50:50 -0500
Subject: [PATCH] org-footnote: fix inserting new footnote mangling drawers

* org-footnote.el (org-footnote-create-definition): Replace
  `forward-line' with `org-end-of-meta-data' to skip over any
  properties and/or drawers that may be present on the
  `org-footnote-section' heading (default "Footnotes").

TINYCHANGE
---
 lisp/org-footnote.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index 3d42421e0..47ad4aa04 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -704,7 +704,7 @@ function doesn't move point."
 	   (concat "^\\*+[ \t]+" (regexp-quote org-footnote-section) "[ \t]*$")
 	   nil t))
 	(goto-char (match-end 0))
-	(forward-line)
+        (org-end-of-meta-data t)
 	(unless (bolp) (insert "\n")))
        (t (org-footnote--clear-footnote-section)))
       (when (zerop (org-back-over-empty-lines)) (insert "\n"))
-- 
2.29.2


  reply	other threads:[~2021-01-09 17:14 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-03 21:27 Bug: inserting footnote when Footnotes heading has property drawer [9.3.6 (9.3.6-23-g01ee25-elpaplus @ /home/user/.emacs.d/elpa/org-plus-contrib-20200309/)] TRS-80
2021-01-09 17:12 ` TRS-80 [this message]
2021-01-11  0:57   ` [PATCH] org-footnote: fix inserting new footnote mangling drawers (was: Re: Bug: inserting footnote when Footnotes heading has property drawer [9.3.6 (9.3.6-23-g01ee25-elpaplus @ /home/user/.emacs.d/elpa/org-plus-contrib-20200309/)]) Kyle Meyer
2021-01-12 19:46     ` TRS-80
2021-01-13  3:47       ` Kyle Meyer
2021-01-14  5:23         ` Kyle Meyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e46f88534b9ccc889f7517638aeaf4ec@isnotmyreal.name \
    --to=lists.trs-80@isnotmyreal.name \
    --cc=emacs-orgmode@gnu.org \
    --subject='[PATCH] org-footnote: fix inserting new footnote mangling drawers (was: Re: Bug: inserting footnote when Footnotes heading has property drawer [9.3.6 (9.3.6-23-g01ee25-elpaplus @ /home/user/.emacs.d/elpa/org-plus-contrib-20200309/)])' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).