|
@@ -103,7 +103,7 @@ Otherwise autoload Org functions will mess up the installation.
|
|
|
#+end_quote
|
|
|
|
|
|
Then, to make sure your Org configuration is taken into account,
|
|
|
-initialize the package system with ~(package-initialize)~ in your
|
|
|
+initialize the package system with =(package-initialize)= in your
|
|
|
Emacs init file before setting any Org option. If you want to use
|
|
|
Org's package repository, check out the [[https://orgmode.org/elpa.html][Org ELPA page]].
|
|
|
|
|
@@ -2119,7 +2119,7 @@ A formula can contain an optional mode string after a semicolon. This
|
|
|
string consists of flags to influence Calc and other modes during
|
|
|
execution. By default, Org uses the standard Calc modes (precision
|
|
|
12, angular units degrees, fraction and symbolic modes off). The
|
|
|
-display format, however, has been changed to ~(float 8)~ to keep
|
|
|
+display format, however, has been changed to =(float 8)= to keep
|
|
|
tables compact. The default settings can be configured using the
|
|
|
variable ~org-calc-default-modes~.
|
|
|
|
|
@@ -2427,7 +2427,7 @@ following command:
|
|
|
|
|
|
Org has three predefined Emacs Lisp functions for lookups in tables.
|
|
|
|
|
|
-- ~(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)~ ::
|
|
|
+- =(org-lookup-first VAL S-LIST R-LIST &optional PREDICATE)= ::
|
|
|
|
|
|
#+findex: org-lookup-first
|
|
|
Searches for the first element {{{var(S)}}} in list
|
|
@@ -2444,13 +2444,13 @@ Org has three predefined Emacs Lisp functions for lookups in tables.
|
|
|
{{{var(S-LIST)}}}. If {{{var(R-LIST)}}} is ~nil~, the matching
|
|
|
element {{{var(S)}}} of {{{var(S-LIST)}}} is returned.
|
|
|
|
|
|
-- ~(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)~ ::
|
|
|
+- =(org-lookup-last VAL S-LIST R-LIST &optional PREDICATE)= ::
|
|
|
|
|
|
#+findex: org-lookup-last
|
|
|
Similar to ~org-lookup-first~ above, but searches for the /last/
|
|
|
element for which {{{var(PREDICATE)}}} is non-~nil~.
|
|
|
|
|
|
-- ~(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)~ ::
|
|
|
+- =(org-lookup-all VAL S-LIST R-LIST &optional PREDICATE)= ::
|
|
|
|
|
|
#+findex: org-lookup-all
|
|
|
Similar to ~org-lookup-first~, but searches for /all/ elements
|
|
@@ -8441,7 +8441,7 @@ days you want to see by default in the agenda, or to a span name, such
|
|
|
a ~day~, ~week~, ~month~ or ~year~. For weekly agendas, the default
|
|
|
is to start on the previous Monday (see
|
|
|
~org-agenda-start-on-weekday~). You can also set the start date using
|
|
|
-a date shift: ~(setq org-agenda-start-day "+10d")~ starts the agenda
|
|
|
+a date shift: =(setq org-agenda-start-day "+10d")= starts the agenda
|
|
|
ten days from today in the future.
|
|
|
|
|
|
Remote editing from the agenda buffer means, for example, that you can
|
|
@@ -9238,7 +9238,7 @@ locally in your custom agenda views (see [[*Custom Agenda Views]]).
|
|
|
Limit the number of tagged entries.
|
|
|
|
|
|
When set to a positive integer, each option excludes entries from
|
|
|
-other categories: for example, ~(setq org-agenda-max-effort 100)~
|
|
|
+other categories: for example, =(setq org-agenda-max-effort 100)=
|
|
|
limits the agenda to 100 minutes of effort and exclude any entry that
|
|
|
has no effort property. If you want to include entries with no effort
|
|
|
property, use a negative value for ~org-agenda-max-effort~. One
|
|
@@ -11262,7 +11262,7 @@ global variables, include:
|
|
|
|
|
|
#+cindex: @samp{SELECT_TAGS}, keyword
|
|
|
#+vindex: org-export-select-tags
|
|
|
- The default value is ~("export")~. When a tree is tagged with
|
|
|
+ The default value is =("export")=. When a tree is tagged with
|
|
|
=export= (~org-export-select-tags~), Org selects that tree and
|
|
|
its sub-trees for export. Org excludes trees with =noexport=
|
|
|
tags, see below. When selectively exporting files with =export=
|
|
@@ -11273,7 +11273,7 @@ global variables, include:
|
|
|
|
|
|
#+cindex: @samp{EXCLUDE_TAGS}, keyword
|
|
|
#+vindex: org-export-exclude-tags
|
|
|
- The default value is ~("noexport")~. When a tree is tagged with
|
|
|
+ The default value is =("noexport")=. When a tree is tagged with
|
|
|
=noexport= (~org-export-exclude-tags~), Org excludes that tree
|
|
|
and its sub-trees from export. Entries tagged with =noexport=
|
|
|
are unconditionally excluded from the export, even if they have
|
|
@@ -15085,7 +15085,7 @@ Other export back-ends included with Org are:
|
|
|
- =ox-man.el=: Export to a man page.
|
|
|
|
|
|
To activate such back-ends, either customize ~org-export-backends~ or
|
|
|
-load directly with ~(require 'ox-man)~. On successful load, the
|
|
|
+load directly with =(require 'ox-man)=. On successful load, the
|
|
|
back-end adds new keys in the export dispatcher (see [[*The Export
|
|
|
Dispatcher]]).
|
|
|
|
|
@@ -18272,7 +18272,7 @@ changing values.
|
|
|
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
|
|
|
+customizing ~org-modules~ or add =(require 'org-tempo)= to your Emacs
|
|
|
init file[fn:143].
|
|
|
|
|
|
#+attr_texinfo: :columns 0.1 0.9
|
|
@@ -19569,7 +19569,7 @@ file:
|
|
|
#+texinfo: @noindent
|
|
|
A review of =org-man.el=:
|
|
|
|
|
|
-1. First, ~(require 'org)~ ensures =org.el= is loaded.
|
|
|
+1. First, =(require 'org)= ensures =org.el= is loaded.
|
|
|
|
|
|
2.
|
|
|
|
|
@@ -19782,14 +19782,15 @@ Orgtbl mode and uses a =tabular= environment to typeset the table and
|
|
|
marks horizontal lines with ~\hline~. For additional parameters to
|
|
|
control output, see [[*Translator functions]]:
|
|
|
|
|
|
-- ~:splice nil/t~ ::
|
|
|
+- =:splice BOOLEAN= ::
|
|
|
|
|
|
- When non-~nil~, return only table body lines; not wrapped in
|
|
|
- tabular environment. Default is ~nil~.
|
|
|
+ When {{{var(BOOLEAN}}} is non-~nil~, return only table body
|
|
|
+ lines; i.e., not wrapped in =tabular= environment. Default is
|
|
|
+ ~nil~.
|
|
|
|
|
|
-- ~:fmt FMT~ ::
|
|
|
+- =:fmt FMT= ::
|
|
|
|
|
|
- Format to warp each field. It should contain =%s= for the
|
|
|
+ Format string to warp each field. It should contain =%s= for the
|
|
|
original field value. For example, to wrap each field value in
|
|
|
dollar symbol, you could use =:fmt "$%s$"=. Format can also wrap
|
|
|
a property list with column numbers and formats, for example
|
|
@@ -19797,15 +19798,14 @@ control output, see [[*Translator functions]]:
|
|
|
of one argument can be used; the function must return a formatted
|
|
|
string.
|
|
|
|
|
|
-- ~:efmt EFMT~ ::
|
|
|
+- =:efmt EFMT= ::
|
|
|
|
|
|
Format numbers as exponentials. The spec should have =%s= twice
|
|
|
- for inserting mantissa and exponent, for example
|
|
|
- ="%s\\times10^{%s}"=. This may also be a property list with
|
|
|
- column numbers and formats, for example =:efmt (2
|
|
|
- "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")=. After
|
|
|
+ for inserting mantissa and exponent, for example ="%s\\times10^{%s}"=.
|
|
|
+ This may also be a property list with column numbers and formats,
|
|
|
+ for example =:efmt (2 "$%s\\times10^{%s}$" 4 "$%s\\cdot10^{%s}$")=. After
|
|
|
{{{var(EFMT)}}} has been applied to a value, {{{var(FMT)}}}---see
|
|
|
- above---is also be applied. Functions with two arguments can be
|
|
|
+ above---is also applied. Functions with two arguments can be
|
|
|
supplied instead of strings. By default, no special formatting
|
|
|
is applied.
|
|
|
|
|
@@ -19997,45 +19997,45 @@ 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:
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'scheduled)~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'scheduled)= ::
|
|
|
|
|
|
Skip current entry if it has been scheduled.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'notscheduled)~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'notscheduled)= ::
|
|
|
|
|
|
Skip current entry if it has not been scheduled.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'deadline)~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'deadline)= ::
|
|
|
|
|
|
Skip current entry if it has a deadline.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'scheduled 'deadline)~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'scheduled 'deadline)= ::
|
|
|
|
|
|
Skip current entry if it has a deadline, or if it is scheduled.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'todo '("TODO" "WAITING"))= ::
|
|
|
|
|
|
Skip current entry if the TODO keyword is TODO or WAITING.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'todo 'done)~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'todo 'done)= ::
|
|
|
|
|
|
Skip current entry if the TODO keyword marks a DONE state.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'timestamp)~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'timestamp)= ::
|
|
|
|
|
|
Skip current entry if it has any timestamp, may also be deadline
|
|
|
or scheduled.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'regexp "regular expression")~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'regexp "regular expression")= ::
|
|
|
|
|
|
Skip current entry if the regular expression matches in the
|
|
|
entry.
|
|
|
|
|
|
-- ~(org-agenda-skip-entry-if 'notregexp "regular expression")~ ::
|
|
|
+- =(org-agenda-skip-entry-if 'notregexp "regular expression")= ::
|
|
|
|
|
|
Skip current entry unless the regular expression matches.
|
|
|
|
|
|
-- ~(org-agenda-skip-subtree-if 'regexp "regular expression")~ ::
|
|
|
+- =(org-agenda-skip-subtree-if 'regexp "regular expression")= ::
|
|
|
|
|
|
Same as above, but check and skip the entire subtree.
|
|
|
|
|
@@ -20316,8 +20316,8 @@ entry point for this API is:
|
|
|
|
|
|
#+attr_texinfo: :options org-map-entries func &optional match scope &rest skip
|
|
|
#+begin_defun
|
|
|
-Call {{{(var(FUNC))}}} at each headline selected by {{{var(MATCH)}}}
|
|
|
-in {{{var(SCOPE)}}}.
|
|
|
+Call {{{var(FUNC)}}} at each headline selected by {{{var(MATCH)}}} in
|
|
|
+{{{var(SCOPE)}}}.
|
|
|
|
|
|
{{{var(FUNC)}}} is a function or a Lisp form. With point positioned
|
|
|
at the beginning of the headline, call the function without arguments.
|
|
@@ -20368,7 +20368,7 @@ of:
|
|
|
|
|
|
All agenda files with any archive files associated with them.
|
|
|
|
|
|
-- ~(file1 file2 ...)~ ::
|
|
|
+- list of filenames ::
|
|
|
|
|
|
If this is a list, all files in the list are scanned.
|
|
|
|
|
@@ -20378,7 +20378,7 @@ skipping facilities. Valid arguments are:
|
|
|
|
|
|
- ~archive~ ::
|
|
|
|
|
|
- Skip trees with the archive tag.
|
|
|
+ Skip trees with the =ARCHIVE= tag.
|
|
|
|
|
|
- ~comment~ ::
|
|
|
|
|
@@ -20914,7 +20914,7 @@ modify this GNU manual."
|
|
|
* Footnotes
|
|
|
|
|
|
[fn:1] If you do not use Font Lock globally turn it on in Org buffer
|
|
|
-with ~(add-hook 'org-mode-hook 'turn-on-font-lock)~.
|
|
|
+with =(add-hook 'org-mode-hook 'turn-on-font-lock)=.
|
|
|
|
|
|
[fn:2] Please consider subscribing to the mailing list in order to
|
|
|
minimize the work the mailing list moderators have to do.
|
|
@@ -21027,7 +21027,7 @@ a timestamp in the headline.
|
|
|
|
|
|
[fn:30] The Org Id library must first be loaded, either through
|
|
|
~org-customize~, by enabling ~id~ in ~org-modules~, or by adding
|
|
|
-~(require 'org-id)~ in your Emacs init file.
|
|
|
+=(require 'org-id)= in your Emacs init file.
|
|
|
|
|
|
[fn:31] Note that you do not have to use this command to insert
|
|
|
a link. Links in Org are plain text, and you can type or paste them
|
|
@@ -21185,7 +21185,7 @@ than 30 stars. This is a hard-coded limitation of ~lmax~ in
|
|
|
~org-clock-sum~.
|
|
|
|
|
|
[fn:72] To resume the clock under the assumption that you have worked
|
|
|
-on this task while outside Emacs, use ~(setq org-clock-persist t)~.
|
|
|
+on this task while outside Emacs, use =(setq org-clock-persist t)=.
|
|
|
|
|
|
[fn:73] To add an effort estimate "on the fly", hook a function doing
|
|
|
this to ~org-clock-in-prepare-hook~.
|