org-manual: Fix grammar issues identified by LanguageTool

* doc/org-manual.org:
This commit is contained in:
Ihor Radchenko 2024-06-23 13:14:40 +02:00
parent 39272e2165
commit de775a36d9
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 138 additions and 138 deletions

View File

@ -34,7 +34,7 @@ detailed project-planning, allowing logging, multiple views on your
tasks, exporting your agendas, etc. tasks, exporting your agendas, etc.
Org mode is implemented on top of Outline mode, which makes it Org mode is implemented on top of Outline mode, which makes it
possible to keep the content of large files well structured. possible to keep the content of large files well-structured.
Visibility cycling and structure editing help to work with the tree. Visibility cycling and structure editing help to work with the tree.
Tables are easily created with a built-in table editor. Plain text Tables are easily created with a built-in table editor. Plain text
URL-like links connect to websites, emails, Usenet messages, BBDB URL-like links connect to websites, emails, Usenet messages, BBDB
@ -117,7 +117,7 @@ with {{{kbd(M-x list-packages)}}}. See [[info:emacs::Package Menu][Package Menu
#+begin_quote #+begin_quote
You need to do this in a session where no =.org= file has been You need to do this in a session where no =.org= file has been
visited, i.e., where no Org built-in function have been loaded. visited, i.e., where no Org built-in function have been loaded.
Otherwise autoload Org functions will mess up the installation. Otherwise, autoload Org functions will mess up the installation.
#+end_quote #+end_quote
To avoid interference with built-in Org mode, you can use command line: To avoid interference with built-in Org mode, you can use command line:
@ -172,7 +172,7 @@ contributed by others. As of Org 9.5, the directory has been moved to
the dedicated org-contrib [[https://git.sr.ht/~bzg/org-contrib][repository]], which you can install the dedicated org-contrib [[https://git.sr.ht/~bzg/org-contrib][repository]], which you can install
separately as a [[https://elpa.nongnu.org/nongnu/org-contrib.html][package]] from NonGNU ELPA. separately as a [[https://elpa.nongnu.org/nongnu/org-contrib.html][package]] from NonGNU ELPA.
There are enough valuable packages maintained outside of the Org repository. There are enough valuable packages maintained outside the Org repository.
Worg has a list of [[https://orgmode.org/worg/org-contrib/index.html][org-contrib and external packages]], certainly it is not Worg has a list of [[https://orgmode.org/worg/org-contrib/index.html][org-contrib and external packages]], certainly it is not
exhaustive. exhaustive.
@ -284,7 +284,7 @@ a command like the example below.
: $ emacs -Q -l /path/to/minimal-org.el : $ emacs -Q -l /path/to/minimal-org.el
However if you are using Org mode as distributed with Emacs, a minimal However, if you are using Org mode as distributed with Emacs, a minimal
setup is not necessary. In that case it is sufficient to start Emacs setup is not necessary. In that case it is sufficient to start Emacs
as =emacs -Q=. The =minimal-org.el= setup file can have contents as as =emacs -Q=. The =minimal-org.el= setup file can have contents as
shown below. shown below.
@ -416,7 +416,7 @@ Emacs profiler, we recommend the following steps:
: M-x profiler-report-write-profile <RET> : M-x profiler-report-write-profile <RET>
: /path/to/profile-file-to-be-saved <RET> : /path/to/profile-file-to-be-saved <RET>
Then, you can attached the saved file to your email to the Org Then, you can attach the saved file to your email to the Org
mailing list, alongside with details about what you did to trigger mailing list, alongside with details about what you did to trigger
the slowdown. the slowdown.
@ -975,7 +975,7 @@ The following commands jump to other headlines in the buffer.
#+kindex: C-c ^ #+kindex: C-c ^
#+findex: org-sort #+findex: org-sort
Sort same-level entries. When there is an active region, all Sort same-level entries. When there is an active region, all
entries in the region are sorted. Otherwise the children of the entries in the region are sorted. Otherwise, the children of the
current headline are sorted. The command prompts for the sorting current headline are sorted. The command prompts for the sorting
method, which can be alphabetically, numerically, by time---first method, which can be alphabetically, numerically, by time---first
timestamp with active preferred, creation time, scheduled time, timestamp with active preferred, creation time, scheduled time,
@ -1245,7 +1245,7 @@ to disable them individually.
#+kindex: M-UP #+kindex: M-UP
#+kindex: M-DOWN #+kindex: M-DOWN
Move the item including subitems up/down[fn:: See Move the item including sub-items up/down[fn:: See
~org-list-use-circular-motion~ for a cyclic behavior.], i.e., swap ~org-list-use-circular-motion~ for a cyclic behavior.], i.e., swap
with previous/next item of same indentation. If the list is with previous/next item of same indentation. If the list is
ordered, renumbering is automatic. ordered, renumbering is automatic.
@ -1261,7 +1261,7 @@ to disable them individually.
#+kindex: M-S-LEFT #+kindex: M-S-LEFT
#+kindex: M-S-RIGHT #+kindex: M-S-RIGHT
Decrease/increase the indentation of the item, including subitems. Decrease/increase the indentation of the item, including sub-items.
Initially, the item tree is selected based on current indentation. Initially, the item tree is selected based on current indentation.
When these commands are executed several times in direct succession, When these commands are executed several times in direct succession,
the initially selected region is used, even if the new indentation the initially selected region is used, even if the new indentation
@ -1367,8 +1367,8 @@ line and press {{{kbd(TAB)}}} there.
You can also arrange for state change notes (see [[Tracking TODO state You can also arrange for state change notes (see [[Tracking TODO state
changes]]) and clock times (see [[*Clocking Work Time]]) to be stored in changes]]) and clock times (see [[*Clocking Work Time]]) to be stored in
a =LOGBOOK= drawer. If you want to store a quick note there, in a =LOGBOOK= drawer. If you want to store a quick note there,
a similar way to state changes, use similarly to state changes, use
- {{{kbd(C-c C-z)}}} :: - {{{kbd(C-c C-z)}}} ::
@ -2351,7 +2351,7 @@ example:
#+texinfo: @noindent #+texinfo: @noindent
extracts the part of the string in column 1 between the character extracts the part of the string in column 1 between the character
positions specified in the integers in column 2 and 3 and it is easier positions specified in the integers in column 2 and 3, and it is easier
to read than the equivalent: to read than the equivalent:
: '(substring $1 (string-to-number $2) (string-to-number $3)) : '(substring $1 (string-to-number $2) (string-to-number $3))
@ -2479,7 +2479,7 @@ same formula is used in all fields of that column, with the following
very convenient exceptions: (i) If the table contains horizontal very convenient exceptions: (i) If the table contains horizontal
separator hlines with rows above and below, everything before the separator hlines with rows above and below, everything before the
first such hline is considered part of the table /header/ and is not first such hline is considered part of the table /header/ and is not
modified by column formulas. Therefore a header is mandatory when you modified by column formulas. Therefore, a header is mandatory when you
use column formulas and want to add hlines to group rows, like for use column formulas and want to add hlines to group rows, like for
example to separate a total row at the bottom from the summand rows example to separate a total row at the bottom from the summand rows
above. (ii) Fields that already get a value from a field/range above. (ii) Fields that already get a value from a field/range
@ -3065,16 +3065,16 @@ For more information and examples see the [[https://orgmode.org/worg/org-tutoria
- =min= :: - =min= ::
Provides a minimum axis value that may be used by a plot type. Provides a minimum axis value that may be used by a plot type.
Implicitly assumes the =y= axis is being referred to. Can Implicitly assumes the =y= axis is being referred to. You can
explicitly provide a value for a either the =x= or =y= axis with explicitly provide a value for the =x= or =y= axis with =xmin= and
=xmin= and =ymin=. =ymin=.
- =max= :: - =max= ::
Provides a maximum axis value that may be used by a plot type. Provides a maximum axis value that may be used by a plot type.
Implicitly assumes the =y= axis is being referred to. Can Implicitly assumes the =y= axis is being referred to. You can
explicitly provide a value for a either the =x= or =y= axis with explicitly provide a value for the =x= or =y= axis with =xmax= and
=xmax= and =ymax=. =ymax=.
- =ticks= :: - =ticks= ::
@ -3499,7 +3499,7 @@ it into an Org file, and to follow the link.
#+findex: org-store-link #+findex: org-store-link
#+cindex: storing links #+cindex: storing links
The main function is ~org-store-link~, called with {{{kbd(M-x The main function is ~org-store-link~, called with {{{kbd(M-x
org-store-link)}}}. Because of its importance, we suggest to bind it org-store-link)}}}. Because of its importance, we suggest binding it
to a widely available key (see [[*Activation]]). It stores a link to the to a widely available key (see [[*Activation]]). It stores a link to the
current location. The link is stored for later insertion into an Org current location. The link is stored for later insertion into an Org
buffer---see below. The kind of link that is created depends on the buffer---see below. The kind of link that is created depends on the
@ -3509,7 +3509,7 @@ current buffer:
For Org files, if there is a =<<target>>= at point, the link points For Org files, if there is a =<<target>>= at point, the link points
to the target. If there is a named block (using =#+name:=) at to the target. If there is a named block (using =#+name:=) at
point, the link points to that name. Otherwise it points to the point, the link points to that name. Otherwise, it points to the
current headline, which is also the description. current headline, which is also the description.
#+vindex: org-id-link-to-org-use-id #+vindex: org-id-link-to-org-use-id
@ -3518,7 +3518,7 @@ current buffer:
If the headline has a =CUSTOM_ID= property, store a link to this If the headline has a =CUSTOM_ID= property, store a link to this
custom ID. In addition or alternatively, depending on the value of custom ID. In addition or alternatively, depending on the value of
~org-id-link-to-org-use-id~, create and/or use a globally unique ~org-id-link-to-org-use-id~, create and/or use a globally unique
=ID= property for the link[fn:: The Org Id library must first be =ID= property for the link[fn:: The ~org-id~ library must first be
loaded, either through ~org-customize~, by enabling ~id~ in loaded, either through ~org-customize~, by enabling ~id~ in
~org-modules~, or by adding =(require 'org-id)= in your Emacs init ~org-modules~, or by adding =(require 'org-id)= in your Emacs init
file.]. So using this command in Org buffers potentially creates file.]. So using this command in Org buffers potentially creates
@ -3577,7 +3577,7 @@ current buffer:
#+vindex: org-irc-links-to-logs #+vindex: org-irc-links-to-logs
For IRC links, if the variable ~org-irc-link-to-logs~ is non-~nil~, For IRC links, if the variable ~org-irc-link-to-logs~ is non-~nil~,
create a =file= style link to the relevant point in the logs for the create a =file= style link to the relevant point in the logs for the
current conversation. Otherwise store an =irc= style link to the current conversation. Otherwise, store an =irc= style link to the
user/channel/server under the point. user/channel/server under the point.
- /Other files/ :: - /Other files/ ::
@ -3644,9 +3644,9 @@ generally, act on links.
argument, insert a link to a file. You may use file name completion argument, insert a link to a file. You may use file name completion
to select the name of the file. The path to the file is inserted to select the name of the file. The path to the file is inserted
relative to the directory of the current Org file, if the linked relative to the directory of the current Org file, if the linked
file is in the current directory or in a sub-directory of it, or if file is in the current directory or in a subdirectory of it, or if
the path is written relative to the current directory using =../=. the path is written relative to the current directory using =../=.
Otherwise an absolute path is used, if possible with =~/= for your Otherwise, an absolute path is used, if possible with =~/= for your
home directory. You can force an absolute path with two home directory. You can force an absolute path with two
{{{kbd(C-u)}}} prefixes. {{{kbd(C-u)}}} prefixes.
@ -3790,7 +3790,7 @@ example above, where we need to encode the URL parameter). Using
=%(my-function)= passes the tag to a custom Lisp function, and replace =%(my-function)= passes the tag to a custom Lisp function, and replace
it by the resulting string. it by the resulting string.
If the replacement text do not contain any specifier, it is simply If the replacement text does not contain any specifier, it is simply
appended to the string in order to create the link. appended to the string in order to create the link.
Instead of a string, you may also specify a Lisp function to create Instead of a string, you may also specify a Lisp function to create
@ -3871,7 +3871,7 @@ link, together with explanations for each:
Search for a link target =<<My Target>>=, or do a text search for Search for a link target =<<My Target>>=, or do a text search for
=my target=, similar to the search in internal links, see [[*Internal =my target=, similar to the search in internal links, see [[*Internal
Links]]. In HTML export (see [[*HTML Export]]), such a file link becomes Links]]. In HTML export (see [[*HTML Export]]), such a file link becomes
a HTML reference to the corresponding named anchor in the linked an HTML reference to the corresponding named anchor in the linked
file. file.
- =*My Target= :: - =*My Target= ::
@ -4137,7 +4137,7 @@ The keywords should all be different, this helps Org mode keep track
of which subsequence should be used for a given entry. In this setup, of which subsequence should be used for a given entry. In this setup,
{{{kbd(C-c C-t)}}} only operates within a sub-sequence, so it switches {{{kbd(C-c C-t)}}} only operates within a sub-sequence, so it switches
from =DONE= to (nothing) to =TODO=, and from =FIXED= to (nothing) to from =DONE= to (nothing) to =TODO=, and from =FIXED= to (nothing) to
=REPORT=. Therefore you need a mechanism to initially select the =REPORT=. Therefore, you need a mechanism to initially select the
correct sequence. In addition to typing a keyword or using completion correct sequence. In addition to typing a keyword or using completion
(see [[*Completion]]), you may also apply the following commands: (see [[*Completion]]), you may also apply the following commands:
@ -4359,7 +4359,7 @@ command ~org-todo~ with a prefix argument.
- {{{kbd(C-u C-c C-t)}}} (~org-todo~) :: - {{{kbd(C-u C-c C-t)}}} (~org-todo~) ::
#+kindex: C-u C-c C-t #+kindex: C-u C-c C-t
Prompt for a note and record a the time of the TODO state change. Prompt for a note and record the time of the TODO state change.
The note is inserted as a list item below the headline, but can also The note is inserted as a list item below the headline, but can also
be placed into a drawer, see [[*Tracking TODO state changes]]. be placed into a drawer, see [[*Tracking TODO state changes]].
@ -4415,9 +4415,9 @@ entry with a =Closing Note= heading.
You might want to automatically keep track of when a state change You might want to automatically keep track of when a state change
occurred and maybe take a note about this change. You can either occurred and maybe take a note about this change. You can either
record just a timestamp, or a time-stamped note. These records are record just a timestamp, or a time-stamped note. These records are
inserted after the headline as an itemized list, newest first[fn:: See inserted after the headline as an itemized list, the newest first[fn::
the variable ~org-log-states-order-reversed~.]. When taking a lot of See the variable ~org-log-states-order-reversed~.]. When taking a lot
notes, you might want to get the notes out of the way into a drawer of notes, you might want to get the notes out of the way into a drawer
(see [[*Drawers]]). Customize the variable ~org-log-into-drawer~ to (see [[*Drawers]]). Customize the variable ~org-log-into-drawer~ to
get this behavior---the recommended drawer for this is called get this behavior---the recommended drawer for this is called
=LOGBOOK=[fn:: Note that the =LOGBOOK= drawer is unfolded when =LOGBOOK=[fn:: Note that the =LOGBOOK= drawer is unfolded when
@ -4510,7 +4510,7 @@ A habit has the following properties:
4. The TODO may also have minimum and maximum ranges specified by 4. The TODO may also have minimum and maximum ranges specified by
using the syntax =.+2d/3d=, which says that you want to do the task using the syntax =.+2d/3d=, which says that you want to do the task
at least every three days, but at most every two days. at least every three days, but, at most, every two days.
5. State logging for the DONE state is enabled (see [[*Tracking TODO 5. State logging for the DONE state is enabled (see [[*Tracking TODO
state changes]]), in order for historical data to be represented in state changes]]), in order for historical data to be represented in
@ -4539,7 +4539,7 @@ actual habit with some history:
- State "DONE" from "TODO" [2009-09-12 Sat] - State "DONE" from "TODO" [2009-09-12 Sat]
#+end_example #+end_example
What this habit says is: I want to shave at most every 2 days---given What this habit says is: I want to shave, at most, every 2 days---given
by the =SCHEDULED= date and repeat interval---and at least every by the =SCHEDULED= date and repeat interval---and at least every
4 days. If today is the 15th, then the habit first appears in the 4 days. If today is the 15th, then the habit first appears in the
agenda (see [[*Agenda Views]]) on Oct 17, after the minimum of 2 days has agenda (see [[*Agenda Views]]) on Oct 17, after the minimum of 2 days has
@ -4730,7 +4730,7 @@ all children are done, you can use the following setup:
#+end_src #+end_src
Another possibility is the use of checkboxes to identify (a hierarchy Another possibility is the use of checkboxes to identify (a hierarchy
of) a large number of subtasks (see [[*Checkboxes]]). of) subtasks (see [[*Checkboxes]]).
** Checkboxes ** Checkboxes
:PROPERTIES: :PROPERTIES:
@ -5002,13 +5002,13 @@ also a special command for inserting tags:
#+vindex: org-complete-tags-always-offer-all-agenda-tags #+vindex: org-complete-tags-always-offer-all-agenda-tags
#+vindex: org-tag-alist #+vindex: org-tag-alist
#+cindex: @samp{TAGS}, keyword #+cindex: @samp{TAGS}, keyword
Org supports tag insertion based on a /list of tags/. By default this Org supports tag insertion based on a /list of tags/. By default, this
list is constructed dynamically, containing all tags currently used in list is constructed dynamically, containing all tags currently used in
the buffer[fn:: To extend this default list to all tags used in all the buffer[fn:: To extend this default list to all tags used in all
agenda files (see [[*Agenda Views]]), customize the variable agenda files (see [[*Agenda Views]]), customize the variable
~org-complete-tags-always-offer-all-agenda-tags~.]. You may also ~org-complete-tags-always-offer-all-agenda-tags~.]. You may also
globally specify a hard list of tags with the variable globally specify a hard list of tags with the variable
~org-tag-alist~. Finally you can set the default tags for a given ~org-tag-alist~. Finally, you can set the default tags for a given
file using the =TAGS= keyword, like file using the =TAGS= keyword, like
#+begin_example #+begin_example
@ -5031,7 +5031,7 @@ by adding a =STARTUP= keyword to that file:
: #+STARTUP: noptag : #+STARTUP: noptag
By default Org mode uses the standard minibuffer completion facilities By default, Org mode uses the standard minibuffer completion facilities
for entering tags. However, it also implements another, quicker, tag for entering tags. However, it also implements another, quicker, tag
selection method called /fast tag selection/. This allows you to selection method called /fast tag selection/. This allows you to
select and deselect tags with just a single key press. For this to select and deselect tags with just a single key press. For this to
@ -5186,7 +5186,7 @@ nesting them creates a tag hierarchy.
One use-case is to create a taxonomy of terms (tags) that can be used One use-case is to create a taxonomy of terms (tags) that can be used
to classify nodes in a document or set of documents. to classify nodes in a document or set of documents.
When you search for a group tag, it return matches for all members in When you search for a group tag, it returns matches for all members in
the group and its subgroups. In an agenda view, filtering by a group the group and its subgroups. In an agenda view, filtering by a group
tag displays or hide headlines tagged with at least one of the members tag displays or hide headlines tagged with at least one of the members
of the group or any of its subgroups. This makes tag searches and of the group or any of its subgroups. This makes tag searches and
@ -5198,7 +5198,7 @@ mandatory so that Org can parse this line correctly:
: #+TAGS: [ GTD : Control Persp ] : #+TAGS: [ GTD : Control Persp ]
In this example, =GTD= is the group tag and it is related to two other In this example, =GTD= is the group tag, and it is related to two other
tags: =Control=, =Persp=. Defining =Control= and =Persp= as group tags: =Control=, =Persp=. Defining =Control= and =Persp= as group
tags creates a hierarchy of tags: tags creates a hierarchy of tags:
@ -5321,7 +5321,7 @@ with many examples, see [[*Matching tags and properties]].
#+cindex: properties #+cindex: properties
A property is a key-value pair associated with an entry. Properties A property is a key-value pair associated with an entry. Properties
can be set so they are associated with a single entry, with every can be set, so they are associated with a single entry, with every
entry in a tree, or with the whole buffer. entry in a tree, or with the whole buffer.
There are two main applications for properties in Org mode. First, There are two main applications for properties in Org mode. First,
@ -5807,7 +5807,7 @@ all values. The =Approved= column does have a modified title
=Time_Estimate= column by adding time duration expressions like HH:MM, =Time_Estimate= column by adding time duration expressions like HH:MM,
and for the =Approved= column, by providing an =[X]= status if all and for the =Approved= column, by providing an =[X]= status if all
children have been checked. The =CLOCKSUM= and =CLOCKSUM_T= columns children have been checked. The =CLOCKSUM= and =CLOCKSUM_T= columns
are special, they lists the sums of CLOCK intervals in the subtree, are special, they list the sums of CLOCK intervals in the subtree,
either for all clocks or just for today. either for all clocks or just for today.
*** Using column view *** Using column view
@ -5906,7 +5906,7 @@ either for all clocks or just for today.
#+kindex: a #+kindex: a
#+findex: org-columns-edit-allowed #+findex: org-columns-edit-allowed
Edit the list of allowed values for this property. If the list is Edit the list of allowed values for this property. If the list is
found in the hierarchy, the modified values is stored there. If no found in the hierarchy, the modified values are stored there. If no
list is found, the new value is stored in the first entry that is list is found, the new value is stored in the first entry that is
part of the current column view. part of the current column view.
@ -6086,7 +6086,7 @@ The following commands insert or update the dynamic block:
you have several clock table blocks, column-capturing blocks or you have several clock table blocks, column-capturing blocks or
other dynamic blocks in a buffer. other dynamic blocks in a buffer.
You can add formulas to the column view table and you may add plotting You can add formulas to the column view table, and you may add plotting
instructions in front of the table---these survive an update of the instructions in front of the table---these survive an update of the
block. If there is a =TBLFM= keyword after the table, the table is block. If there is a =TBLFM= keyword after the table, the table is
recalculated automatically after an update. recalculated automatically after an update.
@ -6376,7 +6376,7 @@ various inputs are interpreted, the items filled in by Org mode are in
| =2012 w4 fri= | \rArr{} Friday of ISO week 4 in 2012 | | =2012 w4 fri= | \rArr{} Friday of ISO week 4 in 2012 |
| =2012-w04-5= | \rArr{} Same as above | | =2012-w04-5= | \rArr{} Same as above |
Furthermore you can specify a relative date by giving, as the /first/ Furthermore, you can specify a relative date by giving, as the /first/
thing in the input: a plus/minus sign, a number and a letter---=h=, thing in the input: a plus/minus sign, a number and a letter---=h=,
=d=, =w=, =m= or =y=---to indicate a change in hours, days, weeks, =d=, =w=, =m= or =y=---to indicate a change in hours, days, weeks,
months, or years. With =h= the date is relative to the current time, months, or years. With =h= the date is relative to the current time,
@ -6397,14 +6397,14 @@ the abbreviation of day name, the date is the Nth such day, e.g.:
#+vindex: parse-time-months #+vindex: parse-time-months
#+vindex: parse-time-weekdays #+vindex: parse-time-weekdays
The function understands English month and weekday abbreviations. If The function understands English month and weekday abbreviations. If
you want to use un-abbreviated names and/or other languages, configure you want to use unabbreviated names and/or other languages, configure
the variables ~parse-time-months~ and ~parse-time-weekdays~. the variables ~parse-time-months~ and ~parse-time-weekdays~.
#+vindex: org-read-date-force-compatible-dates #+vindex: org-read-date-force-compatible-dates
Not all dates can be represented in a given Emacs implementation. By Not all dates can be represented in a given Emacs implementation. By
default Org mode forces dates into the compatibility range 1970--2037 default, Org mode forces dates into the compatibility range 1970--2037
which works on all Emacs implementations. If you want to use dates which works on all Emacs implementations. If you want to use dates
outside of this range, read the docstring of the variable outside this range, read the docstring of the variable
~org-read-date-force-compatible-dates~. ~org-read-date-force-compatible-dates~.
You can specify a time range by giving start and end times or by You can specify a time range by giving start and end times or by
@ -6510,7 +6510,7 @@ following consequences:
disappears from the buffer after /all/ (invisible) characters disappears from the buffer after /all/ (invisible) characters
belonging to the ISO timestamp have been removed. belonging to the ISO timestamp have been removed.
- If the custom timestamp format is longer than the default and you - If the custom timestamp format is longer than the default, and you
are using dates in tables, table alignment will be messed up. If are using dates in tables, table alignment will be messed up. If
the custom format is shorter, things do work as expected. the custom format is shorter, things do work as expected.
@ -6546,7 +6546,7 @@ immediately after the task they refer to.
You can specify a different lead time for warnings for a specific You can specify a different lead time for warnings for a specific
deadlines using the following syntax. Here is an example with deadlines using the following syntax. Here is an example with
a warning period of 5 days =DEADLINE: <2004-02-29 Sun -5d>=. This a warning period of 5 days =DEADLINE: <2004-02-29 Sun -5d>=. This
warning is deactivated if the task gets scheduled and you set warning is deactivated if the task gets scheduled, and you set
~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~. ~org-agenda-skip-deadline-prewarning-if-scheduled~ to ~t~.
- =SCHEDULED= :: - =SCHEDULED= ::
@ -6598,7 +6598,7 @@ repeater. However, the use of diary expression entries like
#+texinfo: @noindent #+texinfo: @noindent
in scheduling and deadline timestamps is limited. Org mode does not in scheduling and deadline timestamps is limited. Org mode does not
know enough about the internals of each function to issue early and know enough about the internals of each function to issue early and
late warnings. However, it shows the item on each day where the late warnings. However, it shows the item on each day when the
expression entry matches. expression entry matches.
*** Inserting deadlines or schedules *** Inserting deadlines or schedules
@ -6852,7 +6852,7 @@ about what to do with it.
=LAST_REPEAT= property.]. You can exercise more control over show =LAST_REPEAT= property.]. You can exercise more control over show
time with the =CLOCK_MODELINE_TOTAL= property. It may have the time with the =CLOCK_MODELINE_TOTAL= property. It may have the
values =current= to show only the current clocking instance, =today= values =current= to show only the current clocking instance, =today=
to show all time clocked on this tasks today---see also the variable to show all time clocked on this task today---see also the variable
~org-extend-today-until~, ~all~ to include all time, or ~auto~ which ~org-extend-today-until~, ~all~ to include all time, or ~auto~ which
is the default[fn:: See also the variable is the default[fn:: See also the variable
~org-clock-mode-line-total~.]. Clicking with {{{kbd(mouse-1)}}} ~org-clock-mode-line-total~.]. Clicking with {{{kbd(mouse-1)}}}
@ -7290,7 +7290,7 @@ choices to correct the discrepancy:
#+kindex: K #+kindex: K
If you use the shift key and press {{{kbd(K)}}}, it keeps however If you use the shift key and press {{{kbd(K)}}}, it keeps however
many minutes you request and then immediately clock out of that many minutes you request and then immediately clock out of that
task. If you keep all of the minutes, this is the same as just task. If you keep all the minutes, this is the same as just
clocking out of the current task. clocking out of the current task.
- {{{kbd(s)}}} :: - {{{kbd(s)}}} ::
@ -7365,7 +7365,7 @@ arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with
#+cindex: auto clocking out after idle time #+cindex: auto clocking out after idle time
#+vindex: org-clock-auto-clockout-timer #+vindex: org-clock-auto-clockout-timer
When you often forget to clock out before being idle and you don't When you often forget to clock out before being idle, and you don't
want to manually set the clocking time to take into account, you can want to manually set the clocking time to take into account, you can
set ~org-clock-auto-clockout-timer~ to a number of seconds and add set ~org-clock-auto-clockout-timer~ to a number of seconds and add
=(org-clock-auto-clockout-insinuate)= to your =.emacs= file. =(org-clock-auto-clockout-insinuate)= to your =.emacs= file.
@ -7569,8 +7569,8 @@ special command:
Refile the entry or region at point. This command offers possible Refile the entry or region at point. This command offers possible
locations for refiling the entry and lets you select one with locations for refiling the entry and lets you select one with
completion. The item (or all items in the region) is filed below completion. The item (or all items in the region) is filed below
the target heading as a subitem. Depending on the target heading as a sub-item. Depending on
~org-reverse-note-order~, it is either the first or last subitem. ~org-reverse-note-order~, it is either the first or last sub-item.
By default, all level 1 headlines in the current buffer are By default, all level 1 headlines in the current buffer are
considered to be targets, but you can have more complex definitions considered to be targets, but you can have more complex definitions
@ -7634,7 +7634,7 @@ special command:
value of ~org-reverse-note-order~ applies to the current buffer. So value of ~org-reverse-note-order~ applies to the current buffer. So
if ~org-refile~ would append the entry as the last entry under the if ~org-refile~ would append the entry as the last entry under the
target header, ~org-refile-reverse~ will prepend it as the first target header, ~org-refile-reverse~ will prepend it as the first
entry, and vice-versa. entry, and vice versa.
** Archiving ** Archiving
:PROPERTIES: :PROPERTIES:
@ -7739,7 +7739,7 @@ its location in the outline tree, but behaves in the following way:
It does not open when you attempt to do so with a visibility cycling It does not open when you attempt to do so with a visibility cycling
command (see [[*Visibility Cycling]]). You can force cycling archived command (see [[*Visibility Cycling]]). You can force cycling archived
subtrees with {{{kbd(C-c C-TAB)}}}, or by setting the option subtrees with {{{kbd(C-c C-TAB)}}}, or by setting the option
~org-cycle-open-archived-trees~. Also normal outline commands, like ~org-cycle-open-archived-trees~. Also, normal outline commands, like
~org-show-all~, open archived subtrees. ~org-show-all~, open archived subtrees.
- -
@ -7978,7 +7978,7 @@ Now lets look at the elements of a template definition. Each entry in
- keys :: - keys ::
The keys that selects the template, as a string, characters only, The keys that select the template, as a string, characters only,
for example ="a"=, for a template to be selected with a single key, for example ="a"=, for a template to be selected with a single key,
or ="bt"= for selection with two keys. When using several keys, or ="bt"= for selection with two keys. When using several keys,
keys using the same prefix key must be sequential in the list and keys using the same prefix key must be sequential in the list and
@ -8102,7 +8102,7 @@ Now lets look at the elements of a template definition. Each entry in
- template :: - template ::
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. You may also get this time and context of the capture call. You may also get this
template string from a file[fn:: When the file name is not absolute, template string from a file[fn:: When the file name is not absolute,
@ -8330,7 +8330,7 @@ given here:
- =%^t= :: - =%^t= ::
Like =%t=, but prompt for date. Similarly =%^T=, =%^u=, =%^U=. You Like =%t=, but prompt for date. Similarly, =%^T=, =%^u=, =%^U=. You
may define a prompt like =%^{Birthday}t=. may define a prompt like =%^{Birthday}t=.
- =%^C= :: - =%^C= ::
@ -8464,7 +8464,7 @@ The following commands deal with attachments:
#+kindex: C-c C-a #+kindex: C-c C-a
#+findex: org-attach #+findex: org-attach
The dispatcher for commands related to the attachment system. After The dispatcher for commands related to the attachment system. After
these keys, a list of commands is displayed and you must press an these keys, a list of commands is displayed, and you must press an
additional key to select a command: additional key to select a command:
- {{{kbd(a)}}} (~org-attach-attach~) :: - {{{kbd(a)}}} (~org-attach-attach~) ::
@ -9015,7 +9015,7 @@ commands:
#+findex: org-toggle-sticky-agenda #+findex: org-toggle-sticky-agenda
Toggle sticky agenda views. By default, Org maintains only a single Toggle sticky agenda views. By default, Org maintains only a single
agenda buffer and rebuilds it each time you change the view, to make agenda buffer and rebuilds it each time you change the view, to make
sure everything is always up to date. If you switch between views sure everything is always up-to-date. If you switch between views
often and the build time bothers you, you can turn on sticky agenda often and the build time bothers you, you can turn on sticky agenda
buffers (make this the default by customizing the variable buffers (make this the default by customizing the variable
~org-agenda-sticky~). With sticky agendas, the dispatcher only ~org-agenda-sticky~). With sticky agendas, the dispatcher only
@ -9659,7 +9659,7 @@ 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.
For agenda display, Org mode extracts the time and displays it in For agenda display, Org mode extracts the time and displays it in
a standard 24 hour format as part of the prefix. The example times in a standard 24-hour format as part of the prefix. The example times in
the previous paragraphs would end up in the agenda like this: the previous paragraphs would end up in the agenda like this:
#+begin_example #+begin_example
@ -10097,7 +10097,7 @@ the other commands, point needs to be in the desired line.
A numeric prefix argument may be used to jump directly to a specific A numeric prefix argument may be used to jump directly to a specific
day of the month. When setting month view, a year may be encoded in day of the month. When setting month view, a year may be encoded in
the prefix argument as well. For example, {{{kbd(200712 m)}}} jumps the prefix argument as well. For example, {{{kbd(200712 m)}}} jumps
to December, 2007. If such a year specification has only one or two to December 2007. If such a year specification has only one or two
digits, it is expanded into one of the 30 next years or the last 69 digits, it is expanded into one of the 30 next years or the last 69
years. years.
@ -10331,9 +10331,9 @@ the other commands, point needs to be in the desired line.
#+kindex: t #+kindex: t
#+findex: org-agenda-todo #+findex: org-agenda-todo
Change the TODO state of the item, both in the agenda and in the Change the TODO state of the item, both in the agenda and in the
original Org file. A prefix arg is passed through to the ~org-todo~ original Org file. A prefix argument is passed through to the
command, so for example a {{{kbd(C-u)}}} prefix are will trigger ~org-todo~ command, so for example a {{{kbd(C-u)}}} prefix are will
taking a note to document the state change. trigger taking a note to document the state change.
- {{{kbd(C-S-RIGHT)}}} (~org-agenda-todo-nextset~) :: - {{{kbd(C-S-RIGHT)}}} (~org-agenda-todo-nextset~) ::
@ -10908,7 +10908,7 @@ Here are two examples:
This defines {{{kbd(h)}}} to create a multi-block view for stuff you This defines {{{kbd(h)}}} to create a multi-block view for stuff you
need to attend to at home. The resulting agenda buffer contains your need to attend to at home. The resulting agenda buffer contains your
agenda for the current week, all TODO items that carry the tag =home=, agenda for the current week, all TODO items that carry the tag =home=,
and also all lines tagged with =garden=. Finally the command and also all lines tagged with =garden=. Finally, the command
{{{kbd(o)}}} provides a similar view for office tasks. {{{kbd(o)}}} provides a similar view for office tasks.
*** Setting options for custom commands *** Setting options for custom commands
@ -11184,7 +11184,7 @@ environment. This causes the following issues:
If any of the columns has a summary type defined (see [[*Column If any of the columns has a summary type defined (see [[*Column
attributes]]), turning on column view in the agenda visits all attributes]]), turning on column view in the agenda visits all
relevant agenda files and make sure that the computations of this relevant agenda files and make sure that the computations of this
property are up to date. This is also true for the special property are up-to-date. This is also true for the special
=CLOCKSUM= property. Org then sums the values displayed in the =CLOCKSUM= property. Org then sums the values displayed in the
agenda. In the daily/weekly agenda, the sums cover a single day; agenda. In the daily/weekly agenda, the sums cover a single day;
in all other views they cover the entire block. in all other views they cover the entire block.
@ -11413,7 +11413,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:: You can turn this on by default by setting the following command[fn:: You can turn this on by default by setting
the variable ~org-pretty-entities~, or on a per-file base with the the variable ~org-pretty-entities~, or on a per-file basis with the
=STARTUP= option =entitiespretty=.]: =STARTUP= option =entitiespretty=.]:
- {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) :: - {{{kbd(C-c C-x \)}}} (~org-toggle-pretty-entities~) ::
@ -11440,7 +11440,7 @@ converted into dashes, and =...= becomes a compact set of dots.
#+cindex: @TeX{} interpretation #+cindex: @TeX{} interpretation
#+cindex: @LaTeX{} interpretation #+cindex: @LaTeX{} interpretation
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:37] is widely used to symbols and the occasional formula. LaTeX[fn:37] is widely used to
typeset scientific documents. Org mode supports embedding LaTeX code typeset scientific documents. Org mode supports embedding LaTeX code
@ -11477,7 +11477,7 @@ snippets are identified as LaTeX source code:
between, and if the closing =$= is followed by whitespace or between, and if the closing =$= is followed by whitespace or
punctuation (but not a dash). punctuation (but not a dash).
Sometimes, it may necessary to have a literal dollar symbol even Sometimes, it may be necessary to have a literal dollar symbol even
when it is recognized as LaTeX math delimiter. Org provides =\dollar= and when it is recognized as LaTeX math delimiter. Org provides =\dollar= and
=\USD= entities (see [[*Special Symbols]]) that are rendered as =$= for =\USD= entities (see [[*Special Symbols]]) that are rendered as =$= for
such scenarios. Also, see [[*Escape Character]]. such scenarios. Also, see [[*Escape Character]].
@ -11712,7 +11712,7 @@ labels, and use them as targets for special hyperlinks like
=[[(name)]]=---i.e., the reference name enclosed in single =[[(name)]]=---i.e., the reference name enclosed in single
parentheses. In HTML, hovering the mouse over such a link parentheses. In HTML, hovering the mouse over such a link
remote-highlights the corresponding code line[fn:: This requires some remote-highlights the corresponding code line[fn:: This requires some
Javascript which is /not/ automatically included in the HTML output: JavaScript which is /not/ automatically included in the HTML output:
you have to customize the variable =org-html-head-include-scripts= to you have to customize the variable =org-html-head-include-scripts= to
~t~ to have it included (it is ~nil~ by default).], which is kind of cool. ~t~ to have it included (it is ~nil~ by default).], which is kind of cool.
@ -11721,7 +11721,7 @@ source code[fn:: Adding =-k= to =-n -r= /keeps/ the labels in the
source code while using line numbers for the links, which might be source code while using line numbers for the links, which might be
useful to explain those in an Org mode example code.]. With the =-n= useful to explain those in an Org mode example code.]. With the =-n=
switch, links to these references are labeled by the line numbers from switch, links to these references are labeled by the line numbers from
the code listing. Otherwise links use the labels with no parentheses. the code listing. Otherwise, links use the labels with no parentheses.
Here is an example: Here is an example:
#+begin_example -l "(dumb-reference:%s)" #+begin_example -l "(dumb-reference:%s)"
@ -11793,7 +11793,7 @@ example
: ./img/cat.jpg : ./img/cat.jpg
If you wish to define a caption for the image (see [[*Captions]]) and If you wish to define a caption for the image (see [[*Captions]]) and
maybe a label for internal cross references (see [[*Internal Links]]), maybe a label for internal cross-references (see [[*Internal Links]]),
make sure that the link is on a line by itself and precede it with make sure that the link is on a line by itself and precede it with
=CAPTION= and =NAME= keywords as follows: =CAPTION= and =NAME= keywords as follows:
@ -11829,12 +11829,12 @@ command:
You can customize the displayed image width using You can customize the displayed image width using
~org-image-actual-width~ variable (globally) or ~org-image-actual-width~ variable (globally) or
=ORG-IMAGE-ACTUAL-WIDTH= property (subtree-level)[fn:: The width can =ORG-IMAGE-ACTUAL-WIDTH= property (subtree-level)[fn:: The width can
be customized in Emacs >= 24.1, built with imagemagick support.]. be customized in Emacs >= 24.1, built with ImageMagick support.].
Their value can be the following: Their value can be the following:
- (default) Non-~nil~, use the actual width of images when inlining - (default) Non-~nil~, use the actual width of images when inlining
them. If the actual width is too wide, limit it according to them. If the actual width is too wide, limit it according to
~org-image-max-width~. ~org-image-max-width~.
- When set to a number, use imagemagick (when available) to set the - When set to a number, use ImageMagick (when available) to set the
image's width to this value. image's width to this value.
- When set to a number in a list, try to get the width from any - When set to a number in a list, try to get the width from any
=#+ATTR.*= keyword if it matches a width specification like: =#+ATTR.*= keyword if it matches a width specification like:
@ -12215,7 +12215,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 timestamp[fn:: The variable A date or a timestamp[fn:: The variable
~org-export-date-timestamp-format~ defines how this timestamp are ~org-export-date-timestamp-format~ defines how this timestamp is
exported.]. exported.].
- =EMAIL= :: - =EMAIL= ::
@ -12520,7 +12520,7 @@ The table of contents includes all headlines in the document. Its
depth is therefore the same as the headline levels in the file. If depth is therefore the same as the headline levels in the file. If
you need to use a different depth, or turn it off entirely, set the you need to use a different depth, or turn it off entirely, set the
~org-export-with-toc~ variable accordingly. You can achieve the same ~org-export-with-toc~ variable accordingly. You can achieve the same
on a per file basis, using the following =toc= item in =OPTIONS= on a per-file basis, using the following =toc= item in =OPTIONS=
keyword: keyword:
#+begin_example #+begin_example
@ -12615,7 +12615,7 @@ example, to include your =.emacs= file, you could use:
#+texinfo: @noindent #+texinfo: @noindent
There are three positional arguments after the include keyword, they are: There are three positional arguments after the include keyword, they are:
1. The file name, this is the sole mandatory argument. Org neither 1. The file name, this is the sole mandatory argument. Org neither
checks for correctness or validates the content in any way. checks for correctness nor validates the content in any way.
2. The block name to wrap the file content in. When this is 2. The block name to wrap the file content in. When this is
=example=, =export=, or =src= the content is escaped by =example=, =export=, or =src= the content is escaped by
~org-escape-code-in-string~. Arbitrary block names may be given, ~org-escape-code-in-string~. Arbitrary block names may be given,
@ -12625,7 +12625,7 @@ There are three positional arguments after the include keyword, they are:
#+cindex: @samp{minlevel}, include #+cindex: @samp{minlevel}, include
If an included file is not specified as having any markup language, If an included file is not specified as having any markup language,
Org assumes it be in Org format and proceeds as usual with a few Org assumes it to be in Org format and proceeds as usual with a few
exceptions. Org makes the footnote labels (see [[*Creating Footnotes]]) exceptions. Org makes the footnote labels (see [[*Creating Footnotes]])
in the included file local to that file. The contents of the included in the included file local to that file. The contents of the included
file belong to the same structure---headline, item---containing the file belong to the same structure---headline, item---containing the
@ -12749,7 +12749,7 @@ Org comes with following pre-defined macros:
understood by ~format-time-string~. If the second argument to the understood by ~format-time-string~. If the second argument to the
~modification-time~ macro is non-~nil~, Org uses =vc.el= to retrieve ~modification-time~ macro is non-~nil~, Org uses =vc.el= to retrieve
the document's modification time from the version control system. the document's modification time from the version control system.
Otherwise Org reads the file attributes. Otherwise, Org reads the file attributes.
- ={{{input-file}}}= :: - ={{{input-file}}}= ::
@ -12810,7 +12810,7 @@ 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:: For a less drastic behavior, consider using a is executed either[fn:: For a less drastic behavior, consider using a
select tag (see [[*Export Settings]]) instead.]. The command below select tag (see [[*Export Settings]]) instead.]. The command below
helps changing the comment status of a headline. helps to change the comment status of a headline.
- {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: - {{{kbd(C-c ;)}}} (~org-toggle-comment~) ::
#+kindex: C-c ; #+kindex: C-c ;
@ -13288,7 +13288,7 @@ settings described in [[*Export Settings]].
#+cindex: @samp{DESCRIPTION}, keyword #+cindex: @samp{DESCRIPTION}, keyword
This is the document's description, which the HTML exporter inserts This is the document's description, which the HTML exporter inserts
it as a HTML meta tag in the HTML file. For long descriptions, use it as an HTML meta tag in the HTML file. For long descriptions, use
multiple =DESCRIPTION= lines. The exporter takes care of wrapping multiple =DESCRIPTION= lines. The exporter takes care of wrapping
the lines properly. the lines properly.
@ -13487,7 +13487,7 @@ name, and date.
:ALT_TITLE: Bare HTML :ALT_TITLE: Bare HTML
:END: :END:
If you want to output a minimal HTML file, with no CSS, no Javascript, If you want to output a minimal HTML file, with no CSS, no JavaScript,
no preamble or postamble, here are the variable you would need to set: no preamble or postamble, here are the variable you would need to set:
#+vindex: org-html-head #+vindex: org-html-head
@ -13513,7 +13513,7 @@ no preamble or postamble, here are the variable you would need to set:
:END: :END:
The HTML export backend transforms =<= and =>= to =&lt;= and =&gt;=. The HTML export backend transforms =<= and =>= to =&lt;= and =&gt;=.
To include raw HTML code in the Org file so the HTML export backend To include raw HTML code in the Org file, so the HTML export backend
can insert that HTML code in the output, use this inline syntax: can insert that HTML code in the output, use this inline syntax:
=@@html:...@@=. For example: =@@html:...@@=. For example:
@ -13709,11 +13709,11 @@ 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. five ems from the left margin.
#+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
variables. The MathJax template can be configure via variables. The MathJax template can be configured via
~org-html-mathjax-template~. ~org-html-mathjax-template~.
If you prefer, you can also request that LaTeX fragments are processed If you prefer, you can also request that LaTeX fragments are processed
@ -13848,7 +13848,7 @@ styles for a particular headline, you can use the ID specified in
a =CUSTOM_ID= property. You can also assign a specific class to a =CUSTOM_ID= property. You can also assign a specific class to
a headline with the =HTML_HEADLINE_CLASS= property. a headline with the =HTML_HEADLINE_CLASS= property.
Never change the ~org-html-style-default~ constant. Instead use other Never change the ~org-html-style-default~ constant. Instead, use other
simpler ways of customizing as described above. simpler ways of customizing as described above.
*** JavaScript supported display of web pages *** JavaScript supported display of web pages
@ -13914,7 +13914,7 @@ options described below:
- =ftoc:= :: - =ftoc:= ::
Does the CSS of the page specify a fixed position for the "toc"? If Does the CSS of the page specify a fixed position for the "toc"? If
yes, the toc is displayed as a section. yes, the TOC is displayed as a section.
- =ltoc:= :: - =ltoc:= ::
@ -14048,7 +14048,7 @@ general options (see [[*Export Settings]]).
#+vindex: org-export-default-language #+vindex: org-export-default-language
Language code of the primary document language. When =LANGUAGE= Language code of the primary document language. When =LANGUAGE=
keyword is not not specified use the value of keyword is not specified use the value of
~org-export-default-language~ (by default - =en=, American English) ~org-export-default-language~ (by default - =en=, American English)
The list of language codes supported by Org is stored in the The list of language codes supported by Org is stored in the
@ -14121,7 +14121,7 @@ general options (see [[*Export Settings]]).
#+vindex: org-latex-subtitle-format #+vindex: org-latex-subtitle-format
The document's subtitle. It is typeset as per The document's subtitle. It is typeset as per
~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is ~org-latex-subtitle-format~. If ~org-latex-subtitle-separate~ is
non-~nil~, it is typed outside of the ~\title~ macro. See non-~nil~, it is typed outside the ~\title~ macro. See
~org-latex-hyperref-template~ for customizing metadata items. See ~org-latex-hyperref-template~ for customizing metadata items. See
~org-latex-title-command~ for typesetting description into the ~org-latex-title-command~ for typesetting description into the
document's front matter. document's front matter.
@ -14249,7 +14249,7 @@ This would produce in LaTeX (with the actual =polyglossia= syntax):
When the available LaTeX export customizations are not sufficient to When the available LaTeX export customizations are not sufficient to
fine-tune the desired output, it is possible to insert any arbitrary fine-tune the desired output, it is possible to insert any arbitrary
LaTeX code (see [[*Embedded LaTeX]]). There are three ways to embed such LaTeX code (see [[*Embedded LaTeX]]). There are three ways to embed such
code in the Org file and they all use different quoting syntax. code in the Org file, and they all use different quoting syntax.
#+cindex: inline, in @LaTeX{} export #+cindex: inline, in @LaTeX{} export
Inserting in-line quoted with @ symbols: Inserting in-line quoted with @ symbols:
@ -14374,7 +14374,7 @@ include:
=:math-arguments= comes in use for matrix macros that require more =:math-arguments= comes in use for matrix macros that require more
than one argument, such as =qbordermatrix=. than one argument, such as =qbordermatrix=.
LaTeX table attributes help formatting tables for a wide range of LaTeX table attributes help to format tables for a wide range of
situations, such as matrix product or spanning multiple pages: situations, such as matrix product or spanning multiple pages:
#+begin_example #+begin_example
@ -14410,7 +14410,7 @@ Set the caption with the LaTeX command
The LaTeX export backend processes image links in Org files that do The LaTeX export backend processes image links in Org files that do
not have descriptions, such as these links =[[file:img.jpg]]= or not have descriptions, such as these links =[[file:img.jpg]]= or
=[[./img.jpg]]=, as direct image insertions in the final PDF output. In =[[./img.jpg]]=, as direct image insertions in the final PDF output. In
the PDF, they are no longer links but actual images embedded on the the PDF, they are no longer links, but actual images embedded on the
page. The LaTeX export backend uses =\includegraphics= macro to page. The LaTeX export backend uses =\includegraphics= macro to
insert the image. But for TikZ (https://sourceforge.net/projects/pgf/) insert the image. But for TikZ (https://sourceforge.net/projects/pgf/)
images, the backend uses an ~\input~ macro wrapped within images, the backend uses an ~\input~ macro wrapped within
@ -14791,7 +14791,7 @@ Since "md" backend is built on top of the HTML backend (see [[*HTML
Export]]), it converts every Org construct not defined in Markdown Export]]), it converts every Org construct not defined in Markdown
syntax, such as tables, to HTML. syntax, such as tables, to HTML.
Do note that the original markdown syntax has differences with other Do note that the original Markdown syntax has differences with other
commonly used Markdown flavors. See commonly used Markdown flavors. See
https://en.wikipedia.org/wiki/Markdown for more details. https://en.wikipedia.org/wiki/Markdown for more details.
@ -14967,7 +14967,7 @@ way to extend (see [[*ODT export commands]]).
:UNNUMBERED: notoc :UNNUMBERED: notoc
:END: :END:
The Org export backend is made to be inter-operable with a wide range The Org export backend is made to be interoperable with a wide range
of text document format converters. Newer generation converters, such of text document format converters. Newer generation converters, such
as LibreOffice and Pandoc, can handle hundreds of formats at once. as LibreOffice and Pandoc, can handle hundreds of formats at once.
Org provides a consistent interaction with whatever converter is Org provides a consistent interaction with whatever converter is
@ -15484,7 +15484,7 @@ factory styles used by the exporter.
- =FILE.odt= or =FILE.ott= and a subset of included files :: - =FILE.odt= or =FILE.ott= and a subset of included files ::
Use the =styles.xml= contained in the specified OpenDocument Text Use the =styles.xml= contained in the specified OpenDocument Text
or Template file. Additionally extract the specified member files or Template file. Additionally, extract the specified member files
and embed those within the final ODT document. and embed those within the final ODT document.
Use this option if the =styles.xml= file references additional Use this option if the =styles.xml= file references additional
@ -16191,7 +16191,7 @@ This option controls how exactly @code{do-something} does its thing.
#+end_example #+end_example
#+texinfo: @noindent #+texinfo: @noindent
Command in parenthesis, as done above, is optional. Command in parentheses, as done above, is optional.
*** Tables in Texinfo export *** Tables in Texinfo export
:PROPERTIES: :PROPERTIES:
@ -16509,7 +16509,7 @@ The =CLASS= property can be used to specify a per-entry visibility
class or access restrictions, and is applied to any entry with class class or access restrictions, and is applied to any entry with class
information. The iCalendar standard defines three visibility classes: information. The iCalendar standard defines three visibility classes:
- =PUBLIC= :: The entry is publicly visible (this is the default). - =PUBLIC= :: The entry is publicly visible (this is the default).
- =CONFIDENTIAL= :: Only a limited group of clients get access to the - =CONFIDENTIAL= :: Only a limited group of clients gets access to the
event. event.
- =PRIVATE= :: The entry can be retrieved only by its owner. - =PRIVATE= :: The entry can be retrieved only by its owner.
The server should treat unknown class properties the same as The server should treat unknown class properties the same as
@ -16671,7 +16671,7 @@ debugging.
:END: :END:
#+findex: org-export-as #+findex: org-export-as
Org mode export is a multi-step process that works on a temporary copy Org mode export is a multistep process that works on a temporary copy
of the buffer. The export process consists of 4 major steps: of the buffer. The export process consists of 4 major steps:
1. Process the temporary copy, making necessary changes to the buffer 1. Process the temporary copy, making necessary changes to the buffer
@ -16757,7 +16757,7 @@ Parse the temporary buffer, creating AST:
- Clocks, drawers, fixed-width environments, footnotes, LaTeX - Clocks, drawers, fixed-width environments, footnotes, LaTeX
environments and fragments, node properties, planning lines, environments and fragments, node properties, planning lines,
property drawers, statistics cookies, timestamps, etc according property drawers, statistics cookies, timestamps, etc. according
to =#+OPTIONS= keyword (see [[*Export Settings]]); to =#+OPTIONS= keyword (see [[*Export Settings]]);
- Table rows containing width and alignment markers, unless the - Table rows containing width and alignment markers, unless the
@ -16824,7 +16824,7 @@ Post-process the exported text:
:END: :END:
Some parts of the conversion process can be extended for certain Some parts of the conversion process can be extended for certain
elements so as to introduce a new or revised translation. That is how elements to introduce a new or revised translation. That is how
the HTML export backend was extended to handle Markdown format. The the HTML export backend was extended to handle Markdown format. The
extensions work seamlessly so any aspect of filtering not done by the extensions work seamlessly so any aspect of filtering not done by the
extended backend is handled by the original backend. Of all the extended backend is handled by the original backend. Of all the
@ -17691,7 +17691,7 @@ Org currently includes the following export processors:
large number of publishers' styles). It only supports LaTeX's large number of publishers' styles). It only supports LaTeX's
=\cite= and =\nocite= commands. =\cite= and =\nocite= commands.
- natbib :: as with the bibtex processor, but using the LaTeX - natbib :: as with the =bibtex= processor, but using the LaTeX
package =natbib=, allowing more stylistic variants that LaTeX's package =natbib=, allowing more stylistic variants that LaTeX's
=\cite= command. =\cite= command.
@ -17939,7 +17939,7 @@ or
- =#+NAME: <name>= :: - =#+NAME: <name>= ::
Optional. Names the source block so it can be called, like Optional. Names the source block, so it can be called, like
a function, from other source blocks or inline code to evaluate or a function, from other source blocks or inline code to evaluate or
to capture the results. Code from other blocks, other files, and to capture the results. Code from other blocks, other files, and
from table formulas (see [[*The Spreadsheet]]) can use the name to from table formulas (see [[*The Spreadsheet]]) can use the name to
@ -18584,7 +18584,7 @@ Setting =dir= to the symbol ~attach~ or the string ~"'attach"~ will
set =dir= to the directory returned by ~(org-attach-dir)~, set =:mkdir set =dir= to the directory returned by ~(org-attach-dir)~, set =:mkdir
yes=, and insert any file paths, as when using =:results file=, which yes=, and insert any file paths, as when using =:results file=, which
are under the node's attachment directory using =attachment:= links are under the node's attachment directory using =attachment:= links
instead of the usual =file:= links. Any returned path outside of the instead of the usual =file:= links. Any returned path outside the
attachment directory will use =file:= links as per usual. attachment directory will use =file:= links as per usual.
For example, to save the plot file in the =Work/= folder of the home For example, to save the plot file in the =Work/= folder of the home
@ -19090,7 +19090,7 @@ follows from the type specified above.
When used along with =file= type, the result is a link to the file When used along with =file= type, the result is a link to the file
specified in =:file= header argument. However, unlike plain =file= specified in =:file= header argument. However, unlike plain =file=
type, code block output is not written to the disk. The block is type, code block output is not written to the disk. The block is
expected to generate the file by its side-effects only, as in the expected to generate the file by its side effects only, as in the
following example: following example:
#+begin_example #+begin_example
@ -19454,7 +19454,7 @@ for tangled files by ~set-file-modes~. Permissions are given by an
octal value, which can be provided calling the ~identity~ function on octal value, which can be provided calling the ~identity~ function on
an elisp octal value. For instance, to create a read-only file one may an elisp octal value. For instance, to create a read-only file one may
use =:tangle-mode (identity #o444)=. To reduce the verbosity required, use =:tangle-mode (identity #o444)=. To reduce the verbosity required,
a octal shorthand is defined, =oXXX= (=o= for octal). Using this, our an octal shorthand is defined, =oXXX= (=o= for octal). Using this, our
read-only example is =:tangle-mode o444=. Omitting the =o= prefix will read-only example is =:tangle-mode o444=. Omitting the =o= prefix will
cause the argument to be interpreted as an integer, which can lead to cause the argument to be interpreted as an integer, which can lead to
unexpected results (=444= is the same as =o674=). unexpected results (=444= is the same as =o674=).
@ -19470,7 +19470,7 @@ multiple source code blocks tangle to a single file with conflicting
#+cindex: @samp{no-expand}, header argument #+cindex: @samp{no-expand}, header argument
By default Org expands code blocks during tangling. The =no-expand= By default Org expands code blocks during tangling. The =no-expand=
header argument turns off such expansions. Note that one side-effect header argument turns off such expansions. Note that one side effect
of expansion by ~org-babel-expand-src-block~ also assigns values (see of expansion by ~org-babel-expand-src-block~ also assigns values (see
[[*Environment of a Code Block]]) to variables. Expansions also replace [[*Environment of a Code Block]]) to variables. Expansions also replace
noweb references with their targets (see [[*Noweb Reference Syntax]]). noweb references with their targets (see [[*Noweb Reference Syntax]]).
@ -20437,7 +20437,7 @@ option ~org-startup-numerated~ to =t=, or locally on a file by using
#+cindex: @kbd{C-c C-c}, overview #+cindex: @kbd{C-c C-c}, overview
The {{{kbd(C-c C-c)}}} key in Org serves many purposes depending on The {{{kbd(C-c C-c)}}} key in Org serves many purposes depending on
the context. It is probably the most over-worked, multi-purpose key the context. It is probably the most over-worked, multipurpose key
combination in Org. Its uses are well documented throughout this combination in Org. Its uses are well documented throughout this
manual, but here is a consolidated list for easy reference. manual, but here is a consolidated list for easy reference.
@ -20849,7 +20849,7 @@ should really read as plain text. Org may use a specific escape
character in some situations, i.e., a backslash in macros (see [[*Macro character in some situations, i.e., a backslash in macros (see [[*Macro
Replacement]]) and links (see [[*Link Format]]), or a comma in source and Replacement]]) and links (see [[*Link Format]]), or a comma in source and
example blocks (see [[*Literal Examples]]). In the general case, however, example blocks (see [[*Literal Examples]]). In the general case, however,
we suggest to use the zero width space. You can insert one with any we suggest using the zero width space. You can insert one with any
of the following: of the following:
: C-x 8 <RET> zero width space <RET> : C-x 8 <RET> zero width space <RET>
@ -21043,10 +21043,10 @@ In Emacs, shift-selection combines motions of point with shift key to
enlarge regions. Emacs sets this mode by default. This conflicts enlarge regions. Emacs sets this mode by default. This conflicts
with Org's use of {{{kbd(S-<cursor>)}}} commands to change timestamps, with Org's use of {{{kbd(S-<cursor>)}}} commands to change timestamps,
TODO keywords, priorities, and item bullet types, etc. Since TODO keywords, priorities, and item bullet types, etc. Since
{{{kbd(S-<cursor>)}}} commands outside of specific contexts do not do {{{kbd(S-<cursor>)}}} commands outside specific contexts do not do
anything, Org offers the variable ~org-support-shift-select~ for anything, Org offers the variable ~org-support-shift-select~ for
customization. Org mode accommodates shift selection by (i) making it customization. Org mode accommodates shift selection by (i) making it
available outside of the special contexts where special commands available outside the special contexts where special commands
apply, and (ii) extending an existing active region even if point apply, and (ii) extending an existing active region even if point
moves across a special context. moves across a special context.
@ -21658,7 +21658,7 @@ of Org.
:END: :END:
#+cindex: hooks #+cindex: hooks
Org has a large number of hook variables for adding functionality. A Org has numerous hook variables for adding functionality. A
complete list of hooks with documentation is maintained by the Worg complete list of hooks with documentation is maintained by the Worg
project at https://orgmode.org/worg/doc.html#hooks. project at https://orgmode.org/worg/doc.html#hooks.
@ -21668,7 +21668,7 @@ project at https://orgmode.org/worg/doc.html#hooks.
:END: :END:
#+cindex: add-on packages #+cindex: add-on packages
Various authors wrote a large number of add-on packages for Org. Some Various authors wrote many add-on packages for Org. Some
of these packages used to be part of the =org-mode= repository but are of these packages used to be part of the =org-mode= repository but are
now hosted in a separate =org-contrib= repository now hosted in a separate =org-contrib= repository
[[https://git.sr.ht/~bzg/org-contrib][here]]. A Worg page with more [[https://git.sr.ht/~bzg/org-contrib][here]]. A Worg page with more
@ -21769,11 +21769,11 @@ A review of =ol-man.el=:
For example, ~org-man-store-link~ is responsible for storing a link For example, ~org-man-store-link~ is responsible for storing a link
when ~org-store-link~ (see [[*Handling Links]]) is called from a buffer when ~org-store-link~ (see [[*Handling Links]]) is called from a buffer
displaying a man page. It is passed an argument ~interactive?~ displaying a man page. It is passed an argument ~interactive?~
which this function does not use, but other store functions use to which this function does not use, but other store functions used to
behave differently when a link is stored interactively by the user. behave differently when a link is stored interactively by the user.
It first checks if the major mode is appropriate. If check fails, It first checks if the major mode is appropriate. If check fails,
the function returns ~nil~, which means it isn't responsible for the function returns ~nil~, which means it isn't responsible for
creating a link to the current buffer. Otherwise the function creating a link to the current buffer. Otherwise, the function
makes a link string by combining the =man:= prefix with the man makes a link string by combining the =man:= prefix with the man
topic. It also provides a default description. The function topic. It also provides a default description. The function
~org-insert-link~ can insert it back into an Org buffer later on. ~org-insert-link~ can insert it back into an Org buffer later on.
@ -21889,7 +21889,7 @@ of these strategies:
- Put the table after an "end" statement. For example ~\bye~ in TeX - Put the table after an "end" statement. For example ~\bye~ in TeX
and ~\end{document}~ in LaTeX. and ~\end{document}~ in LaTeX.
- Comment and un-comment each line of the table during edits. The - Comment and uncomment each line of the table during edits. The
{{{kbd(M-x orgtbl-toggle-comment)}}} command makes toggling easy. {{{kbd(M-x orgtbl-toggle-comment)}}} command makes toggling easy.
*** A LaTeX example of radio tables *** A LaTeX example of radio tables
@ -21943,7 +21943,7 @@ After editing, {{{kbd(C-c C-c)}}} inserts the translated table at the
target location, between the two marker lines. target location, between the two marker lines.
For hand-made custom tables, note that the translator needs to skip For hand-made custom tables, note that the translator needs to skip
the first two lines of the source table. Also the command has to the first two lines of the source table. Also, the command has to
/splice/ out the target table without the header and footer. /splice/ out the target table without the header and footer.
#+begin_example #+begin_example
@ -22150,11 +22150,11 @@ For a global condition applicable to agenda views, use the
condition with ~org-agenda-skip-function~ for custom searching. condition with ~org-agenda-skip-function~ for custom searching.
This example defines a function for a custom view showing TODO items This example defines a function for a custom view showing TODO items
with =waiting= status. Manually this is a multi-step search process, with =waiting= status. Manually this is a multistep search process,
but with a custom view, this can be automated as follows: but with a custom view, this can be automated as follows:
The custom function searches the subtree for the =waiting= tag and The custom function searches the subtree for the =waiting= tag and
returns ~nil~ on match. Otherwise it gives the location from where returns ~nil~ on match. Otherwise, it gives the location from where
the search continues. the search continues.
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -22685,11 +22685,11 @@ Before I get to this list, a few special mentions are in order:
- Bastien Guerry :: - Bastien Guerry ::
Bastien has written a large number of extensions to Org (most of Bastien has written numerous extensions to Org (most of
them integrated into the core by now), including the LaTeX exporter them integrated into the core by now), including the LaTeX exporter
and the plain list parser. His support during the early days was and the plain list parser. His support during the early days was
central to the success of this project. Bastien also invented Worg, central to the success of this project. Bastien also invented Worg,
helped establishing the Web presence of Org, and sponsored hosting helped to establish the Web presence of Org, and sponsored hosting
costs for the orgmode.org website. Bastien stepped in as maintainer costs for the orgmode.org website. Bastien stepped in as maintainer
of Org between 2011 and 2013, at a time when I desperately needed of Org between 2011 and 2013, at a time when I desperately needed
a break. a break.
@ -22822,7 +22822,7 @@ be complete if the ones above were not mentioned in this manual.
also asked for a way to narrow wide table columns. also asked for a way to narrow wide table columns.
- Thomas\nbsp{}S.\nbsp{}Dye contributed documentation on Worg and helped - Thomas\nbsp{}S.\nbsp{}Dye contributed documentation on Worg and helped
integrating the Org Babel documentation into the manual. to integrate the Org Babel documentation into the manual.
- Christian Egli converted the documentation into Texinfo format, - Christian Egli converted the documentation into Texinfo format,
inspired the agenda, patched CSS formatting into the HTML exporter, inspired the agenda, patched CSS formatting into the HTML exporter,
@ -22889,7 +22889,7 @@ be complete if the ones above were not mentioned in this manual.
- Jason\nbsp{}F.\nbsp{}McBrayer suggested agenda export to CSV format. - Jason\nbsp{}F.\nbsp{}McBrayer suggested agenda export to CSV format.
- Kyle Meyer helped setting up the [[https://public-inbox.org/][public-inbox]] archive of the [[https://orgmode.org/list/][Org - Kyle Meyer helped to set up the [[https://public-inbox.org/][public-inbox]] archive of the [[https://orgmode.org/list/][Org
mailing list]] and has been fixing many bugs. mailing list]] and has been fixing many bugs.
- Max Mikhanosha came up with the idea of refiling. - Max Mikhanosha came up with the idea of refiling.
@ -22969,7 +22969,7 @@ be complete if the ones above were not mentioned in this manual.
- Dale Smith proposed link abbreviations. - Dale Smith proposed link abbreviations.
- James TD Smith has contributed a large number of patches for - James TD Smith has contributed numerous patches for
useful tweaks and features. useful tweaks and features.
- Adam Spiers asked for global linking commands, inspired the link - Adam Spiers asked for global linking commands, inspired the link
@ -23164,7 +23164,7 @@ are using both ~org-log-done~ and state change logging. However, it
never prompts for two notes: if you have configured both, the state never prompts for two notes: if you have configured both, the state
change recording note takes precedence and cancel the closing note. change recording note takes precedence and cancel the closing note.
[fn:16] With the exception of description lists. But you can allow it [fn:16] Except for description lists. But you can allow it
by modifying ~org-list-automatic-rules~ accordingly. by modifying ~org-list-automatic-rules~ accordingly.
[fn:17] For both =TIMESTAMP= and =TIMESTAMP_IA=: the word "first" [fn:17] For both =TIMESTAMP= and =TIMESTAMP_IA=: the word "first"