emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: tsd@tsdye.com (Thomas S. Dye)
To: Org-mode <emacs-orgmode@gnu.org>
Subject: Adventures with org-footnote-auto-adjust
Date: Sat, 23 Feb 2013 08:09:34 -1000	[thread overview]
Message-ID: <m1ehg6zyu9.fsf@poto.myhome.westell.com> (raw)

Aloha all,

I keep footnotes in their own section and appreciate having them out of
the way, where I don't have to think about them.

Recently, I set #+STARTUP: fnadjust because I thought it would be nice
to have the footnotes sorted and renumbered.  This was a mistake in my
case that lost data.  I think I know how it happened, though I wasn't
really paying attention to the footnotes as I worked.

In the document I'm editing, I have sentences like this:

  If you want a list to start with a different value (e.g., 20),[fn:17]
  start the text of the item with ~[@20]~.

As a matter of style, I prefer the footnote (which contains qualifying
text, rather than a reference) be at the end of the sentence, and that
it immediately follow the period.  So, I cut and paste to get this:

  If you want a list to start with a different value (e.g., 20),
  start the text of the item with ~[@20]~.[fn:17]

Now, the next time I insert a footnote, with C-c C-x f, I get something
like this:

  If you want a list to start with a different value (e.g., 20),[fn:17]
  start the text of the item with ~[@20]~.[fn:17]

The text of the original footnote, [fn:17], is lost, though the mark
remains in the text.  If the new [fn:17] is some distance away, then the
problem of duplicate numbers isn't readily apparent in the midst of
other work.  Of course, I subsequently discovered that `~.[fn:17]'
wasn't working and put the space back in.  Now, the footnote refers to
the wrong text.

I've learned that there are certain conditions (I don't know how many)
where the space after a sentence won't accept a footnote insertion. The
example sentence is one of these. Apparently, it is the `~.' combination
that triggers the condition. Org is good enough to prohibit inserting a
new footnote into one of these "black holes" (which is how I discovered
them), but it doesn't mind if I cut and paste a footnote into one. 

I'm not certain how much mischief this might have caused. I discovered
the problem when the text of *both* footnotes in a section of the
document were incorrect.

In my case, org-footnote-auto-adjust doesn't perform any crucial
function--it just makes the Org mode buffer seem more orderly.  Given
that there are "black holes" in the buffer, whose presence have the
ability to confuse org-footnote-auto-adjust so that data are lost,
should org-footnote-auto-adjust be deprecated?

All the best,
Tom

-- 
Thomas S. Dye
http://www.tsdye.com

             reply	other threads:[~2013-02-23 18:10 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-02-23 18:09 Thomas S. Dye [this message]
2013-02-25 10:54 ` Adventures with org-footnote-auto-adjust Nicolas Goaziou
2013-02-25 15:56   ` Thomas S. Dye
2013-02-25 16:06     ` Nicolas Goaziou

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=m1ehg6zyu9.fsf@poto.myhome.westell.com \
    --to=tsd@tsdye.com \
    --cc=emacs-orgmode@gnu.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public 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).