org.texi: Update footnotes documentation
* doc/org.texi (Footnotes): Be more accurate about footnote marker. Remove useless information. Inline definitions need not start with a whitepace.
This commit is contained in:
parent
6de8c94d8d
commit
3699558452
20
doc/org.texi
20
doc/org.texi
|
@ -1906,14 +1906,13 @@ or on a per-file basis by using
|
||||||
@section Footnotes
|
@section Footnotes
|
||||||
@cindex footnotes
|
@cindex footnotes
|
||||||
|
|
||||||
Org mode supports the creation of footnotes. In contrast to the
|
Org mode supports the creation of footnotes.
|
||||||
@file{footnote.el} package, Org mode's footnotes are designed for work on
|
|
||||||
a larger document, not only for one-off documents like emails.
|
|
||||||
|
|
||||||
A footnote is started by a footnote marker in square brackets in column 0, no
|
A footnote is started by a footnote marker in square brackets in column 0, no
|
||||||
indentation allowed. It ends at the next footnote definition, headline, or
|
indentation allowed. It ends at the next footnote definition, headline, or
|
||||||
after two consecutive empty lines. The footnote reference is simply the
|
after two consecutive empty lines. The footnote reference is simply the
|
||||||
marker in square brackets, inside text. For example:
|
marker in square brackets, inside text. Markers always start with
|
||||||
|
@code{fn:}. For example:
|
||||||
|
|
||||||
@example
|
@example
|
||||||
The Org homepage[fn:1] now looks a lot better than it used to.
|
The Org homepage[fn:1] now looks a lot better than it used to.
|
||||||
|
@ -1928,10 +1927,10 @@ optional inline definition. Here are the valid references:
|
||||||
@item [fn:name]
|
@item [fn:name]
|
||||||
A named footnote reference, where @code{name} is a unique label word, or, for
|
A named footnote reference, where @code{name} is a unique label word, or, for
|
||||||
simplicity of automatic creation, a number.
|
simplicity of automatic creation, a number.
|
||||||
@item [fn:: This is the inline definition of this footnote]
|
@item [fn::This is the inline definition of this footnote]
|
||||||
A @LaTeX{}-like anonymous footnote where the definition is given directly at the
|
A @LaTeX{}-like anonymous footnote where the definition is given directly at the
|
||||||
reference point.
|
reference point.
|
||||||
@item [fn:name: a definition]
|
@item [fn:name:a definition]
|
||||||
An inline definition of a footnote, which also specifies a name for the note.
|
An inline definition of a footnote, which also specifies a name for the note.
|
||||||
Since Org allows multiple references to the same note, you can then use
|
Since Org allows multiple references to the same note, you can then use
|
||||||
@code{[fn:name]} to create additional references.
|
@code{[fn:name]} to create additional references.
|
||||||
|
@ -1978,9 +1977,7 @@ r @r{Renumber the simple @code{fn:N} footnotes. Automatic renumbering}
|
||||||
S @r{Short for first @code{r}, then @code{s} action.}
|
S @r{Short for first @code{r}, then @code{s} action.}
|
||||||
n @r{Normalize the footnotes by collecting all definitions (including}
|
n @r{Normalize the footnotes by collecting all definitions (including}
|
||||||
@r{inline definitions) into a special section, and then numbering them}
|
@r{inline definitions) into a special section, and then numbering them}
|
||||||
@r{in sequence. The references will then also be numbers. This is}
|
@r{in sequence. The references will then also be numbers.}
|
||||||
@r{meant to be the final step before finishing a document (e.g., sending}
|
|
||||||
@r{off an email).}
|
|
||||||
d @r{Delete the footnote at point, and all definitions of and references}
|
d @r{Delete the footnote at point, and all definitions of and references}
|
||||||
@r{to it.}
|
@r{to it.}
|
||||||
@end example
|
@end example
|
||||||
|
@ -2005,9 +2002,8 @@ you can use the usual commands to follow these links.
|
||||||
@kindex C-c '
|
@kindex C-c '
|
||||||
@item C-c '
|
@item C-c '
|
||||||
@item C-c '
|
@item C-c '
|
||||||
Edit the footnote definition corresponding to the reference at point in a
|
Edit the footnote definition corresponding to the reference at point in
|
||||||
seperate window. This may be useful if editing footnotes in a narrowed
|
a seperate window. The window can be closed by pressing @kbd{C-c '}.
|
||||||
buffer. The window can be closed by pressing @kbd{C-c '}.
|
|
||||||
|
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
|
|
16
etc/ORG-NEWS
16
etc/ORG-NEWS
|
@ -76,6 +76,22 @@ using previous syntax:
|
||||||
(replace-match "EXPORT \\1" nil nil nil 1)))))))))
|
(replace-match "EXPORT \\1" nil nil nil 1)))))))))
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
|
** Incompatible changes
|
||||||
|
*** Footnotes
|
||||||
|
**** [1]-like constructs are not valid footnotes
|
||||||
|
Using =[1]= as a footnote was already discouraged in the manual, since
|
||||||
|
it introduced too many false-positives in many Org documents. These
|
||||||
|
constructs are now unsupported.
|
||||||
|
|
||||||
|
If you used =[N]= in some of your documents, consider turning them
|
||||||
|
into =[fn:N]=.
|
||||||
|
**** /Org Footnote/ library doesn't handle non-Org buffers
|
||||||
|
Commands for footnotes in an Org document no longer try to do
|
||||||
|
something in non-Org ones. If you need to have footnotes there,
|
||||||
|
consider using =footnote.el= library, shipped with Emacs.
|
||||||
|
|
||||||
|
In particular, ~org-footnote-tag-for-non-org-mode-files~ no longer
|
||||||
|
exists.
|
||||||
** New features
|
** New features
|
||||||
*** New org-protocol key=value syntax
|
*** New org-protocol key=value syntax
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue