bug#1318: document footnote-mode

bug#1318: document footnote-mode

[jidanni]

In footnote.el
     (defun footnote-mode (&optional arg)
       "Toggle footnote minor mode.
[Say here in lieu of better documentation:] To get started, play around
with these keys:
     \\<message-mode-map>
     key		binding
     ---		-------
Remove blank line here.
     \\[Footnote-renumber-footnotes]
     \\[Footnote-goto-footnote]
     \\[Footnote-delete-footnote]
     \\[Footnote-cycle-style]
     \\[Footnote-back-to-message]
     \\[Footnote-add-footnote]
Reorder the above with the most common operations first. Also
hardwiring them here often looses track of the complete list. Perhaps
just mention the most often used and say that is all you are mentioning.

bug#1318: document footnote-mode

[martin rudalics]

 >      \\[Footnote-renumber-footnotes]
 >      \\[Footnote-goto-footnote]
 >      \\[Footnote-delete-footnote]
 >      \\[Footnote-cycle-style]
 >      \\[Footnote-back-to-message]
 >      \\[Footnote-add-footnote]
 > Reorder the above with the most common operations first.

I've reordered these for Emacs 23 and fixed a couple of additional
bugs.  Please have a look, for example, via

cvs -z3 -d:pserver:anonymous@cvs.savannah.gnu.org:/cvsroot/emacs co emacs/lisp/mail/footnote.el

 > Also
 > hardwiring them here often looses track of the complete list. Perhaps
 > just mention the most often used and say that is all you are mentioning.

What do you mean by "hardwiring" here?

martin

bug#1318: document footnote-mode

[jidanni]

mr> bugs.  Please have a look, for example, via
mr> cvs -z3 -d:pserver:anonymous@cvs.savannah.gnu.org:/cvsroot/emacs co emacs/lisp/mail/footnote.el
(Say. What if one is reading this mail on a Windows machine at the
public library (where there is a waiting line of people and one only
has 30 minutes)... Hope there is also a HTTP address.)
OK, I managed to use cvs.

Say, perhaps make it a pure UTF-8 file, changing the latin-1 hardwired stuff.

>> Also hardwiring them here often looses track of the complete list.
>> Perhaps just mention the most often used and say that is all you
>> are mentioning.

mr> What do you mean by "hardwiring" here?

If you just dumped the C-c ! map, then you wouldn't need any
"\\[Footnote....] Footnote..." lines. (But then you couldn't order them
exactly. OK, never mind. Thanks.)

bug#1318: marked as done (document footnote-mode)

[Emacs bug Tracking System]

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


Your message dated Tue, 11 Nov 2008 10:41:38 +0100
with message-id <49195352.6040003@gmx.at>
and subject line Re: bug#1318: document footnote-mode
has caused the Emacs bug report #1318,
regarding document footnote-mode
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact don@donarmstrong.com
immediately.)


-- 
1318: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=1318
Emacs Bug Tracking System
Contact don@donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 2594 bytes --]

From: jidanni@jidanni.org
To: bug-gnu-emacs@gnu.org
Subject: document footnote-mode
Date: Sun, 09 Nov 2008 04:32:50 +0800
Message-ID: <87zlkat0ul.fsf@jidanni.org>

In footnote.el
     (defun footnote-mode (&optional arg)
       "Toggle footnote minor mode.
[Say here in lieu of better documentation:] To get started, play around
with these keys:
     \\<message-mode-map>
     key		binding
     ---		-------
Remove blank line here.
     \\[Footnote-renumber-footnotes]
     \\[Footnote-goto-footnote]
     \\[Footnote-delete-footnote]
     \\[Footnote-cycle-style]
     \\[Footnote-back-to-message]
     \\[Footnote-add-footnote]
Reorder the above with the most common operations first. Also
hardwiring them here often looses track of the complete list. Perhaps
just mention the most often used and say that is all you are mentioning.




[-- Attachment #3: Type: message/rfc822, Size: 1506 bytes --]

From: martin rudalics <rudalics@gmx.at>
To: 1318-done@emacsbugs.donarmstrong.com
Cc: jidanni@jidanni.org
Subject: Re: bug#1318: document footnote-mode
Date: Tue, 11 Nov 2008 10:41:38 +0100
Message-ID: <49195352.6040003@gmx.at>

Fixed as

	* mail/footnote.el (footnote-mode): Improve doc-string.
	Suggested by <jidanni@jidanni.org>.  (Bug#1318)

Thanks, martin