Footnote sorting bug

Footnote sorting bug

[Matt Lundin]

Sorting footnotes when org-footnote-section is nil can have very
destructive consequences. For instance, the following file...

--8<---------------cut here---------------start------------->8---
* Heading one

A footnote.[fn:one]

[fn:one] A footnote

Another footnote.[fn:two]

[fn:two] Another footnote

A third footnote.[fn:three]

[fn:three] A third

* Heading two

Some text
--8<---------------cut here---------------end--------------->8---

...loses the second heading when sorted....


--8<---------------cut here---------------start------------->8---
* Heading one

A footnote.[fn:one]

Another footnote.[fn:two]

A third footnote.[fn:three]


[fn:one] A footnote


[fn:two] Another footnote* Heading two

Some text


[fn:three] A third
--8<---------------cut here---------------end--------------->8---

I traced the problem to an extra forward-line added to
org-footnote-goto-local-insertion-point with commit
145109dc4a6f161e4ad826bea9cc970363649280, but seems to have had some
unintended consequences for org buffers.

The following patch fixes the sorting problem in org buffers. AFAICT, it
has no effect on footnote insertion in message mode buffers with
signatures. (Unfortunately, footnote sorting in message buffers with
signatures is broken both before and after this patch.)

--8<---------------cut here---------------start------------->8---
diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index b6a9bca..d28161e 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -511,8 +511,7 @@ ENTRY is (fn-label num-mark definition)."
     (beginning-of-line 0))
   (if (looking-at "[ \t]*#\\+TBLFM:") (beginning-of-line 2))
   (end-of-line 1)
-  (skip-chars-backward "\n\r\t ")
-  (forward-line))
+  (skip-chars-backward "\n\r\t "))
 
 (defun org-footnote-delete (&optional label)
   "Delete the footnote at point.
--8<---------------cut here---------------end--------------->8---

Best,
Matt

Re: Footnote sorting bug

[Matt Lundin]

Matt Lundin <mdl@imapmail.org> writes:

> I traced the problem to an extra forward-line added to
> org-footnote-goto-local-insertion-point with commit
> 145109dc4a6f161e4ad826bea9cc970363649280.
>
> The following patch fixes the sorting problem in org buffers. AFAICT, it
> has no effect on footnote insertion in message mode buffers with
> signatures. (Unfortunately, footnote sorting in message buffers with
> signatures is broken both before and after this patch.)
>
> diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
> index b6a9bca..d28161e 100644
> --- a/lisp/org-footnote.el
> +++ b/lisp/org-footnote.el
> @@ -511,8 +511,7 @@ ENTRY is (fn-label num-mark definition)."
>      (beginning-of-line 0))
>    (if (looking-at "[ \t]*#\\+TBLFM:") (beginning-of-line 2))
>    (end-of-line 1)
> -  (skip-chars-backward "\n\r\t ")
> -  (forward-line))
> +  (skip-chars-backward "\n\r\t "))
>  
>  (defun org-footnote-delete (&optional label)
>    "Delete the footnote at point.

My apologies. Please disregard this patch. It does not fix the issue and
cause problems when creating footnotes.

I'll take a closer look at the code when I get a chance.

- Matt

Re: Footnote sorting bug

[Matt Lundin]

Matt Lundin <mdl@imapmail.org> writes:

> Matt Lundin <mdl@imapmail.org> writes:
>
>> I traced the problem to an extra forward-line added to
>> org-footnote-goto-local-insertion-point with commit
>> 145109dc4a6f161e4ad826bea9cc970363649280.
>>
>> The following patch fixes the sorting problem in org buffers. AFAICT, it
>> has no effect on footnote insertion in message mode buffers with
>> signatures. (Unfortunately, footnote sorting in message buffers with
>> signatures is broken both before and after this patch.)
>>
> My apologies. Please disregard this patch. It does not fix the issue and
> cause problems when creating footnotes.
>
> I'll take a closer look at the code when I get a chance.

The following patch fixes the sorting bug. It also inserts a blank line
above a new footnote definition, which is consistent with the spacing
that results when sorting footnotes. 

--8<---------------cut here---------------start------------->8---
diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index b6a9bca..f2b3489 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -314,7 +314,7 @@ or new, let the user edit the definition of the footnote."
     ;; Skip existing footnotes
     (while (re-search-forward "^[[:space:]]*\\[[^]]+\\] " nil t)
       (forward-line))
-    (insert "[" label "] \n")
+    (insert "\n[" label "] \n")
     (goto-char (1- (point)))
     (message "Edit definition and go back with `C-c &' or, if unique, with `C-c C-c'.")))
 
@@ -500,7 +500,7 @@ ENTRY is (fn-label num-mark definition)."
     (when (re-search-forward (format ".\\[%s[]:]" (regexp-quote (car entry)))
 			     nil t)
       (org-footnote-goto-local-insertion-point)
-      (insert (format "\n\n[%s] %s" (car entry) (nth 2 entry))))))
+      (insert (format "\n[%s] %s\n" (car entry) (nth 2 entry))))))
 
 (defun org-footnote-goto-local-insertion-point ()
   "Find insertion point for footnote, just before next outline heading."
--8<---------------cut here---------------end--------------->8---

Best,
Matt

[Accepted] [O] Re: Footnote sorting bug

[Bastien Guerry]

Patch 658 (http://patchwork.newartisans.com/patch/658/) is now "Accepted".

Maintainer comment: none

This relates to the following submission:

http://mid.gmane.org/%3C8762rul8xr.fsf%40fastmail.fm%3E

Here is the original message containing the patch:

> Content-Type: text/plain; charset="utf-8"
> MIME-Version: 1.0
> Content-Transfer-Encoding: 7bit
> Subject: [O] Re: Footnote sorting bug
> Date: Tue, 08 Mar 2011 06:04:00 -0000
> From: Matt Lundin <mdl@imapmail.org>
> X-Patchwork-Id: 658
> Message-Id: <8762rul8xr.fsf@fastmail.fm>
> To: Org Mode <emacs-orgmode@gnu.org>
> 
> Matt Lundin <mdl@imapmail.org> writes:
> 
> > Matt Lundin <mdl@imapmail.org> writes:
> >
> >> I traced the problem to an extra forward-line added to
> >> org-footnote-goto-local-insertion-point with commit
> >> 145109dc4a6f161e4ad826bea9cc970363649280.
> >>
> >> The following patch fixes the sorting problem in org buffers. AFAICT, it
> >> has no effect on footnote insertion in message mode buffers with
> >> signatures. (Unfortunately, footnote sorting in message buffers with
> >> signatures is broken both before and after this patch.)
> >>
> > My apologies. Please disregard this patch. It does not fix the issue and
> > cause problems when creating footnotes.
> >
> > I'll take a closer look at the code when I get a chance.
> 
> The following patch fixes the sorting bug. It also inserts a blank line
> above a new footnote definition, which is consistent with the spacing
> that results when sorting footnotes. 
> 
> --8<---------------cut here---------------start------------->8---
> --8<---------------cut here---------------end--------------->8---
> 
> Best,
> Matt
> 
> 
> diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
> index b6a9bca..f2b3489 100644
> --- a/lisp/org-footnote.el
> +++ b/lisp/org-footnote.el
> @@ -314,7 +314,7 @@ or new, let the user edit the definition of the footnote."
>      ;; Skip existing footnotes
>      (while (re-search-forward "^[[:space:]]*\\[[^]]+\\] " nil t)
>        (forward-line))
> -    (insert "[" label "] \n")
> +    (insert "\n[" label "] \n")
>      (goto-char (1- (point)))
>      (message "Edit definition and go back with `C-c &' or, if unique, with `C-c C-c'.")))
>  
> @@ -500,7 +500,7 @@ ENTRY is (fn-label num-mark definition)."
>      (when (re-search-forward (format ".\\[%s[]:]" (regexp-quote (car entry)))
>  			     nil t)
>        (org-footnote-goto-local-insertion-point)
> -      (insert (format "\n\n[%s] %s" (car entry) (nth 2 entry))))))
> +      (insert (format "\n[%s] %s\n" (car entry) (nth 2 entry))))))
>  
>  (defun org-footnote-goto-local-insertion-point ()
>    "Find insertion point for footnote, just before next outline heading."
> 

Re: Re: Footnote sorting bug

[Bastien]

Matt Lundin <mdl@imapmail.org> writes:

> The following patch fixes the sorting bug. It also inserts a blank line
> above a new footnote definition, which is consistent with the spacing
> that results when sorting footnotes. 

Applied, thanks.

-- 
 Bastien