Patchwork [Orgmode] Exporting footnotes

login
register
Submitter Ethan Glasser-Camp
Date 2011-01-30 08:00:21
Message ID <4D4528A5.1020700@cs.rpi.edu>
Download mbox | patch
Permalink /patch/566/
State Under Review
Delegated to: Bastien Guerry
Headers show

Comments

Ethan Glasser-Camp - 2011-01-30 08:00:21
Hi list,

I've been playing with the HTML export and it's pretty cool. I just have 
one quibble, which is that footnotes are always put at the end of the 
document. I'd like them to be at the end of each item, which is where I 
put them in my org file -- i.e. I've set org-footnote-section to nil.

I poked around in the code and it looks like the footnotes are being 
normalized, and the normalization function is putting them all at the 
end of the document. Normalization is necessary for the names of 
footnotes, but I think it is too aggressive about moving footnotes. Are 
there exporters for which collecting footnotes in one place is 
necessary? I think org-export-as-html could handle keeping the footnotes 
where they are with minimal changes.

Attached is a sketchy patch that does what I want. It's an ugly hack. 
What do you think?

Thanks.

Ethan
Bastien - 2011-02-12 14:59:16
Hi Ethan,

Ethan Glasser-Camp <glasse@cs.rpi.edu> writes:

> I've been playing with the HTML export and it's pretty cool. I just have
> one quibble, which is that footnotes are always put at the end of the
> document. I'd like them to be at the end of each item, which is where I put
> them in my org file -- i.e. I've set org-footnote-section to nil.
>
> I poked around in the code and it looks like the footnotes are being
> normalized, and the normalization function is putting them all at the end
> of the document. Normalization is necessary for the names of footnotes, but
> I think it is too aggressive about moving footnotes. 

I agree.

> Are there exporters for which collecting footnotes in one place is
> necessary? I think org-export-as-html could handle keeping the
> footnotes where they are with minimal changes.
>
> Attached is a sketchy patch that does what I want. It's an ugly hack. What
> do you think?

I tested the patch and it does what you want, thanks for it.

It doesn't break footnotes export in LaTeX (good thing!).  I didn't 
test for other exporters.

However, it seems to me that org-footnote-normalize does the right thing
when putting every footnotes at a single place -- at least, there should
be a footnote section, even when footnotes live within a subtree.  It'll
make life easier for exporter.

If you don't mind, I first want to do some work on the generic exporter
to decide how to implement your idea.

Thanks!

Patch

diff --git a/lisp/org-exp.el b/lisp/org-exp.el
index a055bac..99b3a64 100644
--- a/lisp/org-exp.el
+++ b/lisp/org-exp.el
@@ -1094,7 +1094,9 @@  on this string to produce the exported version."
 
       ;; Normalize footnotes
       (when (plist-get parameters :footnotes)
-	(org-footnote-normalize nil t))
+	(if htmlp
+	    (org-footnote-normalize nil org-footnote-section)
+	  (org-footnote-normalize nil t)))
 
       ;; Find all headings and compute the targets for them
       (setq target-alist (org-export-define-heading-targets target-alist))
diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el
index 88ffd6e..027856e 100644
--- a/lisp/org-footnote.el
+++ b/lisp/org-footnote.el
@@ -478,14 +478,24 @@  referenced sequence."
 	      (not sort-only)	     ; this is normalization
 	      for-preprocessor)       ; the is the preprocessor
 	  ;; Insert the footnotes together in one place
-	  (progn
-	    (setq def
-		  (mapconcat
-		   (lambda (x)
-		     (format "[%s] %s" (nth (if sort-only 0 1) x)
-			     (org-trim (nth 2 x))))
-		   ref-table "\n\n"))
-	    (if ref-table (insert "\n" def "\n\n")))
+	  (if for-preprocessor
+	      (progn
+		(message "%s" ref-table)
+		(setq def
+		      (mapconcat
+		       (lambda (x)
+			 (format "[%s] %s" (nth (if sort-only 0 1) x)
+				 (org-trim (nth 2 x))))
+		       ref-table "\n\n"))
+		(if ref-table (insert "\n" def "\n\n")))
+	    (mapc (lambda (entry)
+		    (when (car entry)
+		      (goto-char (point-min))
+		      (when (re-search-forward (format ".\\[%s[]:]" (regexp-quote (nth 1 entry)))
+					       nil t)
+			(org-footnote-goto-local-insertion-point)
+			(insert (format "\n\n[%s] %s" (nth 1 entry) (nth 2 entry))))))
+		  ref-table))
 	;; Insert each footnote near the first reference
 	;; Happens only in Org files with no special footnote section,
 	;; and only when doing sorting
diff --git a/lisp/org-html.el b/lisp/org-html.el
index 9a5d225..3dedab9 100644
--- a/lisp/org-html.el
+++ b/lisp/org-html.el
@@ -1676,16 +1676,19 @@  lang=\"%s\" xml:lang=\"%s\">
       ;; the </div> to close the last text-... div.
       (when (and (> umax 0) first-heading-pos) (insert "</div>\n"))
 
-      (save-excursion
-	(goto-char (point-min))
-	(while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
-	  (push (match-string 0) footnotes)
-	  (replace-match "" t t)))
-      (when footnotes
-	(insert (format org-export-html-footnotes-section
-			(nth 4 lang-words)
-			(mapconcat 'identity (nreverse footnotes) "\n"))
-		"\n"))
+      (when org-footnote-section
+	;; Move all the footnotes into a footnotes section
+	(save-excursion
+	  (goto-char (point-min))
+	  (while (re-search-forward "<p class=\"footnote\">[^\000]*?\\(</p>\\|\\'\\)" nil t)
+	    (push (match-string 0) footnotes)
+	    (replace-match "" t t)))
+	(when footnotes
+	  (insert (format org-export-html-footnotes-section
+			  (nth 4 lang-words)
+			  (mapconcat 'identity (nreverse footnotes) "\n"))
+		  "\n")))
+
       (let ((bib (org-export-html-get-bibliography)))
 	(when bib
 	  (insert "\n" bib "\n")))