Merge branch 'maint'
[org-mode.git] / lisp / org.el
blobdef4274d94648a348e89f1b0680856974612c471
1 ;;; org.el --- Outline-based notes management and organizer -*- lexical-binding: t; -*-
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2017 Free Software Foundation, Inc.
5 ;;
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
26 ;;; Commentary:
28 ;; Org is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org mode develops organizational tasks around NOTES files that
32 ;; contain information about projects as plain text. Org mode is
33 ;; implemented on top of outline-mode, which makes it possible to keep
34 ;; the content of large files well structured. Visibility cycling and
35 ;; structure editing help to work with the tree. Tables are easily
36 ;; created with a built-in table editor. Org mode supports ToDo
37 ;; items, deadlines, time stamps, and scheduling. It dynamically
38 ;; compiles entries into an agenda that utilizes and smoothly
39 ;; integrates much of the Emacs calendar and diary. Plain text
40 ;; URL-like links connect to websites, emails, Usenet messages, BBDB
41 ;; entries, and any files related to the projects. For printing and
42 ;; sharing of notes, an Org file can be exported as a structured ASCII
43 ;; file, as HTML, or (todo and agenda items only) as an iCalendar
44 ;; file. It can also serve as a publishing tool for a set of linked
45 ;; webpages.
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
51 ;; http://orgmode.org/org.html#Installation
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org mode can be found in the TeXInfo file. The
56 ;; distribution also contains a PDF version of it. At the homepage of
57 ;; Org mode, you can read the same text online as HTML. There is also an
58 ;; excellent reference card made by Philip Rooke. This card can be found
59 ;; in the doc/ directory.
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
64 ;;; Code:
66 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
67 (defvar-local org-table-formula-constants-local nil
68 "Local version of `org-table-formula-constants'.")
70 ;;;; Require other packages
72 (require 'cl-lib)
74 (eval-when-compile (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (eq this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp "\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol "^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 (declare-function calendar-check-holidays "holidays" (date))
114 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
115 (declare-function isearch-no-upper-case-p "isearch" (string regexp-flag))
116 (declare-function org-add-archive-files "org-archive" (files))
117 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
118 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span with-hour))
119 (declare-function org-agenda-redo "org-agenda" (&optional all))
120 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body) t)
121 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
122 (declare-function org-beamer-mode "ox-beamer" (&optional prefix) t)
123 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
124 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
125 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
126 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
127 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
128 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
129 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
130 (declare-function org-clock-update-time-maybe "org-clock" ())
131 (declare-function org-clocking-buffer "org-clock" ())
132 (declare-function org-clocktable-shift "org-clock" (dir n))
133 (declare-function
134 org-duration-from-minutes "org-duration" (minutes &optional fmt canonical))
135 (declare-function org-element-at-point "org-element" ())
136 (declare-function org-element-cache-refresh "org-element" (pos))
137 (declare-function org-element-cache-reset "org-element" (&optional all))
138 (declare-function org-element-contents "org-element" (element))
139 (declare-function org-element-context "org-element" (&optional element))
140 (declare-function org-element-copy "org-element" (datum))
141 (declare-function org-element-interpret-data "org-element" (data))
142 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
143 (declare-function org-element-link-parser "org-element" ())
144 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
145 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
146 (declare-function org-element-property "org-element" (property element))
147 (declare-function org-element-put-property "org-element" (element property value))
148 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
149 (declare-function org-element-type "org-element" (element))
150 (declare-function org-element-update-syntax "org-element" ())
151 (declare-function org-id-find-id-file "org-id" (id))
152 (declare-function org-id-get-create "org-id" (&optional force))
153 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
154 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
155 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
156 (declare-function org-plot/gnuplot "org-plot" (&optional params))
157 (declare-function org-table-align "org-table" ())
158 (declare-function org-table-begin "org-table" (&optional table-type))
159 (declare-function org-table-beginning-of-field "org-table" (&optional n))
160 (declare-function org-table-blank-field "org-table" ())
161 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
162 (declare-function org-table-copy-region "org-table" (beg end &optional cut))
163 (declare-function org-table-cut-region "org-table" (beg end))
164 (declare-function org-table-edit-field "org-table" (arg))
165 (declare-function org-table-end "org-table" (&optional table-type))
166 (declare-function org-table-end-of-field "org-table" (&optional n))
167 (declare-function org-table-insert-row "org-table" (&optional arg))
168 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
169 (declare-function org-table-maybe-eval-formula "org-table" ())
170 (declare-function org-table-maybe-recalculate-line "org-table" ())
171 (declare-function org-table-next-row "org-table" ())
172 (declare-function org-table-paste-rectangle "org-table" ())
173 (declare-function org-table-recalculate "org-table" (&optional all noalign))
174 (declare-function
175 org-table-sort-lines "org-table"
176 (&optional with-case sorting-type getkey-func compare-func interactive?))
177 (declare-function org-table-shrink "org-table" (&optional begin end))
178 (declare-function org-table-toggle-column-width "org-table" (&optional arg))
179 (declare-function org-table-wrap-region "org-table" (arg))
180 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
181 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
182 (declare-function orgtbl-mode "org-table" (&optional arg))
183 (declare-function org-export-get-backend "ox" (name))
184 (declare-function org-export-get-environment "ox" (&optional backend subtreep ext-plist))
185 (declare-function org-latex-make-preamble "ox-latex" (info &optional template snippet?))
187 (defvar ffap-url-regexp)
188 (defvar org-element-paragraph-separate)
190 ;; load languages based on value of `org-babel-load-languages'
191 (defvar org-babel-load-languages)
193 ;;;###autoload
194 (defun org-babel-do-load-languages (sym value)
195 "Load the languages defined in `org-babel-load-languages'."
196 (set-default sym value)
197 (dolist (pair org-babel-load-languages)
198 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
199 (if active
200 (require (intern (concat "ob-" lang)))
201 (funcall 'fmakunbound
202 (intern (concat "org-babel-execute:" lang)))
203 (funcall 'fmakunbound
204 (intern (concat "org-babel-expand-body:" lang)))))))
206 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
207 ;;;###autoload
208 (defun org-babel-load-file (file &optional compile)
209 "Load Emacs Lisp source code blocks in the Org FILE.
210 This function exports the source code using `org-babel-tangle'
211 and then loads the resulting file using `load-file'. With prefix
212 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
213 file to byte-code before it is loaded."
214 (interactive "fFile to load: \nP")
215 (let* ((age (lambda (file)
216 (float-time
217 (time-subtract (current-time)
218 (nth 5 (or (file-attributes (file-truename file))
219 (file-attributes file)))))))
220 (base-name (file-name-sans-extension file))
221 (exported-file (concat base-name ".el")))
222 ;; tangle if the Org file is newer than the elisp file
223 (unless (and (file-exists-p exported-file)
224 (> (funcall age file) (funcall age exported-file)))
225 ;; Tangle-file traversal returns reversed list of tangled files
226 ;; and we want to evaluate the first target.
227 (setq exported-file
228 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
229 (message "%s %s"
230 (if compile
231 (progn (byte-compile-file exported-file 'load)
232 "Compiled and loaded")
233 (progn (load-file exported-file) "Loaded"))
234 exported-file)))
236 (defcustom org-babel-load-languages '((emacs-lisp . t))
237 "Languages which can be evaluated in Org buffers.
238 This list can be used to load support for any of the languages
239 below, note that each language will depend on a different set of
240 system executables and/or Emacs modes. When a language is
241 \"loaded\", then code blocks in that language can be evaluated
242 with `org-babel-execute-src-block' bound by default to C-c
243 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
244 be set to remove code block evaluation from the C-c C-c
245 keybinding. By default only Emacs Lisp (which has no
246 requirements) is loaded."
247 :group 'org-babel
248 :set 'org-babel-do-load-languages
249 :version "24.1"
250 :type '(alist :tag "Babel Languages"
251 :key-type
252 (choice
253 (const :tag "Awk" awk)
254 (const :tag "C" C)
255 (const :tag "R" R)
256 (const :tag "Asymptote" asymptote)
257 (const :tag "Calc" calc)
258 (const :tag "Clojure" clojure)
259 (const :tag "CSS" css)
260 (const :tag "Ditaa" ditaa)
261 (const :tag "Dot" dot)
262 (const :tag "Ebnf2ps" ebnf2ps)
263 (const :tag "Emacs Lisp" emacs-lisp)
264 (const :tag "Forth" forth)
265 (const :tag "Fortran" fortran)
266 (const :tag "Gnuplot" gnuplot)
267 (const :tag "Haskell" haskell)
268 (const :tag "hledger" hledger)
269 (const :tag "IO" io)
270 (const :tag "J" J)
271 (const :tag "Java" java)
272 (const :tag "Javascript" js)
273 (const :tag "LaTeX" latex)
274 (const :tag "Ledger" ledger)
275 (const :tag "Lilypond" lilypond)
276 (const :tag "Lisp" lisp)
277 (const :tag "Makefile" makefile)
278 (const :tag "Maxima" maxima)
279 (const :tag "Matlab" matlab)
280 (const :tag "Mscgen" mscgen)
281 (const :tag "Ocaml" ocaml)
282 (const :tag "Octave" octave)
283 (const :tag "Org" org)
284 (const :tag "Perl" perl)
285 (const :tag "Pico Lisp" picolisp)
286 (const :tag "PlantUML" plantuml)
287 (const :tag "Python" python)
288 (const :tag "Ruby" ruby)
289 (const :tag "Sass" sass)
290 (const :tag "Scala" scala)
291 (const :tag "Scheme" scheme)
292 (const :tag "Screen" screen)
293 (const :tag "Shell Script" shell)
294 (const :tag "Shen" shen)
295 (const :tag "Sql" sql)
296 (const :tag "Sqlite" sqlite)
297 (const :tag "Stan" stan)
298 (const :tag "Vala" vala))
299 :value-type (boolean :tag "Activate" :value t)))
301 ;;;; Customization variables
302 (defcustom org-clone-delete-id nil
303 "Remove ID property of clones of a subtree.
304 When non-nil, clones of a subtree don't inherit the ID property.
305 Otherwise they inherit the ID property with a new unique
306 identifier."
307 :type 'boolean
308 :version "24.1"
309 :group 'org-id)
311 ;;; Version
312 (org-check-version)
314 ;;;###autoload
315 (defun org-version (&optional here full message)
316 "Show the Org version.
317 Interactively, or when MESSAGE is non-nil, show it in echo area.
318 With prefix argument, or when HERE is non-nil, insert it at point.
319 In non-interactive uses, a reduced version string is output unless
320 FULL is given."
321 (interactive (list current-prefix-arg t (not current-prefix-arg)))
322 (let ((org-dir (ignore-errors (org-find-library-dir "org")))
323 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
324 (load-suffixes (list ".el"))
325 (org-install-dir
326 (ignore-errors (org-find-library-dir "org-loaddefs"))))
327 (unless (and (fboundp 'org-release) (fboundp 'org-git-version))
328 (org-load-noerror-mustsuffix (concat org-dir "org-version")))
329 (let* ((load-suffixes save-load-suffixes)
330 (release (org-release))
331 (git-version (org-git-version))
332 (version (format "Org mode version %s (%s @ %s)"
333 release
334 git-version
335 (if org-install-dir
336 (if (string= org-dir org-install-dir)
337 org-install-dir
338 (concat "mixed installation! "
339 org-install-dir
340 " and "
341 org-dir))
342 "org-loaddefs.el can not be found!")))
343 (version1 (if full version release)))
344 (when here (insert version1))
345 (when message (message "%s" version1))
346 version1)))
348 (defconst org-version (org-version))
351 ;;; Syntax Constants
353 ;;;; Block
355 (defconst org-block-regexp
356 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
357 "Regular expression for hiding blocks.")
359 (defconst org-dblock-start-re
360 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
361 "Matches the start line of a dynamic block, with parameters.")
363 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
364 "Matches the end of a dynamic block.")
366 ;;;; Clock and Planning
368 (defconst org-clock-string "CLOCK:"
369 "String used as prefix for timestamps clocking work hours on an item.")
371 (defvar org-closed-string "CLOSED:"
372 "String used as the prefix for timestamps logging closing a TODO entry.")
374 (defvar org-deadline-string "DEADLINE:"
375 "String to mark deadline entries.
376 \\<org-mode-map>
377 A deadline is this string, followed by a time stamp. It must be
378 a word, terminated by a colon. You can insert a schedule keyword
379 and a timestamp with `\\[org-deadline]'.")
381 (defvar org-scheduled-string "SCHEDULED:"
382 "String to mark scheduled TODO entries.
383 \\<org-mode-map>
384 A schedule is this string, followed by a time stamp. It must be
385 a word, terminated by a colon. You can insert a schedule keyword
386 and a timestamp with `\\[org-schedule]'.")
388 (defconst org-ds-keyword-length
389 (+ 2
390 (apply #'max
391 (mapcar #'length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
397 (concat "^[ \t]*"
398 (regexp-opt
399 (list org-closed-string org-deadline-string org-scheduled-string)
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string "\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
441 (concat "\\<"
442 (regexp-opt
443 (list org-scheduled-string org-deadline-string org-closed-string
444 org-clock-string)
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
450 (concat
451 "\\<"
452 (regexp-opt
453 (list org-scheduled-string org-deadline-string org-closed-string) t)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
458 (concat "\\(\\<"
459 (regexp-opt
460 (list org-scheduled-string org-deadline-string org-closed-string
461 org-clock-string)
463 "\\)?"
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
465 "\\|"
466 "<%%([^\r\n>]*>\\)")
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w 0 -1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string))
473 "List of time keywords.")
475 ;;;; Drawer
477 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*?"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
501 org-clock-drawer-end-re "\\)\n?")
502 "Matches an entire clock drawer.")
504 ;;;; Headline
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag "ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (eval-and-compile
526 (defconst org-comment-string "COMMENT"
527 "Entries starting with this keyword will never be exported.
528 \\<org-mode-map>
529 An entry can be toggled between COMMENT and normal with
530 `\\[org-toggle-comment]'."))
533 ;;;; LaTeX Environments and Fragments
535 (defconst org-latex-regexps
536 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
537 ;; ("$" "\\([ \t(]\\|^\\)\\(\\(\\([$]\\)\\([^ \t\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \t\n,.$]\\)\\4\\)\\)\\([ \t.,?;:'\")]\\|$\\)" 2 nil)
538 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
539 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \t\r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|'\\|$\\)" 2 nil)
540 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \t\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \t\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|'\\|$\\)" 2 nil)
541 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
542 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
543 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
544 "Regular expressions for matching embedded LaTeX.")
546 ;;;; Node Property
548 (defconst org-effort-property "Effort"
549 "The property that is being used to keep track of effort estimates.
550 Effort estimates given in this property need to have the format H:MM.")
552 ;;;; Table
554 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
555 "Detect an org-type or table-type table.")
557 (defconst org-table-line-regexp "^[ \t]*|"
558 "Detect an org-type table line.")
560 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
561 "Detect an org-type table line.")
563 (defconst org-table-hline-regexp "^[ \t]*|-"
564 "Detect an org-type table hline.")
566 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
567 "Detect a table-type table hline.")
569 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
570 "Detect the first line outside a table when searching from within it.
571 This works for both table types.")
573 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
574 "Detect a #+TBLFM line.")
576 ;;;; Timestamp
578 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
579 "Regular expression for fast time stamp matching.")
581 (defconst org-ts-regexp-inactive
582 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
583 "Regular expression for fast inactive time stamp matching.")
585 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
586 "Regular expression for fast time stamp matching.")
588 (defconst org-ts-regexp0
589 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
590 "Regular expression matching time strings for analysis.
591 This one does not require the space after the date, so it can be used
592 on a string that terminates immediately after the date.")
594 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
595 "Regular expression matching time strings for analysis.")
597 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
598 "Regular expression matching time stamps, with groups.")
600 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
601 "Regular expression matching time stamps (also [..]), with groups.")
603 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
604 "Regular expression matching a time stamp range.")
606 (defconst org-tr-regexp-both
607 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
608 "Regular expression matching a time stamp range.")
610 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
611 org-ts-regexp "\\)?")
612 "Regular expression matching a time stamp or time stamp range.")
614 (defconst org-tsr-regexp-both
615 (concat org-ts-regexp-both "\\(--?-?"
616 org-ts-regexp-both "\\)?")
617 "Regular expression matching a time stamp or time stamp range.
618 The time stamps may be either active or inactive.")
620 (defconst org-repeat-re
621 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
622 "Regular expression for specifying repeated events.
623 After a match, group 1 contains the repeat expression.")
625 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
626 "Formats for `format-time-string' which are used for time stamps.")
629 ;;; The custom variables
631 (defgroup org nil
632 "Outline-based notes management and organizer."
633 :tag "Org"
634 :group 'outlines
635 :group 'calendar)
637 (defcustom org-mode-hook nil
638 "Mode hook for Org mode, run after the mode was turned on."
639 :group 'org
640 :type 'hook)
642 (defcustom org-load-hook nil
643 "Hook that is run after org.el has been loaded."
644 :group 'org
645 :type 'hook)
647 (defcustom org-log-buffer-setup-hook nil
648 "Hook that is run after an Org log buffer is created."
649 :group 'org
650 :version "24.1"
651 :type 'hook)
653 (defvar org-modules) ; defined below
654 (defvar org-modules-loaded nil
655 "Have the modules been loaded already?")
657 (defun org-load-modules-maybe (&optional force)
658 "Load all extensions listed in `org-modules'."
659 (when (or force (not org-modules-loaded))
660 (dolist (ext org-modules)
661 (condition-case nil (require ext)
662 (error (message "Problems while trying to load feature `%s'" ext))))
663 (setq org-modules-loaded t)))
665 (defun org-set-modules (var value)
666 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
667 (set var value)
668 (when (featurep 'org)
669 (org-load-modules-maybe 'force)
670 (org-element-cache-reset 'all)))
672 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
673 "Modules that should always be loaded together with org.el.
675 If a description starts with <C>, the file is not part of Emacs
676 and loading it will require that you have downloaded and properly
677 installed the Org mode distribution.
679 You can also use this system to load external packages (i.e. neither Org
680 core modules, nor modules from the CONTRIB directory). Just add symbols
681 to the end of the list. If the package is called org-xyz.el, then you need
682 to add the symbol `xyz', and the package must have a call to:
684 (provide \\='org-xyz)
686 For export specific modules, see also `org-export-backends'."
687 :group 'org
688 :set 'org-set-modules
689 :version "24.4"
690 :package-version '(Org . "8.0")
691 :type
692 '(set :greedy t
693 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
694 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
695 (const :tag " crypt: Encryption of subtrees" org-crypt)
696 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
697 (const :tag " docview: Links to doc-view buffers" org-docview)
698 (const :tag " eww: Store link to url of eww" org-eww)
699 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
700 (const :tag " habit: Track your consistency with habits" org-habit)
701 (const :tag " id: Global IDs for identifying entries" org-id)
702 (const :tag " info: Links to Info nodes" org-info)
703 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
704 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
705 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
706 (const :tag " mouse: Additional mouse support" org-mouse)
707 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
708 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
709 (const :tag " tempo: Fast completion for structures" org-tempo)
710 (const :tag " w3m: Special cut/paste from w3m to Org mode." org-w3m)
712 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
713 (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
714 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
715 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
716 (const :tag "C collector: Collect properties into tables" org-collector)
717 (const :tag "C depend: TODO dependencies for Org mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
718 (const :tag "C drill: Flashcards and spaced repetition for Org mode" org-drill)
719 (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
720 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
721 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
722 (const :tag "C eval: Include command output as text" org-eval)
723 (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
724 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
725 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
726 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
727 (const :tag "C invoice: Help manage client invoices in Org mode" org-invoice)
728 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
729 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
730 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
731 (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
732 (const :tag "C man: Support for links to manpages in Org mode" org-man)
733 (const :tag "C mew: Links to Mew folders/messages" org-mew)
734 (const :tag "C mtags: Support for muse-like tags" org-mtags)
735 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
736 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
737 (const :tag "C registry: A registry for Org links" org-registry)
738 (const :tag "C screen: Visit screen sessions through Org links" org-screen)
739 (const :tag "C secretary: Team management with org-mode" org-secretary)
740 (const :tag "C sqlinsert: Convert Org tables to SQL insertions" orgtbl-sqlinsert)
741 (const :tag "C toc: Table of contents for Org buffer" org-toc)
742 (const :tag "C track: Keep up with Org mode development" org-track)
743 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
744 (const :tag "C vm: Links to VM folders/messages" org-vm)
745 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
746 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
747 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
749 (defvar org-export-registered-backends) ; From ox.el.
750 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
751 (declare-function org-export-backend-name "ox" (backend) t)
752 (defcustom org-export-backends '(ascii html icalendar latex odt)
753 "List of export back-ends that should be always available.
755 If a description starts with <C>, the file is not part of Emacs
756 and loading it will require that you have downloaded and properly
757 installed the Org mode distribution.
759 Unlike to `org-modules', libraries in this list will not be
760 loaded along with Org, but only once the export framework is
761 needed.
763 This variable needs to be set before org.el is loaded. If you
764 need to make a change while Emacs is running, use the customize
765 interface or run the following code, where VAL stands for the new
766 value of the variable, after updating it:
768 (progn
769 (setq org-export-registered-backends
770 (cl-remove-if-not
771 (lambda (backend)
772 (let ((name (org-export-backend-name backend)))
773 (or (memq name val)
774 (catch \\='parentp
775 (dolist (b val)
776 (and (org-export-derived-backend-p b name)
777 (throw \\='parentp t)))))))
778 org-export-registered-backends))
779 (let ((new-list (mapcar #\\='org-export-backend-name
780 org-export-registered-backends)))
781 (dolist (backend val)
782 (cond
783 ((not (load (format \"ox-%s\" backend) t t))
784 (message \"Problems while trying to load export back-end \\=`%s\\='\"
785 backend))
786 ((not (memq backend new-list)) (push backend new-list))))
787 (set-default \\='org-export-backends new-list)))
789 Adding a back-end to this list will also pull the back-end it
790 depends on, if any."
791 :group 'org
792 :group 'org-export
793 :version "26.1"
794 :package-version '(Org . "9.0")
795 :initialize 'custom-initialize-set
796 :set (lambda (var val)
797 (if (not (featurep 'ox)) (set-default var val)
798 ;; Any back-end not required anymore (not present in VAL and not
799 ;; a parent of any back-end in the new value) is removed from the
800 ;; list of registered back-ends.
801 (setq org-export-registered-backends
802 (cl-remove-if-not
803 (lambda (backend)
804 (let ((name (org-export-backend-name backend)))
805 (or (memq name val)
806 (catch 'parentp
807 (dolist (b val)
808 (and (org-export-derived-backend-p b name)
809 (throw 'parentp t)))))))
810 org-export-registered-backends))
811 ;; Now build NEW-LIST of both new back-ends and required
812 ;; parents.
813 (let ((new-list (mapcar #'org-export-backend-name
814 org-export-registered-backends)))
815 (dolist (backend val)
816 (cond
817 ((not (load (format "ox-%s" backend) t t))
818 (message "Problems while trying to load export back-end `%s'"
819 backend))
820 ((not (memq backend new-list)) (push backend new-list))))
821 ;; Set VAR to that list with fixed dependencies.
822 (set-default var new-list))))
823 :type '(set :greedy t
824 (const :tag " ascii Export buffer to ASCII format" ascii)
825 (const :tag " beamer Export buffer to Beamer presentation" beamer)
826 (const :tag " html Export buffer to HTML format" html)
827 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
828 (const :tag " latex Export buffer to LaTeX format" latex)
829 (const :tag " man Export buffer to MAN format" man)
830 (const :tag " md Export buffer to Markdown format" md)
831 (const :tag " odt Export buffer to ODT format" odt)
832 (const :tag " org Export buffer to Org format" org)
833 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
834 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
835 (const :tag "C deck Export buffer to deck.js presentations" deck)
836 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
837 (const :tag "C groff Export buffer to Groff format" groff)
838 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
839 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
840 (const :tag "C s5 Export buffer to s5 presentations" s5)
841 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
843 (eval-after-load 'ox
844 '(dolist (backend org-export-backends)
845 (condition-case nil (require (intern (format "ox-%s" backend)))
846 (error (message "Problems while trying to load export back-end `%s'"
847 backend)))))
849 (defcustom org-support-shift-select nil
850 "Non-nil means make shift-cursor commands select text when possible.
851 \\<org-mode-map>\
853 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
854 start selecting a region, or enlarge regions started in this way.
855 In Org mode, in special contexts, these same keys are used for
856 other purposes, important enough to compete with shift selection.
857 Org tries to balance these needs by supporting `shift-select-mode'
858 outside these special contexts, under control of this variable.
860 The default of this variable is nil, to avoid confusing behavior. Shifted
861 cursor keys will then execute Org commands in the following contexts:
862 - on a headline, changing TODO state (left/right) and priority (up/down)
863 - on a time stamp, changing the time
864 - in a plain list item, changing the bullet type
865 - in a property definition line, switching between allowed values
866 - in the BEGIN line of a clock table (changing the time block).
867 Outside these contexts, the commands will throw an error.
869 When this variable is t and the cursor is not in a special
870 context, Org mode will support shift-selection for making and
871 enlarging regions. To make this more effective, the bullet
872 cycling will no longer happen anywhere in an item line, but only
873 if the cursor is exactly on the bullet.
875 If you set this variable to the symbol `always', then the keys
876 will not be special in headlines, property lines, and item lines,
877 to make shift selection work there as well. If this is what you
878 want, you can use the following alternative commands:
879 `\\[org-todo]' and `\\[org-priority]' \
880 to change TODO state and priority,
881 `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
882 can be used to switch TODO sets,
883 `\\[org-ctrl-c-minus]' to cycle item bullet types,
884 and properties can be edited by hand or in column view.
886 However, when the cursor is on a timestamp, shift-cursor commands
887 will still edit the time stamp - this is just too good to give up."
888 :group 'org
889 :type '(choice
890 (const :tag "Never" nil)
891 (const :tag "When outside special context" t)
892 (const :tag "Everywhere except timestamps" always)))
894 (defcustom org-loop-over-headlines-in-active-region nil
895 "Shall some commands act upon headlines in the active region?
897 When set to t, some commands will be performed in all headlines
898 within the active region.
900 When set to `start-level', some commands will be performed in all
901 headlines within the active region, provided that these headlines
902 are of the same level than the first one.
904 When set to a string, those commands will be performed on the
905 matching headlines within the active region. Such string must be
906 a tags/property/todo match as it is used in the agenda tags view.
908 The list of commands is: `org-schedule', `org-deadline',
909 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
910 `org-archive-to-archive-sibling'. The archiving commands skip
911 already archived entries."
912 :type '(choice (const :tag "Don't loop" nil)
913 (const :tag "All headlines in active region" t)
914 (const :tag "In active region, headlines at the same level than the first one" start-level)
915 (string :tag "Tags/Property/Todo matcher"))
916 :version "24.1"
917 :group 'org-todo
918 :group 'org-archive)
920 (defcustom org-startup-folded t
921 "Non-nil means entering Org mode will switch to OVERVIEW.
923 This can also be configured on a per-file basis by adding one of
924 the following lines anywhere in the buffer:
926 #+STARTUP: fold (or `overview', this is equivalent)
927 #+STARTUP: nofold (or `showall', this is equivalent)
928 #+STARTUP: content
929 #+STARTUP: showeverything
931 Set `org-agenda-inhibit-startup' to a non-nil value if you want
932 to ignore this option when Org opens agenda files for the first
933 time."
934 :group 'org-startup
935 :type '(choice
936 (const :tag "nofold: show all" nil)
937 (const :tag "fold: overview" t)
938 (const :tag "content: all headlines" content)
939 (const :tag "show everything, even drawers" showeverything)))
941 (defcustom org-startup-truncated t
942 "Non-nil means entering Org mode will set `truncate-lines'.
943 This is useful since some lines containing links can be very long and
944 uninteresting. Also tables look terrible when wrapped.
946 The variable `org-startup-truncated' allows to configure
947 truncation for Org mode different to the other modes that use the
948 variable `truncate-lines' and as a shortcut instead of putting
949 the variable `truncate-lines' into the `org-mode-hook'. If one
950 wants to configure truncation for Org mode not statically but
951 dynamically e. g. in a hook like `ediff-prepare-buffer-hook' then
952 the variable `truncate-lines' has to be used because in such a
953 case it is too late to set the variable `org-startup-truncated'."
954 :group 'org-startup
955 :type 'boolean)
957 (defcustom org-startup-indented nil
958 "Non-nil means turn on `org-indent-mode' on startup.
959 This can also be configured on a per-file basis by adding one of
960 the following lines anywhere in the buffer:
962 #+STARTUP: indent
963 #+STARTUP: noindent"
964 :group 'org-structure
965 :type '(choice
966 (const :tag "Not" nil)
967 (const :tag "Globally (slow on startup in large files)" t)))
969 (defcustom org-use-sub-superscripts t
970 "Non-nil means interpret \"_\" and \"^\" for display.
972 If you want to control how Org exports those characters, see
973 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
974 used to be an alias for `org-export-with-sub-superscripts' in
975 Org <8.0, it is not anymore.
977 When this option is turned on, you can use TeX-like syntax for
978 sub- and superscripts within the buffer. Several characters after
979 \"_\" or \"^\" will be considered as a single item - so grouping
980 with {} is normally not needed. For example, the following things
981 will be parsed as single sub- or superscripts:
983 10^24 or 10^tau several digits will be considered 1 item.
984 10^-12 or 10^-tau a leading sign with digits or a word
985 x^2-y^3 will be read as x^2 - y^3, because items are
986 terminated by almost any nonword/nondigit char.
987 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
989 Still, ambiguity is possible. So when in doubt, use {} to enclose
990 the sub/superscript. If you set this variable to the symbol `{}',
991 the braces are *required* in order to trigger interpretations as
992 sub/superscript. This can be helpful in documents that need \"_\"
993 frequently in plain text."
994 :group 'org-startup
995 :version "24.4"
996 :package-version '(Org . "8.0")
997 :type '(choice
998 (const :tag "Always interpret" t)
999 (const :tag "Only with braces" {})
1000 (const :tag "Never interpret" nil)))
1002 (defcustom org-startup-with-beamer-mode nil
1003 "Non-nil means turn on `org-beamer-mode' on startup.
1004 This can also be configured on a per-file basis by adding one of
1005 the following lines anywhere in the buffer:
1007 #+STARTUP: beamer"
1008 :group 'org-startup
1009 :version "24.1"
1010 :type 'boolean)
1012 (defcustom org-startup-align-all-tables nil
1013 "Non-nil means align all tables when visiting a file.
1014 This can also be configured on a per-file basis by adding one of
1015 the following lines anywhere in the buffer:
1016 #+STARTUP: align
1017 #+STARTUP: noalign"
1018 :group 'org-startup
1019 :type 'boolean)
1021 (defcustom org-startup-shrink-all-tables nil
1022 "Non-nil means shrink all table columns with a width cookie.
1023 This can also be configured on a per-file basis by adding one of
1024 the following lines anywhere in the buffer:
1025 #+STARTUP: shrink"
1026 :group 'org-startup
1027 :type 'boolean
1028 :version "27.1"
1029 :package-version '(Org . "9.2")
1030 :safe #'booleanp)
1032 (defcustom org-startup-with-inline-images nil
1033 "Non-nil means show inline images when loading a new Org file.
1034 This can also be configured on a per-file basis by adding one of
1035 the following lines anywhere in the buffer:
1036 #+STARTUP: inlineimages
1037 #+STARTUP: noinlineimages"
1038 :group 'org-startup
1039 :version "24.1"
1040 :type 'boolean)
1042 (defcustom org-startup-with-latex-preview nil
1043 "Non-nil means preview LaTeX fragments when loading a new Org file.
1045 This can also be configured on a per-file basis by adding one of
1046 the following lines anywhere in the buffer:
1047 #+STARTUP: latexpreview
1048 #+STARTUP: nolatexpreview"
1049 :group 'org-startup
1050 :version "24.4"
1051 :package-version '(Org . "8.0")
1052 :type 'boolean)
1054 (defcustom org-insert-mode-line-in-empty-file nil
1055 "Non-nil means insert the first line setting Org mode in empty files.
1056 When the function `org-mode' is called interactively in an empty file, this
1057 normally means that the file name does not automatically trigger Org mode.
1058 To ensure that the file will always be in Org mode in the future, a
1059 line enforcing Org mode will be inserted into the buffer, if this option
1060 has been set."
1061 :group 'org-startup
1062 :type 'boolean)
1064 (defcustom org-replace-disputed-keys nil
1065 "Non-nil means use alternative key bindings for some keys.
1066 Org mode uses S-<cursor> keys for changing timestamps and priorities.
1067 These keys are also used by other packages like shift-selection-mode'
1068 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1069 If you want to use Org mode together with one of these other modes,
1070 or more generally if you would like to move some Org mode commands to
1071 other keys, set this variable and configure the keys with the variable
1072 `org-disputed-keys'.
1074 This option is only relevant at load-time of Org mode, and must be set
1075 *before* org.el is loaded. Changing it requires a restart of Emacs to
1076 become effective."
1077 :group 'org-startup
1078 :type 'boolean)
1080 (defcustom org-use-extra-keys nil
1081 "Non-nil means use extra key sequence definitions for certain commands.
1082 This happens automatically if `window-system' is nil. This
1083 variable lets you do the same manually. You must set it before
1084 loading Org."
1085 :group 'org-startup
1086 :type 'boolean)
1088 (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1090 (defcustom org-disputed-keys
1091 '(([(shift up)] . [(meta p)])
1092 ([(shift down)] . [(meta n)])
1093 ([(shift left)] . [(meta -)])
1094 ([(shift right)] . [(meta +)])
1095 ([(control shift right)] . [(meta shift +)])
1096 ([(control shift left)] . [(meta shift -)]))
1097 "Keys for which Org mode and other modes compete.
1098 This is an alist, cars are the default keys, second element specifies
1099 the alternative to use when `org-replace-disputed-keys' is t.
1101 Keys can be specified in any syntax supported by `define-key'.
1102 The value of this option takes effect only at Org mode startup,
1103 therefore you'll have to restart Emacs to apply it after changing."
1104 :group 'org-startup
1105 :type 'alist)
1107 (defun org-key (key)
1108 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1109 Or return the original if not disputed."
1110 (when org-replace-disputed-keys
1111 (let* ((nkey (key-description key))
1112 (x (cl-find-if (lambda (x) (equal (key-description (car x)) nkey))
1113 org-disputed-keys)))
1114 (setq key (if x (cdr x) key))))
1115 key)
1117 (defun org-defkey (keymap key def)
1118 "Define a key, possibly translated, as returned by `org-key'."
1119 (define-key keymap (org-key key) def))
1121 (defcustom org-ellipsis nil
1122 "The ellipsis to use in the Org mode outline.
1124 When nil, just use the standard three dots. When a non-empty string,
1125 use that string instead.
1127 The change affects only Org mode (which will then use its own display table).
1128 Changing this requires executing `\\[org-mode]' in a buffer to become
1129 effective."
1130 :group 'org-startup
1131 :type '(choice (const :tag "Default" nil)
1132 (string :tag "String" :value "...#"))
1133 :safe (lambda (v) (and (string-or-null-p v) (not (equal "" v)))))
1135 (defvar org-display-table nil
1136 "The display table for Org mode, in case `org-ellipsis' is non-nil.")
1138 (defgroup org-keywords nil
1139 "Keywords in Org mode."
1140 :tag "Org Keywords"
1141 :group 'org)
1143 (defcustom org-closed-keep-when-no-todo nil
1144 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1145 :group 'org-todo
1146 :group 'org-keywords
1147 :version "24.4"
1148 :package-version '(Org . "8.0")
1149 :type 'boolean)
1151 (defgroup org-structure nil
1152 "Options concerning the general structure of Org files."
1153 :tag "Org Structure"
1154 :group 'org)
1156 (defgroup org-reveal-location nil
1157 "Options about how to make context of a location visible."
1158 :tag "Org Reveal Location"
1159 :group 'org-structure)
1161 (defcustom org-show-context-detail '((agenda . local)
1162 (bookmark-jump . lineage)
1163 (isearch . lineage)
1164 (default . ancestors))
1165 "Alist between context and visibility span when revealing a location.
1167 \\<org-mode-map>Some actions may move point into invisible
1168 locations. As a consequence, Org always expose a neighborhood
1169 around point. How much is shown depends on the initial action,
1170 or context. Valid contexts are
1172 agenda when exposing an entry from the agenda
1173 org-goto when using the command `org-goto' (`\\[org-goto]')
1174 occur-tree when using the command `org-occur' (`\\[org-sparse-tree] /')
1175 tags-tree when constructing a sparse tree based on tags matches
1176 link-search when exposing search matches associated with a link
1177 mark-goto when exposing the jump goal of a mark
1178 bookmark-jump when exposing a bookmark location
1179 isearch when exiting from an incremental search
1180 default default for all contexts not set explicitly
1182 Allowed visibility spans are
1184 minimal show current headline; if point is not on headline,
1185 also show entry
1187 local show current headline, entry and next headline
1189 ancestors show current headline and its direct ancestors; if
1190 point is not on headline, also show entry
1192 lineage show current headline, its direct ancestors and all
1193 their children; if point is not on headline, also show
1194 entry and first child
1196 tree show current headline, its direct ancestors and all
1197 their children; if point is not on headline, also show
1198 entry and all children
1200 canonical show current headline, its direct ancestors along with
1201 their entries and children; if point is not located on
1202 the headline, also show current entry and all children
1204 As special cases, a nil or t value means show all contexts in
1205 `minimal' or `canonical' view, respectively.
1207 Some views can make displayed information very compact, but also
1208 make it harder to edit the location of the match. In such
1209 a case, use the command `org-reveal' (`\\[org-reveal]') to show
1210 more context."
1211 :group 'org-reveal-location
1212 :version "26.1"
1213 :package-version '(Org . "9.0")
1214 :type '(choice
1215 (const :tag "Canonical" t)
1216 (const :tag "Minimal" nil)
1217 (repeat :greedy t :tag "Individual contexts"
1218 (cons
1219 (choice :tag "Context"
1220 (const agenda)
1221 (const org-goto)
1222 (const occur-tree)
1223 (const tags-tree)
1224 (const link-search)
1225 (const mark-goto)
1226 (const bookmark-jump)
1227 (const isearch)
1228 (const default))
1229 (choice :tag "Detail level"
1230 (const minimal)
1231 (const local)
1232 (const ancestors)
1233 (const lineage)
1234 (const tree)
1235 (const canonical))))))
1237 (defcustom org-indirect-buffer-display 'other-window
1238 "How should indirect tree buffers be displayed?
1240 This applies to indirect buffers created with the commands
1241 `org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
1243 Valid values are:
1244 current-window Display in the current window
1245 other-window Just display in another window.
1246 dedicated-frame Create one new frame, and re-use it each time.
1247 new-frame Make a new frame each time. Note that in this case
1248 previously-made indirect buffers are kept, and you need to
1249 kill these buffers yourself."
1250 :group 'org-structure
1251 :group 'org-agenda-windows
1252 :type '(choice
1253 (const :tag "In current window" current-window)
1254 (const :tag "In current frame, other window" other-window)
1255 (const :tag "Each time a new frame" new-frame)
1256 (const :tag "One dedicated frame" dedicated-frame)))
1258 (defcustom org-use-speed-commands nil
1259 "Non-nil means activate single letter commands at beginning of a headline.
1260 This may also be a function to test for appropriate locations where speed
1261 commands should be active.
1263 For example, to activate speed commands when the point is on any
1264 star at the beginning of the headline, you can do this:
1266 (setq org-use-speed-commands
1267 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1268 :group 'org-structure
1269 :type '(choice
1270 (const :tag "Never" nil)
1271 (const :tag "At beginning of headline stars" t)
1272 (function)))
1274 (defcustom org-speed-commands-user nil
1275 "Alist of additional speed commands.
1276 This list will be checked before `org-speed-commands-default'
1277 when the variable `org-use-speed-commands' is non-nil
1278 and when the cursor is at the beginning of a headline.
1279 The car of each entry is a string with a single letter, which must
1280 be assigned to `self-insert-command' in the global map.
1281 The cdr is either a command to be called interactively, a function
1282 to be called, or a form to be evaluated.
1283 An entry that is just a list with a single string will be interpreted
1284 as a descriptive headline that will be added when listing the speed
1285 commands in the Help buffer using the `?' speed command."
1286 :group 'org-structure
1287 :type '(repeat :value ("k" . ignore)
1288 (choice :value ("k" . ignore)
1289 (list :tag "Descriptive Headline" (string :tag "Headline"))
1290 (cons :tag "Letter and Command"
1291 (string :tag "Command letter")
1292 (choice
1293 (function)
1294 (sexp))))))
1296 (defcustom org-bookmark-names-plist
1297 '(:last-capture "org-capture-last-stored"
1298 :last-refile "org-refile-last-stored"
1299 :last-capture-marker "org-capture-last-stored-marker")
1300 "Names for bookmarks automatically set by some Org commands.
1301 This can provide strings as names for a number of bookmarks Org sets
1302 automatically. The following keys are currently implemented:
1303 :last-capture
1304 :last-capture-marker
1305 :last-refile
1306 When a key does not show up in the property list, the corresponding bookmark
1307 is not set."
1308 :group 'org-structure
1309 :type 'plist)
1311 (defgroup org-cycle nil
1312 "Options concerning visibility cycling in Org mode."
1313 :tag "Org Cycle"
1314 :group 'org-structure)
1316 (defcustom org-cycle-skip-children-state-if-no-children t
1317 "Non-nil means skip CHILDREN state in entries that don't have any."
1318 :group 'org-cycle
1319 :type 'boolean)
1321 (defcustom org-cycle-max-level nil
1322 "Maximum level which should still be subject to visibility cycling.
1323 Levels higher than this will, for cycling, be treated as text, not a headline.
1324 When `org-odd-levels-only' is set, a value of N in this variable actually
1325 means 2N-1 stars as the limiting headline.
1326 When nil, cycle all levels.
1327 Note that the limiting level of cycling is also influenced by
1328 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1329 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1330 than its value."
1331 :group 'org-cycle
1332 :type '(choice
1333 (const :tag "No limit" nil)
1334 (integer :tag "Maximum level")))
1336 (defcustom org-hide-block-startup nil
1337 "Non-nil means entering Org mode will fold all blocks.
1338 This can also be set in on a per-file basis with
1340 #+STARTUP: hideblocks
1341 #+STARTUP: showblocks"
1342 :group 'org-startup
1343 :group 'org-cycle
1344 :type 'boolean)
1346 (defcustom org-cycle-global-at-bob nil
1347 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1349 This makes it possible to do global cycling without having to use `S-TAB'
1350 or `\\[universal-argument] TAB'. For this special case to work, the first \
1351 line of the buffer
1352 must not be a headline -- it may be empty or some other text.
1354 When used in this way, `org-cycle-hook' is disabled temporarily to make
1355 sure the cursor stays at the beginning of the buffer.
1357 When this option is nil, don't do anything special at the beginning of
1358 the buffer."
1359 :group 'org-cycle
1360 :type 'boolean)
1362 (defcustom org-cycle-level-after-item/entry-creation t
1363 "Non-nil means cycle entry level or item indentation in new empty entries.
1365 When the cursor is at the end of an empty headline, i.e., with only stars
1366 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1367 and then all possible ancestor states, before returning to the original state.
1368 This makes data entry extremely fast: M-RET to create a new headline,
1369 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1371 When the cursor is at the end of an empty plain list item, one TAB will
1372 make it a subitem, two or more tabs will back up to make this an item
1373 higher up in the item hierarchy."
1374 :group 'org-cycle
1375 :type 'boolean)
1377 (defcustom org-cycle-emulate-tab t
1378 "Where should `org-cycle' emulate TAB.
1379 nil Never
1380 white Only in completely white lines
1381 whitestart Only at the beginning of lines, before the first non-white char
1382 t Everywhere except in headlines
1383 exc-hl-bol Everywhere except at the start of a headline
1384 If TAB is used in a place where it does not emulate TAB, the current subtree
1385 visibility is cycled."
1386 :group 'org-cycle
1387 :type '(choice (const :tag "Never" nil)
1388 (const :tag "Only in completely white lines" white)
1389 (const :tag "Before first char in a line" whitestart)
1390 (const :tag "Everywhere except in headlines" t)
1391 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1393 (defcustom org-cycle-separator-lines 2
1394 "Number of empty lines needed to keep an empty line between collapsed trees.
1395 If you leave an empty line between the end of a subtree and the following
1396 headline, this empty line is hidden when the subtree is folded.
1397 Org mode will leave (exactly) one empty line visible if the number of
1398 empty lines is equal or larger to the number given in this variable.
1399 So the default 2 means at least 2 empty lines after the end of a subtree
1400 are needed to produce free space between a collapsed subtree and the
1401 following headline.
1403 If the number is negative, and the number of empty lines is at least -N,
1404 all empty lines are shown.
1406 Special case: when 0, never leave empty lines in collapsed view."
1407 :group 'org-cycle
1408 :type 'integer)
1409 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1411 (defcustom org-pre-cycle-hook nil
1412 "Hook that is run before visibility cycling is happening.
1413 The function(s) in this hook must accept a single argument which indicates
1414 the new state that will be set right after running this hook. The
1415 argument is a symbol. Before a global state change, it can have the values
1416 `overview', `content', or `all'. Before a local state change, it can have
1417 the values `folded', `children', or `subtree'."
1418 :group 'org-cycle
1419 :type 'hook)
1421 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1422 org-cycle-hide-drawers
1423 org-cycle-show-empty-lines
1424 org-optimize-window-after-visibility-change)
1425 "Hook that is run after `org-cycle' has changed the buffer visibility.
1426 The function(s) in this hook must accept a single argument which indicates
1427 the new state that was set by the most recent `org-cycle' command. The
1428 argument is a symbol. After a global state change, it can have the values
1429 `overview', `contents', or `all'. After a local state change, it can have
1430 the values `folded', `children', or `subtree'."
1431 :group 'org-cycle
1432 :type 'hook
1433 :version "26.1"
1434 :package-version '(Org . "8.3"))
1436 (defgroup org-edit-structure nil
1437 "Options concerning structure editing in Org mode."
1438 :tag "Org Edit Structure"
1439 :group 'org-structure)
1441 (defcustom org-odd-levels-only nil
1442 "Non-nil means skip even levels and only use odd levels for the outline.
1443 This has the effect that two stars are being added/taken away in
1444 promotion/demotion commands. It also influences how levels are
1445 handled by the exporters.
1446 Changing it requires restart of `font-lock-mode' to become effective
1447 for fontification also in regions already fontified.
1448 You may also set this on a per-file basis by adding one of the following
1449 lines to the buffer:
1451 #+STARTUP: odd
1452 #+STARTUP: oddeven"
1453 :group 'org-edit-structure
1454 :group 'org-appearance
1455 :type 'boolean)
1457 (defcustom org-adapt-indentation t
1458 "Non-nil means adapt indentation to outline node level.
1460 When this variable is set, Org assumes that you write outlines by
1461 indenting text in each node to align with the headline (after the
1462 stars). The following issues are influenced by this variable:
1464 - The indentation is increased by one space in a demotion
1465 command, and decreased by one in a promotion command. However,
1466 in the latter case, if shifting some line in the entry body
1467 would alter document structure (e.g., insert a new headline),
1468 indentation is not changed at all.
1470 - Property drawers and planning information is inserted indented
1471 when this variable is set. When nil, they will not be indented.
1473 - TAB indents a line relative to current level. The lines below
1474 a headline will be indented when this variable is set.
1476 Note that this is all about true indentation, by adding and
1477 removing space characters. See also \"org-indent.el\" which does
1478 level-dependent indentation in a virtual way, i.e. at display
1479 time in Emacs."
1480 :group 'org-edit-structure
1481 :type 'boolean
1482 :safe #'booleanp)
1484 (defcustom org-special-ctrl-a/e nil
1485 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1487 When t, `C-a' will bring back the cursor to the beginning of the
1488 headline text, i.e. after the stars and after a possible TODO
1489 keyword. In an item, this will be the position after bullet and
1490 check-box, if any. When the cursor is already at that position,
1491 another `C-a' will bring it to the beginning of the line.
1493 `C-e' will jump to the end of the headline, ignoring the presence
1494 of tags in the headline. A second `C-e' will then jump to the
1495 true end of the line, after any tags. This also means that, when
1496 this variable is non-nil, `C-e' also will never jump beyond the
1497 end of the heading of a folded section, i.e. not after the
1498 ellipses.
1500 When set to the symbol `reversed', the first `C-a' or `C-e' works
1501 normally, going to the true line boundary first. Only a directly
1502 following, identical keypress will bring the cursor to the
1503 special positions.
1505 This may also be a cons cell where the behavior for `C-a' and
1506 `C-e' is set separately."
1507 :group 'org-edit-structure
1508 :type '(choice
1509 (const :tag "off" nil)
1510 (const :tag "on: after stars/bullet and before tags first" t)
1511 (const :tag "reversed: true line boundary first" reversed)
1512 (cons :tag "Set C-a and C-e separately"
1513 (choice :tag "Special C-a"
1514 (const :tag "off" nil)
1515 (const :tag "on: after stars/bullet first" t)
1516 (const :tag "reversed: before stars/bullet first" reversed))
1517 (choice :tag "Special C-e"
1518 (const :tag "off" nil)
1519 (const :tag "on: before tags first" t)
1520 (const :tag "reversed: after tags first" reversed)))))
1521 (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1523 (defcustom org-special-ctrl-k nil
1524 "Non-nil means `C-k' will behave specially in headlines.
1525 When nil, `C-k' will call the default `kill-line' command.
1526 When t, the following will happen while the cursor is in the headline:
1528 - When the cursor is at the beginning of a headline, kill the entire
1529 line and possible the folded subtree below the line.
1530 - When in the middle of the headline text, kill the headline up to the tags.
1531 - When after the headline text, kill the tags."
1532 :group 'org-edit-structure
1533 :type 'boolean)
1535 (defcustom org-ctrl-k-protect-subtree nil
1536 "Non-nil means, do not delete a hidden subtree with C-k.
1537 When set to the symbol `error', simply throw an error when C-k is
1538 used to kill (part-of) a headline that has hidden text behind it.
1539 Any other non-nil value will result in a query to the user, if it is
1540 OK to kill that hidden subtree. When nil, kill without remorse."
1541 :group 'org-edit-structure
1542 :version "24.1"
1543 :type '(choice
1544 (const :tag "Do not protect hidden subtrees" nil)
1545 (const :tag "Protect hidden subtrees with a security query" t)
1546 (const :tag "Never kill a hidden subtree with C-k" error)))
1548 (defcustom org-special-ctrl-o t
1549 "Non-nil means, make `C-o' insert a row in tables."
1550 :group 'org-edit-structure
1551 :type 'boolean)
1553 (defcustom org-catch-invisible-edits nil
1554 "Check if in invisible region before inserting or deleting a character.
1555 Valid values are:
1557 nil Do not check, so just do invisible edits.
1558 error Throw an error and do nothing.
1559 show Make point visible, and do the requested edit.
1560 show-and-error Make point visible, then throw an error and abort the edit.
1561 smart Make point visible, and do insertion/deletion if it is
1562 adjacent to visible text and the change feels predictable.
1563 Never delete a previously invisible character or add in the
1564 middle or right after an invisible region. Basically, this
1565 allows insertion and backward-delete right before ellipses.
1566 FIXME: maybe in this case we should not even show?"
1567 :group 'org-edit-structure
1568 :version "24.1"
1569 :type '(choice
1570 (const :tag "Do not check" nil)
1571 (const :tag "Throw error when trying to edit" error)
1572 (const :tag "Unhide, but do not do the edit" show-and-error)
1573 (const :tag "Show invisible part and do the edit" show)
1574 (const :tag "Be smart and do the right thing" smart)))
1576 (defcustom org-yank-folded-subtrees t
1577 "Non-nil means when yanking subtrees, fold them.
1578 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1579 it starts with a heading and all other headings in it are either children
1580 or siblings, then fold all the subtrees. However, do this only if no
1581 text after the yank would be swallowed into a folded tree by this action."
1582 :group 'org-edit-structure
1583 :type 'boolean)
1585 (defcustom org-yank-adjusted-subtrees nil
1586 "Non-nil means when yanking subtrees, adjust the level.
1587 With this setting, `org-paste-subtree' is used to insert the subtree, see
1588 this function for details."
1589 :group 'org-edit-structure
1590 :type 'boolean)
1592 (defcustom org-M-RET-may-split-line '((default . t))
1593 "Non-nil means M-RET will split the line at the cursor position.
1594 When nil, it will go to the end of the line before making a
1595 new line.
1596 You may also set this option in a different way for different
1597 contexts. Valid contexts are:
1599 headline when creating a new headline
1600 item when creating a new item
1601 table in a table field
1602 default the value to be used for all contexts not explicitly
1603 customized"
1604 :group 'org-structure
1605 :group 'org-table
1606 :type '(choice
1607 (const :tag "Always" t)
1608 (const :tag "Never" nil)
1609 (repeat :greedy t :tag "Individual contexts"
1610 (cons
1611 (choice :tag "Context"
1612 (const headline)
1613 (const item)
1614 (const table)
1615 (const default))
1616 (boolean)))))
1619 (defcustom org-insert-heading-respect-content nil
1620 "Non-nil means insert new headings after the current subtree.
1621 \\<org-mode-map>
1622 When nil, the new heading is created directly after the current line.
1623 The commands `\\[org-insert-heading-respect-content]' and \
1624 `\\[org-insert-todo-heading-respect-content]' turn this variable on
1625 for the duration of the command."
1626 :group 'org-structure
1627 :type 'boolean)
1629 (defcustom org-blank-before-new-entry '((heading . auto)
1630 (plain-list-item . auto))
1631 "Should `org-insert-heading' leave a blank line before new heading/item?
1632 The value is an alist, with `heading' and `plain-list-item' as CAR,
1633 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1634 which case Org will look at the surrounding headings/items and try to
1635 make an intelligent decision whether to insert a blank line or not."
1636 :group 'org-edit-structure
1637 :type '(list
1638 (cons (const heading)
1639 (choice (const :tag "Never" nil)
1640 (const :tag "Always" t)
1641 (const :tag "Auto" auto)))
1642 (cons (const plain-list-item)
1643 (choice (const :tag "Never" nil)
1644 (const :tag "Always" t)
1645 (const :tag "Auto" auto)))))
1647 (defcustom org-insert-heading-hook nil
1648 "Hook being run after inserting a new heading."
1649 :group 'org-edit-structure
1650 :type 'hook)
1652 (defcustom org-enable-fixed-width-editor t
1653 "Non-nil means lines starting with \":\" are treated as fixed-width.
1654 This currently only means they are never auto-wrapped.
1655 When nil, such lines will be treated like ordinary lines."
1656 :group 'org-edit-structure
1657 :type 'boolean)
1659 (defgroup org-sparse-trees nil
1660 "Options concerning sparse trees in Org mode."
1661 :tag "Org Sparse Trees"
1662 :group 'org-structure)
1664 (defcustom org-highlight-sparse-tree-matches t
1665 "Non-nil means highlight all matches that define a sparse tree.
1666 The highlights will automatically disappear the next time the buffer is
1667 changed by an edit command."
1668 :group 'org-sparse-trees
1669 :type 'boolean)
1671 (defcustom org-remove-highlights-with-change t
1672 "Non-nil means any change to the buffer will remove temporary highlights.
1673 \\<org-mode-map>\
1674 Such highlights are created by `org-occur' and `org-clock-display'.
1675 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1676 to get rid of the highlights.
1677 The highlights created by `org-toggle-latex-fragment' always need
1678 `\\[org-toggle-latex-fragment]' to be removed."
1679 :group 'org-sparse-trees
1680 :group 'org-time
1681 :type 'boolean)
1683 (defcustom org-occur-case-fold-search t
1684 "Non-nil means `org-occur' should be case-insensitive.
1685 If set to `smart' the search will be case-insensitive only if it
1686 doesn't specify any upper case character."
1687 :group 'org-sparse-trees
1688 :version "26.1"
1689 :type '(choice
1690 (const :tag "Case-sensitive" nil)
1691 (const :tag "Case-insensitive" t)
1692 (const :tag "Case-insensitive for lower case searches only" smart)))
1694 (defcustom org-occur-hook '(org-first-headline-recenter)
1695 "Hook that is run after `org-occur' has constructed a sparse tree.
1696 This can be used to recenter the window to show as much of the structure
1697 as possible."
1698 :group 'org-sparse-trees
1699 :type 'hook)
1701 (defgroup org-table nil
1702 "Options concerning tables in Org mode."
1703 :tag "Org Table"
1704 :group 'org)
1706 (defcustom org-self-insert-cluster-for-undo nil
1707 "Non-nil means cluster self-insert commands for undo when possible.
1708 If this is set, then, like in the Emacs command loop, 20 consecutive
1709 characters will be undone together.
1710 This is configurable, because there is some impact on typing performance."
1711 :group 'org-table
1712 :type 'boolean)
1714 (defcustom org-table-tab-recognizes-table.el t
1715 "Non-nil means TAB will automatically notice a table.el table.
1716 When it sees such a table, it moves point into it and - if necessary -
1717 calls `table-recognize-table'."
1718 :group 'org-table-editing
1719 :type 'boolean)
1721 (defgroup org-link nil
1722 "Options concerning links in Org mode."
1723 :tag "Org Link"
1724 :group 'org)
1726 (defvar-local org-link-abbrev-alist-local nil
1727 "Buffer-local version of `org-link-abbrev-alist', which see.
1728 The value of this is taken from the #+LINK lines.")
1730 (defcustom org-link-parameters
1731 '(("doi" :follow org--open-doi-link)
1732 ("elisp" :follow org--open-elisp-link)
1733 ("file" :complete org-file-complete-link)
1734 ("ftp" :follow (lambda (path) (browse-url (concat "ftp:" path))))
1735 ("help" :follow org--open-help-link)
1736 ("http" :follow (lambda (path) (browse-url (concat "http:" path))))
1737 ("https" :follow (lambda (path) (browse-url (concat "https:" path))))
1738 ("mailto" :follow (lambda (path) (browse-url (concat "mailto:" path))))
1739 ("news" :follow (lambda (path) (browse-url (concat "news:" path))))
1740 ("shell" :follow org--open-shell-link))
1741 "An alist of properties that defines all the links in Org mode.
1742 The key in each association is a string of the link type.
1743 Subsequent optional elements make up a p-list of link properties.
1745 :follow - A function that takes the link path as an argument.
1747 :export - A function that takes the link path, description and
1748 export-backend as arguments.
1750 :store - A function responsible for storing the link. See the
1751 function `org-store-link-functions'.
1753 :complete - A function that inserts a link with completion. The
1754 function takes one optional prefix arg.
1756 :face - A face for the link, or a function that returns a face.
1757 The function takes one argument which is the link path. The
1758 default face is `org-link'.
1760 :mouse-face - The mouse-face. The default is `highlight'.
1762 :display - `full' will not fold the link in descriptive
1763 display. Default is `org-link'.
1765 :help-echo - A string or function that takes (window object position)
1766 as arguments and returns a string.
1768 :keymap - A keymap that is active on the link. The default is
1769 `org-mouse-map'.
1771 :htmlize-link - A function for the htmlize-link. Defaults
1772 to (list :uri \"type:path\")
1774 :activate-func - A function to run at the end of font-lock
1775 activation. The function must accept (link-start link-end path bracketp)
1776 as arguments."
1777 :group 'org-link
1778 :type '(alist :tag "Link display parameters"
1779 :value-type plist)
1780 :version "26.1"
1781 :package-version '(Org . "9.1"))
1783 (defun org-link-get-parameter (type key)
1784 "Get TYPE link property for KEY.
1785 TYPE is a string and KEY is a plist keyword."
1786 (plist-get
1787 (cdr (assoc type org-link-parameters))
1788 key))
1790 (defun org-link-set-parameters (type &rest parameters)
1791 "Set link TYPE properties to PARAMETERS.
1792 PARAMETERS should be :key val pairs."
1793 (let ((data (assoc type org-link-parameters)))
1794 (if data (setcdr data (org-combine-plists (cdr data) parameters))
1795 (push (cons type parameters) org-link-parameters)
1796 (org-make-link-regexps)
1797 (org-element-update-syntax))))
1799 (defun org-link-types ()
1800 "Return a list of known link types."
1801 (mapcar #'car org-link-parameters))
1803 (defcustom org-link-abbrev-alist nil
1804 "Alist of link abbreviations.
1805 The car of each element is a string, to be replaced at the start of a link.
1806 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1807 links in Org buffers can have an optional tag after a double colon, e.g.,
1809 [[linkkey:tag][description]]
1811 The `linkkey' must be a single word, starting with a letter, followed
1812 by letters, numbers, `-' or `_'.
1814 If REPLACE is a string, the tag will simply be appended to create the link.
1815 If the string contains \"%s\", the tag will be inserted there. If the string
1816 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1817 at that point (see the function `url-hexify-string'). If the string contains
1818 the specifier \"%(my-function)\", then the custom function `my-function' will
1819 be invoked: this function takes the tag as its only argument and must return
1820 a string.
1822 REPLACE may also be a function that will be called with the tag as the
1823 only argument to create the link, which should be returned as a string.
1825 See the manual for examples."
1826 :group 'org-link
1827 :type '(repeat
1828 (cons
1829 (string :tag "Protocol")
1830 (choice
1831 (string :tag "Format")
1832 (function)))))
1834 (defcustom org-descriptive-links t
1835 "Non-nil means Org will display descriptive links.
1836 E.g. [[http://orgmode.org][Org website]] will be displayed as
1837 \"Org Website\", hiding the link itself and just displaying its
1838 description. When set to nil, Org will display the full links
1839 literally.
1841 You can interactively set the value of this variable by calling
1842 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1843 :group 'org-link
1844 :type 'boolean)
1846 (defcustom org-link-file-path-type 'adaptive
1847 "How the path name in file links should be stored.
1848 Valid values are:
1850 relative Relative to the current directory, i.e. the directory of the file
1851 into which the link is being inserted.
1852 absolute Absolute path, if possible with ~ for home directory.
1853 noabbrev Absolute path, no abbreviation of home directory.
1854 adaptive Use relative path for files in the current directory and sub-
1855 directories of it. For other files, use an absolute path."
1856 :group 'org-link
1857 :type '(choice
1858 (const relative)
1859 (const absolute)
1860 (const noabbrev)
1861 (const adaptive)))
1863 (defvaralias 'org-activate-links 'org-highlight-links)
1864 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1865 "Types of links that should be highlighted in Org files.
1867 This is a list of symbols, each one of them leading to the
1868 highlighting of a certain link type.
1870 You can still open links that are not highlighted.
1872 In principle, it does not hurt to turn on highlighting for all
1873 link types. There may be a small gain when turning off unused
1874 link types. The types are:
1876 bracket The recommended [[link][description]] or [[link]] links with hiding.
1877 angle Links in angular brackets that may contain whitespace like
1878 <bbdb:Carsten Dominik>.
1879 plain Plain links in normal text, no whitespace, like http://google.com.
1880 radio Text that is matched by a radio target, see manual for details.
1881 tag Tag settings in a headline (link to tag search).
1882 date Time stamps (link to calendar).
1883 footnote Footnote labels.
1885 If you set this variable during an Emacs session, use `org-mode-restart'
1886 in the Org buffer so that the change takes effect."
1887 :group 'org-link
1888 :group 'org-appearance
1889 :type '(set :greedy t
1890 (const :tag "Double bracket links" bracket)
1891 (const :tag "Angular bracket links" angle)
1892 (const :tag "Plain text links" plain)
1893 (const :tag "Radio target matches" radio)
1894 (const :tag "Tags" tag)
1895 (const :tag "Timestamps" date)
1896 (const :tag "Footnotes" footnote)))
1898 (defcustom org-make-link-description-function nil
1899 "Function to use for generating link descriptions from links.
1900 This function must take two parameters: the first one is the
1901 link, the second one is the description generated by
1902 `org-insert-link'. The function should return the description to
1903 use."
1904 :group 'org-link
1905 :type '(choice (const nil) (function)))
1907 (defgroup org-link-store nil
1908 "Options concerning storing links in Org mode."
1909 :tag "Org Store Link"
1910 :group 'org-link)
1912 (defcustom org-url-hexify-p t
1913 "When non-nil, hexify URL when creating a link."
1914 :type 'boolean
1915 :version "24.3"
1916 :group 'org-link-store)
1918 (defcustom org-email-link-description-format "Email %c: %.30s"
1919 "Format of the description part of a link to an email or usenet message.
1920 The following %-escapes will be replaced by corresponding information:
1922 %F full \"From\" field
1923 %f name, taken from \"From\" field, address if no name
1924 %T full \"To\" field
1925 %t first name in \"To\" field, address if no name
1926 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1927 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1928 %s subject
1929 %d date
1930 %m message-id.
1932 You may use normal field width specification between the % and the letter.
1933 This is for example useful to limit the length of the subject.
1935 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1936 :group 'org-link-store
1937 :type 'string)
1939 (defcustom org-from-is-user-regexp
1940 (let (r1 r2)
1941 (when (and user-mail-address (not (string= user-mail-address "")))
1942 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1943 (when (and user-full-name (not (string= user-full-name "")))
1944 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1945 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1946 "Regexp matched against the \"From:\" header of an email or usenet message.
1947 It should match if the message is from the user him/herself."
1948 :group 'org-link-store
1949 :type 'regexp)
1951 (defcustom org-context-in-file-links t
1952 "Non-nil means file links from `org-store-link' contain context.
1953 \\<org-mode-map>
1954 A search string will be added to the file name with :: as separator
1955 and used to find the context when the link is activated by the command
1956 `org-open-at-point'. When this option is t, the entire active region
1957 will be placed in the search string of the file link. If set to a
1958 positive integer, only the first n lines of context will be stored.
1960 Using a prefix arg to the command `org-store-link' (`\\[universal-argument] \
1961 \\[org-store-link]')
1962 negates this setting for the duration of the command."
1963 :group 'org-link-store
1964 :type '(choice boolean integer))
1966 (defcustom org-keep-stored-link-after-insertion nil
1967 "Non-nil means keep link in list for entire session.
1968 \\<org-mode-map>
1969 The command `org-store-link' adds a link pointing to the current
1970 location to an internal list. These links accumulate during a session.
1971 The command `org-insert-link' can be used to insert links into any
1972 Org file (offering completion for all stored links).
1974 When this option is nil, every link which has been inserted once using
1975 `\\[org-insert-link]' will be removed from the list, to make completing the \
1976 unused
1977 links more efficient."
1978 :group 'org-link-store
1979 :type 'boolean)
1981 (defgroup org-link-follow nil
1982 "Options concerning following links in Org mode."
1983 :tag "Org Follow Link"
1984 :group 'org-link)
1986 (defcustom org-link-translation-function nil
1987 "Function to translate links with different syntax to Org syntax.
1988 This can be used to translate links created for example by the Planner
1989 or emacs-wiki packages to Org syntax.
1990 The function must accept two parameters, a TYPE containing the link
1991 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1992 which is everything after the link protocol. It should return a cons
1993 with possibly modified values of type and path.
1994 Org contains a function for this, so if you set this variable to
1995 `org-translate-link-from-planner', you should be able follow many
1996 links created by planner."
1997 :group 'org-link-follow
1998 :type '(choice (const nil) (function)))
2000 (defcustom org-follow-link-hook nil
2001 "Hook that is run after a link has been followed."
2002 :group 'org-link-follow
2003 :type 'hook)
2005 (defcustom org-tab-follows-link nil
2006 "Non-nil means on links TAB will follow the link.
2007 Needs to be set before org.el is loaded.
2008 This really should not be used, it does not make sense, and the
2009 implementation is bad."
2010 :group 'org-link-follow
2011 :type 'boolean)
2013 (defcustom org-return-follows-link nil
2014 "Non-nil means on links RET will follow the link.
2015 In tables, the special behavior of RET has precedence."
2016 :group 'org-link-follow
2017 :type 'boolean)
2019 (defcustom org-mouse-1-follows-link
2020 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
2021 "Non-nil means mouse-1 on a link will follow the link.
2022 A longer mouse click will still set point. Needs to be set
2023 before org.el is loaded."
2024 :group 'org-link-follow
2025 :version "26.1"
2026 :package-version '(Org . "8.3")
2027 :type '(choice
2028 (const :tag "A double click follows the link" double)
2029 (const :tag "Unconditionally follow the link with mouse-1" t)
2030 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2032 (defcustom org-mark-ring-length 4
2033 "Number of different positions to be recorded in the ring.
2034 Changing this requires a restart of Emacs to work correctly."
2035 :group 'org-link-follow
2036 :type 'integer)
2038 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2039 "Non-nil means internal fuzzy links can only match headlines.
2041 When nil, the a fuzzy link may point to a target or a named
2042 construct in the document. When set to the special value
2043 `query-to-create', offer to create a new headline when none
2044 matched.
2046 Spaces and statistics cookies are ignored during heading searches."
2047 :group 'org-link-follow
2048 :version "24.1"
2049 :type '(choice
2050 (const :tag "Use fuzzy text search" nil)
2051 (const :tag "Match only exact headline" t)
2052 (const :tag "Match exact headline or query to create it"
2053 query-to-create))
2054 :safe #'symbolp)
2056 (defcustom org-link-frame-setup
2057 '((vm . vm-visit-folder-other-frame)
2058 (vm-imap . vm-visit-imap-folder-other-frame)
2059 (gnus . org-gnus-no-new-news)
2060 (file . find-file-other-window)
2061 (wl . wl-other-frame))
2062 "Setup the frame configuration for following links.
2063 When following a link with Emacs, it may often be useful to display
2064 this link in another window or frame. This variable can be used to
2065 set this up for the different types of links.
2066 For VM, use any of
2067 `vm-visit-folder'
2068 `vm-visit-folder-other-window'
2069 `vm-visit-folder-other-frame'
2070 For Gnus, use any of
2071 `gnus'
2072 `gnus-other-frame'
2073 `org-gnus-no-new-news'
2074 For FILE, use any of
2075 `find-file'
2076 `find-file-other-window'
2077 `find-file-other-frame'
2078 For Wanderlust use any of
2079 `wl'
2080 `wl-other-frame'
2081 For the calendar, use the variable `calendar-setup'.
2082 For BBDB, it is currently only possible to display the matches in
2083 another window."
2084 :group 'org-link-follow
2085 :type '(list
2086 (cons (const vm)
2087 (choice
2088 (const vm-visit-folder)
2089 (const vm-visit-folder-other-window)
2090 (const vm-visit-folder-other-frame)))
2091 (cons (const vm-imap)
2092 (choice
2093 (const vm-visit-imap-folder)
2094 (const vm-visit-imap-folder-other-window)
2095 (const vm-visit-imap-folder-other-frame)))
2096 (cons (const gnus)
2097 (choice
2098 (const gnus)
2099 (const gnus-other-frame)
2100 (const org-gnus-no-new-news)))
2101 (cons (const file)
2102 (choice
2103 (const find-file)
2104 (const find-file-other-window)
2105 (const find-file-other-frame)))
2106 (cons (const wl)
2107 (choice
2108 (const wl)
2109 (const wl-other-frame)))))
2111 (defcustom org-display-internal-link-with-indirect-buffer nil
2112 "Non-nil means use indirect buffer to display infile links.
2113 Activating internal links (from one location in a file to another location
2114 in the same file) normally just jumps to the location. When the link is
2115 activated with a `\\[universal-argument]' prefix (or with mouse-3), the link \
2116 is displayed in
2117 another window. When this option is set, the other window actually displays
2118 an indirect buffer clone of the current buffer, to avoid any visibility
2119 changes to the current buffer."
2120 :group 'org-link-follow
2121 :type 'boolean)
2123 (defcustom org-open-non-existing-files nil
2124 "Non-nil means `org-open-file' will open non-existing files.
2125 When nil, an error will be generated.
2126 This variable applies only to external applications because they
2127 might choke on non-existing files. If the link is to a file that
2128 will be opened in Emacs, the variable is ignored."
2129 :group 'org-link-follow
2130 :type 'boolean)
2132 (defcustom org-open-directory-means-index-dot-org nil
2133 "Non-nil means a link to a directory really means to index.org.
2134 When nil, following a directory link will run dired or open a finder/explorer
2135 window on that directory."
2136 :group 'org-link-follow
2137 :type 'boolean)
2139 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2140 "Non-nil means ask for confirmation before executing shell links.
2141 Shell links can be dangerous: just think about a link
2143 [[shell:rm -rf ~/*][Google Search]]
2145 This link would show up in your Org document as \"Google Search\",
2146 but really it would remove your entire home directory.
2147 Therefore we advise against setting this variable to nil.
2148 Just change it to `y-or-n-p' if you want to confirm with a
2149 single keystroke rather than having to type \"yes\"."
2150 :group 'org-link-follow
2151 :type '(choice
2152 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2153 (const :tag "with y-or-n (faster)" y-or-n-p)
2154 (const :tag "no confirmation (dangerous)" nil)))
2155 (put 'org-confirm-shell-link-function
2156 'safe-local-variable
2157 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2159 (defcustom org-confirm-shell-link-not-regexp ""
2160 "A regexp to skip confirmation for shell links."
2161 :group 'org-link-follow
2162 :version "24.1"
2163 :type 'regexp)
2165 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2166 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2167 Elisp links can be dangerous: just think about a link
2169 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2171 This link would show up in your Org document as \"Google Search\",
2172 but really it would remove your entire home directory.
2173 Therefore we advise against setting this variable to nil.
2174 Just change it to `y-or-n-p' if you want to confirm with a
2175 single keystroke rather than having to type \"yes\"."
2176 :group 'org-link-follow
2177 :type '(choice
2178 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2179 (const :tag "with y-or-n (faster)" y-or-n-p)
2180 (const :tag "no confirmation (dangerous)" nil)))
2181 (put 'org-confirm-shell-link-function
2182 'safe-local-variable
2183 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2185 (defcustom org-confirm-elisp-link-not-regexp ""
2186 "A regexp to skip confirmation for Elisp links."
2187 :group 'org-link-follow
2188 :version "24.1"
2189 :type 'regexp)
2191 (defconst org-file-apps-defaults-gnu
2192 '((remote . emacs)
2193 (system . mailcap)
2194 (t . mailcap))
2195 "Default file applications on a UNIX or GNU/Linux system.
2196 See `org-file-apps'.")
2198 (defconst org-file-apps-defaults-macosx
2199 '((remote . emacs)
2200 (system . "open %s")
2201 ("ps.gz" . "gv %s")
2202 ("eps.gz" . "gv %s")
2203 ("dvi" . "xdvi %s")
2204 ("fig" . "xfig %s")
2205 (t . "open %s"))
2206 "Default file applications on a macOS system.
2207 The system \"open\" is known as a default, but we use X11 applications
2208 for some files for which the OS does not have a good default.
2209 See `org-file-apps'.")
2211 (defconst org-file-apps-defaults-windowsnt
2212 (list '(remote . emacs)
2213 (cons 'system (lambda (file _path)
2214 (with-no-warnings (w32-shell-execute "open" file))))
2215 (cons t (lambda (file _path)
2216 (with-no-warnings (w32-shell-execute "open" file)))))
2217 "Default file applications on a Windows NT system.
2218 The system \"open\" is used for most files.
2219 See `org-file-apps'.")
2221 (defcustom org-file-apps
2222 '((auto-mode . emacs)
2223 ("\\.mm\\'" . default)
2224 ("\\.x?html?\\'" . default)
2225 ("\\.pdf\\'" . default))
2226 "External applications for opening `file:path' items in a document.
2227 \\<org-mode-map>\
2229 Org mode uses system defaults for different file types, but
2230 you can use this variable to set the application for a given file
2231 extension. The entries in this list are cons cells where the car identifies
2232 files and the cdr the corresponding command.
2234 Possible values for the file identifier are:
2236 \"string\" A string as a file identifier can be interpreted in different
2237 ways, depending on its contents:
2239 - Alphanumeric characters only:
2240 Match links with this file extension.
2241 Example: (\"pdf\" . \"evince %s\")
2242 to open PDFs with evince.
2244 - Regular expression: Match links where the
2245 filename matches the regexp. If you want to
2246 use groups here, use shy groups.
2248 Example: (\"\\\\.x?html\\\\\\='\" . \"firefox %s\")
2249 (\"\\\\(?:xhtml\\\\|html\\\\)\\\\\\='\" . \"firefox %s\")
2250 to open *.html and *.xhtml with firefox.
2252 - Regular expression which contains (non-shy) groups:
2253 Match links where the whole link, including \"::\", and
2254 anything after that, matches the regexp.
2255 In a custom command string, %1, %2, etc. are replaced with
2256 the parts of the link that were matched by the groups.
2257 For backwards compatibility, if a command string is given
2258 that does not use any of the group matches, this case is
2259 handled identically to the second one (i.e. match against
2260 file name only).
2261 In a custom function, you can access the group matches with
2262 (match-string n link).
2264 Example: (\"\\\\.pdf::\\\\(\\\\d+\\\\)\\\\\\='\" . \
2265 \"evince -p %1 %s\")
2266 to open [[file:document.pdf::5]] with evince at page 5.
2268 `directory' Matches a directory
2269 `remote' Matches a remote file, accessible through tramp or efs.
2270 Remote files most likely should be visited through Emacs
2271 because external applications cannot handle such paths.
2272 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2273 so all files Emacs knows how to handle. Using this with
2274 command `emacs' will open most files in Emacs. Beware that this
2275 will also open html files inside Emacs, unless you add
2276 (\"html\" . default) to the list as well.
2277 `system' The system command to open files, like `open' on Windows
2278 and macOS, and mailcap under GNU/Linux. This is the command
2279 that will be selected if you call `org-open-at-point' with a
2280 double prefix argument (`\\[universal-argument] \
2281 \\[universal-argument] \\[org-open-at-point]').
2282 t Default for files not matched by any of the other options.
2284 Possible values for the command are:
2286 `emacs' The file will be visited by the current Emacs process.
2287 `default' Use the default application for this file type, which is the
2288 association for t in the list, most likely in the system-specific
2289 part. This can be used to overrule an unwanted setting in the
2290 system-specific variable.
2291 `system' Use the system command for opening files, like \"open\".
2292 This command is specified by the entry whose car is `system'.
2293 Most likely, the system-specific version of this variable
2294 does define this command, but you can overrule/replace it
2295 here.
2296 `mailcap' Use command specified in the mailcaps.
2297 string A command to be executed by a shell; %s will be replaced
2298 by the path to the file.
2299 function A Lisp function, which will be called with two arguments:
2300 the file path and the original link string, without the
2301 \"file:\" prefix.
2303 For more examples, see the system specific constants
2304 `org-file-apps-defaults-macosx'
2305 `org-file-apps-defaults-windowsnt'
2306 `org-file-apps-defaults-gnu'."
2307 :group 'org-link-follow
2308 :type '(repeat
2309 (cons (choice :value ""
2310 (string :tag "Extension")
2311 (const :tag "System command to open files" system)
2312 (const :tag "Default for unrecognized files" t)
2313 (const :tag "Remote file" remote)
2314 (const :tag "Links to a directory" directory)
2315 (const :tag "Any files that have Emacs modes"
2316 auto-mode))
2317 (choice :value ""
2318 (const :tag "Visit with Emacs" emacs)
2319 (const :tag "Use default" default)
2320 (const :tag "Use the system command" system)
2321 (string :tag "Command")
2322 (function :tag "Function")))))
2324 (defcustom org-doi-server-url "http://dx.doi.org/"
2325 "The URL of the DOI server."
2326 :type 'string
2327 :version "24.3"
2328 :group 'org-link-follow)
2330 (defgroup org-refile nil
2331 "Options concerning refiling entries in Org mode."
2332 :tag "Org Refile"
2333 :group 'org)
2335 (defcustom org-directory "~/org"
2336 "Directory with Org files.
2337 This is just a default location to look for Org files. There is no need
2338 at all to put your files into this directory. It is used in the
2339 following situations:
2341 1. When a capture template specifies a target file that is not an
2342 absolute path. The path will then be interpreted relative to
2343 `org-directory'
2344 2. When the value of variable `org-agenda-files' is a single file, any
2345 relative paths in this file will be taken as relative to
2346 `org-directory'."
2347 :group 'org-refile
2348 :group 'org-capture
2349 :type 'directory)
2351 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2352 "Default target for storing notes.
2353 Used as a fall back file for org-capture.el, for templates that
2354 do not specify a target file."
2355 :group 'org-refile
2356 :group 'org-capture
2357 :type 'file)
2359 (defcustom org-reverse-note-order nil
2360 "Non-nil means store new notes at the beginning of a file or entry.
2361 When nil, new notes will be filed to the end of a file or entry.
2362 This can also be a list with cons cells of regular expressions that
2363 are matched against file names, and values."
2364 :group 'org-capture
2365 :group 'org-refile
2366 :type '(choice
2367 (const :tag "Reverse always" t)
2368 (const :tag "Reverse never" nil)
2369 (repeat :tag "By file name regexp"
2370 (cons regexp boolean))))
2372 (defcustom org-log-refile nil
2373 "Information to record when a task is refiled.
2375 Possible values are:
2377 nil Don't add anything
2378 time Add a time stamp to the task
2379 note Prompt for a note and add it with template `org-log-note-headings'
2381 This option can also be set with on a per-file-basis with
2383 #+STARTUP: nologrefile
2384 #+STARTUP: logrefile
2385 #+STARTUP: lognoterefile
2387 You can have local logging settings for a subtree by setting the LOGGING
2388 property to one or more of these keywords.
2390 When bulk-refiling from the agenda, the value `note' is forbidden and
2391 will temporarily be changed to `time'."
2392 :group 'org-refile
2393 :group 'org-progress
2394 :version "24.1"
2395 :type '(choice
2396 (const :tag "No logging" nil)
2397 (const :tag "Record timestamp" time)
2398 (const :tag "Record timestamp with note." note)))
2400 (defcustom org-refile-targets nil
2401 "Targets for refiling entries with `\\[org-refile]'.
2402 This is a list of cons cells. Each cell contains:
2403 - a specification of the files to be considered, either a list of files,
2404 or a symbol whose function or variable value will be used to retrieve
2405 a file name or a list of file names. If you use `org-agenda-files' for
2406 that, all agenda files will be scanned for targets. Nil means consider
2407 headings in the current buffer.
2408 - A specification of how to find candidate refile targets. This may be
2409 any of:
2410 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2411 This tag has to be present in all target headlines, inheritance will
2412 not be considered.
2413 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2414 todo keyword.
2415 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2416 headlines that are refiling targets.
2417 - a cons cell (:level . N). Any headline of level N is considered a target.
2418 Note that, when `org-odd-levels-only' is set, level corresponds to
2419 order in hierarchy, not to the number of stars.
2420 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2421 Note that, when `org-odd-levels-only' is set, level corresponds to
2422 order in hierarchy, not to the number of stars.
2424 Each element of this list generates a set of possible targets.
2425 The union of these sets is presented (with completion) to
2426 the user by `org-refile'.
2428 You can set the variable `org-refile-target-verify-function' to a function
2429 to verify each headline found by the simple criteria above.
2431 When this variable is nil, all top-level headlines in the current buffer
2432 are used, equivalent to the value `((nil . (:level . 1))'."
2433 :group 'org-refile
2434 :type '(repeat
2435 (cons
2436 (choice :value org-agenda-files
2437 (const :tag "All agenda files" org-agenda-files)
2438 (const :tag "Current buffer" nil)
2439 (function) (variable) (file))
2440 (choice :tag "Identify target headline by"
2441 (cons :tag "Specific tag" (const :value :tag) (string))
2442 (cons :tag "TODO keyword" (const :value :todo) (string))
2443 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2444 (cons :tag "Level number" (const :value :level) (integer))
2445 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2447 (defcustom org-refile-target-verify-function nil
2448 "Function to verify if the headline at point should be a refile target.
2449 The function will be called without arguments, with point at the
2450 beginning of the headline. It should return t and leave point
2451 where it is if the headline is a valid target for refiling.
2453 If the target should not be selected, the function must return nil.
2454 In addition to this, it may move point to a place from where the search
2455 should be continued. For example, the function may decide that the entire
2456 subtree of the current entry should be excluded and move point to the end
2457 of the subtree."
2458 :group 'org-refile
2459 :type '(choice
2460 (const nil)
2461 (function)))
2463 (defcustom org-refile-use-cache nil
2464 "Non-nil means cache refile targets to speed up the process.
2465 \\<org-mode-map>\
2466 The cache for a particular file will be updated automatically when
2467 the buffer has been killed, or when any of the marker used for flagging
2468 refile targets no longer points at a live buffer.
2469 If you have added new entries to a buffer that might themselves be targets,
2470 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2471 if you find that easier, \
2472 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2473 \\[org-refile]'."
2474 :group 'org-refile
2475 :version "24.1"
2476 :type 'boolean)
2478 (defcustom org-refile-use-outline-path nil
2479 "Non-nil means provide refile targets as paths.
2480 So a level 3 headline will be available as level1/level2/level3.
2482 When the value is `file', also include the file name (without directory)
2483 into the path. In this case, you can also stop the completion after
2484 the file name, to get entries inserted as top level in the file.
2486 When `full-file-path', include the full file path.
2488 When `buffer-name', use the buffer name."
2489 :group 'org-refile
2490 :type '(choice
2491 (const :tag "Not" nil)
2492 (const :tag "Yes" t)
2493 (const :tag "Start with file name" file)
2494 (const :tag "Start with full file path" full-file-path)
2495 (const :tag "Start with buffer name" buffer-name)))
2497 (defcustom org-outline-path-complete-in-steps t
2498 "Non-nil means complete the outline path in hierarchical steps.
2499 When Org uses the refile interface to select an outline path (see
2500 `org-refile-use-outline-path'), the completion of the path can be
2501 done in a single go, or it can be done in steps down the headline
2502 hierarchy. Going in steps is probably the best if you do not use
2503 a special completion package like `ido' or `icicles'. However,
2504 when using these packages, going in one step can be very fast,
2505 while still showing the whole path to the entry."
2506 :group 'org-refile
2507 :type 'boolean)
2509 (defcustom org-refile-allow-creating-parent-nodes nil
2510 "Non-nil means allow the creation of new nodes as refile targets.
2511 New nodes are then created by adding \"/new node name\" to the completion
2512 of an existing node. When the value of this variable is `confirm',
2513 new node creation must be confirmed by the user (recommended).
2514 When nil, the completion must match an existing entry.
2516 Note that, if the new heading is not seen by the criteria
2517 listed in `org-refile-targets', multiple instances of the same
2518 heading would be created by trying again to file under the new
2519 heading."
2520 :group 'org-refile
2521 :type '(choice
2522 (const :tag "Never" nil)
2523 (const :tag "Always" t)
2524 (const :tag "Prompt for confirmation" confirm)))
2526 (defcustom org-refile-active-region-within-subtree nil
2527 "Non-nil means also refile active region within a subtree.
2529 By default `org-refile' doesn't allow refiling regions if they
2530 don't contain a set of subtrees, but it might be convenient to
2531 do so sometimes: in that case, the first line of the region is
2532 converted to a headline before refiling."
2533 :group 'org-refile
2534 :version "24.1"
2535 :type 'boolean)
2537 (defgroup org-todo nil
2538 "Options concerning TODO items in Org mode."
2539 :tag "Org TODO"
2540 :group 'org)
2542 (defgroup org-progress nil
2543 "Options concerning Progress logging in Org mode."
2544 :tag "Org Progress"
2545 :group 'org-time)
2547 (defvar org-todo-interpretation-widgets
2548 '((:tag "Sequence (cycling hits every state)" sequence)
2549 (:tag "Type (cycling directly to DONE)" type))
2550 "The available interpretation symbols for customizing `org-todo-keywords'.
2551 Interested libraries should add to this list.")
2553 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2554 "List of TODO entry keyword sequences and their interpretation.
2555 \\<org-mode-map>This is a list of sequences.
2557 Each sequence starts with a symbol, either `sequence' or `type',
2558 indicating if the keywords should be interpreted as a sequence of
2559 action steps, or as different types of TODO items. The first
2560 keywords are states requiring action - these states will select a headline
2561 for inclusion into the global TODO list Org produces. If one of the
2562 \"keywords\" is the vertical bar, \"|\", the remaining keywords
2563 signify that no further action is necessary. If \"|\" is not found,
2564 the last keyword is treated as the only DONE state of the sequence.
2566 The command `\\[org-todo]' cycles an entry through these states, and one
2567 additional state where no keyword is present. For details about this
2568 cycling, see the manual.
2570 TODO keywords and interpretation can also be set on a per-file basis with
2571 the special #+SEQ_TODO and #+TYP_TODO lines.
2573 Each keyword can optionally specify a character for fast state selection
2574 \(in combination with the variable `org-use-fast-todo-selection')
2575 and specifiers for state change logging, using the same syntax that
2576 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2577 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2578 indicates to record a time stamp each time this state is selected.
2580 Each keyword may also specify if a timestamp or a note should be
2581 recorded when entering or leaving the state, by adding additional
2582 characters in the parenthesis after the keyword. This looks like this:
2583 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2584 record only the time of the state change. With X and Y being either
2585 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2586 Y when leaving the state if and only if the *target* state does not
2587 define X. You may omit any of the fast-selection key or X or /Y,
2588 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2590 For backward compatibility, this variable may also be just a list
2591 of keywords. In this case the interpretation (sequence or type) will be
2592 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2593 :group 'org-todo
2594 :group 'org-keywords
2595 :type '(choice
2596 (repeat :tag "Old syntax, just keywords"
2597 (string :tag "Keyword"))
2598 (repeat :tag "New syntax"
2599 (cons
2600 (choice
2601 :tag "Interpretation"
2602 ;;Quick and dirty way to see
2603 ;;`org-todo-interpretations'. This takes the
2604 ;;place of item arguments
2605 :convert-widget
2606 (lambda (widget)
2607 (widget-put widget
2608 :args (mapcar
2609 (lambda (x)
2610 (widget-convert
2611 (cons 'const x)))
2612 org-todo-interpretation-widgets))
2613 widget))
2614 (repeat
2615 (string :tag "Keyword"))))))
2617 (defvar-local org-todo-keywords-1 nil
2618 "All TODO and DONE keywords active in a buffer.")
2619 (defvar org-todo-keywords-for-agenda nil)
2620 (defvar org-done-keywords-for-agenda nil)
2621 (defvar org-todo-keyword-alist-for-agenda nil)
2622 (defvar org-tag-alist-for-agenda nil
2623 "Alist of all tags from all agenda files.")
2624 (defvar org-tag-groups-alist-for-agenda nil
2625 "Alist of all groups tags from all current agenda files.")
2626 (defvar-local org-tag-groups-alist nil)
2627 (defvar org-agenda-contributing-files nil)
2628 (defvar-local org-current-tag-alist nil
2629 "Alist of all tag groups in current buffer.
2630 This variable takes into consideration `org-tag-alist',
2631 `org-tag-persistent-alist' and TAGS keywords in the buffer.")
2632 (defvar-local org-not-done-keywords nil)
2633 (defvar-local org-done-keywords nil)
2634 (defvar-local org-todo-heads nil)
2635 (defvar-local org-todo-sets nil)
2636 (defvar-local org-todo-log-states nil)
2637 (defvar-local org-todo-kwd-alist nil)
2638 (defvar-local org-todo-key-alist nil)
2639 (defvar-local org-todo-key-trigger nil)
2641 (defcustom org-todo-interpretation 'sequence
2642 "Controls how TODO keywords are interpreted.
2643 This variable is in principle obsolete and is only used for
2644 backward compatibility, if the interpretation of todo keywords is
2645 not given already in `org-todo-keywords'. See that variable for
2646 more information."
2647 :group 'org-todo
2648 :group 'org-keywords
2649 :type '(choice (const sequence)
2650 (const type)))
2652 (defcustom org-use-fast-todo-selection t
2653 "\\<org-mode-map>\
2654 Non-nil means use the fast todo selection scheme with `\\[org-todo]'.
2655 This variable describes if and under what circumstances the cycling
2656 mechanism for TODO keywords will be replaced by a single-key, direct
2657 selection scheme.
2659 When nil, fast selection is never used.
2661 When the symbol `prefix', it will be used when `org-todo' is called
2662 with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
2663 in an Org buffer, and
2664 `\\[universal-argument] t' in an agenda buffer.
2666 When t, fast selection is used by default. In this case, the prefix
2667 argument forces cycling instead.
2669 In all cases, the special interface is only used if access keys have
2670 actually been assigned by the user, i.e. if keywords in the configuration
2671 are followed by a letter in parenthesis, like TODO(t)."
2672 :group 'org-todo
2673 :type '(choice
2674 (const :tag "Never" nil)
2675 (const :tag "By default" t)
2676 (const :tag "Only with C-u C-c C-t" prefix)))
2678 (defcustom org-provide-todo-statistics t
2679 "Non-nil means update todo statistics after insert and toggle.
2680 ALL-HEADLINES means update todo statistics by including headlines
2681 with no TODO keyword as well, counting them as not done.
2682 A list of TODO keywords means the same, but skip keywords that are
2683 not in this list.
2684 When set to a list of two lists, the first list contains keywords
2685 to consider as TODO keywords, the second list contains keywords
2686 to consider as DONE keywords.
2688 When this is set, todo statistics is updated in the parent of the
2689 current entry each time a todo state is changed."
2690 :group 'org-todo
2691 :type '(choice
2692 (const :tag "Yes, only for TODO entries" t)
2693 (const :tag "Yes, including all entries" all-headlines)
2694 (repeat :tag "Yes, for TODOs in this list"
2695 (string :tag "TODO keyword"))
2696 (list :tag "Yes, for TODOs and DONEs in these lists"
2697 (repeat (string :tag "TODO keyword"))
2698 (repeat (string :tag "DONE keyword")))
2699 (other :tag "No TODO statistics" nil)))
2701 (defcustom org-hierarchical-todo-statistics t
2702 "Non-nil means TODO statistics covers just direct children.
2703 When nil, all entries in the subtree are considered.
2704 This has only an effect if `org-provide-todo-statistics' is set.
2705 To set this to nil for only a single subtree, use a COOKIE_DATA
2706 property and include the word \"recursive\" into the value."
2707 :group 'org-todo
2708 :type 'boolean)
2710 (defcustom org-after-todo-state-change-hook nil
2711 "Hook which is run after the state of a TODO item was changed.
2712 The new state (a string with a TODO keyword, or nil) is available in the
2713 Lisp variable `org-state'."
2714 :group 'org-todo
2715 :type 'hook)
2717 (defvar org-blocker-hook nil
2718 "Hook for functions that are allowed to block a state change.
2720 Functions in this hook should not modify the buffer.
2721 Each function gets as its single argument a property list,
2722 see `org-trigger-hook' for more information about this list.
2724 If any of the functions in this hook returns nil, the state change
2725 is blocked.")
2727 (defvar org-trigger-hook nil
2728 "Hook for functions that are triggered by a state change.
2730 Each function gets as its single argument a property list with at
2731 least the following elements:
2733 (:type type-of-change :position pos-at-entry-start
2734 :from old-state :to new-state)
2736 Depending on the type, more properties may be present.
2738 This mechanism is currently implemented for:
2740 TODO state changes
2741 ------------------
2742 :type todo-state-change
2743 :from previous state (keyword as a string), or nil, or a symbol
2744 `todo' or `done', to indicate the general type of state.
2745 :to new state, like in :from")
2747 (defcustom org-enforce-todo-dependencies nil
2748 "Non-nil means undone TODO entries will block switching the parent to DONE.
2749 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2750 be blocked if any prior sibling is not yet done.
2751 Finally, if the parent is blocked because of ordered siblings of its own,
2752 the child will also be blocked."
2753 :set (lambda (var val)
2754 (set var val)
2755 (if val
2756 (add-hook 'org-blocker-hook
2757 'org-block-todo-from-children-or-siblings-or-parent)
2758 (remove-hook 'org-blocker-hook
2759 'org-block-todo-from-children-or-siblings-or-parent)))
2760 :group 'org-todo
2761 :type 'boolean)
2763 (defcustom org-enforce-todo-checkbox-dependencies nil
2764 "Non-nil means unchecked boxes will block switching the parent to DONE.
2765 When this is nil, checkboxes have no influence on switching TODO states.
2766 When non-nil, you first need to check off all check boxes before the TODO
2767 entry can be switched to DONE.
2768 This variable needs to be set before org.el is loaded, and you need to
2769 restart Emacs after a change to make the change effective. The only way
2770 to change is while Emacs is running is through the customize interface."
2771 :set (lambda (var val)
2772 (set var val)
2773 (if val
2774 (add-hook 'org-blocker-hook
2775 'org-block-todo-from-checkboxes)
2776 (remove-hook 'org-blocker-hook
2777 'org-block-todo-from-checkboxes)))
2778 :group 'org-todo
2779 :type 'boolean)
2781 (defcustom org-treat-insert-todo-heading-as-state-change nil
2782 "Non-nil means inserting a TODO heading is treated as state change.
2783 So when the command `\\[org-insert-todo-heading]' is used, state change
2784 logging will apply if appropriate. When nil, the new TODO item will
2785 be inserted directly, and no logging will take place."
2786 :group 'org-todo
2787 :type 'boolean)
2789 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2790 "Non-nil means switching TODO states with S-cursor counts as state change.
2791 This is the default behavior. However, setting this to nil allows a
2792 convenient way to select a TODO state and bypass any logging associated
2793 with that."
2794 :group 'org-todo
2795 :type 'boolean)
2797 (defcustom org-todo-state-tags-triggers nil
2798 "Tag changes that should be triggered by TODO state changes.
2799 This is a list. Each entry is
2801 (state-change (tag . flag) .......)
2803 State-change can be a string with a state, and empty string to indicate the
2804 state that has no TODO keyword, or it can be one of the symbols `todo'
2805 or `done', meaning any not-done or done state, respectively."
2806 :group 'org-todo
2807 :group 'org-tags
2808 :type '(repeat
2809 (cons (choice :tag "When changing to"
2810 (const :tag "Not-done state" todo)
2811 (const :tag "Done state" done)
2812 (string :tag "State"))
2813 (repeat
2814 (cons :tag "Tag action"
2815 (string :tag "Tag")
2816 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2818 (defcustom org-log-done nil
2819 "Information to record when a task moves to the DONE state.
2821 Possible values are:
2823 nil Don't add anything, just change the keyword
2824 time Add a time stamp to the task
2825 note Prompt for a note and add it with template `org-log-note-headings'
2827 This option can also be set with on a per-file-basis with
2829 #+STARTUP: nologdone
2830 #+STARTUP: logdone
2831 #+STARTUP: lognotedone
2833 You can have local logging settings for a subtree by setting the LOGGING
2834 property to one or more of these keywords."
2835 :group 'org-todo
2836 :group 'org-progress
2837 :type '(choice
2838 (const :tag "No logging" nil)
2839 (const :tag "Record CLOSED timestamp" time)
2840 (const :tag "Record CLOSED timestamp with note." note)))
2842 ;; Normalize old uses of org-log-done.
2843 (cond
2844 ((eq org-log-done t) (setq org-log-done 'time))
2845 ((and (listp org-log-done) (memq 'done org-log-done))
2846 (setq org-log-done 'note)))
2848 (defcustom org-log-reschedule nil
2849 "Information to record when the scheduling date of a tasks is modified.
2851 Possible values are:
2853 nil Don't add anything, just change the date
2854 time Add a time stamp to the task
2855 note Prompt for a note and add it with template `org-log-note-headings'
2857 This option can also be set with on a per-file-basis with
2859 #+STARTUP: nologreschedule
2860 #+STARTUP: logreschedule
2861 #+STARTUP: lognotereschedule"
2862 :group 'org-todo
2863 :group 'org-progress
2864 :type '(choice
2865 (const :tag "No logging" nil)
2866 (const :tag "Record timestamp" time)
2867 (const :tag "Record timestamp with note." note)))
2869 (defcustom org-log-redeadline nil
2870 "Information to record when the deadline date of a tasks is modified.
2872 Possible values are:
2874 nil Don't add anything, just change the date
2875 time Add a time stamp to the task
2876 note Prompt for a note and add it with template `org-log-note-headings'
2878 This option can also be set with on a per-file-basis with
2880 #+STARTUP: nologredeadline
2881 #+STARTUP: logredeadline
2882 #+STARTUP: lognoteredeadline
2884 You can have local logging settings for a subtree by setting the LOGGING
2885 property to one or more of these keywords."
2886 :group 'org-todo
2887 :group 'org-progress
2888 :type '(choice
2889 (const :tag "No logging" nil)
2890 (const :tag "Record timestamp" time)
2891 (const :tag "Record timestamp with note." note)))
2893 (defcustom org-log-note-clock-out nil
2894 "Non-nil means record a note when clocking out of an item.
2895 This can also be configured on a per-file basis by adding one of
2896 the following lines anywhere in the buffer:
2898 #+STARTUP: lognoteclock-out
2899 #+STARTUP: nolognoteclock-out"
2900 :group 'org-todo
2901 :group 'org-progress
2902 :type 'boolean)
2904 (defcustom org-log-done-with-time t
2905 "Non-nil means the CLOSED time stamp will contain date and time.
2906 When nil, only the date will be recorded."
2907 :group 'org-progress
2908 :type 'boolean)
2910 (defcustom org-log-note-headings
2911 '((done . "CLOSING NOTE %t")
2912 (state . "State %-12s from %-12S %t")
2913 (note . "Note taken on %t")
2914 (reschedule . "Rescheduled from %S on %t")
2915 (delschedule . "Not scheduled, was %S on %t")
2916 (redeadline . "New deadline from %S on %t")
2917 (deldeadline . "Removed deadline, was %S on %t")
2918 (refile . "Refiled on %t")
2919 (clock-out . ""))
2920 "Headings for notes added to entries.
2922 The value is an alist, with the car being a symbol indicating the
2923 note context, and the cdr is the heading to be used. The heading
2924 may also be the empty string. The following placeholders can be
2925 used:
2927 %t a time stamp.
2928 %T an active time stamp instead the default inactive one
2929 %d a short-format time stamp.
2930 %D an active short-format time stamp.
2931 %s the new TODO state or time stamp (inactive), in double quotes.
2932 %S the old TODO state or time stamp (inactive), in double quotes.
2933 %u the user name.
2934 %U full user name.
2936 In fact, it is not a good idea to change the `state' entry,
2937 because Agenda Log mode depends on the format of these entries."
2938 :group 'org-todo
2939 :group 'org-progress
2940 :type '(list :greedy t
2941 (cons (const :tag "Heading when closing an item" done) string)
2942 (cons (const :tag
2943 "Heading when changing todo state (todo sequence only)"
2944 state) string)
2945 (cons (const :tag "Heading when just taking a note" note) string)
2946 (cons (const :tag "Heading when rescheduling" reschedule) string)
2947 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2948 (cons (const :tag "Heading when changing deadline" redeadline) string)
2949 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2950 (cons (const :tag "Heading when refiling" refile) string)
2951 (cons (const :tag "Heading when clocking out" clock-out) string)))
2953 (unless (assq 'note org-log-note-headings)
2954 (push '(note . "%t") org-log-note-headings))
2956 (defcustom org-log-into-drawer nil
2957 "Non-nil means insert state change notes and time stamps into a drawer.
2958 When nil, state changes notes will be inserted after the headline and
2959 any scheduling and clock lines, but not inside a drawer.
2961 The value of this variable should be the name of the drawer to use.
2962 LOGBOOK is proposed as the default drawer for this purpose, you can
2963 also set this to a string to define the drawer of your choice.
2965 A value of t is also allowed, representing \"LOGBOOK\".
2967 A value of t or nil can also be set with on a per-file-basis with
2969 #+STARTUP: logdrawer
2970 #+STARTUP: nologdrawer
2972 If this variable is set, `org-log-state-notes-insert-after-drawers'
2973 will be ignored.
2975 You can set the property LOG_INTO_DRAWER to overrule this setting for
2976 a subtree.
2978 Do not check directly this variable in a Lisp program. Call
2979 function `org-log-into-drawer' instead."
2980 :group 'org-todo
2981 :group 'org-progress
2982 :type '(choice
2983 (const :tag "Not into a drawer" nil)
2984 (const :tag "LOGBOOK" t)
2985 (string :tag "Other")))
2987 (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2989 (defun org-log-into-drawer ()
2990 "Name of the log drawer, as a string, or nil.
2991 This is the value of `org-log-into-drawer'. However, if the
2992 current entry has or inherits a LOG_INTO_DRAWER property, it will
2993 be used instead of the default value."
2994 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2995 (cond ((equal p "nil") nil)
2996 ((equal p "t") "LOGBOOK")
2997 ((stringp p) p)
2998 (p "LOGBOOK")
2999 ((stringp org-log-into-drawer) org-log-into-drawer)
3000 (org-log-into-drawer "LOGBOOK"))))
3002 (defcustom org-log-state-notes-insert-after-drawers nil
3003 "Non-nil means insert state change notes after any drawers in entry.
3004 Only the drawers that *immediately* follow the headline and the
3005 deadline/scheduled line are skipped.
3006 When nil, insert notes right after the heading and perhaps the line
3007 with deadline/scheduling if present.
3009 This variable will have no effect if `org-log-into-drawer' is
3010 set."
3011 :group 'org-todo
3012 :group 'org-progress
3013 :type 'boolean)
3015 (defcustom org-log-states-order-reversed t
3016 "Non-nil means the latest state note will be directly after heading.
3017 When nil, the state change notes will be ordered according to time.
3019 This option can also be set with on a per-file-basis with
3021 #+STARTUP: logstatesreversed
3022 #+STARTUP: nologstatesreversed"
3023 :group 'org-todo
3024 :group 'org-progress
3025 :type 'boolean)
3027 (defcustom org-todo-repeat-to-state nil
3028 "The TODO state to which a repeater should return the repeating task.
3029 By default this is the first task of a TODO sequence or the
3030 previous state of a TYPE_TODO set. But you can specify to use
3031 the previous state in a TODO sequence or a string.
3033 Alternatively, you can set the :REPEAT_TO_STATE: property of the
3034 entry, which has precedence over this option."
3035 :group 'org-todo
3036 :version "24.1"
3037 :type '(choice (const :tag "Use the previous TODO state" t)
3038 (const :tag "Use the head of the TODO sequence" nil)
3039 (string :tag "Use a specific TODO state")))
3041 (defcustom org-log-repeat 'time
3042 "Non-nil means record moving through the DONE state when triggering repeat.
3043 An auto-repeating task is immediately switched back to TODO when
3044 marked DONE. If you are not logging state changes (by adding \"@\"
3045 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3046 record a closing note, there will be no record of the task moving
3047 through DONE. This variable forces taking a note anyway.
3049 nil Don't force a record
3050 time Record a time stamp
3051 note Prompt for a note and add it with template `org-log-note-headings'
3053 This option can also be set with on a per-file-basis with
3055 #+STARTUP: nologrepeat
3056 #+STARTUP: logrepeat
3057 #+STARTUP: lognoterepeat
3059 You can have local logging settings for a subtree by setting the LOGGING
3060 property to one or more of these keywords."
3061 :group 'org-todo
3062 :group 'org-progress
3063 :type '(choice
3064 (const :tag "Don't force a record" nil)
3065 (const :tag "Force recording the DONE state" time)
3066 (const :tag "Force recording a note with the DONE state" note)))
3069 (defgroup org-priorities nil
3070 "Priorities in Org mode."
3071 :tag "Org Priorities"
3072 :group 'org-todo)
3074 (defcustom org-enable-priority-commands t
3075 "Non-nil means priority commands are active.
3076 When nil, these commands will be disabled, so that you never accidentally
3077 set a priority."
3078 :group 'org-priorities
3079 :type 'boolean)
3081 (defcustom org-highest-priority ?A
3082 "The highest priority of TODO items. A character like ?A, ?B etc.
3083 Must have a smaller ASCII number than `org-lowest-priority'."
3084 :group 'org-priorities
3085 :type 'character)
3087 (defcustom org-lowest-priority ?C
3088 "The lowest priority of TODO items. A character like ?A, ?B etc.
3089 Must have a larger ASCII number than `org-highest-priority'."
3090 :group 'org-priorities
3091 :type 'character)
3093 (defcustom org-default-priority ?B
3094 "The default priority of TODO items.
3095 This is the priority an item gets if no explicit priority is given.
3096 When starting to cycle on an empty priority the first step in the cycle
3097 depends on `org-priority-start-cycle-with-default'. The resulting first
3098 step priority must not exceed the range from `org-highest-priority' to
3099 `org-lowest-priority' which means that `org-default-priority' has to be
3100 in this range exclusive or inclusive the range boundaries. Else the
3101 first step refuses to set the default and the second will fall back
3102 to (depending on the command used) the highest or lowest priority."
3103 :group 'org-priorities
3104 :type 'character)
3106 (defcustom org-priority-start-cycle-with-default t
3107 "Non-nil means start with default priority when starting to cycle.
3108 When this is nil, the first step in the cycle will be (depending on the
3109 command used) one higher or lower than the default priority.
3110 See also `org-default-priority'."
3111 :group 'org-priorities
3112 :type 'boolean)
3114 (defcustom org-get-priority-function nil
3115 "Function to extract the priority from a string.
3116 The string is normally the headline. If this is nil Org computes the
3117 priority from the priority cookie like [#A] in the headline. It returns
3118 an integer, increasing by 1000 for each priority level.
3119 The user can set a different function here, which should take a string
3120 as an argument and return the numeric priority."
3121 :group 'org-priorities
3122 :version "24.1"
3123 :type '(choice
3124 (const nil)
3125 (function)))
3127 (defgroup org-time nil
3128 "Options concerning time stamps and deadlines in Org mode."
3129 :tag "Org Time"
3130 :group 'org)
3132 (defcustom org-time-stamp-rounding-minutes '(0 5)
3133 "Number of minutes to round time stamps to.
3134 \\<org-mode-map>\
3135 These are two values, the first applies when first creating a time stamp.
3136 The second applies when changing it with the commands `S-up' and `S-down'.
3137 When changing the time stamp, this means that it will change in steps
3138 of N minutes, as given by the second value.
3140 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3141 numbers should be factors of 60, so for example 5, 10, 15.
3143 When this is larger than 1, you can still force an exact time stamp by using
3144 a double prefix argument to a time stamp command like \
3145 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3146 and by using a prefix arg to `S-up/down' to specify the exact number
3147 of minutes to shift."
3148 :group 'org-time
3149 :get (lambda (var) ; Make sure both elements are there
3150 (if (integerp (default-value var))
3151 (list (default-value var) 5)
3152 (default-value var)))
3153 :type '(list
3154 (integer :tag "when inserting times")
3155 (integer :tag "when modifying times")))
3157 ;; Normalize old customizations of this variable.
3158 (when (integerp org-time-stamp-rounding-minutes)
3159 (setq org-time-stamp-rounding-minutes
3160 (list org-time-stamp-rounding-minutes
3161 org-time-stamp-rounding-minutes)))
3163 (defcustom org-display-custom-times nil
3164 "Non-nil means overlay custom formats over all time stamps.
3165 The formats are defined through the variable `org-time-stamp-custom-formats'.
3166 To turn this on on a per-file basis, insert anywhere in the file:
3167 #+STARTUP: customtime"
3168 :group 'org-time
3169 :set 'set-default
3170 :type 'sexp)
3171 (make-variable-buffer-local 'org-display-custom-times)
3173 (defcustom org-time-stamp-custom-formats
3174 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3175 "Custom formats for time stamps. See `format-time-string' for the syntax.
3176 These are overlaid over the default ISO format if the variable
3177 `org-display-custom-times' is set. Time like %H:%M should be at the
3178 end of the second format. The custom formats are also honored by export
3179 commands, if custom time display is turned on at the time of export."
3180 :group 'org-time
3181 :type 'sexp)
3183 (defun org-time-stamp-format (&optional long inactive)
3184 "Get the right format for a time string."
3185 (let ((f (if long (cdr org-time-stamp-formats)
3186 (car org-time-stamp-formats))))
3187 (if inactive
3188 (concat "[" (substring f 1 -1) "]")
3189 f)))
3191 (defcustom org-deadline-warning-days 14
3192 "Number of days before expiration during which a deadline becomes active.
3193 This variable governs the display in sparse trees and in the agenda.
3194 When 0 or negative, it means use this number (the absolute value of it)
3195 even if a deadline has a different individual lead time specified.
3197 Custom commands can set this variable in the options section."
3198 :group 'org-time
3199 :group 'org-agenda-daily/weekly
3200 :type 'integer)
3202 (defcustom org-scheduled-delay-days 0
3203 "Number of days before a scheduled item becomes active.
3204 This variable governs the display in sparse trees and in the agenda.
3205 The default value (i.e. 0) means: don't delay scheduled item.
3206 When negative, it means use this number (the absolute value of it)
3207 even if a scheduled item has a different individual delay time
3208 specified.
3210 Custom commands can set this variable in the options section."
3211 :group 'org-time
3212 :group 'org-agenda-daily/weekly
3213 :version "24.4"
3214 :package-version '(Org . "8.0")
3215 :type 'integer)
3217 (defcustom org-read-date-prefer-future t
3218 "Non-nil means assume future for incomplete date input from user.
3219 This affects the following situations:
3220 1. The user gives a month but not a year.
3221 For example, if it is April and you enter \"feb 2\", this will be read
3222 as Feb 2, *next* year. \"May 5\", however, will be this year.
3223 2. The user gives a day, but no month.
3224 For example, if today is the 15th, and you enter \"3\", Org will read
3225 this as the third of *next* month. However, if you enter \"17\",
3226 it will be considered as *this* month.
3228 If you set this variable to the symbol `time', then also the following
3229 will work:
3231 3. If the user gives a time.
3232 If the time is before now, it will be interpreted as tomorrow.
3234 Currently none of this works for ISO week specifications.
3236 When this option is nil, the current day, month and year will always be
3237 used as defaults.
3239 See also `org-agenda-jump-prefer-future'."
3240 :group 'org-time
3241 :type '(choice
3242 (const :tag "Never" nil)
3243 (const :tag "Check month and day" t)
3244 (const :tag "Check month, day, and time" time)))
3246 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3247 "Should the agenda jump command prefer the future for incomplete dates?
3248 The default is to do the same as configured in `org-read-date-prefer-future'.
3249 But you can also set a deviating value here.
3250 This may t or nil, or the symbol `org-read-date-prefer-future'."
3251 :group 'org-agenda
3252 :group 'org-time
3253 :version "24.1"
3254 :type '(choice
3255 (const :tag "Use org-read-date-prefer-future"
3256 org-read-date-prefer-future)
3257 (const :tag "Never" nil)
3258 (const :tag "Always" t)))
3260 (defcustom org-read-date-force-compatible-dates t
3261 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3263 Depending on the system Emacs is running on, certain dates cannot
3264 be represented with the type used internally to represent time.
3265 Dates between 1970-1-1 and 2038-1-1 can always be represented
3266 correctly. Some systems allow for earlier dates, some for later,
3267 some for both. One way to find out it to insert any date into an
3268 Org buffer, putting the cursor on the year and hitting S-up and
3269 S-down to test the range.
3271 When this variable is set to t, the date/time prompt will not let
3272 you specify dates outside the 1970-2037 range, so it is certain that
3273 these dates will work in whatever version of Emacs you are
3274 running, and also that you can move a file from one Emacs implementation
3275 to another. WHenever Org is forcing the year for you, it will display
3276 a message and beep.
3278 When this variable is nil, Org will check if the date is
3279 representable in the specific Emacs implementation you are using.
3280 If not, it will force a year, usually the current year, and beep
3281 to remind you. Currently this setting is not recommended because
3282 the likelihood that you will open your Org files in an Emacs that
3283 has limited date range is not negligible.
3285 A workaround for this problem is to use diary sexp dates for time
3286 stamps outside of this range."
3287 :group 'org-time
3288 :version "24.1"
3289 :type 'boolean)
3291 (defcustom org-read-date-display-live t
3292 "Non-nil means display current interpretation of date prompt live.
3293 This display will be in an overlay, in the minibuffer."
3294 :group 'org-time
3295 :type 'boolean)
3297 (defcustom org-read-date-popup-calendar t
3298 "Non-nil means pop up a calendar when prompting for a date.
3299 In the calendar, the date can be selected with mouse-1. However, the
3300 minibuffer will also be active, and you can simply enter the date as well.
3301 When nil, only the minibuffer will be available."
3302 :group 'org-time
3303 :type 'boolean)
3304 (defvaralias 'org-popup-calendar-for-date-prompt
3305 'org-read-date-popup-calendar)
3307 (defcustom org-extend-today-until 0
3308 "The hour when your day really ends. Must be an integer.
3309 This has influence for the following applications:
3310 - When switching the agenda to \"today\". It it is still earlier than
3311 the time given here, the day recognized as TODAY is actually yesterday.
3312 - When a date is read from the user and it is still before the time given
3313 here, the current date and time will be assumed to be yesterday, 23:59.
3314 Also, timestamps inserted in capture templates follow this rule.
3316 IMPORTANT: This is a feature whose implementation is and likely will
3317 remain incomplete. Really, it is only here because past midnight seems to
3318 be the favorite working time of John Wiegley :-)"
3319 :group 'org-time
3320 :type 'integer)
3322 (defcustom org-use-effective-time nil
3323 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3324 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3325 \"effective time\" of any timestamps between midnight and 8am will be
3326 23:59 of the previous day."
3327 :group 'org-time
3328 :version "24.1"
3329 :type 'boolean)
3331 (defcustom org-use-last-clock-out-time-as-effective-time nil
3332 "When non-nil, use the last clock out time for `org-todo'.
3333 Note that this option has precedence over the combined use of
3334 `org-use-effective-time' and `org-extend-today-until'."
3335 :group 'org-time
3336 :version "24.4"
3337 :package-version '(Org . "8.0")
3338 :type 'boolean)
3340 (defcustom org-edit-timestamp-down-means-later nil
3341 "Non-nil means S-down will increase the time in a time stamp.
3342 When nil, S-up will increase."
3343 :group 'org-time
3344 :type 'boolean)
3346 (defcustom org-calendar-follow-timestamp-change t
3347 "Non-nil means make the calendar window follow timestamp changes.
3348 When a timestamp is modified and the calendar window is visible, it will be
3349 moved to the new date."
3350 :group 'org-time
3351 :type 'boolean)
3353 (defgroup org-tags nil
3354 "Options concerning tags in Org mode."
3355 :tag "Org Tags"
3356 :group 'org)
3358 (defcustom org-tag-alist nil
3359 "Default tags available in Org files.
3361 The value of this variable is an alist. Associations either:
3363 (TAG)
3364 (TAG . SELECT)
3365 (SPECIAL)
3367 where TAG is a tag as a string, SELECT is character, used to
3368 select that tag through the fast tag selection interface, and
3369 SPECIAL is one of the following keywords: `:startgroup',
3370 `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
3371 `:newline'. These keywords are used to define a hierarchy of
3372 tags. See manual for details.
3374 When this variable is nil, Org mode bases tag input on what is
3375 already in the buffer. The value can be overridden locally by
3376 using a TAGS keyword, e.g.,
3378 #+TAGS: tag1 tag2
3380 See also `org-tag-persistent-alist' to sidestep this behavior."
3381 :group 'org-tags
3382 :type '(repeat
3383 (choice
3384 (cons :tag "Tag with key"
3385 (string :tag "Tag name")
3386 (character :tag "Access char"))
3387 (list :tag "Tag" (string :tag "Tag name"))
3388 (const :tag "Start radio group" (:startgroup))
3389 (const :tag "Start tag group, non distinct" (:startgrouptag))
3390 (const :tag "Group tags delimiter" (:grouptags))
3391 (const :tag "End radio group" (:endgroup))
3392 (const :tag "End tag group, non distinct" (:endgrouptag))
3393 (const :tag "New line" (:newline)))))
3395 (defcustom org-tag-persistent-alist nil
3396 "Tags always available in Org files.
3398 The value of this variable is an alist. Associations either:
3400 (TAG)
3401 (TAG . SELECT)
3402 (SPECIAL)
3404 where TAG is a tag as a string, SELECT is a character, used to
3405 select that tag through the fast tag selection interface, and
3406 SPECIAL is one of the following keywords: `:startgroup',
3407 `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
3408 `:newline'. These keywords are used to define a hierarchy of
3409 tags. See manual for details.
3411 Unlike to `org-tag-alist', tags defined in this variable do not
3412 depend on a local TAGS keyword. Instead, to disable these tags
3413 on a per-file basis, insert anywhere in the file:
3415 #+STARTUP: noptag"
3416 :group 'org-tags
3417 :type '(repeat
3418 (choice
3419 (cons :tag "Tag with key"
3420 (string :tag "Tag name")
3421 (character :tag "Access char"))
3422 (list :tag "Tag" (string :tag "Tag name"))
3423 (const :tag "Start radio group" (:startgroup))
3424 (const :tag "Start tag group, non distinct" (:startgrouptag))
3425 (const :tag "Group tags delimiter" (:grouptags))
3426 (const :tag "End radio group" (:endgroup))
3427 (const :tag "End tag group, non distinct" (:endgrouptag))
3428 (const :tag "New line" (:newline)))))
3430 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3431 "If non-nil, always offer completion for all tags of all agenda files.
3432 Instead of customizing this variable directly, you might want to
3433 set it locally for capture buffers, because there no list of
3434 tags in that file can be created dynamically (there are none).
3436 (add-hook \\='org-capture-mode-hook
3437 (lambda ()
3438 (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
3439 :group 'org-tags
3440 :version "24.1"
3441 :type 'boolean)
3443 (defvar org-file-tags nil
3444 "List of tags that can be inherited by all entries in the file.
3445 The tags will be inherited if the variable `org-use-tag-inheritance'
3446 says they should be.
3447 This variable is populated from #+FILETAGS lines.")
3449 (defcustom org-use-fast-tag-selection 'auto
3450 "Non-nil means use fast tag selection scheme.
3451 This is a special interface to select and deselect tags with single keys.
3452 When nil, fast selection is never used.
3453 When the symbol `auto', fast selection is used if and only if selection
3454 characters for tags have been configured, either through the variable
3455 `org-tag-alist' or through a #+TAGS line in the buffer.
3456 When t, fast selection is always used and selection keys are assigned
3457 automatically if necessary."
3458 :group 'org-tags
3459 :type '(choice
3460 (const :tag "Always" t)
3461 (const :tag "Never" nil)
3462 (const :tag "When selection characters are configured" auto)))
3464 (defcustom org-fast-tag-selection-single-key nil
3465 "Non-nil means fast tag selection exits after first change.
3466 When nil, you have to press RET to exit it.
3467 During fast tag selection, you can toggle this flag with `C-c'.
3468 This variable can also have the value `expert'. In this case, the window
3469 displaying the tags menu is not even shown, until you press C-c again."
3470 :group 'org-tags
3471 :type '(choice
3472 (const :tag "No" nil)
3473 (const :tag "Yes" t)
3474 (const :tag "Expert" expert)))
3476 (defvar org-fast-tag-selection-include-todo nil
3477 "Non-nil means fast tags selection interface will also offer TODO states.
3478 This is an undocumented feature, you should not rely on it.")
3480 (defcustom org-tags-column -77
3481 "The column to which tags should be indented in a headline.
3482 If this number is positive, it specifies the column. If it is negative,
3483 it means that the tags should be flushright to that column. For example,
3484 -80 works well for a normal 80 character screen.
3485 When 0, place tags directly after headline text, with only one space in
3486 between."
3487 :group 'org-tags
3488 :type 'integer)
3490 (defcustom org-auto-align-tags t
3491 "Non-nil keeps tags aligned when modifying headlines.
3492 Some operations (i.e. demoting) change the length of a headline and
3493 therefore shift the tags around. With this option turned on, after
3494 each such operation the tags are again aligned to `org-tags-column'."
3495 :group 'org-tags
3496 :type 'boolean)
3498 (defcustom org-use-tag-inheritance t
3499 "Non-nil means tags in levels apply also for sublevels.
3500 When nil, only the tags directly given in a specific line apply there.
3501 This may also be a list of tags that should be inherited, or a regexp that
3502 matches tags that should be inherited. Additional control is possible
3503 with the variable `org-tags-exclude-from-inheritance' which gives an
3504 explicit list of tags to be excluded from inheritance, even if the value of
3505 `org-use-tag-inheritance' would select it for inheritance.
3507 If this option is t, a match early-on in a tree can lead to a large
3508 number of matches in the subtree when constructing the agenda or creating
3509 a sparse tree. If you only want to see the first match in a tree during
3510 a search, check out the variable `org-tags-match-list-sublevels'."
3511 :group 'org-tags
3512 :type '(choice
3513 (const :tag "Not" nil)
3514 (const :tag "Always" t)
3515 (repeat :tag "Specific tags" (string :tag "Tag"))
3516 (regexp :tag "Tags matched by regexp")))
3518 (defcustom org-tags-exclude-from-inheritance nil
3519 "List of tags that should never be inherited.
3520 This is a way to exclude a few tags from inheritance. For way to do
3521 the opposite, to actively allow inheritance for selected tags,
3522 see the variable `org-use-tag-inheritance'."
3523 :group 'org-tags
3524 :type '(repeat (string :tag "Tag")))
3526 (defun org-tag-inherit-p (tag)
3527 "Check if TAG is one that should be inherited."
3528 (cond
3529 ((member tag org-tags-exclude-from-inheritance) nil)
3530 ((eq org-use-tag-inheritance t) t)
3531 ((not org-use-tag-inheritance) nil)
3532 ((stringp org-use-tag-inheritance)
3533 (string-match org-use-tag-inheritance tag))
3534 ((listp org-use-tag-inheritance)
3535 (member tag org-use-tag-inheritance))
3536 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3538 (defcustom org-tags-match-list-sublevels t
3539 "Non-nil means list also sublevels of headlines matching a search.
3540 This variable applies to tags/property searches, and also to stuck
3541 projects because this search is based on a tags match as well.
3543 When set to the symbol `indented', sublevels are indented with
3544 leading dots.
3546 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3547 the sublevels of a headline matching a tag search often also match
3548 the same search. Listing all of them can create very long lists.
3549 Setting this variable to nil causes subtrees of a match to be skipped.
3551 This variable is semi-obsolete and probably should always be true. It
3552 is better to limit inheritance to certain tags using the variables
3553 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3554 :group 'org-tags
3555 :type '(choice
3556 (const :tag "No, don't list them" nil)
3557 (const :tag "Yes, do list them" t)
3558 (const :tag "List them, indented with leading dots" indented)))
3560 (defcustom org-tags-sort-function nil
3561 "When set, tags are sorted using this function as a comparator."
3562 :group 'org-tags
3563 :type '(choice
3564 (const :tag "No sorting" nil)
3565 (const :tag "Alphabetical" string<)
3566 (const :tag "Reverse alphabetical" string>)
3567 (function :tag "Custom function" nil)))
3569 (defvar org-tags-history nil
3570 "History of minibuffer reads for tags.")
3571 (defvar org-last-tags-completion-table nil
3572 "The last used completion table for tags.")
3573 (defvar org-after-tags-change-hook nil
3574 "Hook that is run after the tags in a line have changed.")
3576 (defgroup org-properties nil
3577 "Options concerning properties in Org mode."
3578 :tag "Org Properties"
3579 :group 'org)
3581 (defcustom org-property-format "%-10s %s"
3582 "How property key/value pairs should be formatted by `indent-line'.
3583 When `indent-line' hits a property definition, it will format the line
3584 according to this format, mainly to make sure that the values are
3585 lined-up with respect to each other."
3586 :group 'org-properties
3587 :type 'string)
3589 (defcustom org-properties-postprocess-alist nil
3590 "Alist of properties and functions to adjust inserted values.
3591 Elements of this alist must be of the form
3593 ([string] [function])
3595 where [string] must be a property name and [function] must be a
3596 lambda expression: this lambda expression must take one argument,
3597 the value to adjust, and return the new value as a string.
3599 For example, this element will allow the property \"Remaining\"
3600 to be updated wrt the relation between the \"Effort\" property
3601 and the clock summary:
3603 ((\"Remaining\" (lambda(value)
3604 (let ((clocksum (org-clock-sum-current-item))
3605 (effort (org-duration-to-minutes
3606 (org-entry-get (point) \"Effort\"))))
3607 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3608 :group 'org-properties
3609 :version "24.1"
3610 :type '(alist :key-type (string :tag "Property")
3611 :value-type (function :tag "Function")))
3613 (defcustom org-use-property-inheritance nil
3614 "Non-nil means properties apply also for sublevels.
3616 This setting is chiefly used during property searches. Turning it on can
3617 cause significant overhead when doing a search, which is why it is not
3618 on by default.
3620 When nil, only the properties directly given in the current entry count.
3621 When t, every property is inherited. The value may also be a list of
3622 properties that should have inheritance, or a regular expression matching
3623 properties that should be inherited.
3625 However, note that some special properties use inheritance under special
3626 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3627 and the properties ending in \"_ALL\" when they are used as descriptor
3628 for valid values of a property.
3630 Note for programmers:
3631 When querying an entry with `org-entry-get', you can control if inheritance
3632 should be used. By default, `org-entry-get' looks only at the local
3633 properties. You can request inheritance by setting the inherit argument
3634 to t (to force inheritance) or to `selective' (to respect the setting
3635 in this variable)."
3636 :group 'org-properties
3637 :type '(choice
3638 (const :tag "Not" nil)
3639 (const :tag "Always" t)
3640 (repeat :tag "Specific properties" (string :tag "Property"))
3641 (regexp :tag "Properties matched by regexp")))
3643 (defun org-property-inherit-p (property)
3644 "Return a non-nil value if PROPERTY should be inherited."
3645 (cond
3646 ((eq org-use-property-inheritance t) t)
3647 ((not org-use-property-inheritance) nil)
3648 ((stringp org-use-property-inheritance)
3649 (string-match org-use-property-inheritance property))
3650 ((listp org-use-property-inheritance)
3651 (member-ignore-case property org-use-property-inheritance))
3652 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3654 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3655 "The default column format, if no other format has been defined.
3656 This variable can be set on the per-file basis by inserting a line
3658 #+COLUMNS: %25ITEM ....."
3659 :group 'org-properties
3660 :type 'string)
3662 (defcustom org-columns-ellipses ".."
3663 "The ellipses to be used when a field in column view is truncated.
3664 When this is the empty string, as many characters as possible are shown,
3665 but then there will be no visual indication that the field has been truncated.
3666 When this is a string of length N, the last N characters of a truncated
3667 field are replaced by this string. If the column is narrower than the
3668 ellipses string, only part of the ellipses string will be shown."
3669 :group 'org-properties
3670 :type 'string)
3672 (defconst org-global-properties-fixed
3673 '(("VISIBILITY_ALL" . "folded children content all")
3674 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3675 "List of property/value pairs that can be inherited by any entry.
3677 These are fixed values, for the preset properties. The user variable
3678 that can be used to add to this list is `org-global-properties'.
3680 The entries in this list are cons cells where the car is a property
3681 name and cdr is a string with the value. If the value represents
3682 multiple items like an \"_ALL\" property, separate the items by
3683 spaces.")
3685 (defcustom org-global-properties nil
3686 "List of property/value pairs that can be inherited by any entry.
3688 This list will be combined with the constant `org-global-properties-fixed'.
3690 The entries in this list are cons cells where the car is a property
3691 name and cdr is a string with the value.
3693 You can set buffer-local values for the same purpose in the variable
3694 `org-file-properties' this by adding lines like
3696 #+PROPERTY: NAME VALUE"
3697 :group 'org-properties
3698 :type '(repeat
3699 (cons (string :tag "Property")
3700 (string :tag "Value"))))
3702 (defvar-local org-file-properties nil
3703 "List of property/value pairs that can be inherited by any entry.
3704 Valid for the current buffer.
3705 This variable is populated from #+PROPERTY lines.")
3707 (defgroup org-agenda nil
3708 "Options concerning agenda views in Org mode."
3709 :tag "Org Agenda"
3710 :group 'org)
3712 (defvar-local org-category nil
3713 "Variable used by org files to set a category for agenda display.
3714 Such files should use a file variable to set it, for example
3716 # -*- mode: org; org-category: \"ELisp\"
3718 or contain a special line
3720 #+CATEGORY: ELisp
3722 If the file does not specify a category, then file's base name
3723 is used instead.")
3724 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3726 (defcustom org-agenda-files nil
3727 "The files to be used for agenda display.
3729 If an entry is a directory, all files in that directory that are matched
3730 by `org-agenda-file-regexp' will be part of the file list.
3732 If the value of the variable is not a list but a single file name, then
3733 the list of agenda files is actually stored and maintained in that file,
3734 one agenda file per line. In this file paths can be given relative to
3735 `org-directory'. Tilde expansion and environment variable substitution
3736 are also made.
3738 Entries may be added to this list with `\\[org-agenda-file-to-front]'
3739 and removed with `\\[org-remove-file]'."
3740 :group 'org-agenda
3741 :type '(choice
3742 (repeat :tag "List of files and directories" file)
3743 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3745 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3746 "Regular expression to match files for `org-agenda-files'.
3747 If any element in the list in that variable contains a directory instead
3748 of a normal file, all files in that directory that are matched by this
3749 regular expression will be included."
3750 :group 'org-agenda
3751 :type 'regexp)
3753 (defcustom org-agenda-text-search-extra-files nil
3754 "List of extra files to be searched by text search commands.
3755 These files will be searched in addition to the agenda files by the
3756 commands `org-search-view' (`\\[org-agenda] s') \
3757 and `org-occur-in-agenda-files'.
3758 Note that these files will only be searched for text search commands,
3759 not for the other agenda views like todo lists, tag searches or the weekly
3760 agenda. This variable is intended to list notes and possibly archive files
3761 that should also be searched by these two commands.
3762 In fact, if the first element in the list is the symbol `agenda-archives',
3763 then all archive files of all agenda files will be added to the search
3764 scope."
3765 :group 'org-agenda
3766 :type '(set :greedy t
3767 (const :tag "Agenda Archives" agenda-archives)
3768 (repeat :inline t (file))))
3770 (defvaralias 'org-agenda-multi-occur-extra-files
3771 'org-agenda-text-search-extra-files)
3773 (defcustom org-agenda-skip-unavailable-files nil
3774 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3775 A nil value means to remove them, after a query, from the list."
3776 :group 'org-agenda
3777 :type 'boolean)
3779 (defcustom org-calendar-to-agenda-key [?c]
3780 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3781 The command `org-calendar-goto-agenda' will be bound to this key. The
3782 default is the character `c' because then `c' can be used to switch back and
3783 forth between agenda and calendar."
3784 :group 'org-agenda
3785 :type 'sexp)
3787 (defcustom org-calendar-insert-diary-entry-key [?i]
3788 "The key to be installed in `calendar-mode-map' for adding diary entries.
3789 This option is irrelevant until `org-agenda-diary-file' has been configured
3790 to point to an Org file. When that is the case, the command
3791 `org-agenda-diary-entry' will be bound to the key given here, by default
3792 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3793 if you want to continue doing this, you need to change this to a different
3794 key."
3795 :group 'org-agenda
3796 :type 'sexp)
3798 (defcustom org-agenda-diary-file 'diary-file
3799 "File to which to add new entries with the `i' key in agenda and calendar.
3800 When this is the symbol `diary-file', the functionality in the Emacs
3801 calendar will be used to add entries to the `diary-file'. But when this
3802 points to a file, `org-agenda-diary-entry' will be used instead."
3803 :group 'org-agenda
3804 :type '(choice
3805 (const :tag "The standard Emacs diary file" diary-file)
3806 (file :tag "Special Org file diary entries")))
3808 (eval-after-load "calendar"
3809 '(progn
3810 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3811 'org-calendar-goto-agenda)
3812 (add-hook 'calendar-mode-hook
3813 (lambda ()
3814 (unless (eq org-agenda-diary-file 'diary-file)
3815 (define-key calendar-mode-map
3816 org-calendar-insert-diary-entry-key
3817 'org-agenda-diary-entry))))))
3819 (defgroup org-latex nil
3820 "Options for embedding LaTeX code into Org mode."
3821 :tag "Org LaTeX"
3822 :group 'org)
3824 (defcustom org-format-latex-options
3825 '(:foreground default :background default :scale 1.0
3826 :html-foreground "Black" :html-background "Transparent"
3827 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3828 "Options for creating images from LaTeX fragments.
3829 This is a property list with the following properties:
3830 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3831 `default' means use the foreground of the default face.
3832 `auto' means use the foreground from the text face.
3833 :background the background color, or \"Transparent\".
3834 `default' means use the background of the default face.
3835 `auto' means use the background from the text face.
3836 :scale a scaling factor for the size of the images, to get more pixels
3837 :html-foreground, :html-background, :html-scale
3838 the same numbers for HTML export.
3839 :matchers a list indicating which matchers should be used to
3840 find LaTeX fragments. Valid members of this list are:
3841 \"begin\" find environments
3842 \"$1\" find single characters surrounded by $.$
3843 \"$\" find math expressions surrounded by $...$
3844 \"$$\" find math expressions surrounded by $$....$$
3845 \"\\(\" find math expressions surrounded by \\(...\\)
3846 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3847 :group 'org-latex
3848 :type 'plist)
3850 (defcustom org-format-latex-signal-error t
3851 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3852 When nil, just push out a message."
3853 :group 'org-latex
3854 :version "24.1"
3855 :type 'boolean)
3857 (defcustom org-latex-to-mathml-jar-file nil
3858 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3859 Use this to specify additional executable file say a jar file.
3861 When using MathToWeb as the converter, specify the full-path to
3862 your mathtoweb.jar file."
3863 :group 'org-latex
3864 :version "24.1"
3865 :type '(choice
3866 (const :tag "None" nil)
3867 (file :tag "JAR file" :must-match t)))
3869 (defcustom org-latex-to-mathml-convert-command nil
3870 "Command to convert LaTeX fragments to MathML.
3871 Replace format-specifiers in the command as noted below and use
3872 `shell-command' to convert LaTeX to MathML.
3873 %j: Executable file in fully expanded form as specified by
3874 `org-latex-to-mathml-jar-file'.
3875 %I: Input LaTeX file in fully expanded form.
3876 %i: The latex fragment to be converted.
3877 %o: Output MathML file.
3879 This command is used by `org-create-math-formula'.
3881 When using MathToWeb as the converter, set this option to
3882 \"java -jar %j -unicode -force -df %o %I\".
3884 When using LaTeXML set this option to
3885 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3886 :group 'org-latex
3887 :version "24.1"
3888 :type '(choice
3889 (const :tag "None" nil)
3890 (string :tag "\nShell command")))
3892 (defcustom org-preview-latex-default-process 'dvipng
3893 "The default process to convert LaTeX fragments to image files.
3894 All available processes and theirs documents can be found in
3895 `org-preview-latex-process-alist', which see."
3896 :group 'org-latex
3897 :version "26.1"
3898 :package-version '(Org . "9.0")
3899 :type 'symbol)
3901 (defcustom org-preview-latex-process-alist
3902 '((dvipng
3903 :programs ("latex" "dvipng")
3904 :description "dvi > png"
3905 :message "you need to install the programs: latex and dvipng."
3906 :image-input-type "dvi"
3907 :image-output-type "png"
3908 :image-size-adjust (1.0 . 1.0)
3909 :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
3910 :image-converter ("dvipng -fg %F -bg %B -D %D -T tight -o %O %f"))
3911 (dvisvgm
3912 :programs ("latex" "dvisvgm")
3913 :description "dvi > svg"
3914 :message "you need to install the programs: latex and dvisvgm."
3915 :use-xcolor t
3916 :image-input-type "dvi"
3917 :image-output-type "svg"
3918 :image-size-adjust (1.7 . 1.5)
3919 :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
3920 :image-converter ("dvisvgm %f -n -b min -c %S -o %O"))
3921 (imagemagick
3922 :programs ("latex" "convert")
3923 :description "pdf > png"
3924 :message "you need to install the programs: latex and imagemagick."
3925 :use-xcolor t
3926 :image-input-type "pdf"
3927 :image-output-type "png"
3928 :image-size-adjust (1.0 . 1.0)
3929 :latex-compiler ("pdflatex -interaction nonstopmode -output-directory %o %f")
3930 :image-converter
3931 ("convert -density %D -trim -antialias %f -quality 100 %O")))
3932 "Definitions of external processes for LaTeX previewing.
3933 Org mode can use some external commands to generate TeX snippet's images for
3934 previewing or inserting into HTML files, e.g., \"dvipng\". This variable tells
3935 `org-create-formula-image' how to call them.
3937 The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
3938 PROPERTIES accepts the following attributes:
3940 :programs list of strings, required programs.
3941 :description string, describe the process.
3942 :message string, message it when required programs cannot be found.
3943 :image-input-type string, input file type of image converter (e.g., \"dvi\").
3944 :image-output-type string, output file type of image converter (e.g., \"png\").
3945 :use-xcolor boolean, when non-nil, LaTeX \"xcolor\" macro is used to
3946 deal with background and foreground color of image.
3947 Otherwise, dvipng style background and foreground color
3948 format are generated. You may then refer to them in
3949 command options with \"%F\" and \"%B\".
3950 :image-size-adjust cons of numbers, the car element is used to adjust LaTeX
3951 image size showed in buffer and the cdr element is for
3952 HTML file. This option is only useful for process
3953 developers, users should use variable
3954 `org-format-latex-options' instead.
3955 :post-clean list of strings, files matched are to be cleaned up once
3956 the image is generated. When nil, the files with \".dvi\",
3957 \".xdv\", \".pdf\", \".tex\", \".aux\", \".log\", \".svg\",
3958 \".png\", \".jpg\", \".jpeg\" or \".out\" extension will
3959 be cleaned up.
3960 :latex-header list of strings, the LaTeX header of the snippet file.
3961 When nil, the fallback value is used instead, which is
3962 controlled by `org-format-latex-header',
3963 `org-latex-default-packages-alist' and
3964 `org-latex-packages-alist', which see.
3965 :latex-compiler list of LaTeX commands, as strings. Each of them is given
3966 to the shell. Place-holders \"%t\", \"%b\" and \"%o\" are
3967 replaced with values defined below.
3968 :image-converter list of image converter commands strings. Each of them is
3969 given to the shell and supports any of the following
3970 place-holders defined below.
3972 Place-holders used by `:image-converter' and `:latex-compiler':
3974 %f input file name
3975 %b base name of input file
3976 %o base directory of input file
3977 %O absolute output file name
3979 Place-holders only used by `:image-converter':
3981 %F foreground of image
3982 %B background of image
3983 %D dpi, which is used to adjust image size by some processing commands.
3984 %S the image size scale ratio, which is used to adjust image size by some
3985 processing commands."
3986 :group 'org-latex
3987 :version "26.1"
3988 :package-version '(Org . "9.0")
3989 :type '(alist :tag "LaTeX to image backends"
3990 :value-type (plist)))
3992 (defcustom org-preview-latex-image-directory "ltximg/"
3993 "Path to store latex preview images.
3994 A relative path here creates many directories relative to the
3995 processed org files paths. An absolute path puts all preview
3996 images at the same place."
3997 :group 'org-latex
3998 :version "26.1"
3999 :package-version '(Org . "9.0")
4000 :type 'string)
4002 (defun org-format-latex-mathml-available-p ()
4003 "Return t if `org-latex-to-mathml-convert-command' is usable."
4004 (save-match-data
4005 (when (and (boundp 'org-latex-to-mathml-convert-command)
4006 org-latex-to-mathml-convert-command)
4007 (let ((executable (car (split-string
4008 org-latex-to-mathml-convert-command))))
4009 (when (executable-find executable)
4010 (if (string-match
4011 "%j" org-latex-to-mathml-convert-command)
4012 (file-readable-p org-latex-to-mathml-jar-file)
4013 t))))))
4015 (defcustom org-format-latex-header "\\documentclass{article}
4016 \\usepackage[usenames]{color}
4017 \[PACKAGES]
4018 \[DEFAULT-PACKAGES]
4019 \\pagestyle{empty} % do not remove
4020 % The settings below are copied from fullpage.sty
4021 \\setlength{\\textwidth}{\\paperwidth}
4022 \\addtolength{\\textwidth}{-3cm}
4023 \\setlength{\\oddsidemargin}{1.5cm}
4024 \\addtolength{\\oddsidemargin}{-2.54cm}
4025 \\setlength{\\evensidemargin}{\\oddsidemargin}
4026 \\setlength{\\textheight}{\\paperheight}
4027 \\addtolength{\\textheight}{-\\headheight}
4028 \\addtolength{\\textheight}{-\\headsep}
4029 \\addtolength{\\textheight}{-\\footskip}
4030 \\addtolength{\\textheight}{-3cm}
4031 \\setlength{\\topmargin}{1.5cm}
4032 \\addtolength{\\topmargin}{-2.54cm}"
4033 "The document header used for processing LaTeX fragments.
4034 It is imperative that this header make sure that no page number
4035 appears on the page. The package defined in the variables
4036 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4037 will either replace the placeholder \"[PACKAGES]\" in this
4038 header, or they will be appended."
4039 :group 'org-latex
4040 :type 'string)
4042 (defun org-set-packages-alist (var val)
4043 "Set the packages alist and make sure it has 3 elements per entry."
4044 (set var (mapcar (lambda (x)
4045 (if (and (consp x) (= (length x) 2))
4046 (list (car x) (nth 1 x) t)
4048 val)))
4050 (defun org-get-packages-alist (var)
4051 "Get the packages alist and make sure it has 3 elements per entry."
4052 (mapcar (lambda (x)
4053 (if (and (consp x) (= (length x) 2))
4054 (list (car x) (nth 1 x) t)
4056 (default-value var)))
4058 (defcustom org-latex-default-packages-alist
4059 '(("AUTO" "inputenc" t ("pdflatex"))
4060 ("T1" "fontenc" t ("pdflatex"))
4061 ("" "graphicx" t)
4062 ("" "grffile" t)
4063 ("" "longtable" nil)
4064 ("" "wrapfig" nil)
4065 ("" "rotating" nil)
4066 ("normalem" "ulem" t)
4067 ("" "amsmath" t)
4068 ("" "textcomp" t)
4069 ("" "amssymb" t)
4070 ("" "capt-of" nil)
4071 ("" "hyperref" nil))
4072 "Alist of default packages to be inserted in the header.
4074 Change this only if one of the packages here causes an
4075 incompatibility with another package you are using.
4077 The packages in this list are needed by one part or another of
4078 Org mode to function properly:
4080 - inputenc, fontenc: for basic font and character selection
4081 - graphicx: for including images
4082 - grffile: allow periods and spaces in graphics file names
4083 - longtable: For multipage tables
4084 - wrapfig: for figure placement
4085 - rotating: for sideways figures and tables
4086 - ulem: for underline and strike-through
4087 - amsmath: for subscript and superscript and math environments
4088 - textcomp, amssymb: for various symbols used
4089 for interpreting the entities in `org-entities'. You can skip
4090 some of these packages if you don't use any of their symbols.
4091 - capt-of: for captions outside of floats
4092 - hyperref: for cross references
4094 Therefore you should not modify this variable unless you know
4095 what you are doing. The one reason to change it anyway is that
4096 you might be loading some other package that conflicts with one
4097 of the default packages. Each element is either a cell or
4098 a string.
4100 A cell is of the format
4102 (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
4104 If SNIPPET-FLAG is non-nil, the package also needs to be included
4105 when compiling LaTeX snippets into images for inclusion into
4106 non-LaTeX output. COMPILERS is a list of compilers that should
4107 include the package, see `org-latex-compiler'. If the document
4108 compiler is not in the list, and the list is non-nil, the package
4109 will not be inserted in the final document.
4111 A string will be inserted as-is in the header of the document."
4112 :group 'org-latex
4113 :group 'org-export-latex
4114 :set 'org-set-packages-alist
4115 :get 'org-get-packages-alist
4116 :version "26.1"
4117 :package-version '(Org . "8.3")
4118 :type '(repeat
4119 (choice
4120 (list :tag "options/package pair"
4121 (string :tag "options")
4122 (string :tag "package")
4123 (boolean :tag "Snippet")
4124 (choice
4125 (const :tag "For all compilers" nil)
4126 (repeat :tag "Allowed compiler" string)))
4127 (string :tag "A line of LaTeX"))))
4129 (defcustom org-latex-packages-alist nil
4130 "Alist of packages to be inserted in every LaTeX header.
4132 These will be inserted after `org-latex-default-packages-alist'.
4133 Each element is either a cell or a string.
4135 A cell is of the format:
4137 (\"options\" \"package\" SNIPPET-FLAG)
4139 SNIPPET-FLAG, when non-nil, indicates that this package is also
4140 needed when turning LaTeX snippets into images for inclusion into
4141 non-LaTeX output.
4143 A string will be inserted as-is in the header of the document.
4145 Make sure that you only list packages here which:
4147 - you want in every file;
4148 - do not conflict with the setup in `org-format-latex-header';
4149 - do not conflict with the default packages in
4150 `org-latex-default-packages-alist'."
4151 :group 'org-latex
4152 :group 'org-export-latex
4153 :set 'org-set-packages-alist
4154 :get 'org-get-packages-alist
4155 :type '(repeat
4156 (choice
4157 (list :tag "options/package pair"
4158 (string :tag "options")
4159 (string :tag "package")
4160 (boolean :tag "Snippet"))
4161 (string :tag "A line of LaTeX"))))
4163 (defgroup org-appearance nil
4164 "Settings for Org mode appearance."
4165 :tag "Org Appearance"
4166 :group 'org)
4168 (defcustom org-level-color-stars-only nil
4169 "Non-nil means fontify only the stars in each headline.
4170 When nil, the entire headline is fontified.
4171 Changing it requires restart of `font-lock-mode' to become effective
4172 also in regions already fontified."
4173 :group 'org-appearance
4174 :type 'boolean)
4176 (defcustom org-hide-leading-stars nil
4177 "Non-nil means hide the first N-1 stars in a headline.
4178 This works by using the face `org-hide' for these stars. This
4179 face is white for a light background, and black for a dark
4180 background. You may have to customize the face `org-hide' to
4181 make this work.
4182 Changing it requires restart of `font-lock-mode' to become effective
4183 also in regions already fontified.
4184 You may also set this on a per-file basis by adding one of the following
4185 lines to the buffer:
4187 #+STARTUP: hidestars
4188 #+STARTUP: showstars"
4189 :group 'org-appearance
4190 :type 'boolean)
4192 (defcustom org-hidden-keywords nil
4193 "List of symbols corresponding to keywords to be hidden the org buffer.
4194 For example, a value \\='(title) for this list will make the document's title
4195 appear in the buffer without the initial #+TITLE: keyword."
4196 :group 'org-appearance
4197 :version "24.1"
4198 :type '(set (const :tag "#+AUTHOR" author)
4199 (const :tag "#+DATE" date)
4200 (const :tag "#+EMAIL" email)
4201 (const :tag "#+TITLE" title)))
4203 (defcustom org-custom-properties nil
4204 "List of properties (as strings) with a special meaning.
4205 The default use of these custom properties is to let the user
4206 hide them with `org-toggle-custom-properties-visibility'."
4207 :group 'org-properties
4208 :group 'org-appearance
4209 :version "24.3"
4210 :type '(repeat (string :tag "Property Name")))
4212 (defcustom org-fontify-done-headline nil
4213 "Non-nil means change the face of a headline if it is marked DONE.
4214 Normally, only the TODO/DONE keyword indicates the state of a headline.
4215 When this is non-nil, the headline after the keyword is set to the
4216 `org-headline-done' as an additional indication."
4217 :group 'org-appearance
4218 :type 'boolean)
4220 (defcustom org-fontify-emphasized-text t
4221 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4222 Changing this variable requires a restart of Emacs to take effect."
4223 :group 'org-appearance
4224 :type 'boolean)
4226 (defcustom org-fontify-whole-heading-line nil
4227 "Non-nil means fontify the whole line for headings.
4228 This is useful when setting a background color for the
4229 org-level-* faces."
4230 :group 'org-appearance
4231 :type 'boolean)
4233 (defcustom org-highlight-latex-and-related nil
4234 "Non-nil means highlight LaTeX related syntax in the buffer.
4235 When non nil, the value should be a list containing any of the
4236 following symbols:
4237 `latex' Highlight LaTeX snippets and environments.
4238 `script' Highlight subscript and superscript.
4239 `entities' Highlight entities."
4240 :group 'org-appearance
4241 :version "24.4"
4242 :package-version '(Org . "8.0")
4243 :type '(choice
4244 (const :tag "No highlighting" nil)
4245 (set :greedy t :tag "Highlight"
4246 (const :tag "LaTeX snippets and environments" latex)
4247 (const :tag "Subscript and superscript" script)
4248 (const :tag "Entities" entities))))
4250 (defcustom org-hide-emphasis-markers nil
4251 "Non-nil mean font-lock should hide the emphasis marker characters."
4252 :group 'org-appearance
4253 :type 'boolean)
4255 (defcustom org-hide-macro-markers nil
4256 "Non-nil mean font-lock should hide the brackets marking macro calls."
4257 :group 'org-appearance
4258 :type 'boolean)
4260 (defcustom org-pretty-entities nil
4261 "Non-nil means show entities as UTF8 characters.
4262 When nil, the \\name form remains in the buffer."
4263 :group 'org-appearance
4264 :version "24.1"
4265 :type 'boolean)
4267 (defcustom org-pretty-entities-include-sub-superscripts t
4268 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4269 :group 'org-appearance
4270 :version "24.1"
4271 :type 'boolean)
4273 (defvar org-emph-re nil
4274 "Regular expression for matching emphasis.
4275 After a match, the match groups contain these elements:
4276 0 The match of the full regular expression, including the characters
4277 before and after the proper match
4278 1 The character before the proper match, or empty at beginning of line
4279 2 The proper match, including the leading and trailing markers
4280 3 The leading marker like * or /, indicating the type of highlighting
4281 4 The text between the emphasis markers, not including the markers
4282 5 The character after the match, empty at the end of a line")
4284 (defvar org-verbatim-re nil
4285 "Regular expression for matching verbatim text.")
4287 (defvar org-emphasis-regexp-components) ; defined just below
4288 (defvar org-emphasis-alist) ; defined just below
4289 (defun org-set-emph-re (var val)
4290 "Set variable and compute the emphasis regular expression."
4291 (set var val)
4292 (when (and (boundp 'org-emphasis-alist)
4293 (boundp 'org-emphasis-regexp-components)
4294 org-emphasis-alist org-emphasis-regexp-components)
4295 (pcase-let*
4296 ((`(,pre ,post ,border ,body ,nl) org-emphasis-regexp-components)
4297 (body (if (<= nl 0) body
4298 (format "%s*?\\(?:\n%s*?\\)\\{0,%d\\}" body body nl)))
4299 (template
4300 (format (concat "\\([%s]\\|^\\)" ;before markers
4301 "\\(\\([%%s]\\)\\([^%s]\\|[^%s]%s[^%s]\\)\\3\\)"
4302 "\\([%s]\\|$\\)") ;after markers
4303 pre border border body border post)))
4304 (setq org-emph-re (format template "*/_+"))
4305 (setq org-verbatim-re (format template "=~")))))
4307 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4308 ;; set this option proved cumbersome. See this message/thread:
4309 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4310 (defvar org-emphasis-regexp-components
4311 '("-[:space:]('\"{" "-[:space:].,:!?;'\")}\\[" "[:space:]" "." 1)
4312 "Components used to build the regular expression for emphasis.
4313 This is a list with five entries. Terminology: In an emphasis string
4314 like \" *strong word* \", we call the initial space PREMATCH, the final
4315 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4316 and \"trong wor\" is the body. The different components in this variable
4317 specify what is allowed/forbidden in each part:
4319 pre Chars allowed as prematch. Beginning of line will be allowed too.
4320 post Chars allowed as postmatch. End of line will be allowed too.
4321 border The chars *forbidden* as border characters.
4322 body-regexp A regexp like \".\" to match a body character. Don't use
4323 non-shy groups here, and don't allow newline here.
4324 newline The maximum number of newlines allowed in an emphasis exp.
4326 You need to reload Org or to restart Emacs after setting this.")
4328 (defcustom org-emphasis-alist
4329 '(("*" bold)
4330 ("/" italic)
4331 ("_" underline)
4332 ("=" org-verbatim verbatim)
4333 ("~" org-code verbatim)
4334 ("+" (:strike-through t)))
4335 "Alist of characters and faces to emphasize text.
4336 Text starting and ending with a special character will be emphasized,
4337 for example *bold*, _underlined_ and /italic/. This variable sets the
4338 marker characters and the face to be used by font-lock for highlighting
4339 in Org buffers.
4341 You need to reload Org or to restart Emacs after customizing this."
4342 :group 'org-appearance
4343 :set 'org-set-emph-re
4344 :version "24.4"
4345 :package-version '(Org . "8.0")
4346 :type '(repeat
4347 (list
4348 (string :tag "Marker character")
4349 (choice
4350 (face :tag "Font-lock-face")
4351 (plist :tag "Face property list"))
4352 (option (const verbatim)))))
4354 (defvar org-protecting-blocks '("src" "example" "export")
4355 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4356 This is needed for font-lock setup.")
4358 ;;; Functions and variables from their packages
4359 ;; Declared here to avoid compiler warnings
4360 (defvar mark-active)
4362 ;; Various packages
4363 (declare-function calc-eval "calc" (str &optional separator &rest args))
4364 (declare-function calendar-forward-day "cal-move" (arg))
4365 (declare-function calendar-goto-date "cal-move" (date))
4366 (declare-function calendar-goto-today "cal-move" ())
4367 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4368 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4369 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4370 (declare-function cdlatex-tab "ext:cdlatex" ())
4371 (declare-function dired-get-filename
4372 "dired"
4373 (&optional localp no-error-if-not-filep))
4374 (declare-function iswitchb-read-buffer
4375 "iswitchb"
4376 (prompt &optional
4377 default require-match _predicate start matches-set))
4378 (declare-function org-agenda-change-all-lines
4379 "org-agenda"
4380 (newhead hdmarker &optional fixface just-this))
4381 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4382 "org-agenda"
4383 (&optional end))
4384 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4385 (declare-function org-agenda-format-item
4386 "org-agenda"
4387 (extra txt &optional level category tags dotime
4388 remove-re habitp))
4389 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4390 (declare-function org-agenda-save-markers-for-cut-and-paste
4391 "org-agenda"
4392 (beg end))
4393 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4394 (declare-function org-agenda-skip "org-agenda" ())
4395 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4396 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4397 (declare-function org-indent-mode "org-indent" (&optional arg))
4398 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4399 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4400 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4401 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4402 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4403 (declare-function parse-time-string "parse-time" (string))
4405 (defvar align-mode-rules-list)
4406 (defvar calc-embedded-close-formula)
4407 (defvar calc-embedded-open-formula)
4408 (defvar calc-embedded-open-mode)
4409 (defvar font-lock-unfontify-region-function)
4410 (defvar iswitchb-temp-buflist)
4411 (defvar org-agenda-tags-todo-honor-ignore-options)
4412 (defvar remember-data-file)
4413 (defvar texmathp-why)
4415 ;;;###autoload
4416 (defun turn-on-orgtbl ()
4417 "Unconditionally turn on `orgtbl-mode'."
4418 (require 'org-table)
4419 (orgtbl-mode 1))
4421 (defun org-at-table-p (&optional table-type)
4422 "Non-nil if the cursor is inside an Org table.
4423 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4424 (and (org-match-line (if table-type "[ \t]*[|+]" "[ \t]*|"))
4425 (or (not (derived-mode-p 'org-mode))
4426 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4427 (and e (or table-type
4428 (eq 'org (org-element-property :type e))))))))
4430 (defun org-at-table.el-p ()
4431 "Non-nil when point is at a table.el table."
4432 (and (org-match-line "[ \t]*[|+]")
4433 (let ((element (org-element-at-point)))
4434 (and (eq (org-element-type element) 'table)
4435 (eq (org-element-property :type element) 'table.el)))))
4437 (defun org-at-table-hline-p ()
4438 "Non-nil when point is inside a hline in a table.
4439 Assume point is already in a table."
4440 (org-match-line org-table-hline-regexp))
4442 (defun org-table-map-tables (function &optional quietly)
4443 "Apply FUNCTION to the start of all tables in the buffer."
4444 (org-with-wide-buffer
4445 (goto-char (point-min))
4446 (while (re-search-forward org-table-any-line-regexp nil t)
4447 (unless quietly
4448 (message "Mapping tables: %d%%"
4449 (floor (* 100.0 (point)) (buffer-size))))
4450 (beginning-of-line 1)
4451 (when (and (looking-at org-table-line-regexp)
4452 ;; Exclude tables in src/example/verbatim/clocktable blocks
4453 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4454 (save-excursion (funcall function))
4455 (or (looking-at org-table-line-regexp)
4456 (forward-char 1)))
4457 (re-search-forward org-table-any-border-regexp nil 1)))
4458 (unless quietly (message "Mapping tables: done")))
4460 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4461 (declare-function org-clock-update-mode-line "org-clock" ())
4462 (declare-function org-resolve-clocks "org-clock"
4463 (&optional also-non-dangling-p prompt last-valid))
4465 (defun org-at-TBLFM-p (&optional pos)
4466 "Non-nil when point (or POS) is in #+TBLFM line."
4467 (save-excursion
4468 (goto-char (or pos (point)))
4469 (beginning-of-line)
4470 (and (let ((case-fold-search t)) (looking-at org-TBLFM-regexp))
4471 (eq (org-element-type (org-element-at-point)) 'table))))
4473 (defvar org-clock-start-time)
4474 (defvar org-clock-marker (make-marker)
4475 "Marker recording the last clock-in.")
4476 (defvar org-clock-hd-marker (make-marker)
4477 "Marker recording the last clock-in, but the headline position.")
4478 (defvar org-clock-heading ""
4479 "The heading of the current clock entry.")
4480 (defun org-clock-is-active ()
4481 "Return the buffer where the clock is currently running.
4482 Return nil if no clock is running."
4483 (marker-buffer org-clock-marker))
4485 (defun org-check-running-clock ()
4486 "Check if the current buffer contains the running clock.
4487 If yes, offer to stop it and to save the buffer with the changes."
4488 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4489 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4490 (buffer-name))))
4491 (org-clock-out)
4492 (when (y-or-n-p "Save changed buffer?")
4493 (save-buffer))))
4495 (defun org-clocktable-try-shift (dir n)
4496 "Check if this line starts a clock table, if yes, shift the time block."
4497 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4498 (org-clocktable-shift dir n)))
4500 ;;;###autoload
4501 (defun org-clock-persistence-insinuate ()
4502 "Set up hooks for clock persistence."
4503 (require 'org-clock)
4504 (add-hook 'org-mode-hook 'org-clock-load)
4505 (add-hook 'kill-emacs-hook 'org-clock-save))
4507 (defgroup org-archive nil
4508 "Options concerning archiving in Org mode."
4509 :tag "Org Archive"
4510 :group 'org-structure)
4512 (defcustom org-archive-location "%s_archive::"
4513 "The location where subtrees should be archived.
4515 The value of this variable is a string, consisting of two parts,
4516 separated by a double-colon. The first part is a filename and
4517 the second part is a headline.
4519 When the filename is omitted, archiving happens in the same file.
4520 %s in the filename will be replaced by the current file
4521 name (without the directory part). Archiving to a different file
4522 is useful to keep archived entries from contributing to the
4523 Org Agenda.
4525 The archived entries will be filed as subtrees of the specified
4526 headline. When the headline is omitted, the subtrees are simply
4527 filed away at the end of the file, as top-level entries. Also in
4528 the heading you can use %s to represent the file name, this can be
4529 useful when using the same archive for a number of different files.
4531 Here are a few examples:
4532 \"%s_archive::\"
4533 If the current file is Projects.org, archive in file
4534 Projects.org_archive, as top-level trees. This is the default.
4536 \"::* Archived Tasks\"
4537 Archive in the current file, under the top-level headline
4538 \"* Archived Tasks\".
4540 \"~/org/archive.org::\"
4541 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4543 \"~/org/archive.org::* From %s\"
4544 Archive in file ~/org/archive.org (absolute path), under headlines
4545 \"From FILENAME\" where file name is the current file name.
4547 \"~/org/datetree.org::datetree/* Finished Tasks\"
4548 The \"datetree/\" string is special, signifying to archive
4549 items to the datetree. Items are placed in either the CLOSED
4550 date of the item, or the current date if there is no CLOSED date.
4551 The heading will be a subentry to the current date. There doesn't
4552 need to be a heading, but there always needs to be a slash after
4553 datetree. For example, to store archived items directly in the
4554 datetree, use \"~/org/datetree.org::datetree/\".
4556 \"basement::** Finished Tasks\"
4557 Archive in file ./basement (relative path), as level 3 trees
4558 below the level 2 heading \"** Finished Tasks\".
4560 You may set this option on a per-file basis by adding to the buffer a
4561 line like
4563 #+ARCHIVE: basement::** Finished Tasks
4565 You may also define it locally for a subtree by setting an ARCHIVE property
4566 in the entry. If such a property is found in an entry, or anywhere up
4567 the hierarchy, it will be used."
4568 :group 'org-archive
4569 :type 'string)
4571 (defcustom org-agenda-skip-archived-trees t
4572 "Non-nil means the agenda will skip any items located in archived trees.
4573 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4574 variable is no longer recommended, you should leave it at the value t.
4575 Instead, use the key `v' to cycle the archives-mode in the agenda."
4576 :group 'org-archive
4577 :group 'org-agenda-skip
4578 :type 'boolean)
4580 (defcustom org-columns-skip-archived-trees t
4581 "Non-nil means ignore archived trees when creating column view."
4582 :group 'org-archive
4583 :group 'org-properties
4584 :type 'boolean)
4586 (defcustom org-cycle-open-archived-trees nil
4587 "Non-nil means `org-cycle' will open archived trees.
4588 An archived tree is a tree marked with the tag ARCHIVE.
4589 When nil, archived trees will stay folded. You can still open them with
4590 normal outline commands like `show-all', but not with the cycling commands."
4591 :group 'org-archive
4592 :group 'org-cycle
4593 :type 'boolean)
4595 (defcustom org-sparse-tree-open-archived-trees nil
4596 "Non-nil means sparse tree construction shows matches in archived trees.
4597 When nil, matches in these trees are highlighted, but the trees are kept in
4598 collapsed state."
4599 :group 'org-archive
4600 :group 'org-sparse-trees
4601 :type 'boolean)
4603 (defcustom org-sparse-tree-default-date-type nil
4604 "The default date type when building a sparse tree.
4605 When this is nil, a date is a scheduled or a deadline timestamp.
4606 Otherwise, these types are allowed:
4608 all: all timestamps
4609 active: only active timestamps (<...>)
4610 inactive: only inactive timestamps ([...])
4611 scheduled: only scheduled timestamps
4612 deadline: only deadline timestamps"
4613 :type '(choice (const :tag "Scheduled or deadline" nil)
4614 (const :tag "All timestamps" all)
4615 (const :tag "Only active timestamps" active)
4616 (const :tag "Only inactive timestamps" inactive)
4617 (const :tag "Only scheduled timestamps" scheduled)
4618 (const :tag "Only deadline timestamps" deadline)
4619 (const :tag "Only closed timestamps" closed))
4620 :version "26.1"
4621 :package-version '(Org . "8.3")
4622 :group 'org-sparse-trees)
4624 (defun org-cycle-hide-archived-subtrees (state)
4625 "Re-hide all archived subtrees after a visibility state change.
4626 STATE should be one of the symbols listed in the docstring of
4627 `org-cycle-hook'."
4628 (when (and (not org-cycle-open-archived-trees)
4629 (not (memq state '(overview folded))))
4630 (save-excursion
4631 (let* ((globalp (memq state '(contents all)))
4632 (beg (if globalp (point-min) (point)))
4633 (end (if globalp (point-max) (org-end-of-subtree t))))
4634 (org-hide-archived-subtrees beg end)
4635 (goto-char beg)
4636 (when (looking-at-p (concat ".*:" org-archive-tag ":"))
4637 (message "%s" (substitute-command-keys
4638 "Subtree is archived and stays closed. Use \
4639 `\\[org-force-cycle-archived]' to cycle it anyway.")))))))
4641 (defun org-force-cycle-archived ()
4642 "Cycle subtree even if it is archived."
4643 (interactive)
4644 (setq this-command 'org-cycle)
4645 (let ((org-cycle-open-archived-trees t))
4646 (call-interactively 'org-cycle)))
4648 (defun org-hide-archived-subtrees (beg end)
4649 "Re-hide all archived subtrees after a visibility state change."
4650 (org-with-wide-buffer
4651 (let ((case-fold-search nil)
4652 (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":")))
4653 (goto-char beg)
4654 ;; Include headline point is currently on.
4655 (beginning-of-line)
4656 (while (and (< (point) end) (re-search-forward re end t))
4657 (when (member org-archive-tag (org-get-tags))
4658 (org-flag-subtree t)
4659 (org-end-of-subtree t))))))
4661 (declare-function outline-end-of-heading "outline" ())
4662 (declare-function outline-flag-region "outline" (from to flag))
4663 (defun org-flag-subtree (flag)
4664 (save-excursion
4665 (org-back-to-heading t)
4666 (outline-end-of-heading)
4667 (outline-flag-region (point)