ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

org-capture: Get capture templates from anonymous functions 

* lisp/org-capture.el (org-capture-get-template): Allow specifying
template from an anonymous function.
* doc/org-manual.org (Template elements): Document it.
This commit is contained in:
Nicolas Goaziou 2019-12-12 22:33:22 +01:00
parent f9a55cba31
commit b64a3308aa
2 changed files with 171 additions and 167 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

310
doc/org-manual.org
View File

@ -7540,9 +7540,12 @@ Now lets look at the elements of a template definition. Each entry in
The template for creating the capture item. If you leave this The template for creating the capture item. If you leave this
empty, an appropriate default template will be used. Otherwise this empty, an appropriate default template will be used. Otherwise this
is a string with escape codes, which will be replaced depending on is a string with escape codes, which will be replaced depending on
time and context of the capture call. The string with escapes may time and context of the capture call. You may also get this
be loaded from a template file, using the special syntax =(file template string from a file[fn:85], or dynamically, from a function
"template filename")=. See below for more details. using either syntax:
: (file "/path/to/template-file")
: (function FUNCTION-RETURNING-THE-TEMPLATE)
- properties :: - properties ::
@ -7622,7 +7625,7 @@ Now lets look at the elements of a template definition. Each entry in
:DESCRIPTION: Filling in information about time and context. :DESCRIPTION: Filling in information about time and context.
:END: :END:
In the template itself, special "%-escapes"[fn:85] allow dynamic In the template itself, special "%-escapes"[fn:86] allow dynamic
insertion of content. The templates are expanded in the order given insertion of content. The templates are expanded in the order given
here: here:
@ -7749,7 +7752,7 @@ here:
After completing the template, position point here. After completing the template, position point here.
#+vindex: org-store-link-props #+vindex: org-store-link-props
For specific link types, the following keywords are defined[fn:86]: For specific link types, the following keywords are defined[fn:87]:
#+vindex: org-link-from-user-regexp #+vindex: org-link-from-user-regexp
| Link type | Available keywords | | Link type | Available keywords |
@ -7762,7 +7765,7 @@ For specific link types, the following keywords are defined[fn:86]:
| | =%:date= (message date header field) | | | =%:date= (message date header field) |
| | =%:date-timestamp= (date as active timestamp) | | | =%:date-timestamp= (date as active timestamp) |
| | =%:date-timestamp-inactive= (date as inactive timestamp) | | | =%:date-timestamp-inactive= (date as inactive timestamp) |
| | =%:fromto= (either "to NAME" or "from NAME")[fn:87] | | | =%:fromto= (either "to NAME" or "from NAME")[fn:88] |
| gnus | =%:group=, for messages also all email fields | | gnus | =%:group=, for messages also all email fields |
| w3, w3m | =%:url= | | w3, w3m | =%:url= |
| info | =%:file=, =%:node= | | info | =%:file=, =%:node= |
@ -7820,7 +7823,7 @@ By default, org-attach will use ID properties when adding attachments
to outline nodes. This makes working with attachments fully to outline nodes. This makes working with attachments fully
automated. There is no decision needed for folder-name or location. automated. There is no decision needed for folder-name or location.
ID-based directories are by default located in the =data/= directory, ID-based directories are by default located in the =data/= directory,
which lives in the same directory where your Org file lives[fn:88]. which lives in the same directory where your Org file lives[fn:89].
For more control over the setup, see [[*Attachment options]]. For more control over the setup, see [[*Attachment options]].
When attachments are made using ~org-attach~ a default tag =ATTACH= is When attachments are made using ~org-attach~ a default tag =ATTACH= is
@ -8199,12 +8202,12 @@ the window configuration is restored when the agenda exits:
#+vindex: org-agenda-files #+vindex: org-agenda-files
The information to be shown is normally collected from all /agenda The information to be shown is normally collected from all /agenda
files/, the files listed in the variable ~org-agenda-files~[fn:89]. files/, the files listed in the variable ~org-agenda-files~[fn:90].
If a directory is part of this list, all files with the extension If a directory is part of this list, all files with the extension
=.org= in this directory are part of the list. =.org= in this directory are part of the list.
Thus, even if you only work with a single Org file, that file should Thus, even if you only work with a single Org file, that file should
be put into the list[fn:90]. You can customize ~org-agenda-files~, be put into the list[fn:91]. You can customize ~org-agenda-files~,
but the easiest way to maintain it is through the following commands but the easiest way to maintain it is through the following commands
#+attr_texinfo: :sep and #+attr_texinfo: :sep and
@ -8337,7 +8340,7 @@ commands:
- {{{kbd(<)}}} :: - {{{kbd(<)}}} ::
#+kindex: < @r{(Agenda dispatcher)} #+kindex: < @r{(Agenda dispatcher)}
Restrict an agenda command to the current buffer[fn:91]. If Restrict an agenda command to the current buffer[fn:92]. If
narrowing is in effect restrict to the narrowed part of the buffer. narrowing is in effect restrict to the narrowed part of the buffer.
After pressing {{{kbd(<)}}}, you still need to press the character After pressing {{{kbd(<)}}}, you still need to press the character
selecting the command. selecting the command.
@ -8347,7 +8350,7 @@ commands:
#+kindex: < < @r{(Agenda dispatcher)} #+kindex: < < @r{(Agenda dispatcher)}
If there is an active region, restrict the following agenda command If there is an active region, restrict the following agenda command
to the region. Otherwise, restrict it to the current to the region. Otherwise, restrict it to the current
subtree[fn:92]. After pressing {{{kbd(< <)}}}, you still need to subtree[fn:93]. After pressing {{{kbd(< <)}}}, you still need to
press the character selecting the command. press the character selecting the command.
- {{{kbd(*)}}} :: - {{{kbd(*)}}} ::
@ -8397,7 +8400,7 @@ a paper agenda, showing all the tasks for the current week or day.
#+cindex: org-agenda, command #+cindex: org-agenda, command
Compile an agenda for the current week from a list of Org files. Compile an agenda for the current week from a list of Org files.
The agenda shows the entries for each day. With a numeric prefix The agenda shows the entries for each day. With a numeric prefix
argument[fn:93]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you may argument[fn:94]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you may
set the number of days to be displayed. set the number of days to be displayed.
#+vindex: org-agenda-span #+vindex: org-agenda-span
@ -8456,7 +8459,7 @@ move the entries into an Org file. Org mode evaluates diary-style
expression entries, and does it faster because there is no overhead expression entries, and does it faster because there is no overhead
for first creating the diary display. Note that the expression for first creating the diary display. Note that the expression
entries must start at the left margin, no whitespace is allowed before entries must start at the left margin, no whitespace is allowed before
them, as seen in the following segment of an Org file:[fn:94] them, as seen in the following segment of an Org file:[fn:95]
#+begin_example #+begin_example
,* Holidays ,* Holidays
@ -8958,7 +8961,7 @@ Time ranges can be specified with two timestamps:
#+vindex: org-agenda-search-headline-for-time #+vindex: org-agenda-search-headline-for-time
In the headline of the entry itself, a time(range)---like =12:45= or In the headline of the entry itself, a time(range)---like =12:45= or
a =8:30-1pm=---may also appear as plain text[fn:95]. a =8:30-1pm=---may also appear as plain text[fn:96].
If the agenda integrates the Emacs diary (see [[*Weekly/daily agenda]]), If the agenda integrates the Emacs diary (see [[*Weekly/daily agenda]]),
time specifications in diary entries are recognized as well. time specifications in diary entries are recognized as well.
@ -9048,7 +9051,7 @@ filters and limits allow to flexibly narrow down the list of agenda
entries. entries.
/Filters/ only change the visibility of items, are very fast and are /Filters/ only change the visibility of items, are very fast and are
mostly used interactively[fn:96]. You can switch quickly between mostly used interactively[fn:97]. You can switch quickly between
different filters without having to recreate the agenda. /Limits/ on different filters without having to recreate the agenda. /Limits/ on
the other hand take effect before the agenda buffer is populated, so the other hand take effect before the agenda buffer is populated, so
they are mostly useful when defined as local variables within custom they are mostly useful when defined as local variables within custom
@ -9513,7 +9516,7 @@ the other commands, point needs to be in the desired line.
variable ~org-agenda-start-with-clockreport-mode~. By using variable ~org-agenda-start-with-clockreport-mode~. By using
a prefix argument when toggling this mode (i.e., {{{kbd(C-u R)}}}), a prefix argument when toggling this mode (i.e., {{{kbd(C-u R)}}}),
the clock table does not show contributions from entries that are the clock table does not show contributions from entries that are
hidden by agenda filtering[fn:97]. See also the variable hidden by agenda filtering[fn:98]. See also the variable
~org-clock-report-include-clocking-task~. ~org-clock-report-include-clocking-task~.
- {{{kbd(v c)}}} :: - {{{kbd(v c)}}} ::
@ -9952,7 +9955,7 @@ the other commands, point needs to be in the desired line.
- {{{kbd(f)}}} :: - {{{kbd(f)}}} ::
#+vindex: org-agenda-bulk-custom-functions #+vindex: org-agenda-bulk-custom-functions
Apply a function[fn:98] to marked entries. For example, the Apply a function[fn:99] to marked entries. For example, the
function below sets the =CATEGORY= property of the entries to function below sets the =CATEGORY= property of the entries to
=web=. =web=.
@ -9992,7 +9995,7 @@ the other commands, point needs to be in the desired line.
#+cindex: diary entries, creating from agenda #+cindex: diary entries, creating from agenda
Insert a new entry into the diary, using the date at point and (for Insert a new entry into the diary, using the date at point and (for
block entries) the date at the mark. This adds to the Emacs diary block entries) the date at the mark. This adds to the Emacs diary
file[fn:99], in a way similar to the {{{kbd(i)}}} command in the file[fn:100], in a way similar to the {{{kbd(i)}}} command in the
calendar. The diary file pops up in another window, where you can calendar. The diary file pops up in another window, where you can
add the entry. add the entry.
@ -10118,13 +10121,13 @@ after the dispatcher command in order to access the command. Usually
this is just a single character, but if you have many similar this is just a single character, but if you have many similar
commands, you can also define two-letter combinations where the first commands, you can also define two-letter combinations where the first
character is the same in several combinations and serves as a prefix character is the same in several combinations and serves as a prefix
key[fn:100]. The second parameter is the search type, followed by the key[fn:101]. The second parameter is the search type, followed by the
string or regular expression to be used for the matching. The example string or regular expression to be used for the matching. The example
above will therefore define: above will therefore define:
- {{{kbd(x)}}} :: - {{{kbd(x)}}} ::
as a global search for agenda entries planned[fn:101] this week/day. as a global search for agenda entries planned[fn:102] this week/day.
- {{{kbd(y)}}} :: - {{{kbd(y)}}} ::
@ -10304,8 +10307,8 @@ See the docstring of the variable for more information.
If you are away from your computer, it can be very useful to have If you are away from your computer, it can be very useful to have
a printed version of some agenda views to carry around. Org mode can a printed version of some agenda views to carry around. Org mode can
export custom agenda views as plain text, HTML[fn:102], Postscript, export custom agenda views as plain text, HTML[fn:103], Postscript,
PDF[fn:103], and iCalendar files. If you want to do this only PDF[fn:104], and iCalendar files. If you want to do this only
occasionally, use the following command: occasionally, use the following command:
- {{{kbd(C-x C-w)}}} (~org-agenda-write~) :: - {{{kbd(C-x C-w)}}} (~org-agenda-write~) ::
@ -10319,7 +10322,7 @@ occasionally, use the following command:
If you need to export certain agenda views frequently, you can If you need to export certain agenda views frequently, you can
associate any custom agenda command with a list of output file associate any custom agenda command with a list of output file
names[fn:104]. Here is an example that first defines custom commands names[fn:105]. Here is an example that first defines custom commands
for the agenda and the global TODO list, together with a number of for the agenda and the global TODO list, together with a number of
files to which to export them. Then we define two block agenda files to which to export them. Then we define two block agenda
commands and specify file names for them as well. File names can be commands and specify file names for them as well. File names can be
@ -10407,7 +10410,7 @@ emacs -eval (org-batch-store-agenda-views) -kill
#+end_src #+end_src
#+texinfo: @noindent #+texinfo: @noindent
or, if you need to modify some parameters[fn:105] or, if you need to modify some parameters[fn:106]
#+begin_src shell #+begin_src shell
emacs -eval '(org-batch-store-agenda-views \ emacs -eval '(org-batch-store-agenda-views \
@ -10651,7 +10654,7 @@ becomes =&nbsp;= in HTML and =~= in LaTeX.
#+cindex: special symbols, in-buffer display #+cindex: special symbols, in-buffer display
If you would like to see entities displayed as UTF-8 characters, use If you would like to see entities displayed as UTF-8 characters, use
the following command[fn:106]: the following command[fn:107]:
- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) :: - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
#+kindex: C-c C-x \ #+kindex: C-c C-x \
@ -10665,7 +10668,7 @@ the following command[fn:106]:
#+cindex: dash, special symbol #+cindex: dash, special symbol
#+cindex: ellipsis, special symbol #+cindex: ellipsis, special symbol
In addition to regular entities defined above, Org exports in In addition to regular entities defined above, Org exports in
a special way[fn:107] the following commonly used character a special way[fn:108] the following commonly used character
combinations: =\-= is treated as a shy hyphen, =--= and =---= are combinations: =\-= is treated as a shy hyphen, =--= and =---= are
converted into dashes, and =...= becomes a compact set of dots. converted into dashes, and =...= becomes a compact set of dots.
@ -10678,7 +10681,7 @@ converted into dashes, and =...= becomes a compact set of dots.
Plain ASCII is normally sufficient for almost all note taking. Plain ASCII is normally sufficient for almost all note taking.
Exceptions include scientific notes, which often require mathematical Exceptions include scientific notes, which often require mathematical
symbols and the occasional formula. LaTeX[fn:108] is widely used to symbols and the occasional formula. LaTeX[fn:109] is widely used to
typeset scientific documents. Org mode supports embedding LaTeX code typeset scientific documents. Org mode supports embedding LaTeX code
into its files, because many academics are used to writing and reading into its files, because many academics are used to writing and reading
LaTeX source code, and because it can be readily processed to produce LaTeX source code, and because it can be readily processed to produce
@ -10700,7 +10703,7 @@ into images (see [[*Previewing LaTeX fragments]]).
LaTeX fragments do not need any special marking at all. The following LaTeX fragments do not need any special marking at all. The following
snippets are identified as LaTeX source code: snippets are identified as LaTeX source code:
- Environments of any kind[fn:109]. The only requirement is that the - Environments of any kind[fn:110]. The only requirement is that the
=\begin= statement appears on a new line, preceded by only =\begin= statement appears on a new line, preceded by only
whitespace. whitespace.
@ -10744,7 +10747,7 @@ lines:
#+vindex: org-preview-latex-default-process #+vindex: org-preview-latex-default-process
If you have a working LaTeX installation and =dvipng=, =dvisvgm= or If you have a working LaTeX installation and =dvipng=, =dvisvgm= or
=convert= installed[fn:110], LaTeX fragments can be processed to =convert= installed[fn:111], LaTeX fragments can be processed to
produce images of the typeset expressions to be used for inclusion produce images of the typeset expressions to be used for inclusion
while exporting to HTML (see [[*LaTeX fragments]]), or for inline while exporting to HTML (see [[*LaTeX fragments]]), or for inline
previewing within Org mode. previewing within Org mode.
@ -10815,7 +10818,7 @@ more details see the documentation of CDLaTeX mode):
#+kindex: TAB #+kindex: TAB
The {{{kbd(TAB)}}} key expands the template if point is inside The {{{kbd(TAB)}}} key expands the template if point is inside
a LaTeX fragment[fn:111]. For example, {{{kbd(TAB)}}} expands =fr= a LaTeX fragment[fn:112]. For example, {{{kbd(TAB)}}} expands =fr=
to =\frac{}{}= and position point correctly inside the first brace. to =\frac{}{}= and position point correctly inside the first brace.
Another {{{kbd(TAB)}}} gets you into the second brace. Another {{{kbd(TAB)}}} gets you into the second brace.
@ -10898,9 +10901,9 @@ Here is an example
#+vindex: org-latex-listings #+vindex: org-latex-listings
If the example is source code from a programming language, or any If the example is source code from a programming language, or any
other text that can be marked up by Font Lock in Emacs, you can ask other text that can be marked up by Font Lock in Emacs, you can ask
for the example to look like the fontified Emacs buffer[fn:112]. This for the example to look like the fontified Emacs buffer[fn:113]. This
is done with the code block, where you also need to specify the name is done with the code block, where you also need to specify the name
of the major mode that should be used to fontify the example[fn:113], of the major mode that should be used to fontify the example[fn:114],
see [[*Structure Templates]] for shortcuts to easily insert code blocks. see [[*Structure Templates]] for shortcuts to easily insert code blocks.
#+cindex: @samp{BEGIN_SRC} #+cindex: @samp{BEGIN_SRC}
@ -10941,7 +10944,7 @@ In HTML, hovering the mouse over such a link remote-highlights the
corresponding code line, which is kind of cool. corresponding code line, which is kind of cool.
You can also add a =-r= switch which /removes/ the labels from the You can also add a =-r= switch which /removes/ the labels from the
source code[fn:114]. With the =-n= switch, links to these references source code[fn:115]. With the =-n= switch, links to these references
are labeled by the line numbers from the code listing. Otherwise are labeled by the line numbers from the code listing. Otherwise
links use the labels with no parentheses. Here is an example: links use the labels with no parentheses. Here is an example:
@ -10986,7 +10989,7 @@ a shortcut is provided (see [[*Structure Templates]]).
need to exit by pressing {{{kbd(C-c ')}}} again. The edited version need to exit by pressing {{{kbd(C-c ')}}} again. The edited version
then replaces the old version in the Org buffer. Fixed-width then replaces the old version in the Org buffer. Fixed-width
regions---where each line starts with a colon followed by regions---where each line starts with a colon followed by
a space---are edited using Artist mode[fn:115] to allow creating a space---are edited using Artist mode[fn:116] to allow creating
ASCII drawings easily. Using this command in an empty line creates ASCII drawings easily. Using this command in an empty line creates
a new fixed-width region. a new fixed-width region.
@ -11005,7 +11008,7 @@ the end of the current line. Then the label is stored as a link
#+cindex: inlining images #+cindex: inlining images
#+cindex: images, markup rules #+cindex: images, markup rules
An image is a link to an image file[fn:116] that does not have An image is a link to an image file[fn:117] that does not have
a description part, for example a description part, for example
: ./img/cat.jpg : ./img/cat.jpg
@ -11033,7 +11036,7 @@ command:
a prefix argument, also display images that do have a link a prefix argument, also display images that do have a link
description. You can ask for inline images to be displayed at description. You can ask for inline images to be displayed at
startup by configuring the variable startup by configuring the variable
~org-startup-with-inline-images~[fn:117]. ~org-startup-with-inline-images~[fn:118].
** Captions ** Captions
:PROPERTIES: :PROPERTIES:
@ -11125,7 +11128,7 @@ The following command handles footnotes:
#+vindex: org-footnote-define-inline #+vindex: org-footnote-define-inline
#+vindex: org-footnote-section #+vindex: org-footnote-section
Otherwise, create a new footnote. Depending on the variable Otherwise, create a new footnote. Depending on the variable
~org-footnote-define-inline~[fn:118], the definition is placed right ~org-footnote-define-inline~[fn:119], the definition is placed right
into the text as part of the reference, or separately into the into the text as part of the reference, or separately into the
location determined by the variable ~org-footnote-section~. location determined by the variable ~org-footnote-section~.
@ -11140,7 +11143,7 @@ The following command handles footnotes:
| {{{kbd(d)}}} | Delete the footnote at point, including definition and references. | | {{{kbd(d)}}} | Delete the footnote at point, including definition and references. |
#+vindex: org-footnote-auto-adjust #+vindex: org-footnote-auto-adjust
Depending on the variable ~org-footnote-auto-adjust~[fn:119], Depending on the variable ~org-footnote-auto-adjust~[fn:120],
renumbering and sorting footnotes can be automatic after each renumbering and sorting footnotes can be automatic after each
insertion or deletion. insertion or deletion.
@ -11330,7 +11333,7 @@ global variables, include:
#+cindex: @samp{DATE}, keyword #+cindex: @samp{DATE}, keyword
#+vindex: org-export-date-timestamp-format #+vindex: org-export-date-timestamp-format
A date or a time-stamp[fn:120]. A date or a time-stamp[fn:121].
- =EMAIL= :: - =EMAIL= ::
@ -11345,7 +11348,7 @@ global variables, include:
Language to use for translating certain strings Language to use for translating certain strings
(~org-export-default-language~). With =#+LANGUAGE: fr=, for (~org-export-default-language~). With =#+LANGUAGE: fr=, for
example, Org translates =Table of contents= to the French =Table des example, Org translates =Table of contents= to the French =Table des
matières=[fn:121]. matières=[fn:122].
- =SELECT_TAGS= :: - =SELECT_TAGS= ::
@ -11622,7 +11625,7 @@ keyword:
#+cindex: excluding entries from table of contents #+cindex: excluding entries from table of contents
#+cindex: table of contents, exclude entries #+cindex: table of contents, exclude entries
Org includes both numbered and unnumbered headlines in the table of Org includes both numbered and unnumbered headlines in the table of
contents[fn:122]. If you need to exclude an unnumbered headline, contents[fn:123]. If you need to exclude an unnumbered headline,
along with all its children, set the =UNNUMBERED= property to =notoc= along with all its children, set the =UNNUMBERED= property to =notoc=
value. value.
@ -11741,7 +11744,7 @@ be omitted to use the obvious defaults.
| =#+INCLUDE: "~/.emacs" :lines "10-"= | Include lines from 10 to EOF | | =#+INCLUDE: "~/.emacs" :lines "10-"= | Include lines from 10 to EOF |
Inclusions may specify a file-link to extract an object matched by Inclusions may specify a file-link to extract an object matched by
~org-link-search~[fn:123] (see [[*Search Options in File Links]]). The ~org-link-search~[fn:124] (see [[*Search Options in File Links]]). The
ranges for =:lines= keyword are relative to the requested element. ranges for =:lines= keyword are relative to the requested element.
Therefore, Therefore,
@ -11781,7 +11784,7 @@ following syntax:
: #+MACRO: name replacement text; $1, $2 are arguments : #+MACRO: name replacement text; $1, $2 are arguments
#+texinfo: @noindent #+texinfo: @noindent
which can be referenced using ={{{name(arg1, arg2)}}}=[fn:124]. For which can be referenced using ={{{name(arg1, arg2)}}}=[fn:125]. For
example example
#+begin_example #+begin_example
@ -11900,7 +11903,7 @@ are not exported.
Finally, a =COMMENT= keyword at the beginning of an entry, but after Finally, a =COMMENT= keyword at the beginning of an entry, but after
any other keyword or priority cookie, comments out the entire subtree. any other keyword or priority cookie, comments out the entire subtree.
In this case, the subtree is not exported and no code block within it In this case, the subtree is not exported and no code block within it
is executed either[fn:125]. The command below helps changing the is executed either[fn:126]. The command below helps changing the
comment status of a headline. comment status of a headline.
- {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: - {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
@ -12172,7 +12175,7 @@ should in principle be exportable as a Beamer presentation.
- Org exports a Beamer frame's objects as block environments. Org can - Org exports a Beamer frame's objects as block environments. Org can
enforce wrapping in special block types when =BEAMER_ENV= property enforce wrapping in special block types when =BEAMER_ENV= property
is set[fn:126]. For valid values see is set[fn:127]. For valid values see
~org-beamer-environments-default~. To add more values, see ~org-beamer-environments-default~. To add more values, see
~org-beamer-environments-extra~. ~org-beamer-environments-extra~.
#+vindex: org-beamer-environments-default #+vindex: org-beamer-environments-default
@ -12757,7 +12760,7 @@ as-is.
#+vindex: org-html-mathjax-options~ #+vindex: org-html-mathjax-options~
LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two LaTeX math snippets (see [[*LaTeX fragments]]) can be displayed in two
different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]], different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax]],
which should work out of the box with Org[fn:127][fn:128]. Some MathJax which should work out of the box with Org[fn:128][fn:129]. Some MathJax
display options can be configured via ~org-html-mathjax-options~, or display options can be configured via ~org-html-mathjax-options~, or
in the buffer. For example, with the following settings, in the buffer. For example, with the following settings,
@ -12769,7 +12772,7 @@ in the buffer. For example, with the following settings,
#+texinfo: @noindent #+texinfo: @noindent
equation labels are displayed on the left margin and equations are equation labels are displayed on the left margin and equations are
five em from the left margin. In addition, it loads the two MathJax five em from the left margin. In addition, it loads the two MathJax
extensions =cancel.js= and =noErrors.js=[fn:129]. extensions =cancel.js= and =noErrors.js=[fn:130].
#+vindex: org-html-mathjax-template #+vindex: org-html-mathjax-template
See the docstring of ~org-html-mathjax-options~ for all supported See the docstring of ~org-html-mathjax-options~ for all supported
@ -12832,7 +12835,7 @@ line.
#+vindex: org-export-html-todo-kwd-class-prefix #+vindex: org-export-html-todo-kwd-class-prefix
#+vindex: org-export-html-tag-class-prefix #+vindex: org-export-html-tag-class-prefix
You can modify the CSS style definitions for the exported file. The You can modify the CSS style definitions for the exported file. The
HTML exporter assigns the following special CSS classes[fn:130] to HTML exporter assigns the following special CSS classes[fn:131] to
appropriate parts of the document---your style specifications may appropriate parts of the document---your style specifications may
change these, in addition to any of the standard classes like for change these, in addition to any of the standard classes like for
headlines, tables, etc. headlines, tables, etc.
@ -13071,7 +13074,7 @@ LaTeX export back-end finds the compiler version to use from
Org file. See the docstring for the Org file. See the docstring for the
~org-latex-default-packages-alist~ for loading packages with certain ~org-latex-default-packages-alist~ for loading packages with certain
compilers. Also see ~org-latex-bibtex-compiler~ to set the compilers. Also see ~org-latex-bibtex-compiler~ to set the
bibliography compiler[fn:131]. bibliography compiler[fn:132].
*** LaTeX specific export settings *** LaTeX specific export settings
:PROPERTIES: :PROPERTIES:
@ -13693,7 +13696,7 @@ a limit to a level before the absolute limit (see [[*Export Settings]]).
The ODT export back-end handles creating of OpenDocument Text (ODT) The ODT export back-end handles creating of OpenDocument Text (ODT)
format. Documents created by this exporter use the format. Documents created by this exporter use the
{{{cite(OpenDocument-v1.2 specification)}}}[fn:132] and are compatible {{{cite(OpenDocument-v1.2 specification)}}}[fn:133] and are compatible
with LibreOffice 3.4. with LibreOffice 3.4.
*** Pre-requisites for ODT export *** Pre-requisites for ODT export
@ -14094,7 +14097,7 @@ document in one of the following ways:
variables ~org-latex-to-mathml-convert-command~ and variables ~org-latex-to-mathml-convert-command~ and
~org-latex-to-mathml-jar-file~. ~org-latex-to-mathml-jar-file~.
If you prefer to use MathToWeb[fn:133] as your converter, you can If you prefer to use MathToWeb[fn:134] as your converter, you can
configure the above variables as shown below. configure the above variables as shown below.
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -14105,7 +14108,7 @@ document in one of the following ways:
#+end_src #+end_src
#+texinfo: @noindent #+texinfo: @noindent
or, to use LaTeX​ML[fn:134] instead, or, to use LaTeX​ML[fn:135] instead,
#+begin_src emacs-lisp #+begin_src emacs-lisp
(setq org-latex-to-mathml-convert-command (setq org-latex-to-mathml-convert-command
@ -14424,7 +14427,7 @@ with the =#+ATTR_ODT= line. For a discussion on default formatting of
tables, see [[*Tables in ODT export]]. tables, see [[*Tables in ODT export]].
This feature closely mimics the way table templates are defined in the This feature closely mimics the way table templates are defined in the
OpenDocument-v1.2 specification[fn:135]. OpenDocument-v1.2 specification[fn:136].
#+vindex: org-odt-table-styles #+vindex: org-odt-table-styles
For quick preview of this feature, install the settings below and export the For quick preview of this feature, install the settings below and export the
@ -14458,7 +14461,7 @@ templates, define new styles there.
To use this feature proceed as follows: To use this feature proceed as follows:
1. Create a table template[fn:136]. 1. Create a table template[fn:137].
A table template is set of =table-cell= and =paragraph= styles for A table template is set of =table-cell= and =paragraph= styles for
each of the following table cell categories: each of the following table cell categories:
@ -14497,7 +14500,7 @@ To use this feature proceed as follows:
=</office:automatic-styles>= element of the content template file =</office:automatic-styles>= element of the content template file
(see [[x-orgodtcontenttemplate-xml][Factory styles]]). (see [[x-orgodtcontenttemplate-xml][Factory styles]]).
2. Define a table style[fn:137]. 2. Define a table style[fn:138].
#+vindex: org-odt-table-styles #+vindex: org-odt-table-styles
To define a table style, create an entry for the style in the To define a table style, create an entry for the style in the
@ -15585,7 +15588,7 @@ If you want to publish the Org file as an =.org= file but with
~org-publish-org-to-org~. This produces =file.org= and put it in the ~org-publish-org-to-org~. This produces =file.org= and put it in the
publishing directory. If you want a htmlized version of this file, publishing directory. If you want a htmlized version of this file,
set the parameter ~:htmlized-source~ to ~t~. It produces set the parameter ~:htmlized-source~ to ~t~. It produces
=file.org.html= in the publishing directory[fn:138]. =file.org.html= in the publishing directory[fn:139].
Other files like images only need to be copied to the publishing Other files like images only need to be copied to the publishing
destination; for this you can use ~org-publish-attachment~. For destination; for this you can use ~org-publish-attachment~. For
@ -16958,13 +16961,13 @@ See [[*Languages]] to enable other languages.
#+kindex: C-c C-v e #+kindex: C-c C-v e
#+findex: org-babel-execute-src-block #+findex: org-babel-execute-src-block
Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or Org provides many ways to execute code blocks. {{{kbd(C-c C-c)}}} or
{{{kbd(C-c C-v e)}}} with the point on a code block[fn:139] calls the {{{kbd(C-c C-v e)}}} with the point on a code block[fn:140] calls the
~org-babel-execute-src-block~ function, which executes the code in the ~org-babel-execute-src-block~ function, which executes the code in the
block, collects the results, and inserts them in the buffer. block, collects the results, and inserts them in the buffer.
#+cindex: @samp{CALL}, keyword #+cindex: @samp{CALL}, keyword
#+vindex: org-babel-inline-result-wrap #+vindex: org-babel-inline-result-wrap
By calling a named code block[fn:140] from an Org mode buffer or By calling a named code block[fn:141] from an Org mode buffer or
a table. Org can call the named code blocks from the current Org mode a table. Org can call the named code blocks from the current Org mode
buffer or from the "Library of Babel" (see [[*Library of Babel]]). buffer or from the "Library of Babel" (see [[*Library of Babel]]).
@ -17765,10 +17768,10 @@ Code blocks in the following languages are supported.
| Asymptote | =asymptote= | Lisp | =lisp= | | Asymptote | =asymptote= | Lisp | =lisp= |
| Awk | =awk= | Lua | =lua= | | Awk | =awk= | Lua | =lua= |
| C | =C= | MATLAB | =matlab= | | C | =C= | MATLAB | =matlab= |
| C++ | =C++=[fn:141] | Mscgen | =mscgen= | | C++ | =C++=[fn:142] | Mscgen | =mscgen= |
| Clojure | =clojure= | Objective Caml | =ocaml= | | Clojure | =clojure= | Objective Caml | =ocaml= |
| CSS | =css= | Octave | =octave= | | CSS | =css= | Octave | =octave= |
| D | =D=[fn:142] | Org mode | =org= | | D | =D=[fn:143] | Org mode | =org= |
| ditaa | =ditaa= | Oz | =oz= | | ditaa | =ditaa= | Oz | =oz= |
| Emacs Calc | =calc= | Perl | =perl= | | Emacs Calc | =calc= | Perl | =perl= |
| Emacs Lisp | =emacs-lisp= | Plantuml | =plantuml= | | Emacs Lisp | =emacs-lisp= | Plantuml | =plantuml= |
@ -17897,7 +17900,7 @@ for Python and Emacs Lisp languages.
#+cindex: syntax, Noweb #+cindex: syntax, Noweb
#+cindex: source code, Noweb reference #+cindex: source code, Noweb reference
Org supports named blocks in Noweb[fn:143] style syntax: Org supports named blocks in Noweb[fn:144] style syntax:
: <<CODE-BLOCK-ID>> : <<CODE-BLOCK-ID>>
@ -18393,7 +18396,7 @@ Org Tempo expands snippets to structures defined in
~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For ~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
example, {{{kbd(< s TAB)}}} creates a code block. Enable it by example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
customizing ~org-modules~ or add =(require 'org-tempo)= to your Emacs customizing ~org-modules~ or add =(require 'org-tempo)= to your Emacs
init file[fn:144]. init file[fn:145].
#+attr_texinfo: :columns 0.1 0.9 #+attr_texinfo: :columns 0.1 0.9
| {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= | | {{{kbd(a)}}} | =#+BEGIN_EXPORT ascii= ... =#+END_EXPORT= |
@ -18473,13 +18476,13 @@ in the desired amount with hard spaces and hiding leading stars.
To display the buffer in the indented view, activate Org Indent minor To display the buffer in the indented view, activate Org Indent minor
mode, using {{{kbd(M-x org-indent-mode)}}}. Text lines that are not mode, using {{{kbd(M-x org-indent-mode)}}}. Text lines that are not
headlines are prefixed with virtual spaces to vertically align with headlines are prefixed with virtual spaces to vertically align with
the headline text[fn:145]. the headline text[fn:146].
#+vindex: org-indent-indentation-per-level #+vindex: org-indent-indentation-per-level
To make more horizontal space, the headlines are shifted by two To make more horizontal space, the headlines are shifted by two
characters. Configure ~org-indent-indentation-per-level~ variable for characters. Configure ~org-indent-indentation-per-level~ variable for
a different number. Only one star on each headline is visible, the a different number. Only one star on each headline is visible, the
rest are masked with the same font color as the background[fn:146]. rest are masked with the same font color as the background[fn:147].
#+vindex: org-startup-indented #+vindex: org-startup-indented
To globally turn on Org Indent mode for all files, customize the To globally turn on Org Indent mode for all files, customize the
@ -18493,7 +18496,7 @@ use =STARTUP= keyword as follows:
It is possible to use hard spaces to achieve the indentation instead, It is possible to use hard spaces to achieve the indentation instead,
if the bare ASCII file should have the indented look also outside if the bare ASCII file should have the indented look also outside
Emacs[fn:147]. With Org's support, you have to indent all lines to Emacs[fn:148]. With Org's support, you have to indent all lines to
line up with the outline headers. You would use these settings: line up with the outline headers. You would use these settings:
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -18732,7 +18735,7 @@ changes.
#+vindex: org-startup-indented #+vindex: org-startup-indented
Dynamic virtual indentation is controlled by the variable Dynamic virtual indentation is controlled by the variable
~org-startup-indented~[fn:148]. ~org-startup-indented~[fn:149].
| =indent= | Start with Org Indent mode turned on. | | =indent= | Start with Org Indent mode turned on. |
| =noindent= | Start with Org Indent mode turned off. | | =noindent= | Start with Org Indent mode turned off. |
@ -19540,7 +19543,7 @@ these variables.
#+vindex: org-mobile-directory #+vindex: org-mobile-directory
The mobile application needs access to a file directory on The mobile application needs access to a file directory on
a server[fn:149] to interact with Emacs. Pass its location through a server[fn:150] to interact with Emacs. Pass its location through
the ~org-mobile-directory~ variable. If you can mount that directory the ~org-mobile-directory~ variable. If you can mount that directory
locally just set the variable to point to that directory: locally just set the variable to point to that directory:
@ -19561,7 +19564,7 @@ With a public server, consider encrypting the files. Org also
requires OpenSSL installed on the local computer. To turn on requires OpenSSL installed on the local computer. To turn on
encryption, set the same password in the mobile application and in encryption, set the same password in the mobile application and in
Emacs. Set the password in the variable Emacs. Set the password in the variable
~org-mobile-use-encryption~[fn:150]. Note that even after the mobile ~org-mobile-use-encryption~[fn:151]. Note that even after the mobile
application encrypts the file contents, the file name remains visible application encrypts the file contents, the file name remains visible
on the file systems of the local computer, the server, and the mobile on the file systems of the local computer, the server, and the mobile
device. device.
@ -19577,15 +19580,15 @@ The command ~org-mobile-push~ copies files listed in
~org-mobile-files~ into the staging area. Files include agenda files ~org-mobile-files~ into the staging area. Files include agenda files
(as listed in ~org-agenda-files~). Customize ~org-mobile-files~ to (as listed in ~org-agenda-files~). Customize ~org-mobile-files~ to
add other files. File names are staged with paths relative to add other files. File names are staged with paths relative to
~org-directory~, so all files should be inside this directory[fn:151]. ~org-directory~, so all files should be inside this directory[fn:152].
Push creates a special Org file =agendas.org= with custom agenda views Push creates a special Org file =agendas.org= with custom agenda views
defined by the user[fn:152]. defined by the user[fn:153].
Finally, Org writes the file =index.org=, containing links to other Finally, Org writes the file =index.org=, containing links to other
files. The mobile application reads this file first from the server files. The mobile application reads this file first from the server
to determine what other files to download for agendas. For faster to determine what other files to download for agendas. For faster
downloads, it is expected to only read files whose checksums[fn:153] downloads, it is expected to only read files whose checksums[fn:154]
have changed. have changed.
*** Pulling from the mobile application *** Pulling from the mobile application
@ -19602,7 +19605,7 @@ data in an inbox file format, through the following steps:
1. 1.
#+vindex: org-mobile-inbox-for-pull #+vindex: org-mobile-inbox-for-pull
Org moves all entries found in =mobileorg.org=[fn:154] and appends Org moves all entries found in =mobileorg.org=[fn:155] and appends
them to the file pointed to by the variable them to the file pointed to by the variable
~org-mobile-inbox-for-pull~. It should reside neither in the ~org-mobile-inbox-for-pull~. It should reside neither in the
staging area nor on the server. Each captured entry and each staging area nor on the server. Each captured entry and each
@ -19893,9 +19896,9 @@ of these strategies:
#+cindex: @LaTeX{}, and Orgtbl mode #+cindex: @LaTeX{}, and Orgtbl mode
To wrap a source table in LaTeX, use the =comment= environment To wrap a source table in LaTeX, use the =comment= environment
provided by =comment.sty=[fn:155]. To activate it, put provided by =comment.sty=[fn:156]. To activate it, put
~\usepackage{comment}~ in the document header. Orgtbl mode inserts ~\usepackage{comment}~ in the document header. Orgtbl mode inserts
a radio table skeleton[fn:156] with the command {{{kbd(M-x a radio table skeleton[fn:157] with the command {{{kbd(M-x
orgtbl-insert-radio-table)}}}, which prompts for a table name. For orgtbl-insert-radio-table)}}}, which prompts for a table name. For
example, if =salesfigures= is the name, the template inserts: example, if =salesfigures= is the name, the template inserts:
@ -19914,7 +19917,7 @@ The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function
~orgtbl-to-latex~ to convert the table to LaTeX format, then insert ~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
the table at the target (receive) location named =salesfigures=. Now the table at the target (receive) location named =salesfigures=. Now
the table is ready for data entry. It can even use spreadsheet the table is ready for data entry. It can even use spreadsheet
features[fn:157]: features[fn:158]:
#+begin_example #+begin_example
% BEGIN RECEIVE ORGTBL salesfigures % BEGIN RECEIVE ORGTBL salesfigures
@ -20130,7 +20133,7 @@ Dynamic blocks, like any other block, can be narrowed with
#+vindex: org-agenda-skip-function #+vindex: org-agenda-skip-function
#+vindex: org-agenda-skip-function-global #+vindex: org-agenda-skip-function-global
Org provides a special hook to further limit items in agenda views: Org provides a special hook to further limit items in agenda views:
~agenda~, ~agenda*~[fn:158], ~todo~, ~alltodo~, ~tags~, ~tags-todo~, ~agenda~, ~agenda*~[fn:159], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
~tags-tree~. Specify a custom function that tests inclusion of every ~tags-tree~. Specify a custom function that tests inclusion of every
matched item in the view. This function can also skip as much as is matched item in the view. This function can also skip as much as is
needed. needed.
@ -20173,7 +20176,7 @@ meaningful string suitable for the agenda view.
#+vindex: org-agenda-skip-function #+vindex: org-agenda-skip-function
Search for entries with a limit set on levels for the custom search. Search for entries with a limit set on levels for the custom search.
This is a general approach to creating custom searches in Org. To This is a general approach to creating custom searches in Org. To
include all levels, use =LEVEL>0=[fn:159]. Then to selectively pick include all levels, use =LEVEL>0=[fn:160]. Then to selectively pick
the matched entries, use ~org-agenda-skip-function~, which also the matched entries, use ~org-agenda-skip-function~, which also
accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
~org-agenda-skip-subtree-if~. For example: ~org-agenda-skip-subtree-if~. For example:
@ -21372,48 +21375,51 @@ properties. Please rewrite your date/week-tree targets using
level, months or ISO weeks as sublevels and then dates on the lowest level, months or ISO weeks as sublevels and then dates on the lowest
level. Tags are allowed in the tree structure. level. Tags are allowed in the tree structure.
[fn:85] If you need one of these sequences literally, escape the =%= [fn:85] When the file name is not absolute, Org assumes it is relative
to ~org-directory~.
[fn:86] If you need one of these sequences literally, escape the =%=
with a backslash. with a backslash.
[fn:86] If you define your own link types (see [[*Adding Hyperlink [fn:87] If you define your own link types (see [[*Adding Hyperlink
Types]]), any property you store with ~org-store-link-props~ can be Types]]), any property you store with ~org-store-link-props~ can be
accessed in capture templates in a similar way. accessed in capture templates in a similar way.
[fn:87] This is always the other, not the user. See the variable [fn:88] This is always the other, not the user. See the variable
~org-link-from-user-regexp~. ~org-link-from-user-regexp~.
[fn:88] If you move entries or Org files from one directory to [fn:89] If you move entries or Org files from one directory to
another, you may want to configure ~org-attach-id-dir~ to contain another, you may want to configure ~org-attach-id-dir~ to contain
an absolute path. an absolute path.
[fn:89] If the value of that variable is not a list, but a single file [fn:90] If the value of that variable is not a list, but a single file
name, then the list of agenda files in maintained in that external name, then the list of agenda files in maintained in that external
file. file.
[fn:90] When using the dispatcher, pressing {{{kbd(<)}}} before [fn:91] When using the dispatcher, pressing {{{kbd(<)}}} before
selecting a command actually limits the command to the current file, selecting a command actually limits the command to the current file,
and ignores ~org-agenda-files~ until the next dispatcher command. and ignores ~org-agenda-files~ until the next dispatcher command.
[fn:91] For backward compatibility, you can also press {{{kbd(1)}}} to [fn:92] For backward compatibility, you can also press {{{kbd(1)}}} to
restrict to the current buffer. restrict to the current buffer.
[fn:92] For backward compatibility, you can also press {{{kbd(0)}}} to [fn:93] For backward compatibility, you can also press {{{kbd(0)}}} to
restrict to the current region/subtree. restrict to the current region/subtree.
[fn:93] For backward compatibility, the universal prefix argument [fn:94] For backward compatibility, the universal prefix argument
{{{kbd(C-u)}}} causes all TODO entries to be listed before the agenda. {{{kbd(C-u)}}} causes all TODO entries to be listed before the agenda.
This feature is deprecated, use the dedicated TODO list, or a block This feature is deprecated, use the dedicated TODO list, or a block
agenda instead (see [[*Block agenda]]). agenda instead (see [[*Block agenda]]).
[fn:94] The variable ~org-anniversary~ used in the example is just [fn:95] The variable ~org-anniversary~ used in the example is just
like ~diary-anniversary~, but the argument order is always according like ~diary-anniversary~, but the argument order is always according
to ISO and therefore independent of the value of to ISO and therefore independent of the value of
~calendar-date-style~. ~calendar-date-style~.
[fn:95] You can, however, disable this by setting [fn:96] You can, however, disable this by setting
~org-agenda-search-headline-for-time~ variable to a ~nil~ value. ~org-agenda-search-headline-for-time~ variable to a ~nil~ value.
[fn:96] Custom agenda commands can preset a filter by binding one of [fn:97] Custom agenda commands can preset a filter by binding one of
the variables ~org-agenda-tag-filter-preset~, the variables ~org-agenda-tag-filter-preset~,
~org-agenda-category-filter-preset~, ~org-agenda-effort-filter-preset~ ~org-agenda-category-filter-preset~, ~org-agenda-effort-filter-preset~
or ~org-agenda-regexp-filter-preset~ as an option. This filter is or ~org-agenda-regexp-filter-preset~ as an option. This filter is
@ -21423,223 +21429,223 @@ property of the entire agenda view---in a block agenda, you should
only set this in the global options section, not in the section of an only set this in the global options section, not in the section of an
individual block. individual block.
[fn:97] Only tags filtering is respected here, effort filtering is [fn:98] Only tags filtering is respected here, effort filtering is
ignored. ignored.
[fn:98] You can also create persistent custom functions through [fn:99] You can also create persistent custom functions through
~org-agenda-bulk-custom-functions~. ~org-agenda-bulk-custom-functions~.
[fn:99] This file is parsed for the agenda when [fn:100] This file is parsed for the agenda when
~org-agenda-include-diary~ is set. ~org-agenda-include-diary~ is set.
[fn:100] You can provide a description for a prefix key by inserting [fn:101] You can provide a description for a prefix key by inserting
a cons cell with the prefix and the description. a cons cell with the prefix and the description.
[fn:101] /Planned/ means here that these entries have some planning [fn:102] /Planned/ means here that these entries have some planning
information attached to them, like a time-stamp, a scheduled or information attached to them, like a time-stamp, a scheduled or
a deadline string. See ~org-agenda-entry-types~ on how to set what a deadline string. See ~org-agenda-entry-types~ on how to set what
planning information is taken into account. planning information is taken into account.
[fn:102] For HTML you need to install Hrvoje Nikšić's =htmlize.el= [fn:103] For HTML you need to install Hrvoje Nikšić's =htmlize.el=
as an Emacs package from MELPA or from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Nikšić's repository]]. as an Emacs package from MELPA or from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Nikšić's repository]].
[fn:103] To create PDF output, the Ghostscript ps2pdf utility must be [fn:104] To create PDF output, the Ghostscript ps2pdf utility must be
installed on the system. Selecting a PDF file also creates the installed on the system. Selecting a PDF file also creates the
postscript file. postscript file.
[fn:104] If you want to store standard views like the weekly agenda or [fn:105] If you want to store standard views like the weekly agenda or
the global TODO list as well, you need to define custom commands for the global TODO list as well, you need to define custom commands for
them in order to be able to specify file names. them in order to be able to specify file names.
[fn:105] Quoting depends on the system you use, please check the FAQ [fn:106] Quoting depends on the system you use, please check the FAQ
for examples. for examples.
[fn:106] You can turn this on by default by setting the variable [fn:107] You can turn this on by default by setting the variable
~org-pretty-entities~, or on a per-file base with the =STARTUP= option ~org-pretty-entities~, or on a per-file base with the =STARTUP= option
=entitiespretty=. =entitiespretty=.
[fn:107] This behavior can be disabled with =-= export setting (see [fn:108] This behavior can be disabled with =-= export setting (see
[[*Export Settings]]). [[*Export Settings]]).
[fn:108] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX [fn:109] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX
system. Many of the features described here as "LaTeX" are really system. Many of the features described here as "LaTeX" are really
from TeX, but for simplicity I am blurring this distinction. from TeX, but for simplicity I am blurring this distinction.
[fn:109] When MathJax is used, only the environments recognized by [fn:110] When MathJax is used, only the environments recognized by
MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is
used to create images, any LaTeX environment is handled. used to create images, any LaTeX environment is handled.
[fn:110] These are respectively available at [fn:111] These are respectively available at
[[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]] [[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]]
and from the ImageMagick suite. Choose the converter by setting the and from the ImageMagick suite. Choose the converter by setting the
variable ~org-preview-latex-default-process~ accordingly. variable ~org-preview-latex-default-process~ accordingly.
[fn:111] Org mode has a method to test if point is inside such [fn:112] Org mode has a method to test if point is inside such
a fragment, see the documentation of the function a fragment, see the documentation of the function
~org-inside-LaTeX-fragment-p~. ~org-inside-LaTeX-fragment-p~.
[fn:112] This works automatically for the HTML backend (it requires [fn:113] This works automatically for the HTML backend (it requires
version 1.34 of the =htmlize.el= package, which you need to install). version 1.34 of the =htmlize.el= package, which you need to install).
Fontified code chunks in LaTeX can be achieved using either the Fontified code chunks in LaTeX can be achieved using either the
[[https://www.ctan.org/pkg/listings][listings]] package or the [[https://www.ctan.org/pkg/minted][minted]] package. Refer to [[https://www.ctan.org/pkg/listings][listings]] package or the [[https://www.ctan.org/pkg/minted][minted]] package. Refer to
~org-export-latex-listings~ for details. ~org-export-latex-listings~ for details.
[fn:113] Source code in code blocks may also be evaluated either [fn:114] Source code in code blocks may also be evaluated either
interactively or on export. See [[*Working with Source Code]] for more interactively or on export. See [[*Working with Source Code]] for more
information on evaluating code blocks. information on evaluating code blocks.
[fn:114] Adding =-k= to =-n -r= /keeps/ the labels in the source code [fn:115] Adding =-k= to =-n -r= /keeps/ the labels in the source code
while using line numbers for the links, which might be useful to while using line numbers for the links, which might be useful to
explain those in an Org mode example code. explain those in an Org mode example code.
[fn:115] You may select a different mode with the variable [fn:116] You may select a different mode with the variable
~org-edit-fixed-width-region-mode~. ~org-edit-fixed-width-region-mode~.
[fn:116] What Emacs considers to be an image depends on [fn:117] What Emacs considers to be an image depends on
~image-file-name-extensions~ and ~image-file-name-regexps~. ~image-file-name-extensions~ and ~image-file-name-regexps~.
[fn:117] The variable ~org-startup-with-inline-images~ can be set [fn:118] The variable ~org-startup-with-inline-images~ can be set
within a buffer with the =STARTUP= options =inlineimages= and within a buffer with the =STARTUP= options =inlineimages= and
=noinlineimages=. =noinlineimages=.
[fn:118] The corresponding in-buffer setting is: =#+STARTUP: fninline= [fn:119] The corresponding in-buffer setting is: =#+STARTUP: fninline=
or =#+STARTUP: nofninline=. or =#+STARTUP: nofninline=.
[fn:119] The corresponding in-buffer options are =#+STARTUP: fnadjust= [fn:120] The corresponding in-buffer options are =#+STARTUP: fnadjust=
and =#+STARTUP: nofnadjust=. and =#+STARTUP: nofnadjust=.
[fn:120] The variable ~org-export-date-timestamp-format~ defines how [fn:121] The variable ~org-export-date-timestamp-format~ defines how
this timestamp are exported. this timestamp are exported.
[fn:121] For export to LaTeX format---or LaTeX-related formats such as [fn:122] For export to LaTeX format---or LaTeX-related formats such as
Beamer---, the =org-latex-package-alist= variable needs further Beamer---, the =org-latex-package-alist= variable needs further
configuration. See [[LaTeX specific export settings]]. configuration. See [[LaTeX specific export settings]].
[fn:122] At the moment, some export back-ends do not obey this [fn:123] At the moment, some export back-ends do not obey this
specification. For example, LaTeX export excludes every unnumbered specification. For example, LaTeX export excludes every unnumbered
headline from the table of contents. headline from the table of contents.
[fn:123] Note that ~org-link-search-must-match-exact-headline~ is [fn:124] Note that ~org-link-search-must-match-exact-headline~ is
locally bound to non-~nil~. Therefore, ~org-link-search~ only matches locally bound to non-~nil~. Therefore, ~org-link-search~ only matches
headlines and named elements. headlines and named elements.
[fn:124] Since commas separate the arguments, commas within arguments [fn:125] Since commas separate the arguments, commas within arguments
have to be escaped with the backslash character. So only those have to be escaped with the backslash character. So only those
backslash characters before a comma need escaping with another backslash characters before a comma need escaping with another
backslash character. backslash character.
[fn:125] For a less drastic behavior, consider using a select tag (see [fn:126] For a less drastic behavior, consider using a select tag (see
[[*Export Settings]]) instead. [[*Export Settings]]) instead.
[fn:126] If =BEAMER_ENV= is set, Org export adds =B_environment= tag [fn:127] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
to make it visible. The tag serves as a visual aid and has no to make it visible. The tag serves as a visual aid and has no
semantic relevance. semantic relevance.
[fn:127] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by [fn:128] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
[[http://www.mathjax.org][MathJax]]. [[http://www.mathjax.org][MathJax]].
[fn:128] Please note that exported formulas are part of an HTML [fn:129] Please note that exported formulas are part of an HTML
document, and that signs such as =<=, =>=, or =&= have special document, and that signs such as =<=, =>=, or =&= have special
meanings. See [[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax TeX and LaTeX support]]. meanings. See [[http://docs.mathjax.org/en/latest/tex.html#tex-and-latex-in-html-documents][MathJax TeX and LaTeX support]].
[fn:129] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn [fn:130] See [[http://docs.mathjax.org/en/latest/tex.html#tex-extensions][TeX and LaTeX extensions]] in the [[http://docs.mathjax.org][MathJax manual]] to learn
about extensions. about extensions.
[fn:130] If the classes on TODO keywords and tags lead to conflicts, [fn:131] If the classes on TODO keywords and tags lead to conflicts,
use the variables ~org-html-todo-kwd-class-prefix~ and use the variables ~org-html-todo-kwd-class-prefix~ and
~org-html-tag-class-prefix~ to make them unique. ~org-html-tag-class-prefix~ to make them unique.
[fn:131] This does not allow setting different bibliography compilers [fn:132] This does not allow setting different bibliography compilers
for different files. However, "smart" LaTeX compilation systems, such for different files. However, "smart" LaTeX compilation systems, such
as latexmk, can select the correct bibliography compiler. as latexmk, can select the correct bibliography compiler.
[fn:132] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications [fn:133] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
(OpenDocument) Version 1.2]]. (OpenDocument) Version 1.2]].
[fn:133] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]]. [fn:134] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
[fn:134] See [[http://dlmf.nist.gov/LaTeXML/]]. [fn:135] See [[http://dlmf.nist.gov/LaTeXML/]].
[fn:135] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]] [fn:136] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
[fn:136] See the =<table:table-template>= element of the [fn:137] See the =<table:table-template>= element of the
OpenDocument-v1.2 specification. OpenDocument-v1.2 specification.
[fn:137] See the attributes =table:template-name=, [fn:138] See the attributes =table:template-name=,
=table:use-first-row-styles=, =table:use-last-row-styles=, =table:use-first-row-styles=, =table:use-last-row-styles=,
=table:use-first-column-styles=, =table:use-last-column-styles=, =table:use-first-column-styles=, =table:use-last-column-styles=,
=table:use-banding-rows-styles=, and =table:use-banding-column-styles= =table:use-banding-rows-styles=, and =table:use-banding-column-styles=
of the =<table:table>= element in the OpenDocument-v1.2 specification. of the =<table:table>= element in the OpenDocument-v1.2 specification.
[fn:138] If the publishing directory is the same as the source [fn:139] If the publishing directory is the same as the source
directory, =file.org= is exported as =file.org.org=, so you probably directory, =file.org= is exported as =file.org.org=, so you probably
do not want to do this. do not want to do this.
[fn:139] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used [fn:140] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding. to remove code evaluation from the {{{kbd(C-c C-c)}}} key binding.
[fn:140] Actually, the constructs =call_<name>()= and =src_<lang>{}= [fn:141] Actually, the constructs =call_<name>()= and =src_<lang>{}=
are not evaluated when they appear in a keyword (see [[*Summary of are not evaluated when they appear in a keyword (see [[*Summary of
In-Buffer Settings]]). In-Buffer Settings]]).
[fn:141] C++ language is handled in =ob-C.el=. Even though the [fn:142] C++ language is handled in =ob-C.el=. Even though the
identifier for such source blocks is =C++=, you activate it by loading identifier for such source blocks is =C++=, you activate it by loading
the C language. the C language.
[fn:142] D language is handled in =ob-C.el=. Even though the [fn:143] D language is handled in =ob-C.el=. Even though the
identifier for such source blocks is =D=, you activate it by loading identifier for such source blocks is =D=, you activate it by loading
the C language. the C language.
[fn:143] For Noweb literate programming details, see [fn:144] For Noweb literate programming details, see
http://www.cs.tufts.edu/~nr/noweb/. http://www.cs.tufts.edu/~nr/noweb/.
[fn:144] For more information, please refer to the commentary section [fn:145] For more information, please refer to the commentary section
in =org-tempo.el=. in =org-tempo.el=.
[fn:145] Org Indent mode also sets ~wrap-prefix~ correctly for [fn:146] Org Indent mode also sets ~wrap-prefix~ correctly for
indenting and wrapping long lines of headlines or text. This minor indenting and wrapping long lines of headlines or text. This minor
mode also handles Visual Line mode and directly applied settings mode also handles Visual Line mode and directly applied settings
through ~word-wrap~. through ~word-wrap~.
[fn:146] Note that turning on Org Indent mode sets [fn:147] Note that turning on Org Indent mode sets
~org-hide-leading-stars~ to ~t~ and ~org-adapt-indentation~ to ~nil~. ~org-hide-leading-stars~ to ~t~ and ~org-adapt-indentation~ to ~nil~.
[fn:147] This works, but requires extra effort. Org Indent mode is [fn:148] This works, but requires extra effort. Org Indent mode is
more convenient for most applications. more convenient for most applications.
[fn:148] Note that Org Indent mode also sets the ~wrap-prefix~ [fn:149] Note that Org Indent mode also sets the ~wrap-prefix~
property, such that Visual Line mode (or purely setting ~word-wrap~) property, such that Visual Line mode (or purely setting ~word-wrap~)
wraps long lines, including headlines, correctly indented. wraps long lines, including headlines, correctly indented.
[fn:149] For a server to host files, consider using a WebDAV server, [fn:150] For a server to host files, consider using a WebDAV server,
such as [[https://nextcloud.com][Nextcloud]]. Additional help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]]. such as [[https://nextcloud.com][Nextcloud]]. Additional help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]].
[fn:150] If Emacs is configured for safe storing of passwords, then [fn:151] If Emacs is configured for safe storing of passwords, then
configure the variable ~org-mobile-encryption-password~; please read configure the variable ~org-mobile-encryption-password~; please read
the docstring of that variable. the docstring of that variable.
[fn:151] Symbolic links in ~org-directory~ need to have the same name [fn:152] Symbolic links in ~org-directory~ need to have the same name
as their targets. as their targets.
[fn:152] While creating the agendas, Org mode forces =ID= properties [fn:153] While creating the agendas, Org mode forces =ID= properties
on all referenced entries, so that these entries can be uniquely on all referenced entries, so that these entries can be uniquely
identified if Org Mobile flags them for further action. To avoid identified if Org Mobile flags them for further action. To avoid
setting properties configure the variable setting properties configure the variable
~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies ~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
on outline paths, assuming they are unique. on outline paths, assuming they are unique.
[fn:153] Checksums are stored automatically in the file [fn:154] Checksums are stored automatically in the file
=checksums.dat=. =checksums.dat=.
[fn:154] The file will be empty after this operation. [fn:155] The file will be empty after this operation.
[fn:155] https://www.ctan.org/pkg/comment [fn:156] https://www.ctan.org/pkg/comment
[fn:156] By default this works only for LaTeX, HTML, and Texinfo. [fn:157] By default this works only for LaTeX, HTML, and Texinfo.
Configure the variable ~orgtbl-radio-table-templates~ to install Configure the variable ~orgtbl-radio-table-templates~ to install
templates for other modes. templates for other modes.
[fn:157] If the =TBLFM= keyword contains an odd number of dollar [fn:158] If the =TBLFM= keyword contains an odd number of dollar
characters, this may cause problems with Font Lock in LaTeX mode. As characters, this may cause problems with Font Lock in LaTeX mode. As
shown in the example you can fix this by adding an extra line inside shown in the example you can fix this by adding an extra line inside
the =comment= environment that is used to balance the dollar the =comment= environment that is used to balance the dollar
@ -21647,9 +21653,9 @@ expressions. If you are using AUCTeX with the font-latex library,
a much better solution is to add the =comment= environment to the a much better solution is to add the =comment= environment to the
variable ~LaTeX-verbatim-environments~. variable ~LaTeX-verbatim-environments~.
[fn:158] The ~agenda*~ view is the same as ~agenda~ except that it [fn:159] The ~agenda*~ view is the same as ~agenda~ except that it
only considers /appointments/, i.e., scheduled and deadline items that only considers /appointments/, i.e., scheduled and deadline items that
have a time specification =[h]h:mm= in their time-stamps. have a time specification =[h]h:mm= in their time-stamps.
[fn:159] Note that, for ~org-odd-levels-only~, a level number [fn:160] Note that, for ~org-odd-levels-only~, a level number
corresponds to order in the hierarchy, not to the number of stars. corresponds to order in the hierarchy, not to the number of stars.

28
lisp/org-capture.el
View File

@ -698,21 +698,19 @@ of the day at point (if any) or the current HH:MM time."
(defun org-capture-get-template () (defun org-capture-get-template ()
"Get the template from a file or a function if necessary." "Get the template from a file or a function if necessary."
(let ((txt (org-capture-get :template)) file) (org-capture-put
(cond :template
((and (listp txt) (eq (car txt) 'file)) (pcase (org-capture-get :template)
(if (file-exists-p (`nil "")
(setq file (expand-file-name (nth 1 txt) org-directory))) ((and (pred stringp) template) template)
(setq txt (org-file-contents file)) (`(file ,file)
(setq txt (format "* Template file %s not found" (nth 1 txt))))) (let ((filename (expand-file-name file org-directory)))
((and (listp txt) (eq (car txt) 'function)) (if (file-exists-p filename) (org-file-contents filename)
(if (fboundp (nth 1 txt)) (format "* Template file %S not found" file))))
(setq txt (funcall (nth 1 txt))) (`(function ,f)
(setq txt (format "* Template function %s not found" (nth 1 txt))))) (if (functionp f) (funcall f)
((not txt) (setq txt "")) (format "* Template function %S not found" f)))
((stringp txt)) (_ "* Invalid capture template"))))
(t (setq txt "* Invalid capture template")))
(org-capture-put :template txt)))
(defun org-capture-finalize (&optional stay-with-capture) (defun org-capture-finalize (&optional stay-with-capture)
"Finalize the capture process. "Finalize the capture process.