summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <mail@nicolasgoaziou.fr>2018-02-17 21:41:10 +0100
committerNicolas Goaziou <mail@nicolasgoaziou.fr>2018-02-17 21:41:10 +0100
commit1c6e72c086f74d8730827885da54262646d42387 (patch)
tree040e8e51d83afa68ea35233c17c91987838da911
parentd0351559016b8f1d771f7d0e3785435d411bce69 (diff)
downloadorg-mode-1c6e72c086f74d8730827885da54262646d42387.tar.gz
manual: Do not assume `org-capture' is bound to `C-c c'
-rw-r--r--contrib/manual.org322
1 files changed, 158 insertions, 164 deletions
diff --git a/contrib/manual.org b/contrib/manual.org
index e0d06fe..ec3ca27 100644
--- a/contrib/manual.org
+++ b/contrib/manual.org
@@ -174,7 +174,6 @@ time to check the list.
#+findex: org-agenda
#+findex: org-capture
#+findex: org-store-link
-#+findex: org-iswitchb
For a better experience, the three Org commands ~org-store-link~,
~org-capture~ and ~org-agenda~ ought to be accessible anywhere in
Emacs, not just in Org buffers. To that effect, you need to bind them
@@ -7061,43 +7060,42 @@ compact and fast.
Capture lets you quickly store notes with little interruption of your
work flow. Org's method for capturing new items is heavily inspired
-by John Wiegley's excellent =remember.el= package.
+by John Wiegley's excellent Remember package.
*** Setting up capture
:PROPERTIES:
:DESCRIPTION: Where notes will be stored.
:END:
-The following customization sets a default target file for notes, and
-defines a global key[fn:80] for capturing new material.
+The following customization sets a default target file for notes.
#+vindex: org-default-notes-file
#+begin_src emacs-lisp
(setq org-default-notes-file (concat org-directory "/notes.org"))
- (define-key global-map "\C-cc" 'org-capture)
#+end_src
+You may also define a global key for capturing new material (see
+[[*Activation]]).
+
*** Using capture
:PROPERTIES:
:DESCRIPTION: Commands to invoke and terminate capture.
:END:
-- {{{kbd(C-c c)}}} (~org-capture~) ::
+- {{{kbd(M-x org-capture)}}} (~org-capture~) ::
- #+kindex: C-c c
#+findex: org-capture
#+cindex: date tree
- Call the command ~org-capture~. Note that this keybinding is
- global and not active by default: you need to install it. If you
- have templates defined (see [[*Capture templates]]), it offers these
- templates for selection or use a new Org outline node as the
- default template. It inserts the template into the target file
- and switch to an indirect buffer narrowed to this new node. You
- may then insert the information you want.
+ Display the capture templates menu. If you have templates
+ defined (see [[*Capture templates]]), it offers these templates for
+ selection or use a new Org outline node as the default template.
+ It inserts the template into the target file and switch to an
+ indirect buffer narrowed to this new node. You may then insert
+ the information you want.
- {{{kbd(C-c C-c)}}} (~org-capture-finalize~) ::
- #+kindex: C-c C-c
+ #+kindex: C-c C-c @r{(Capture buffer)}
#+findex: org-capture-finalize
Once you have finished entering information into the capture
buffer, {{{kbd(C-c C-c)}}} returns you to the window
@@ -7107,7 +7105,7 @@ defines a global key[fn:80] for capturing new material.
- {{{kbd(C-c C-w)}}} (~org-capture-refile~) ::
- #+kindex: C-c C-w
+ #+kindex: C-c C-w @r{(Capture buffer)}
#+findex: org-capture-refile
Finalize the capture process by refiling the note to a different
place (see [[*Refile and Copy]]). Please realize that this is
@@ -7119,10 +7117,11 @@ defines a global key[fn:80] for capturing new material.
- {{{kbd(C-c C-k)}}} (~org-capture-kill~) ::
- #+kindex: C-c C-k
+ #+kindex: C-c C-k @r{(Capture buffer)}
#+findex: org-capture-kill
Abort the capture process and return to the previous state.
+#+kindex: k c @r{(Agenda)}
You can also call ~org-capture~ in a special way from the agenda,
using the {{{kbd(k c)}}} key combination. With this access, any
timestamps inserted by the selected capture template defaults to the
@@ -7131,15 +7130,13 @@ cursor date in the agenda, rather than to the current date.
To find the locations of the last stored capture, use ~org-capture~
with prefix commands:
-- {{{kbd(C-u C-c c)}}} ::
+- {{{kbd(C-u M-x org-capture)}}} ::
- #+kindex: C-u C-c c
Visit the target location of a capture template. You get to
select the template in the usual way.
-- {{{kbd(C-u C-u C-c c)}}} ::
+- {{{kbd(C-u C-u M-x org-capture)}}} ::
- #+kindex: C-u C-u C-c c
Visit the last stored capture item in its buffer.
#+vindex: org-capture-bookmark
@@ -7160,9 +7157,9 @@ You can use templates for different types of capture items, and for
different target locations. The easiest way to create such templates
is through the customize interface.
-- {{{kbd(C-c c C)}}} ::
+- {{{kbd(C)}}} ::
- #+kindex: C-c c C
+ #+kindex: C @r{(Capture menu}
#+vindex: org-capture-templates
Customize the variable ~org-capture-templates~.
@@ -7182,8 +7179,8 @@ configuration would look like:
#+end_src
#+texinfo: @noindent
-If you then press {{{kbd(C-c c t)}}}, Org will prepare the template
-for you like this:
+If you then press {{{kbd(t)}}} from the capture menu, Org will prepare
+the template for you like this:
#+begin_example
,* TODO
@@ -7304,7 +7301,7 @@ Now lets look at the elements of a template definition. Each entry in
- =(file+olp+datetree "filename" [ "Level 1 heading" ...])= ::
- This target[fn:81] creates a heading in a date tree[fn:82] for
+ This target[fn:80] creates a heading in a date tree[fn:81] for
today's date. If the optional outline path is given, the tree
will be built under the node it is pointing to, instead of at
top level. Check out the ~:time-prompt~ and ~:tree-type~
@@ -7407,7 +7404,7 @@ Now lets look at the elements of a template definition. Each entry in
:DESCRIPTION: Filling in information about time and context.
:END:
-In the template itself, special "%-escapes"[fn:83] allow dynamic
+In the template itself, special "%-escapes"[fn:82] allow dynamic
insertion of content. The templates are expanded in the order given
here:
@@ -7530,7 +7527,7 @@ here:
#+texinfo: @noindent
#+vindex: org-store-link-props
-For specific link types, the following keywords are defined[fn:84]:
+For specific link types, the following keywords are defined[fn:83]:
#+vindex: org-from-is-user-regexp
| Link type | Available keywords |
@@ -7543,7 +7540,7 @@ For specific link types, the following keywords are defined[fn:84]:
| | ~%:date~ (message date header field) |
| | ~%:date-timestamp~ (date as active timestamp) |
| | ~%:date-timestamp-inactive~ (date as inactive timestamp) |
-| | ~%:fromto~ (either "to NAME" or "from NAME")[fn:85] |
+| | ~%:fromto~ (either "to NAME" or "from NAME")[fn:84] |
| gnus | ~%:group~, for messages also all email fields |
| w3, w3m | ~%:url~ |
| info | ~%:file~, ~%:node~ |
@@ -7593,7 +7590,7 @@ Another method is /attachments/, which are files located in
a directory belonging to an outline node. Org uses directories named
by the unique ID of each entry. These directories are located in the
~data~ directory which lives in the same directory where your Org file
-lives[fn:86]. If you initialize this directory with =git init=, Org
+lives[fn:85]. If you initialize this directory with =git init=, Org
automatically commits changes when it sees them. The attachment
system has been contributed to Org by John Wiegley.
@@ -8014,7 +8011,7 @@ special command:
~org-outline-path-complete-in-steps~. If you would like to be
able to create new nodes as new parents for refiling on the fly,
check the variable ~org-refile-allow-creating-parent-nodes~.
- When the variable ~org-log-refile~[fn:87] is set, a timestamp or
+ When the variable ~org-log-refile~[fn:86] is set, a timestamp or
a note is recorded whenever an entry is refiled.
- {{{kbd(C-u C-c C-w)}}} ::
@@ -8279,12 +8276,12 @@ the window configuration is restored when the agenda exits:
#+vindex: org-agenda-files
The information to be shown is normally collected from all /agenda
-files/, the files listed in the variable ~org-agenda-files~[fn:88].
+files/, the files listed in the variable ~org-agenda-files~[fn:87].
If a directory is part of this list, all files with the extension
=.org= in this directory are part of the list.
Thus, even if you only work with a single Org file, that file should
-be put into the list[fn:89]. You can customize ~org-agenda-files~,
+be put into the list[fn:88]. You can customize ~org-agenda-files~,
but the easiest way to maintain it is through the following commands
#+attr_texinfo: :sep and
@@ -8417,7 +8414,7 @@ commands:
- {{{kbd(<)}}} ::
#+kindex: < @r{(Agenda dispatcher)}
- Restrict an agenda command to the current buffer[fn:90]. After
+ Restrict an agenda command to the current buffer[fn:89]. After
pressing {{{kbd(<)}}}, you still need to press the character
selecting the command.
@@ -8426,7 +8423,7 @@ commands:
#+kindex: < < @r{(Agenda dispatcher)}
If there is an active region, restrict the following agenda
command to the region. Otherwise, restrict it to the current
- subtree[fn:91]. After pressing {{{kbd(< <)}}}, you still need to
+ subtree[fn:90]. After pressing {{{kbd(< <)}}}, you still need to
press the character selecting the command.
- {{{kbd(*)}}} ::
@@ -8477,7 +8474,7 @@ a paper agenda, showing all the tasks for the current week or day.
#+cindex: org-agenda, command
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
- argument[fn:92]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you
+ argument[fn:91]---like {{{kbd(C-u 2 1 M-x org-agenda a)}}}---you
may set the number of days to be displayed.
#+vindex: org-agenda-span
@@ -8536,7 +8533,7 @@ the entries into an Org file. Org mode evaluates diary-style sexp
entries, and does it faster because there is no overhead for first
creating the diary display. Note that the sexp entries must start at
the left margin, no whitespace is allowed before them, as seen in the
-following segment of an Org file:[fn:93]
+following segment of an Org file:[fn:92]
#+begin_example
,* Holidays
@@ -9150,7 +9147,7 @@ custom agenda commands.
estimates. The difference between this and a custom agenda
command is that filtering is very fast, so that you can switch
quickly between different filters without having to recreate the
- agenda.[fn:94]
+ agenda.[fn:93]
You are prompted for a tag selection letter; {{{kbd(SPC)}}} means
any tag at all. Pressing {{{kbd(TAB)}}} at that prompt offers
@@ -9578,7 +9575,7 @@ the other commands, the cursor needs to be in the desired line.
with the variable ~org-agenda-start-with-clockreport-mode~. By
using a prefix argument when toggling this mode (i.e., {{{kbd(C-u
R)}}}), the clock table does not show contributions from entries
- that are hidden by agenda filtering[fn:95]. See also the
+ that are hidden by agenda filtering[fn:94]. See also the
variable ~org-clock-report-include-clocking-task~.
- {{{kbd(v c)}}} ::
@@ -10016,7 +10013,7 @@ the other commands, the cursor needs to be in the desired line.
- {{{kbd(f)}}} ::
#+vindex: org-agenda-bulk-custom-functions
- Apply a function[fn:96] to marked entries. For example, the
+ Apply a function[fn:95] to marked entries. For example, the
function below sets the =CATEGORY= property of the entries to
=web=.
@@ -10057,7 +10054,7 @@ the other commands, the cursor needs to be in the desired line.
#+cindex: diary entries, creating from agenda
Insert a new entry into the diary, using the date at the cursor
and (for block entries) the date at the mark. This adds to the
- Emacs diary file[fn:97], in a way similar to the {{{kbd(i)}}}
+ Emacs diary file[fn:96], in a way similar to the {{{kbd(i)}}}
command in the calendar. The diary file pops up in another
window, where you can add the entry.
@@ -10185,13 +10182,13 @@ after the dispatcher command in order to access the command. Usually
this will be just a single character, but if you have many similar
commands, you can also define two-letter combinations where the first
character is the same in several combinations and serves as a prefix
-key[fn:98]. The second parameter is the search type, followed by the
+key[fn:97]. The second parameter is the search type, followed by the
string or regular expression to be used for the matching. The example
above will therefore define:
- {{{kbd(x)}}} ::
- as a global search for agenda entries planned[fn:99] this
+ as a global search for agenda entries planned[fn:98] this
week/day.
- {{{kbd(y)}}} ::
@@ -10373,8 +10370,8 @@ See the docstring of the variable for more information.
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
-export custom agenda views as plain text, HTML[fn:100], Postscript,
-PDF[fn:101], and iCalendar files. If you want to do this only
+export custom agenda views as plain text, HTML[fn:99], Postscript,
+PDF[fn:100], and iCalendar files. If you want to do this only
occasionally, use the following command:
- {{{kbd(C-x C-w)}}} (~org-agenda-write~) ::
@@ -10388,7 +10385,7 @@ occasionally, use the following command:
If you need to export certain agenda views frequently, you can
associate any custom agenda command with a list of output file
-names[fn:102]. Here is an example that first defines custom commands
+names[fn:101]. Here is an example that first defines custom commands
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
commands and specify file names for them as well. File names can be
@@ -10477,7 +10474,7 @@ From the command line you may also use:
#+end_src
#+texinfo: @noindent
-or, if you need to modify some parameters[fn:103]
+or, if you need to modify some parameters[fn:102]
#+begin_src shell
emacs -eval '(org-batch-store-agenda-views \
@@ -10743,9 +10740,9 @@ may also be additional whitespace before the colon:
#+vindex: org-latex-listings
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
-for the example to look like the fontified Emacs buffer[fn:104]. This
+for the example to look like the fontified Emacs buffer[fn:103]. This
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:105],
+of the major mode that should be used to fontify the example[fn:104],
see [[*Structure Templates]] for shortcuts to easily insert code blocks.
#+cindex: BEGIN_SRC
@@ -10786,7 +10783,7 @@ In HTML, hovering the mouse over such a link remote-highlights the
corresponding code line, which is kind of cool.
You can also add a =-r= switch which /removes/ the labels from the
-source code[fn:106]. With the =-n= switch, links to these references
+source code[fn:105]. With the =-n= switch, links to these references
are labeled by the line numbers from the code listing. Otherwise
links use the labels with no parentheses. Here is an example:
@@ -10824,10 +10821,10 @@ a shortcut is provided (see [[*Structure Templates]]).
#+findex: org-edit-special
Edit the source code example at point in its native mode. This
works by switching to a temporary buffer with the source code.
- You need to exit by pressing {{{kbd(C-c ')}}} again[fn:107]. The
+ You need to exit by pressing {{{kbd(C-c ')}}} again[fn:106]. The
edited version then replaces the old version in the Org buffer.
Fixed-width regions---where each line starts with a colon
- followed by a space---are edited using ~artist-mode~[fn:108] to
+ followed by a space---are edited using ~artist-mode~[fn:107] to
allow creating ASCII drawings easily. Using this command in an
empty line creates a new fixed-width region.
@@ -10884,7 +10881,7 @@ document, e.g., =\under{}not underlined\under= exports as =_not underlined_=.
#+cindex: special symbols, in-buffer display
If you would like to see entities displayed as UTF-8 characters, use
-the following command[fn:109]:
+the following command[fn:108]:
- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
#+kindex: C-c C-x \
@@ -10898,7 +10895,7 @@ the following command[fn:109]:
#+cindex: dash, special symbol
#+cindex: ellipsis, special symbol
In addition to regular entities defined above, Org exports in
-a special way[fn:110] the following commonly used character
+a special way[fn:109] the following commonly used character
combinations: =\-= is treated as a shy hyphen, =--= and =---= are
converted into dashes, and =...= becomes a compact set of dots.
@@ -10942,7 +10939,7 @@ change this convention. For example, when setting this variable to
Plain ASCII is normally sufficient for almost all note taking.
Exceptions include scientific notes, which often require mathematical
-symbols and the occasional formula. LaTeX[fn:111] is widely used to
+symbols and the occasional formula. LaTeX[fn:110] is widely used to
typeset scientific documents. Org mode supports embedding LaTeX code
into its files, because many academics are used to writing and reading
LaTeX source code, and because it can be readily processed to produce
@@ -10964,7 +10961,7 @@ into images (see [[*Previewing LaTeX fragments]]).
LaTeX fragments do not need any special marking at all. The following
snippets are identified as LaTeX source code:
-- Environments of any kind[fn:112]. The only requirement is that the
+- Environments of any kind[fn:111]. The only requirement is that the
=\begin= statement appears on a new line, preceded by only
whitespace.
@@ -11008,7 +11005,7 @@ lines:
#+vindex: org-preview-latex-default-process
If you have a working LaTeX installation and =dvipng=, =dvisvgm= or
-=convert= installed[fn:113], LaTeX fragments can be processed to
+=convert= installed[fn:112], LaTeX fragments can be processed to
produce images of the typeset expressions to be used for inclusion
while exporting to HTML (see [[*LaTeX fragments]]), or for inline
previewing within Org mode.
@@ -11077,7 +11074,7 @@ more details see the documentation of CDLaTeX mode):
#+kindex: TAB
The {{{kbd(TAB)}}} expands the template if the cursor is inside
- a LaTeX fragment[fn:114]. For example, {{{kbd(TAB)}}} expands
+ a LaTeX fragment[fn:113]. For example, {{{kbd(TAB)}}} expands
=fr= to =\frac{}{}= and position the cursor correctly inside the
first brace. Another {{{kbd(TAB)}}} gets you into the second
brace.
@@ -11292,7 +11289,7 @@ global variables, include:
#+cindex: DATE, keyword
#+vindex: org-export-date-timestamp-format
- A date or a time-stamp[fn:115].
+ A date or a time-stamp[fn:114].
- =EMAIL= ::
@@ -11587,7 +11584,7 @@ keyword:
#+cindex: excluding entries from table of contents
#+cindex: table of contents, exclude entries
Org includes both numbered and unnumbered headlines in the table of
-contents[fn:116]. If you need to exclude an unnumbered headline,
+contents[fn:115]. If you need to exclude an unnumbered headline,
along with all its children, set the =UNNUMBERED= property to =notoc=
value.
@@ -11705,7 +11702,7 @@ following syntax:
: #+MACRO: name replacement text; $1, $2 are arguments
#+texinfo: @noindent
-which can be referenced using ={{{name(arg1, arg2)}}}=[fn:117]. For
+which can be referenced using ={{{name(arg1, arg2)}}}=[fn:116]. For
example
#+begin_example
@@ -11819,7 +11816,7 @@ are not exported.
Finally, a =COMMENT= keyword at the beginning of an entry, but after
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
-is executed either[fn:118]. The command below helps changing the
+is executed either[fn:117]. The command below helps changing the
comment status of a headline.
- {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
@@ -12090,7 +12087,7 @@ should in principle be exportable as a Beamer presentation.
- Org exports a Beamer frame's objects as block environments. Org can
enforce wrapping in special block types when =BEAMER_ENV= property
- is set[fn:119]. For valid values see
+ is set[fn:118]. For valid values see
~org-beamer-environments-default~. To add more values, see
~org-beamer-environments-extra~.
#+vindex: org-beamer-environments-default
@@ -12666,7 +12663,7 @@ is.
#+vindex: org-html-mathjax-options~
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]],
-which should work out of the box with Org[fn:120]. Some MathJax
+which should work out of the box with Org[fn:119]. Some MathJax
display options can be configured via ~org-html-mathjax-options~, or
in the buffer. For example, with the following settings,
@@ -12678,7 +12675,7 @@ in the buffer. For example, with the following settings,
#+texinfo: @noindent
equation labels are displayed on the left margin and equations are
five em from the left margin. In addition, it loads the two MathJax
-extensions =cancel.js= and =noErrors.js=[fn:121].
+extensions =cancel.js= and =noErrors.js=[fn:120].
#+vindex: org-html-mathjax-template
See the docstring of ~org-html-mathjax-options~ for all supported
@@ -12741,7 +12738,7 @@ line.
#+vindex: org-export-html-todo-kwd-class-prefix
#+vindex: org-export-html-tag-class-prefix
You can modify the CSS style definitions for the exported file. The
-HTML exporter assigns the following special CSS classes[fn:122] to
+HTML exporter assigns the following special CSS classes[fn:121] to
appropriate parts of the document---your style specifications may
change these, in addition to any of the standard classes like for
headlines, tables, etc.
@@ -12981,7 +12978,7 @@ LaTeX export back-end finds the compiler version to use from
Org file. See the docstring for the
~org-latex-default-packages-alist~ for loading packages with certain
compilers. Also see ~org-latex-bibtex-compiler~ to set the
-bibliography compiler[fn:123].
+bibliography compiler[fn:122].
*** LaTeX specific export settings
:PROPERTIES:
@@ -13591,7 +13588,7 @@ a limit to a level before the absolute limit (see [[*Export Settings]]).
The ODT export back-end handles creating of OpenDocument Text (ODT)
format. Documents created by this exporter use the
-{{{cite(OpenDocument-v1.2 specification)}}}[fn:124] and are compatible
+{{{cite(OpenDocument-v1.2 specification)}}}[fn:123] and are compatible
with LibreOffice 3.4.
*** Pre-requisites for ODT export
@@ -13992,7 +13989,7 @@ document in one of the following ways:
variables ~org-latex-to-mathml-convert-command~ and
~org-latex-to-mathml-jar-file~.
- If you prefer to use MathToWeb[fn:125] as your converter, you can
+ If you prefer to use MathToWeb[fn:124] as your converter, you can
configure the above variables as shown below.
#+begin_src emacs-lisp
@@ -14002,7 +13999,7 @@ document in one of the following ways:
"/path/to/mathtoweb.jar")
#+end_src
- To use LaTeX​ML[fn:126] use
+ To use LaTeX​ML[fn:125] use
#+begin_src emacs-lisp
(setq org-latex-to-mathml-convert-command
@@ -14322,7 +14319,7 @@ with the =#+ATTR_ODT= line. For a discussion on default formatting of
tables, see [[*Tables in ODT export]].
This feature closely mimics the way table templates are defined in the
-OpenDocument-v1.2 specification.[fn:127]
+OpenDocument-v1.2 specification.[fn:126]
#+vindex: org-odt-table-styles
For quick preview of this feature, install the settings below and export the
@@ -14356,7 +14353,7 @@ templates, define new styles there.
To use this feature proceed as follows:
-1. Create a table template[fn:128].
+1. Create a table template[fn:127].
A table template is set of =table-cell= and =paragraph= styles for
each of the following table cell categories:
@@ -14395,7 +14392,7 @@ To use this feature proceed as follows:
=</office:automatic-styles>= element of the content template file
(see [[x-orgodtcontenttemplate-xml][Factory styles]]).
-2. Define a table style[fn:129].
+2. Define a table style[fn:128].
#+vindex: org-odt-table-styles
To define a table style, create an entry for the style in the
@@ -15422,7 +15419,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
publishing directory. If you want a htmlized version of this file,
set the parameter ~:htmlized-source~ to ~t~. It produces
-=file.org.html= in the publishing directory[fn:130].
+=file.org.html= in the publishing directory[fn:129].
Other files like images only need to be copied to the publishing
destination; for this you can use ~org-publish-attachment~. For
@@ -16799,13 +16796,13 @@ See [[*Languages]] to enable other languages.
#+kindex: C-c C-v e
#+findex: org-babel-execute-src-block
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:131] calls the
+{{{kbd(C-c C-v e)}}} with the point on a code block[fn:130] calls the
~org-babel-execute-src-block~ function, which executes the code in the
block, collects the results, and inserts them in the buffer.
#+cindex: CALL, keyword
#+vindex: org-babel-inline-result-wrap
-By calling a named code block[fn:132] from an Org mode buffer or
+By calling a named code block[fn:131] from an Org mode buffer or
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]]).
@@ -17696,7 +17693,7 @@ for Python and Emacs Lisp languages.
#+cindex: syntax, Noweb
#+cindex: source code, Noweb reference
-Org supports named blocks in Noweb[fn:133] style syntax:
+Org supports named blocks in Noweb[fn:132] style syntax:
: <<CODE-BLOCK-ID>>
@@ -18194,7 +18191,7 @@ Org Tempo expands snippets to structures defined in
~org-structure-template-alist~ and ~org-tempo-keywords-alist~. For
example, {{{kbd(< s TAB)}}} creates a code block. Enable it by
customizing ~org-modules~ or add ~(require 'org-tempo)~ to your Emacs
-init file[fn:134].
+init file[fn:133].
#+attr_texinfo: :columns 0.1 0.9
@@ -18449,7 +18446,7 @@ changes.
#+vindex: org-startup-indented
Dynamic virtual indentation is controlled by the variable
- ~org-startup-indented~.[fn:135]
+ ~org-startup-indented~.[fn:134]
- =indent= ::
@@ -18781,7 +18778,7 @@ uses only one star and indents text to line with the heading:
#+findex: org-indent-mode
To turn this mode on, use the minor mode, ~org-indent-mode~. Text
lines that are not headlines are prefixed with spaces to vertically
-align with the headline text[fn:136].
+align with the headline text[fn:135].
#+vindex: org-indent-indentation-per-level
To make more horizontal space, the headlines are shifted by two stars.
@@ -18816,7 +18813,7 @@ headings as shown in examples below.
#+vindex: org-adapt-indentation
Org supports this with paragraph filling, line wrapping, and
structure editing, preserving or adapting the indentation as
- appropriate[fn:137].
+ appropriate[fn:136].
- /Hiding leading stars/ ::
@@ -18850,7 +18847,7 @@ headings as shown in examples below.
#+vindex: org-odd-levels-only
Using stars for only odd levels, 1, 3, 5, ..., can also clean up
- the clutter. This removes two stars from each level[fn:138].
+ the clutter. This removes two stars from each level[fn:137].
For Org to properly handle this cleaner structure during edits
and exports, configure the variable ~org-odd-levels-only~. To
set this per-file, use either one of the following lines:
@@ -19419,9 +19416,9 @@ of these strategies:
#+cindex: @LaTeX{}, and Orgtbl mode
To wrap a source table in LaTeX, use the =comment= environment
-provided by =comment.sty=[fn:139]. To activate it, put
+provided by =comment.sty=[fn:138]. To activate it, put
~\usepackage{comment}~ in the document header. Orgtbl mode inserts
-a radio table skeleton[fn:138] with the command {{{kbd(M-x
+a radio table skeleton[fn:137] with the command {{{kbd(M-x
orgtbl-insert-radio-table)}}}, which prompts for a table name. For
example, if =salesfigures= is the name, the template inserts:
@@ -19440,7 +19437,7 @@ The line =#+ORGTBL: SEND= tells Orgtbl mode to use the function
~orgtbl-to-latex~ to convert the table to LaTeX format, then insert
the table at the target (receive) location named =salesfigures=. Now
the table is ready for data entry. It can even use spreadsheet
-features[fn:140]:
+features[fn:139]:
#+begin_example
% BEGIN RECEIVE ORGTBL salesfigures
@@ -19655,7 +19652,7 @@ Dynamic blocks, like any other block, can be narrowed with
#+vindex: org-agenda-skip-function
#+vindex: org-agenda-skip-function-global
Org provides a special hook to further limit items in agenda views:
-~agenda~, ~agenda*~[fn:141], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
+~agenda~, ~agenda*~[fn:140], ~todo~, ~alltodo~, ~tags~, ~tags-todo~,
~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
needed.
@@ -19698,7 +19695,7 @@ meaningful string suitable for the agenda view.
#+vindex: org-agenda-skip-function
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
-include all levels, use =LEVEL>0=[fn:142]. Then to selectively pick
+include all levels, use =LEVEL>0=[fn:141]. Then to selectively pick
the matched entries, use ~org-agenda-skip-function~, which also
accepts Lisp forms, such as ~org-agenda-skip-entry-if~ and
~org-agenda-skip-subtree-if~. For example:
@@ -20193,13 +20190,13 @@ with Emacs. With a public server, consider encrypting the files.
MobileOrg version 1.5 supports encryption for the iPhone. Org also
requires =openssl= installed on the local computer. To turn on
encryption, set the same password in MobileOrg and in Emacs. Set the
-password in the variable ~org-mobile-use-encryption~[fn:143]. Note
+password in the variable ~org-mobile-use-encryption~[fn:142]. Note
that even after MobileOrg encrypts the file contents, the file name
remains visible on the file systems of the local computer, the server,
and the mobile device.
For a server to host files, consider options like [[http://dropbox.com][Dropbox.com]]
-account[fn:144]. On first connection, MobileOrg creates a directory
+account[fn:143]. On first connection, MobileOrg creates a directory
=MobileOrg= on Dropbox. Pass its location to Emacs through an
initialisation file variable as follows:
@@ -20221,15 +20218,15 @@ Org pushes files listed in ~org-mobile-files~ to
~org-mobile-directory~. Files include agenda files (as listed in
~org-agenda-files~). Customize ~org-mobile-files~ to add other files.
File names are staged with paths relative to ~org-directory~, so all
-files should be inside this directory[fn:145].
+files should be inside this directory[fn:144].
Push creates a special Org file =agendas.org= with custom agenda views
-defined by the user[fn:146].
+defined by the user[fn:145].
Finally, Org writes the file =index.org=, containing links to other
files. MobileOrg reads this file first from the server to determine
what other files to download for agendas. For faster downloads,
-MobileOrg only reads files whose checksums[fn:147] have changed.
+MobileOrg only reads files whose checksums[fn:146] have changed.
** Pulling from MobileOrg
:PROPERTIES:
@@ -20243,7 +20240,7 @@ Org integrates its data in an inbox file format.
1.
#+vindex: org-mobile-inbox-for-pull
- Org moves all entries found in =mobileorg.org=[fn:148] and appends
+ Org moves all entries found in =mobileorg.org=[fn:147] and appends
them to the file pointed to by the variable
~org-mobile-inbox-for-pull~. Each captured entry and each editing
event is a top-level entry in the inbox file.
@@ -21048,229 +21045,226 @@ On other systems, idle time refers to Emacs idle time only.
[fn:79] Please note the pitfalls of summing hierarchical data in
a flat list ([[*Using Column View in the Agenda]]).
-[fn:80] Please select your own key, {{{kbd(C-c c)}}} is only
-a suggestion.
-
-[fn:81] Org used to offer four different targets for date/week tree
+[fn:80] Org used to offer four different targets for date/week tree
capture. Now, Org automatically translates these to use
~file+olp+datetree~, applying the ~:time-prompt~ and ~:tree-type~
properties. Please rewrite your date/week-tree targets using
~file+olp+datetree~ since the older targets are now deprecated.
-[fn:82] A date tree is an outline structure with years on the highest
+[fn:81] A date tree is an outline structure with years on the highest
level, months or ISO weeks as sublevels and then dates on the lowest
level. Tags are allowed in the tree structure.
-[fn:83] If you need one of these sequences literally, escape the =%=
+[fn:82] If you need one of these sequences literally, escape the =%=
with a backslash.
-[fn:84] If you define your own link types (see [[*Adding Hyperlink
+[fn:83] If you define your own link types (see [[*Adding Hyperlink
Types]]), any property you store with ~org-store-link-props~ can be
accessed in capture templates in a similar way.
-[fn:85] This is always the other, not the user. See the variable
+[fn:84] This is always the other, not the user. See the variable
~org-from-is-user-regexp~.
-[fn:86] If you move entries or Org files from one directory to
+[fn:85] If you move entries or Org files from one directory to
another, you may want to configure ~org-attach-directory~ to contain
an absolute path.
-[fn:87] Note the corresponding =STARTUP= options =logrefile=,
+[fn:86] Note the corresponding =STARTUP= options =logrefile=,
=lognoterefile=, and =nologrefile=.
-[fn:88] If the value of that variable is not a list, but a single file
+[fn:87] 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
file.
-[fn:89] When using the dispatcher, pressing {{{kbd(<)}}} before
+[fn:88] When using the dispatcher, pressing {{{kbd(<)}}} before
selecting a command actually limits the command to the current file,
and ignores ~org-agenda-files~ until the next dispatcher command.
-[fn:90] For backward compatibility, you can also press {{{kbd(1)}}} to
+[fn:89] For backward compatibility, you can also press {{{kbd(1)}}} to
restrict to the current buffer.
-[fn:91] For backward compatibility, you can also press {{{kbd(0)}}} to
+[fn:90] For backward compatibility, you can also press {{{kbd(0)}}} to
restrict to the current region/subtree.
-[fn:92] For backward compatibility, the universal prefix argument
+[fn:91] For backward compatibility, the universal prefix argument
{{{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
agenda instead (see [[*Block agenda]]).
-[fn:93] The variable ~org-anniversary~ used in the example is just
+[fn:92] The variable ~org-anniversary~ used in the example is just
like ~diary-anniversary~, but the argument order is always according
to ISO and therefore independent of the value of
~calendar-date-style~.
-[fn:94] Custom commands can preset a filter by binding the variable
+[fn:93] Custom commands can preset a filter by binding the variable
~org-agenda-tag-filter-preset~ as an option. This filter is then
applied to the view and persists as a basic filter through refreshes
and more secondary filtering. The filter is a global 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 individual block.
-[fn:95] Only tags filtering is respected here, effort filtering is
+[fn:94] Only tags filtering is respected here, effort filtering is
ignored.
-[fn:96] You can also create persistent custom functions through
+[fn:95] You can also create persistent custom functions through
~org-agenda-bulk-custom-functions~.
-[fn:97] This file is parsed for the agenda when
+[fn:96] This file is parsed for the agenda when
~org-agenda-include-diary~ is set.
-[fn:98] You can provide a description for a prefix key by inserting
+[fn:97] You can provide a description for a prefix key by inserting
a cons cell with the prefix and the description.
-[fn:99] /Planned/ means here that these entries have some planning
+[fn:98] /Planned/ means here that these entries have some planning
information attached to them, like a time-stamp, a scheduled or
a deadline string. See ~org-agenda-entry-types~ on how to set what
planning information is taken into account.
-[fn:100] For HTML you need to install Hrvoje Niksic's =htmlize.el=
+[fn:99] For HTML you need to install Hrvoje Niksic's =htmlize.el=
from [[https://github.com/hniksic/emacs-htmlize][Hrvoje Niksic's repository]].
-[fn:101] To create PDF output, the Ghostscript ps2pdf utility must be
+[fn:100] To create PDF output, the Ghostscript ps2pdf utility must be
installed on the system. Selecting a PDF file also creates the
postscript file.
-[fn:102] If you want to store standard views like the weekly agenda or
+[fn:101] 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
them in order to be able to specify file names.
-[fn:103] Quoting depends on the system you use, please check the FAQ
+[fn:102] Quoting depends on the system you use, please check the FAQ
for examples.
-[fn:104] This works automatically for the HTML backend (it requires
+[fn:103] This works automatically for the HTML backend (it requires
version 1.34 of the =htmlize.el= package, which you need to install).
Fontified code chunks in LaTeX can be achieved using either the
listings package or the [[https://github.com/gpoore/minted][minted]] package. Refer to
~org-export-latex-listings~ for details.
-[fn:105] Source code in code blocks may also be evaluated either
+[fn:104] Source code in code blocks may also be evaluated either
interactively or on export. See [[*Working with Source Code]] for more
information on evaluating code blocks.
-[fn:106] Adding =-k= to =-n -r= /keeps/ the labels in the source code
+[fn:105] Adding =-k= to =-n -r= /keeps/ the labels in the source code
while using line numbers for the links, which might be useful to
explain those in an Org mode example code.
-[fn:107] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
+[fn:106] Upon exit, lines starting with =*=, =,*=, =#+= and =,#+= get
a comma prepended, to keep them from being interpreted by Org as
outline nodes or special syntax. These commas are stripped when
editing with {{{kbd(C-c ')}}}, and also before export.
-[fn:108] You may select a different-mode with the variable
+[fn:107] You may select a different-mode with the variable
~org-edit-fixed-width-region-mode~.
-[fn:109] You can turn this on by default by setting the variable
+[fn:108] You can turn this on by default by setting the variable
~org-pretty-entities~, or on a per-file base with the =STARTUP= option
=entitiespretty=.
-[fn:110] This behaviour can be disabled with =-= export setting (see
+[fn:109] This behaviour can be disabled with =-= export setting (see
[[*Export Settings]]).
-[fn:111] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX
+[fn:110] 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
from TeX, but for simplicity I am blurring this distinction.
-[fn:112] When MathJax is used, only the environments recognized by
+[fn:111] When MathJax is used, only the environments recognized by
MathJax are processed. When dvipng, dvisvgm, or ImageMagick suite is
used to create images, any LaTeX environment is handled.
-[fn:113] These are respectively available at
+[fn:112] These are respectively available at
[[http://sourceforge.net/projects/dvipng/]], [[http://dvisvgm.bplaced.net/]]
and from the ImageMagick suite. Choose the converter by setting the
variable ~org-preview-latex-default-process~ accordingly.
-[fn:114] Org mode has a method to test if the cursor is inside such
+[fn:113] Org mode has a method to test if the cursor is inside such
a fragment, see the documentation of the function
~org-inside-LaTeX-fragment-p~.
-[fn:115] The variable ~org-export-date-timestamp-format~ defines how
+[fn:114] The variable ~org-export-date-timestamp-format~ defines how
this timestamp are exported.
-[fn:116] At the moment, some export back-ends do not obey this
+[fn:115] At the moment, some export back-ends do not obey this
specification. For example, LaTeX export excludes every unnumbered
headline from the table of contents.
-[fn:117] Since commas separate the arguments, commas within arguments
+[fn:116] Since commas separate the arguments, commas within arguments
have to be escaped with the backslash character. So only those
backslash characters before a comma need escaping with another
backslash character.
-[fn:118] For a less drastic behavior, consider using a select tag (see
+[fn:117] For a less drastic behavior, consider using a select tag (see
[[*Export Settings]]) instead.
-[fn:119] If =BEAMER_ENV= is set, Org export adds =B_environment= tag
+[fn:118] 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
semantic relevance.
-[fn:120] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
+[fn:119] By default Org loads MathJax from [[https://cdnjs.com][cdnjs.com]] as recommended by
[[http://www.mathjax.org][MathJax]].
-[fn:121] 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:120] 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.
-[fn:122] If the classes on TODO keywords and tags lead to conflicts,
+[fn:121] If the classes on TODO keywords and tags lead to conflicts,
use the variables ~org-html-todo-kwd-class-prefix~ and
~org-html-tag-class-prefix~ to make them unique.
-[fn:123] This does not allow setting different bibliography compilers
+[fn:122] This does not allow setting different bibliography compilers
for different files. However, "smart" LaTeX compilation systems, such
as latexmk, can select the correct bibliography compiler.
-[fn:124] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
+[fn:123] See [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open Document Format for Office Applications
(OpenDocument) Version 1.2]].
-[fn:125] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
+[fn:124] See [[http://www.mathtoweb.com/cgi-bin/mathtoweb_home.pl][MathToWeb]].
-[fn:126] See [[http://dlmf.nist.gov/LaTeXML/]].
+[fn:125] See [[http://dlmf.nist.gov/LaTeXML/]].
-[fn:127] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
+[fn:126] [[http://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][OpenDocument-v1.2 Specification]]
-[fn:128] See the =<table:table-template>= element of the
+[fn:127] See the =<table:table-template>= element of the
OpenDocument-v1.2 specification.
-[fn:129] See the attributes =table:template-name=,
+[fn:128] See the attributes =table:template-name=,
=table:use-first-row-styles=, =table:use-last-row-styles=,
=table:use-first-column-styles=, =table:use-last-column-styles=,
=table:use-banding-rows-styles=, and =table:use-banding-column-styles=
of the =<table:table>= element in the OpenDocument-v1.2 specification.
-[fn:130] If the publishing directory is the same as the source
+[fn:129] If the publishing directory is the same as the source
directory, =file.org= is exported as =file.org.org=, so you probably
do not want to do this.
-[fn:131] The option ~org-babel-no-eval-on-ctrl-c-ctrl-c~ can be used
+[fn:130] 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.
-[fn:132] Actually, the constructs =call_<name>()= and =src_<lang>{}=
+[fn:131] Actually, the constructs =call_<name>()= and =src_<lang>{}=
are not evaluated when they appear in a keyword line---i.e. lines
starting with =#+KEYWORD:=, see [[*Summary of In-Buffer Settings]].
-[fn:133] For Noweb literate programming details, see
+[fn:132] For Noweb literate programming details, see
http://www.cs.tufts.edu/~nr/noweb/.
-[fn:134] For more information, please refer to the commentary section
+[fn:133] For more information, please refer to the commentary section
in =org-tempo.el=.
-[fn:135] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
+[fn:134] Note that ~org-indent-mode~ also sets the ~wrap-prefix~
property, such that ~visual-line-mode~ (or purely setting ~word-wrap~)
wraps long lines (including headlines) correctly indented.
-[fn:136] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
+[fn:135] The ~org-indent-mode~ also sets the ~wrap-prefix~ correctly
for indenting and wrapping long lines of headlines or text. This
minor mode handles ~visual-line-mode~ and directly applied settings
through ~word-wrap~.
-[fn:137] Also see the variable ~org-adapt-indentation~.
+[fn:136] Also see the variable ~org-adapt-indentation~.
-[fn:138] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
+[fn:137] Because =LEVEL=2= has 3 stars, =LEVEL=3= has 4 stars, and so
on.
-[fn:139] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
+[fn:138] https://ctan.org/tex-archive/macros/latex/contrib/comment?lang=en
-[fn:140] If the =TBLFM= keyword contains an odd number of dollar
+[fn:139] If the =TBLFM= keyword contains an odd number of dollar
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
the =comment= environment that is used to balance the dollar
@@ -21278,32 +21272,32 @@ expressions. If you are using AUCTeX with the font-latex library,
a much better solution is to add the =comment= environment to the
variable ~LaTeX-verbatim-environments~.
-[fn:141] The ~agenda*~ view is the same as ~agenda~ except that it
+[fn:140] The ~agenda*~ view is the same as ~agenda~ except that it
only considers /appointments/, i.e., scheduled and deadline items that
have a time specification =[h]h:mm= in their time-stamps.
-[fn:142] Note that, for ~org-odd-levels-only~, a level number
+[fn:141] Note that, for ~org-odd-levels-only~, a level number
corresponds to order in the hierarchy, not to the number of stars.
-[fn:143] If Emacs is configured for safe storing of passwords, then
+[fn:142] If Emacs is configured for safe storing of passwords, then
configure the variable, ~org-mobile-encryption-password~; please read
the docstring of that variable.
-[fn:144] An alternative is to use a WebDAV server. MobileOrg
+[fn:143] An alternative is to use a WebDAV server. MobileOrg
documentation has details of WebDAV server configuration. Additional
help is at this [[https://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]].
-[fn:145] Symbolic links in ~org-directory~ need to have the same name
+[fn:144] Symbolic links in ~org-directory~ need to have the same name
as their targets.
-[fn:146] While creating the agendas, Org mode forces ID properties on
+[fn:145] While creating the agendas, Org mode forces ID properties on
all referenced entries, so that these entries can be uniquely
identified if MobileOrg flags them for further action. To avoid
setting properties configure the variable
~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode then relies
on outline paths, assuming they are unique.
-[fn:147] Checksums are stored automatically in the file
+[fn:146] Checksums are stored automatically in the file
=checksums.dat=.
-[fn:148] The file will be empty after this operation.
+[fn:147] The file will be empty after this operation.