org-agenda: Fix typo in docstring
[org-mode.git] / lisp / org.el
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-2016 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:
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
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 <>.
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 ;;
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 ;;
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"
119 (&optional arg start-day span with-hour))
120 (declare-function org-agenda-redo "org-agenda" (&optional all))
121 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body) t)
122 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
123 (declare-function org-beamer-mode "ox-beamer" (&optional prefix) t)
124 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
125 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
126 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
127 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
128 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
129 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
130 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
131 (declare-function org-clock-update-time-maybe "org-clock" ())
132 (declare-function org-clocktable-shift "org-clock" (dir n))
133 (declare-function org-element-at-point "org-element" ())
134 (declare-function org-element-cache-refresh "org-element" (pos))
135 (declare-function org-element-cache-reset "org-element" (&optional all))
136 (declare-function org-element-contents "org-element" (element))
137 (declare-function org-element-context "org-element" (&optional element))
138 (declare-function org-element-copy "org-element" (datum))
139 (declare-function org-element-interpret-data "org-element" (data))
140 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
141 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
142 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
143 (declare-function org-element-property "org-element" (property element))
144 (declare-function org-element-put-property "org-element" (element property value))
145 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
146 (declare-function org-element-type "org-element" (element))
147 (declare-function org-element-update-syntax "org-element" ())
148 (declare-function org-id-find-id-file "org-id" (id))
149 (declare-function org-id-get-create "org-id" (&optional force))
150 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
151 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
152 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
153 (declare-function org-plot/gnuplot "org-plot" (&optional params))
154 (declare-function org-table-align "org-table" ())
155 (declare-function org-table-begin "org-table" (&optional table-type))
156 (declare-function org-table-beginning-of-field "org-table" (&optional n))
157 (declare-function org-table-blank-field "org-table" ())
158 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
159 (declare-function org-table-copy-region "org-table" (beg end &optional cut))
160 (declare-function org-table-cut-region "org-table" (beg end))
161 (declare-function org-table-edit-field "org-table" (arg))
162 (declare-function org-table-end "org-table" (&optional table-type))
163 (declare-function org-table-end-of-field "org-table" (&optional n))
164 (declare-function org-table-insert-row "org-table" (&optional arg))
165 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
166 (declare-function org-table-maybe-eval-formula "org-table" ())
167 (declare-function org-table-maybe-recalculate-line "org-table" ())
168 (declare-function org-table-next-row "org-table" ())
169 (declare-function org-table-paste-rectangle "org-table" ())
170 (declare-function org-table-recalculate "org-table" (&optional all noalign))
171 (declare-function org-table-wrap-region "org-table" (arg))
172 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
173 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
174 (declare-function orgtbl-mode "org-table" (&optional arg))
176 (defsubst org-uniquify (list)
177 "Non-destructively remove duplicate elements from LIST."
178 (let ((res (copy-sequence list))) (delete-dups res)))
180 (defsubst org-get-at-bol (property)
181 "Get text property PROPERTY at the beginning of line."
182 (get-text-property (point-at-bol) property))
184 (defsubst org-trim (s &optional keep-lead)
185 "Remove whitespace at the beginning and the end of string S.
186 When optional argument KEEP-LEAD is non-nil, removing blank lines
187 at the beginning of the string does not affect leading indentation."
188 (replace-regexp-in-string
189 (if keep-lead "\\`\\([ \t]*\n\\)+" "\\`[ \t\n\r]+") ""
190 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
192 ;; load languages based on value of `org-babel-load-languages'
193 (defvar org-babel-load-languages)
195 ;;;###autoload
196 (defun org-babel-do-load-languages (sym value)
197 "Load the languages defined in `org-babel-load-languages'."
198 (set-default sym value)
199 (dolist (pair org-babel-load-languages)
200 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
201 (if active
202 (require (intern (concat "ob-" lang)))
203 (funcall 'fmakunbound
204 (intern (concat "org-babel-execute:" lang)))
205 (funcall 'fmakunbound
206 (intern (concat "org-babel-expand-body:" lang)))))))
208 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
209 ;;;###autoload
210 (defun org-babel-load-file (file &optional compile)
211 "Load Emacs Lisp source code blocks in the Org FILE.
212 This function exports the source code using `org-babel-tangle'
213 and then loads the resulting file using `load-file'. With prefix
214 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
215 file to byte-code before it is loaded."
216 (interactive "fFile to load: \nP")
217 (let* ((age (lambda (file)
218 (float-time
219 (time-subtract (current-time)
220 (nth 5 (or (file-attributes (file-truename file))
221 (file-attributes file)))))))
222 (base-name (file-name-sans-extension file))
223 (exported-file (concat base-name ".el")))
224 ;; tangle if the Org file is newer than the elisp file
225 (unless (and (file-exists-p exported-file)
226 (> (funcall age file) (funcall age exported-file)))
227 ;; Tangle-file traversal returns reversed list of tangled files
228 ;; and we want to evaluate the first target.
229 (setq exported-file
230 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
231 (message "%s %s"
232 (if compile
233 (progn (byte-compile-file exported-file 'load)
234 "Compiled and loaded")
235 (progn (load-file exported-file) "Loaded"))
236 exported-file)))
238 (defcustom org-babel-load-languages '((emacs-lisp . t))
239 "Languages which can be evaluated in Org buffers.
240 This list can be used to load support for any of the languages
241 below, note that each language will depend on a different set of
242 system executables and/or Emacs modes. When a language is
243 \"loaded\", then code blocks in that language can be evaluated
244 with `org-babel-execute-src-block' bound by default to C-c
245 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
246 be set to remove code block evaluation from the C-c C-c
247 keybinding. By default only Emacs Lisp (which has no
248 requirements) is loaded."
249 :group 'org-babel
250 :set 'org-babel-do-load-languages
251 :version "24.1"
252 :type '(alist :tag "Babel Languages"
253 :key-type
254 (choice
255 (const :tag "Awk" awk)
256 (const :tag "C" C)
257 (const :tag "R" R)
258 (const :tag "Asymptote" asymptote)
259 (const :tag "Calc" calc)
260 (const :tag "Clojure" clojure)
261 (const :tag "CSS" css)
262 (const :tag "Ditaa" ditaa)
263 (const :tag "Dot" dot)
264 (const :tag "Emacs Lisp" emacs-lisp)
265 (const :tag "Forth" forth)
266 (const :tag "Fortran" fortran)
267 (const :tag "Gnuplot" gnuplot)
268 (const :tag "Haskell" haskell)
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 "ebnf2ps" ebnf2ps))
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 (defconst org-comment-string "COMMENT"
526 "Entries starting with this keyword will never be exported.
527 \\<org-mode-map>
528 An entry can be toggled between COMMENT and normal with
529 `\\[org-toggle-comment]'.")
532 ;;;; LaTeX Environments and Fragments
534 (defconst org-latex-regexps
535 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
536 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
537 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
538 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
539 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
540 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
541 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
542 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
543 "Regular expressions for matching embedded LaTeX.")
545 ;;;; Node Property
547 (defconst org-effort-property "Effort"
548 "The property that is being used to keep track of effort estimates.
549 Effort estimates given in this property need to have the format H:MM.")
551 ;;;; Table
553 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
554 "Detect an org-type or table-type table.")
556 (defconst org-table-line-regexp "^[ \t]*|"
557 "Detect an org-type table line.")
559 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
560 "Detect an org-type table line.")
562 (defconst org-table-hline-regexp "^[ \t]*|-"
563 "Detect an org-type table hline.")
565 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
566 "Detect a table-type table hline.")
568 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
569 "Detect the first line outside a table when searching from within it.
570 This works for both table types.")
572 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
573 "Detect a #+TBLFM line.")
575 ;;;; Timestamp
577 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
578 "Regular expression for fast time stamp matching.")
580 (defconst org-ts-regexp-inactive
581 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
582 "Regular expression for fast inactive time stamp matching.")
584 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
585 "Regular expression for fast time stamp matching.")
587 (defconst org-ts-regexp0
588 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
589 "Regular expression matching time strings for analysis.
590 This one does not require the space after the date, so it can be used
591 on a string that terminates immediately after the date.")
593 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
594 "Regular expression matching time strings for analysis.")
596 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
597 "Regular expression matching time stamps, with groups.")
599 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
600 "Regular expression matching time stamps (also [..]), with groups.")
602 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
603 "Regular expression matching a time stamp range.")
605 (defconst org-tr-regexp-both
606 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
607 "Regular expression matching a time stamp range.")
609 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
610 org-ts-regexp "\\)?")
611 "Regular expression matching a time stamp or time stamp range.")
613 (defconst org-tsr-regexp-both
614 (concat org-ts-regexp-both "\\(--?-?"
615 org-ts-regexp-both "\\)?")
616 "Regular expression matching a time stamp or time stamp range.
617 The time stamps may be either active or inactive.")
619 (defconst org-repeat-re
620 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
621 "Regular expression for specifying repeated events.
622 After a match, group 1 contains the repeat expression.")
624 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
625 "Formats for `format-time-string' which are used for time stamps.")
628 ;;; The custom variables
630 (defgroup org nil
631 "Outline-based notes management and organizer."
632 :tag "Org"
633 :group 'outlines
634 :group 'calendar)
636 (defcustom org-mode-hook nil
637 "Mode hook for Org mode, run after the mode was turned on."
638 :group 'org
639 :type 'hook)
641 (defcustom org-load-hook nil
642 "Hook that is run after org.el has been loaded."
643 :group 'org
644 :type 'hook)
646 (defcustom org-log-buffer-setup-hook nil
647 "Hook that is run after an Org log buffer is created."
648 :group 'org
649 :version "24.1"
650 :type 'hook)
652 (defvar org-modules) ; defined below
653 (defvar org-modules-loaded nil
654 "Have the modules been loaded already?")
656 (defun org-load-modules-maybe (&optional force)
657 "Load all extensions listed in `org-modules'."
658 (when (or force (not org-modules-loaded))
659 (dolist (ext org-modules)
660 (condition-case nil (require ext)
661 (error (message "Problems while trying to load feature `%s'" ext))))
662 (setq org-modules-loaded t)))
664 (defun org-set-modules (var value)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (set var value)
667 (when (featurep 'org)
668 (org-load-modules-maybe 'force)
669 (org-element-cache-reset 'all)))
671 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
683 (provide \\='org-xyz)
685 For export specific modules, see also `org-export-backends'."
686 :group 'org
687 :set 'org-set-modules
688 :version "24.4"
689 :package-version '(Org . "8.0")
690 :type
691 '(set :greedy t
692 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
693 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
694 (const :tag " crypt: Encryption of subtrees" org-crypt)
695 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
696 (const :tag " docview: Links to doc-view buffers" org-docview)
697 (const :tag " eww: Store link to url of eww" org-eww)
698 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
699 (const :tag " habit: Track your consistency with habits" org-habit)
700 (const :tag " id: Global IDs for identifying entries" org-id)
701 (const :tag " info: Links to Info nodes" org-info)
702 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
703 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
704 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
705 (const :tag " mouse: Additional mouse support" org-mouse)
706 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
707 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
708 (const :tag " w3m: Special cut/paste from w3m to Org mode." org-w3m)
710 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
711 (const :tag "C bookmark: Org links to bookmarks" org-bookmark)
712 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
713 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
714 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
715 (const :tag "C collector: Collect properties into tables" org-collector)
716 (const :tag "C depend: TODO dependencies for Org mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
717 (const :tag "C drill: Flashcards and spaced repetition for Org mode" org-drill)
718 (const :tag "C elisp-symbol: Org links to emacs-lisp symbols" org-elisp-symbol)
719 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
720 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
721 (const :tag "C eval: Include command output as text" org-eval)
722 (const :tag "C expiry: Expiry mechanism for Org entries" org-expiry)
723 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
724 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
725 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
726 (const :tag "C invoice: Help manage client invoices in Org mode" org-invoice)
727 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
728 (const :tag "C mac-iCal Imports events from to the Emacs diary" org-mac-iCal)
729 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
730 (const :tag "C mairix: Hook mairix search into Org for different MUAs" org-mairix)
731 (const :tag "C man: Support for links to manpages in Org mode" org-man)
732 (const :tag "C mew: Links to Mew folders/messages" org-mew)
733 (const :tag "C mtags: Support for muse-like tags" org-mtags)
734 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
735 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
736 (const :tag "C registry: A registry for Org links" org-registry)
737 (const :tag "C screen: Visit screen sessions through Org links" org-screen)
738 (const :tag "C secretary: Team management with org-mode" org-secretary)
739 (const :tag "C sqlinsert: Convert Org tables to SQL insertions" orgtbl-sqlinsert)
740 (const :tag "C toc: Table of contents for Org buffer" org-toc)
741 (const :tag "C track: Keep up with Org mode development" org-track)
742 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
743 (const :tag "C vm: Links to VM folders/messages" org-vm)
744 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
745 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
746 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
748 (defvar org-export-registered-backends) ; From ox.el.
749 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
750 (declare-function org-export-backend-name "ox" (backend) t)
751 (defcustom org-export-backends '(ascii html icalendar latex odt)
752 "List of export back-ends that should be always available.
754 If a description starts with <C>, the file is not part of Emacs
755 and loading it will require that you have downloaded and properly
756 installed the Org mode distribution.
758 Unlike to `org-modules', libraries in this list will not be
759 loaded along with Org, but only once the export framework is
760 needed.
762 This variable needs to be set before org.el is loaded. If you
763 need to make a change while Emacs is running, use the customize
764 interface or run the following code, where VAL stands for the new
765 value of the variable, after updating it:
767 (progn
768 (setq org-export-registered-backends
769 (cl-remove-if-not
770 (lambda (backend)
771 (let ((name (org-export-backend-name backend)))
772 (or (memq name val)
773 (catch \\='parentp
774 (dolist (b val)
775 (and (org-export-derived-backend-p b name)
776 (throw \\='parentp t)))))))
777 org-export-registered-backends))
778 (let ((new-list (mapcar #\\='org-export-backend-name
779 org-export-registered-backends)))
780 (dolist (backend val)
781 (cond
782 ((not (load (format \"ox-%s\" backend) t t))
783 (message \"Problems while trying to load export back-end \\=`%s\\='\"
784 backend))
785 ((not (memq backend new-list)) (push backend new-list))))
786 (set-default \\='org-export-backends new-list)))
788 Adding a back-end to this list will also pull the back-end it
789 depends on, if any."
790 :group 'org
791 :group 'org-export
792 :version "25.2"
793 :package-version '(Org . "9.0")
794 :initialize 'custom-initialize-set
795 :set (lambda (var val)
796 (if (not (featurep 'ox)) (set-default var val)
797 ;; Any back-end not required anymore (not present in VAL and not
798 ;; a parent of any back-end in the new value) is removed from the
799 ;; list of registered back-ends.
800 (setq org-export-registered-backends
801 (cl-remove-if-not
802 (lambda (backend)
803 (let ((name (org-export-backend-name backend)))
804 (or (memq name val)
805 (catch 'parentp
806 (dolist (b val)
807 (and (org-export-derived-backend-p b name)
808 (throw 'parentp t)))))))
809 org-export-registered-backends))
810 ;; Now build NEW-LIST of both new back-ends and required
811 ;; parents.
812 (let ((new-list (mapcar #'org-export-backend-name
813 org-export-registered-backends)))
814 (dolist (backend val)
815 (cond
816 ((not (load (format "ox-%s" backend) t t))
817 (message "Problems while trying to load export back-end `%s'"
818 backend))
819 ((not (memq backend new-list)) (push backend new-list))))
820 ;; Set VAR to that list with fixed dependencies.
821 (set-default var new-list))))
822 :type '(set :greedy t
823 (const :tag " ascii Export buffer to ASCII format" ascii)
824 (const :tag " beamer Export buffer to Beamer presentation" beamer)
825 (const :tag " html Export buffer to HTML format" html)
826 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
827 (const :tag " latex Export buffer to LaTeX format" latex)
828 (const :tag " man Export buffer to MAN format" man)
829 (const :tag " md Export buffer to Markdown format" md)
830 (const :tag " odt Export buffer to ODT format" odt)
831 (const :tag " org Export buffer to Org format" org)
832 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
833 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
834 (const :tag "C deck Export buffer to deck.js presentations" deck)
835 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
836 (const :tag "C groff Export buffer to Groff format" groff)
837 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
838 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
839 (const :tag "C s5 Export buffer to s5 presentations" s5)
840 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
842 (eval-after-load 'ox
843 '(dolist (backend org-export-backends)
844 (condition-case nil (require (intern (format "ox-%s" backend)))
845 (error (message "Problems while trying to load export back-end `%s'"
846 backend)))))
848 (defcustom org-support-shift-select nil
849 "Non-nil means make shift-cursor commands select text when possible.
850 \\<org-mode-map>\
852 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
853 start selecting a region, or enlarge regions started in this way.
854 In Org mode, in special contexts, these same keys are used for
855 other purposes, important enough to compete with shift selection.
856 Org tries to balance these needs by supporting `shift-select-mode'
857 outside these special contexts, under control of this variable.
859 The default of this variable is nil, to avoid confusing behavior. Shifted
860 cursor keys will then execute Org commands in the following contexts:
861 - on a headline, changing TODO state (left/right) and priority (up/down)
862 - on a time stamp, changing the time
863 - in a plain list item, changing the bullet type
864 - in a property definition line, switching between allowed values
865 - in the BEGIN line of a clock table (changing the time block).
866 Outside these contexts, the commands will throw an error.
868 When this variable is t and the cursor is not in a special
869 context, Org mode will support shift-selection for making and
870 enlarging regions. To make this more effective, the bullet
871 cycling will no longer happen anywhere in an item line, but only
872 if the cursor is exactly on the bullet.
874 If you set this variable to the symbol `always', then the keys
875 will not be special in headlines, property lines, and item lines,
876 to make shift selection work there as well. If this is what you
877 want, you can use the following alternative commands:
878 `\\[org-todo]' and `\\[org-priority]' \
879 to change TODO state and priority,
880 `\\[universal-argument] \\[universal-argument] \\[org-todo]' \
881 can be used to switch TODO sets,
882 `\\[org-ctrl-c-minus]' to cycle item bullet types,
883 and properties can be edited by hand or in column view.
885 However, when the cursor is on a timestamp, shift-cursor commands
886 will still edit the time stamp - this is just too good to give up."
887 :group 'org
888 :type '(choice
889 (const :tag "Never" nil)
890 (const :tag "When outside special context" t)
891 (const :tag "Everywhere except timestamps" always)))
893 (defcustom org-loop-over-headlines-in-active-region nil
894 "Shall some commands act upon headlines in the active region?
896 When set to t, some commands will be performed in all headlines
897 within the active region.
899 When set to `start-level', some commands will be performed in all
900 headlines within the active region, provided that these headlines
901 are of the same level than the first one.
903 When set to a string, those commands will be performed on the
904 matching headlines within the active region. Such string must be
905 a tags/property/todo match as it is used in the agenda tags view.
907 The list of commands is: `org-schedule', `org-deadline',
908 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
909 `org-archive-to-archive-sibling'. The archiving commands skip
910 already archived entries."
911 :type '(choice (const :tag "Don't loop" nil)
912 (const :tag "All headlines in active region" t)
913 (const :tag "In active region, headlines at the same level than the first one" start-level)
914 (string :tag "Tags/Property/Todo matcher"))
915 :version "24.1"
916 :group 'org-todo
917 :group 'org-archive)
919 (defgroup org-startup nil
920 "Options concerning startup of Org mode."
921 :tag "Org Startup"
922 :group 'org)
924 (defcustom org-startup-folded t
925 "Non-nil means entering Org mode will switch to OVERVIEW.
927 This can also be configured on a per-file basis by adding one of
928 the following lines anywhere in the buffer:
930 #+STARTUP: fold (or `overview', this is equivalent)
931 #+STARTUP: nofold (or `showall', this is equivalent)
932 #+STARTUP: content
933 #+STARTUP: showeverything
935 Set `org-agenda-inhibit-startup' to a non-nil value if you want
936 to ignore this option when Org opens agenda files for the first
937 time."
938 :group 'org-startup
939 :type '(choice
940 (const :tag "nofold: show all" nil)
941 (const :tag "fold: overview" t)
942 (const :tag "content: all headlines" content)
943 (const :tag "show everything, even drawers" showeverything)))
945 (defcustom org-startup-truncated t
946 "Non-nil means entering Org mode will set `truncate-lines'.
947 This is useful since some lines containing links can be very long and
948 uninteresting. Also tables look terrible when wrapped.
950 The variable `org-startup-truncated' allows to configure
951 truncation for Org mode different to the other modes that use the
952 variable `truncate-lines' and as a shortcut instead of putting
953 the variable `truncate-lines' into the `org-mode-hook'. If one
954 wants to configure truncation for Org mode not statically but
955 dynamically e. g. in a hook like `ediff-prepare-buffer-hook' then
956 the variable `truncate-lines' has to be used because in such a
957 case it is too late to set the variable `org-startup-truncated'."
958 :group 'org-startup
959 :type 'boolean)
961 (defcustom org-startup-indented nil
962 "Non-nil means turn on `org-indent-mode' on startup.
963 This can also be configured on a per-file basis by adding one of
964 the following lines anywhere in the buffer:
966 #+STARTUP: indent
967 #+STARTUP: noindent"
968 :group 'org-structure
969 :type '(choice
970 (const :tag "Not" nil)
971 (const :tag "Globally (slow on startup in large files)" t)))
973 (defcustom org-use-sub-superscripts t
974 "Non-nil means interpret \"_\" and \"^\" for display.
976 If you want to control how Org exports those characters, see
977 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
978 used to be an alias for `org-export-with-sub-superscripts' in
979 Org <8.0, it is not anymore.
981 When this option is turned on, you can use TeX-like syntax for
982 sub- and superscripts within the buffer. Several characters after
983 \"_\" or \"^\" will be considered as a single item - so grouping
984 with {} is normally not needed. For example, the following things
985 will be parsed as single sub- or superscripts:
987 10^24 or 10^tau several digits will be considered 1 item.
988 10^-12 or 10^-tau a leading sign with digits or a word
989 x^2-y^3 will be read as x^2 - y^3, because items are
990 terminated by almost any nonword/nondigit char.
991 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
993 Still, ambiguity is possible. So when in doubt, use {} to enclose
994 the sub/superscript. If you set this variable to the symbol `{}',
995 the braces are *required* in order to trigger interpretations as
996 sub/superscript. This can be helpful in documents that need \"_\"
997 frequently in plain text."
998 :group 'org-startup
999 :version "24.4"
1000 :package-version '(Org . "8.0")
1001 :type '(choice
1002 (const :tag "Always interpret" t)
1003 (const :tag "Only with braces" {})
1004 (const :tag "Never interpret" nil)))
1006 (defcustom org-startup-with-beamer-mode nil
1007 "Non-nil means turn on `org-beamer-mode' on startup.
1008 This can also be configured on a per-file basis by adding one of
1009 the following lines anywhere in the buffer:
1011 #+STARTUP: beamer"
1012 :group 'org-startup
1013 :version "24.1"
1014 :type 'boolean)
1016 (defcustom org-startup-align-all-tables nil
1017 "Non-nil means align all tables when visiting a file.
1018 This is useful when the column width in tables is forced with <N> cookies
1019 in table fields. Such tables will look correct only after the first re-align.
1020 This can also be configured on a per-file basis by adding one of
1021 the following lines anywhere in the buffer:
1022 #+STARTUP: align
1023 #+STARTUP: noalign"
1024 :group 'org-startup
1025 :type 'boolean)
1027 (defcustom org-startup-with-inline-images nil
1028 "Non-nil means show inline images when loading a new Org file.
1029 This can also be configured on a per-file basis by adding one of
1030 the following lines anywhere in the buffer:
1031 #+STARTUP: inlineimages
1032 #+STARTUP: noinlineimages"
1033 :group 'org-startup
1034 :version "24.1"
1035 :type 'boolean)
1037 (defcustom org-startup-with-latex-preview nil
1038 "Non-nil means preview LaTeX fragments when loading a new Org file.
1040 This can also be configured on a per-file basis by adding one of
1041 the following lines anywhere in the buffer:
1042 #+STARTUP: latexpreview
1043 #+STARTUP: nolatexpreview"
1044 :group 'org-startup
1045 :version "24.4"
1046 :package-version '(Org . "8.0")
1047 :type 'boolean)
1049 (defcustom org-insert-mode-line-in-empty-file nil
1050 "Non-nil means insert the first line setting Org mode in empty files.
1051 When the function `org-mode' is called interactively in an empty file, this
1052 normally means that the file name does not automatically trigger Org mode.
1053 To ensure that the file will always be in Org mode in the future, a
1054 line enforcing Org mode will be inserted into the buffer, if this option
1055 has been set."
1056 :group 'org-startup
1057 :type 'boolean)
1059 (defcustom org-replace-disputed-keys nil
1060 "Non-nil means use alternative key bindings for some keys.
1061 Org mode uses S-<cursor> keys for changing timestamps and priorities.
1062 These keys are also used by other packages like shift-selection-mode'
1063 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1064 If you want to use Org mode together with one of these other modes,
1065 or more generally if you would like to move some Org mode commands to
1066 other keys, set this variable and configure the keys with the variable
1067 `org-disputed-keys'.
1069 This option is only relevant at load-time of Org mode, and must be set
1070 *before* org.el is loaded. Changing it requires a restart of Emacs to
1071 become effective."
1072 :group 'org-startup
1073 :type 'boolean)
1075 (defcustom org-use-extra-keys nil
1076 "Non-nil means use extra key sequence definitions for certain commands.
1077 This happens automatically if `window-system' is nil. This
1078 variable lets you do the same manually. You must set it before
1079 loading Org."
1080 :group 'org-startup
1081 :type 'boolean)
1083 (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1085 (defcustom org-disputed-keys
1086 '(([(shift up)] . [(meta p)])
1087 ([(shift down)] . [(meta n)])
1088 ([(shift left)] . [(meta -)])
1089 ([(shift right)] . [(meta +)])
1090 ([(control shift right)] . [(meta shift +)])
1091 ([(control shift left)] . [(meta shift -)]))
1092 "Keys for which Org mode and other modes compete.
1093 This is an alist, cars are the default keys, second element specifies
1094 the alternative to use when `org-replace-disputed-keys' is t.
1096 Keys can be specified in any syntax supported by `define-key'.
1097 The value of this option takes effect only at Org mode startup,
1098 therefore you'll have to restart Emacs to apply it after changing."
1099 :group 'org-startup
1100 :type 'alist)
1102 (defun org-key (key)
1103 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1104 Or return the original if not disputed."
1105 (when org-replace-disputed-keys
1106 (let* ((nkey (key-description key))
1107 (x (cl-find-if (lambda (x) (equal (key-description (car x)) nkey))
1108 org-disputed-keys)))
1109 (setq key (if x (cdr x) key))))
1110 key)
1112 (defun org-defkey (keymap key def)
1113 "Define a key, possibly translated, as returned by `org-key'."
1114 (define-key keymap (org-key key) def))
1116 (defcustom org-ellipsis nil
1117 "The ellipsis to use in the Org mode outline.
1119 When nil, just use the standard three dots.
1120 When a string, use that string instead.
1122 The change affects only Org mode (which will then use its own display table).
1123 Changing this requires executing `\\[org-mode]' in a buffer to become
1124 effective."
1125 :group 'org-startup
1126 :type '(choice (const :tag "Default" nil)
1127 (string :tag "String" :value "...#"))
1128 :safe #'string-or-null-p)
1130 (defvar org-display-table nil
1131 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1133 (defgroup org-keywords nil
1134 "Keywords in Org mode."
1135 :tag "Org Keywords"
1136 :group 'org)
1138 (defcustom org-closed-keep-when-no-todo nil
1139 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1140 :group 'org-todo
1141 :group 'org-keywords
1142 :version "24.4"
1143 :package-version '(Org . "8.0")
1144 :type 'boolean)
1146 (defgroup org-structure nil
1147 "Options concerning the general structure of Org files."
1148 :tag "Org Structure"
1149 :group 'org)
1151 (defgroup org-reveal-location nil
1152 "Options about how to make context of a location visible."
1153 :tag "Org Reveal Location"
1154 :group 'org-structure)
1156 (defcustom org-show-context-detail '((agenda . local)
1157 (bookmark-jump . lineage)
1158 (isearch . lineage)
1159 (default . ancestors))
1160 "Alist between context and visibility span when revealing a location.
1162 \\<org-mode-map>Some actions may move point into invisible
1163 locations. As a consequence, Org always expose a neighborhood
1164 around point. How much is shown depends on the initial action,
1165 or context. Valid contexts are
1167 agenda when exposing an entry from the agenda
1168 org-goto when using the command `org-goto' (`\\[org-goto]')
1169 occur-tree when using the command `org-occur' (`\\[org-sparse-tree] /')
1170 tags-tree when constructing a sparse tree based on tags matches
1171 link-search when exposing search matches associated with a link
1172 mark-goto when exposing the jump goal of a mark
1173 bookmark-jump when exposing a bookmark location
1174 isearch when exiting from an incremental search
1175 default default for all contexts not set explicitly
1177 Allowed visibility spans are
1179 minimal show current headline; if point is not on headline,
1180 also show entry
1182 local show current headline, entry and next headline
1184 ancestors show current headline and its direct ancestors; if
1185 point is not on headline, also show entry
1187 lineage show current headline, its direct ancestors and all
1188 their children; if point is not on headline, also show
1189 entry and first child
1191 tree show current headline, its direct ancestors and all
1192 their children; if point is not on headline, also show
1193 entry and all children
1195 canonical show current headline, its direct ancestors along with
1196 their entries and children; if point is not located on
1197 the headline, also show current entry and all children
1199 As special cases, a nil or t value means show all contexts in
1200 `minimal' or `canonical' view, respectively.
1202 Some views can make displayed information very compact, but also
1203 make it harder to edit the location of the match. In such
1204 a case, use the command `org-reveal' (`\\[org-reveal]') to show
1205 more context."
1206 :group 'org-reveal-location
1207 :version "25.2"
1208 :package-version '(Org . "9.0")
1209 :type '(choice
1210 (const :tag "Canonical" t)
1211 (const :tag "Minimal" nil)
1212 (repeat :greedy t :tag "Individual contexts"
1213 (cons
1214 (choice :tag "Context"
1215 (const agenda)
1216 (const org-goto)
1217 (const occur-tree)
1218 (const tags-tree)
1219 (const link-search)
1220 (const mark-goto)
1221 (const bookmark-jump)
1222 (const isearch)
1223 (const default))
1224 (choice :tag "Detail level"
1225 (const minimal)
1226 (const local)
1227 (const ancestors)
1228 (const lineage)
1229 (const tree)
1230 (const canonical))))))
1232 (defcustom org-indirect-buffer-display 'other-window
1233 "How should indirect tree buffers be displayed?
1235 This applies to indirect buffers created with the commands
1236 `org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
1238 Valid values are:
1239 current-window Display in the current window
1240 other-window Just display in another window.
1241 dedicated-frame Create one new frame, and re-use it each time.
1242 new-frame Make a new frame each time. Note that in this case
1243 previously-made indirect buffers are kept, and you need to
1244 kill these buffers yourself."
1245 :group 'org-structure
1246 :group 'org-agenda-windows
1247 :type '(choice
1248 (const :tag "In current window" current-window)
1249 (const :tag "In current frame, other window" other-window)
1250 (const :tag "Each time a new frame" new-frame)
1251 (const :tag "One dedicated frame" dedicated-frame)))
1253 (defcustom org-use-speed-commands nil
1254 "Non-nil means activate single letter commands at beginning of a headline.
1255 This may also be a function to test for appropriate locations where speed
1256 commands should be active.
1258 For example, to activate speed commands when the point is on any
1259 star at the beginning of the headline, you can do this:
1261 (setq org-use-speed-commands
1262 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1263 :group 'org-structure
1264 :type '(choice
1265 (const :tag "Never" nil)
1266 (const :tag "At beginning of headline stars" t)
1267 (function)))
1269 (defcustom org-speed-commands-user nil
1270 "Alist of additional speed commands.
1271 This list will be checked before `org-speed-commands-default'
1272 when the variable `org-use-speed-commands' is non-nil
1273 and when the cursor is at the beginning of a headline.
1274 The car if each entry is a string with a single letter, which must
1275 be assigned to `self-insert-command' in the global map.
1276 The cdr is either a command to be called interactively, a function
1277 to be called, or a form to be evaluated.
1278 An entry that is just a list with a single string will be interpreted
1279 as a descriptive headline that will be added when listing the speed
1280 commands in the Help buffer using the `?' speed command."
1281 :group 'org-structure
1282 :type '(repeat :value ("k" . ignore)
1283 (choice :value ("k" . ignore)
1284 (list :tag "Descriptive Headline" (string :tag "Headline"))
1285 (cons :tag "Letter and Command"
1286 (string :tag "Command letter")
1287 (choice
1288 (function)
1289 (sexp))))))
1291 (defcustom org-bookmark-names-plist
1292 '(:last-capture "org-capture-last-stored"
1293 :last-refile "org-refile-last-stored"
1294 :last-capture-marker "org-capture-last-stored-marker")
1295 "Names for bookmarks automatically set by some Org commands.
1296 This can provide strings as names for a number of bookmarks Org sets
1297 automatically. The following keys are currently implemented:
1298 :last-capture
1299 :last-capture-marker
1300 :last-refile
1301 When a key does not show up in the property list, the corresponding bookmark
1302 is not set."
1303 :group 'org-structure
1304 :type 'plist)
1306 (defgroup org-cycle nil
1307 "Options concerning visibility cycling in Org mode."
1308 :tag "Org Cycle"
1309 :group 'org-structure)
1311 (defcustom org-cycle-skip-children-state-if-no-children t
1312 "Non-nil means skip CHILDREN state in entries that don't have any."
1313 :group 'org-cycle
1314 :type 'boolean)
1316 (defcustom org-cycle-max-level nil
1317 "Maximum level which should still be subject to visibility cycling.
1318 Levels higher than this will, for cycling, be treated as text, not a headline.
1319 When `org-odd-levels-only' is set, a value of N in this variable actually
1320 means 2N-1 stars as the limiting headline.
1321 When nil, cycle all levels.
1322 Note that the limiting level of cycling is also influenced by
1323 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1324 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1325 than its value."
1326 :group 'org-cycle
1327 :type '(choice
1328 (const :tag "No limit" nil)
1329 (integer :tag "Maximum level")))
1331 (defcustom org-hide-block-startup nil
1332 "Non-nil means entering Org mode will fold all blocks.
1333 This can also be set in on a per-file basis with
1335 #+STARTUP: hideblocks
1336 #+STARTUP: showblocks"
1337 :group 'org-startup
1338 :group 'org-cycle
1339 :type 'boolean)
1341 (defcustom org-cycle-global-at-bob nil
1342 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1344 This makes it possible to do global cycling without having to use `S-TAB'
1345 or `\\[universal-argument] TAB'. For this special case to work, the first \
1346 line of the buffer
1347 must not be a headline -- it may be empty or some other text.
1349 When used in this way, `org-cycle-hook' is disabled temporarily to make
1350 sure the cursor stays at the beginning of the buffer.
1352 When this option is nil, don't do anything special at the beginning of
1353 the buffer."
1354 :group 'org-cycle
1355 :type 'boolean)
1357 (defcustom org-cycle-level-after-item/entry-creation t
1358 "Non-nil means cycle entry level or item indentation in new empty entries.
1360 When the cursor is at the end of an empty headline, i.e., with only stars
1361 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1362 and then all possible ancestor states, before returning to the original state.
1363 This makes data entry extremely fast: M-RET to create a new headline,
1364 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1366 When the cursor is at the end of an empty plain list item, one TAB will
1367 make it a subitem, two or more tabs will back up to make this an item
1368 higher up in the item hierarchy."
1369 :group 'org-cycle
1370 :type 'boolean)
1372 (defcustom org-cycle-emulate-tab t
1373 "Where should `org-cycle' emulate TAB.
1374 nil Never
1375 white Only in completely white lines
1376 whitestart Only at the beginning of lines, before the first non-white char
1377 t Everywhere except in headlines
1378 exc-hl-bol Everywhere except at the start of a headline
1379 If TAB is used in a place where it does not emulate TAB, the current subtree
1380 visibility is cycled."
1381 :group 'org-cycle
1382 :type '(choice (const :tag "Never" nil)
1383 (const :tag "Only in completely white lines" white)
1384 (const :tag "Before first char in a line" whitestart)
1385 (const :tag "Everywhere except in headlines" t)
1386 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1388 (defcustom org-cycle-separator-lines 2
1389 "Number of empty lines needed to keep an empty line between collapsed trees.
1390 If you leave an empty line between the end of a subtree and the following
1391 headline, this empty line is hidden when the subtree is folded.
1392 Org mode will leave (exactly) one empty line visible if the number of
1393 empty lines is equal or larger to the number given in this variable.
1394 So the default 2 means at least 2 empty lines after the end of a subtree
1395 are needed to produce free space between a collapsed subtree and the
1396 following headline.
1398 If the number is negative, and the number of empty lines is at least -N,
1399 all empty lines are shown.
1401 Special case: when 0, never leave empty lines in collapsed view."
1402 :group 'org-cycle
1403 :type 'integer)
1404 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1406 (defcustom org-pre-cycle-hook nil
1407 "Hook that is run before visibility cycling is happening.
1408 The function(s) in this hook must accept a single argument which indicates
1409 the new state that will be set right after running this hook. The
1410 argument is a symbol. Before a global state change, it can have the values
1411 `overview', `content', or `all'. Before a local state change, it can have
1412 the values `folded', `children', or `subtree'."
1413 :group 'org-cycle
1414 :type 'hook)
1416 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1417 org-cycle-hide-drawers
1418 org-cycle-show-empty-lines
1419 org-optimize-window-after-visibility-change)
1420 "Hook that is run after `org-cycle' has changed the buffer visibility.
1421 The function(s) in this hook must accept a single argument which indicates
1422 the new state that was set by the most recent `org-cycle' command. The
1423 argument is a symbol. After a global state change, it can have the values
1424 `overview', `contents', or `all'. After a local state change, it can have
1425 the values `folded', `children', or `subtree'."
1426 :group 'org-cycle
1427 :type 'hook
1428 :version "25.2"
1429 :package-version '(Org . "8.3"))
1431 (defgroup org-edit-structure nil
1432 "Options concerning structure editing in Org mode."
1433 :tag "Org Edit Structure"
1434 :group 'org-structure)
1436 (defcustom org-odd-levels-only nil
1437 "Non-nil means skip even levels and only use odd levels for the outline.
1438 This has the effect that two stars are being added/taken away in
1439 promotion/demotion commands. It also influences how levels are
1440 handled by the exporters.
1441 Changing it requires restart of `font-lock-mode' to become effective
1442 for fontification also in regions already fontified.
1443 You may also set this on a per-file basis by adding one of the following
1444 lines to the buffer:
1446 #+STARTUP: odd
1447 #+STARTUP: oddeven"
1448 :group 'org-edit-structure
1449 :group 'org-appearance
1450 :type 'boolean)
1452 (defcustom org-adapt-indentation t
1453 "Non-nil means adapt indentation to outline node level.
1455 When this variable is set, Org assumes that you write outlines by
1456 indenting text in each node to align with the headline (after the
1457 stars). The following issues are influenced by this variable:
1459 - The indentation is increased by one space in a demotion
1460 command, and decreased by one in a promotion command. However,
1461 in the latter case, if shifting some line in the entry body
1462 would alter document structure (e.g., insert a new headline),
1463 indentation is not changed at all.
1465 - Property drawers and planning information is inserted indented
1466 when this variable is set. When nil, they will not be indented.
1468 - TAB indents a line relative to current level. The lines below
1469 a headline will be indented when this variable is set.
1471 Note that this is all about true indentation, by adding and
1472 removing space characters. See also `org-indent.el' which does
1473 level-dependent indentation in a virtual way, i.e. at display
1474 time in Emacs."
1475 :group 'org-edit-structure
1476 :type 'boolean)
1478 (defcustom org-special-ctrl-a/e nil
1479 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1481 When t, `C-a' will bring back the cursor to the beginning of the
1482 headline text, i.e. after the stars and after a possible TODO
1483 keyword. In an item, this will be the position after bullet and
1484 check-box, if any. When the cursor is already at that position,
1485 another `C-a' will bring it to the beginning of the line.
1487 `C-e' will jump to the end of the headline, ignoring the presence
1488 of tags in the headline. A second `C-e' will then jump to the
1489 true end of the line, after any tags. This also means that, when
1490 this variable is non-nil, `C-e' also will never jump beyond the
1491 end of the heading of a folded section, i.e. not after the
1492 ellipses.
1494 When set to the symbol `reversed', the first `C-a' or `C-e' works
1495 normally, going to the true line boundary first. Only a directly
1496 following, identical keypress will bring the cursor to the
1497 special positions.
1499 This may also be a cons cell where the behavior for `C-a' and
1500 `C-e' is set separately."
1501 :group 'org-edit-structure
1502 :type '(choice
1503 (const :tag "off" nil)
1504 (const :tag "on: after stars/bullet and before tags first" t)
1505 (const :tag "reversed: true line boundary first" reversed)
1506 (cons :tag "Set C-a and C-e separately"
1507 (choice :tag "Special C-a"
1508 (const :tag "off" nil)
1509 (const :tag "on: after stars/bullet first" t)
1510 (const :tag "reversed: before stars/bullet first" reversed))
1511 (choice :tag "Special C-e"
1512 (const :tag "off" nil)
1513 (const :tag "on: before tags first" t)
1514 (const :tag "reversed: after tags first" reversed)))))
1515 (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1517 (defcustom org-special-ctrl-k nil
1518 "Non-nil means `C-k' will behave specially in headlines.
1519 When nil, `C-k' will call the default `kill-line' command.
1520 When t, the following will happen while the cursor is in the headline:
1522 - When the cursor is at the beginning of a headline, kill the entire
1523 line and possible the folded subtree below the line.
1524 - When in the middle of the headline text, kill the headline up to the tags.
1525 - When after the headline text, kill the tags."
1526 :group 'org-edit-structure
1527 :type 'boolean)
1529 (defcustom org-ctrl-k-protect-subtree nil
1530 "Non-nil means, do not delete a hidden subtree with C-k.
1531 When set to the symbol `error', simply throw an error when C-k is
1532 used to kill (part-of) a headline that has hidden text behind it.
1533 Any other non-nil value will result in a query to the user, if it is
1534 OK to kill that hidden subtree. When nil, kill without remorse."
1535 :group 'org-edit-structure
1536 :version "24.1"
1537 :type '(choice
1538 (const :tag "Do not protect hidden subtrees" nil)
1539 (const :tag "Protect hidden subtrees with a security query" t)
1540 (const :tag "Never kill a hidden subtree with C-k" error)))
1542 (defcustom org-special-ctrl-o t
1543 "Non-nil means, make `C-o' insert a row in tables."
1544 :group 'org-edit-structure
1545 :type 'boolean)
1547 (defcustom org-catch-invisible-edits nil
1548 "Check if in invisible region before inserting or deleting a character.
1549 Valid values are:
1551 nil Do not check, so just do invisible edits.
1552 error Throw an error and do nothing.
1553 show Make point visible, and do the requested edit.
1554 show-and-error Make point visible, then throw an error and abort the edit.
1555 smart Make point visible, and do insertion/deletion if it is
1556 adjacent to visible text and the change feels predictable.
1557 Never delete a previously invisible character or add in the
1558 middle or right after an invisible region. Basically, this
1559 allows insertion and backward-delete right before ellipses.
1560 FIXME: maybe in this case we should not even show?"
1561 :group 'org-edit-structure
1562 :version "24.1"
1563 :type '(choice
1564 (const :tag "Do not check" nil)
1565 (const :tag "Throw error when trying to edit" error)
1566 (const :tag "Unhide, but do not do the edit" show-and-error)
1567 (const :tag "Show invisible part and do the edit" show)
1568 (const :tag "Be smart and do the right thing" smart)))
1570 (defcustom org-yank-folded-subtrees t
1571 "Non-nil means when yanking subtrees, fold them.
1572 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1573 it starts with a heading and all other headings in it are either children
1574 or siblings, then fold all the subtrees. However, do this only if no
1575 text after the yank would be swallowed into a folded tree by this action."
1576 :group 'org-edit-structure
1577 :type 'boolean)
1579 (defcustom org-yank-adjusted-subtrees nil
1580 "Non-nil means when yanking subtrees, adjust the level.
1581 With this setting, `org-paste-subtree' is used to insert the subtree, see
1582 this function for details."
1583 :group 'org-edit-structure
1584 :type 'boolean)
1586 (defcustom org-M-RET-may-split-line '((default . t))
1587 "Non-nil means M-RET will split the line at the cursor position.
1588 When nil, it will go to the end of the line before making a
1589 new line.
1590 You may also set this option in a different way for different
1591 contexts. Valid contexts are:
1593 headline when creating a new headline
1594 item when creating a new item
1595 table in a table field
1596 default the value to be used for all contexts not explicitly
1597 customized"
1598 :group 'org-structure
1599 :group 'org-table
1600 :type '(choice
1601 (const :tag "Always" t)
1602 (const :tag "Never" nil)
1603 (repeat :greedy t :tag "Individual contexts"
1604 (cons
1605 (choice :tag "Context"
1606 (const headline)
1607 (const item)
1608 (const table)
1609 (const default))
1610 (boolean)))))
1613 (defcustom org-insert-heading-respect-content nil
1614 "Non-nil means insert new headings after the current subtree.
1615 \\<org-mode-map>
1616 When nil, the new heading is created directly after the current line.
1617 The commands `\\[org-insert-heading-respect-content]' and \
1618 `\\[org-insert-todo-heading-respect-content]' turn this variable on
1619 for the duration of the command."
1620 :group 'org-structure
1621 :type 'boolean)
1623 (defcustom org-blank-before-new-entry '((heading . auto)
1624 (plain-list-item . auto))
1625 "Should `org-insert-heading' leave a blank line before new heading/item?
1626 The value is an alist, with `heading' and `plain-list-item' as CAR,
1627 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1628 which case Org will look at the surrounding headings/items and try to
1629 make an intelligent decision whether to insert a blank line or not."
1630 :group 'org-edit-structure
1631 :type '(list
1632 (cons (const heading)
1633 (choice (const :tag "Never" nil)
1634 (const :tag "Always" t)
1635 (const :tag "Auto" auto)))
1636 (cons (const plain-list-item)
1637 (choice (const :tag "Never" nil)
1638 (const :tag "Always" t)
1639 (const :tag "Auto" auto)))))
1641 (defcustom org-insert-heading-hook nil
1642 "Hook being run after inserting a new heading."
1643 :group 'org-edit-structure
1644 :type 'hook)
1646 (defcustom org-enable-fixed-width-editor t
1647 "Non-nil means lines starting with \":\" are treated as fixed-width.
1648 This currently only means they are never auto-wrapped.
1649 When nil, such lines will be treated like ordinary lines."
1650 :group 'org-edit-structure
1651 :type 'boolean)
1653 (defcustom org-goto-auto-isearch t
1654 "Non-nil means typing characters in `org-goto' starts incremental search.
1655 When nil, you can use these keybindings to navigate the buffer:
1657 q Quit the org-goto interface
1658 n Go to the next visible heading
1659 p Go to the previous visible heading
1660 f Go one heading forward on same level
1661 b Go one heading backward on same level
1662 u Go one heading up"
1663 :group 'org-edit-structure
1664 :type 'boolean)
1666 (defgroup org-sparse-trees nil
1667 "Options concerning sparse trees in Org mode."
1668 :tag "Org Sparse Trees"
1669 :group 'org-structure)
1671 (defcustom org-highlight-sparse-tree-matches t
1672 "Non-nil means highlight all matches that define a sparse tree.
1673 The highlights will automatically disappear the next time the buffer is
1674 changed by an edit command."
1675 :group 'org-sparse-trees
1676 :type 'boolean)
1678 (defcustom org-remove-highlights-with-change t
1679 "Non-nil means any change to the buffer will remove temporary highlights.
1680 \\<org-mode-map>\
1681 Such highlights are created by `org-occur' and `org-clock-display'.
1682 When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
1683 to get rid of the highlights.
1684 The highlights created by `org-toggle-latex-fragment' always need
1685 `\\[org-toggle-latex-fragment]' to be removed."
1686 :group 'org-sparse-trees
1687 :group 'org-time
1688 :type 'boolean)
1690 (defcustom org-occur-case-fold-search t
1691 "Non-nil means `org-occur' should be case-insensitive.
1692 If set to `smart' the search will be case-insensitive only if it
1693 doesn't specify any upper case character."
1694 :group 'org-sparse-trees
1695 :version "25.2"
1696 :type '(choice
1697 (const :tag "Case-sensitive" nil)
1698 (const :tag "Case-insensitive" t)
1699 (const :tag "Case-insensitive for lower case searches only" 'smart)))
1701 (defcustom org-occur-hook '(org-first-headline-recenter)
1702 "Hook that is run after `org-occur' has constructed a sparse tree.
1703 This can be used to recenter the window to show as much of the structure
1704 as possible."
1705 :group 'org-sparse-trees
1706 :type 'hook)
1708 (defgroup org-imenu-and-speedbar nil
1709 "Options concerning imenu and speedbar in Org mode."
1710 :tag "Org Imenu and Speedbar"
1711 :group 'org-structure)
1713 (defcustom org-imenu-depth 2
1714 "The maximum level for Imenu access to Org headlines.
1715 This also applied for speedbar access."
1716 :group 'org-imenu-and-speedbar
1717 :type 'integer)
1719 (defgroup org-table nil
1720 "Options concerning tables in Org mode."
1721 :tag "Org Table"
1722 :group 'org)
1724 (defcustom org-enable-table-editor 'optimized
1725 "Non-nil means lines starting with \"|\" are handled by the table editor.
1726 When nil, such lines will be treated like ordinary lines.
1728 When equal to the symbol `optimized', the table editor will be optimized to
1729 do the following:
1730 - Automatic overwrite mode in front of whitespace in table fields.
1731 This makes the structure of the table stay in tact as long as the edited
1732 field does not exceed the column width.
1733 - Minimize the number of realigns. Normally, the table is aligned each time
1734 TAB or RET are pressed to move to another field. With optimization this
1735 happens only if changes to a field might have changed the column width.
1736 Optimization requires replacing the functions `self-insert-command',
1737 `delete-char', and `backward-delete-char' in Org buffers, with a
1738 slight (in fact: unnoticeable) speed impact for normal typing. Org is very
1739 good at guessing when a re-align will be necessary, but you can always
1740 force one with `\\[org-ctrl-c-ctrl-c]'.
1742 If you would like to use the optimized version in Org mode, but the
1743 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1745 This variable can be used to turn on and off the table editor during a session,
1746 but in order to toggle optimization, a restart is required.
1748 See also the variable `org-table-auto-blank-field'."
1749 :group 'org-table
1750 :type '(choice
1751 (const :tag "off" nil)
1752 (const :tag "on" t)
1753 (const :tag "on, optimized" optimized)))
1755 (defcustom org-self-insert-cluster-for-undo nil
1756 "Non-nil means cluster self-insert commands for undo when possible.
1757 If this is set, then, like in the Emacs command loop, 20 consecutive
1758 characters will be undone together.
1759 This is configurable, because there is some impact on typing performance."
1760 :group 'org-table
1761 :type 'boolean)
1763 (defcustom org-table-tab-recognizes-table.el t
1764 "Non-nil means TAB will automatically notice a table.el table.
1765 When it sees such a table, it moves point into it and - if necessary -
1766 calls `table-recognize-table'."
1767 :group 'org-table-editing
1768 :type 'boolean)
1770 (defgroup org-link nil
1771 "Options concerning links in Org mode."
1772 :tag "Org Link"
1773 :group 'org)
1775 (defvar-local org-link-abbrev-alist-local nil
1776 "Buffer-local version of `org-link-abbrev-alist', which see.
1777 The value of this is taken from the #+LINK lines.")
1779 (defcustom org-link-parameters
1780 '(("doi" :follow org--open-doi-link)
1781 ("elisp" :follow org--open-elisp-link)
1782 ("file" :complete org-file-complete-link)
1783 ("ftp" :follow (lambda (path) (browse-url (concat "ftp:" path))))
1784 ("help" :follow org--open-help-link)
1785 ("http" :follow (lambda (path) (browse-url (concat "http:" path))))
1786 ("https" :follow (lambda (path) (browse-url (concat "https:" path))))
1787 ("mailto" :follow (lambda (path) (browse-url (concat "mailto:" path))))
1788 ("message" :follow (lambda (path) (browse-url (concat "message:" path))))
1789 ("news" :follow (lambda (path) (browse-url (concat "news:" path))))
1790 ("shell" :follow org--open-shell-link))
1791 "An alist of properties that defines all the links in Org mode.
1792 The key in each association is a string of the link type.
1793 Subsequent optional elements make up a p-list of link properties.
1795 :follow - A function that takes the link path as an argument.
1797 :export - A function that takes the link path, description and
1798 export-backend as arguments.
1800 :store - A function responsible for storing the link. See the
1801 function `org-store-link-functions'.
1803 :complete - A function that inserts a link with completion. The
1804 function takes one optional prefix arg.
1806 :face - A face for the link, or a function that returns a face.
1807 The function takes one argument which is the link path. The
1808 default face is `org-link'.
1810 :mouse-face - The mouse-face. The default is `highlight'.
1812 :display - `full' will not fold the link in descriptive
1813 display. Default is `org-link'.
1815 :help-echo - A string or function that takes (window object position)
1816 as arguments and returns a string.
1818 :keymap - A keymap that is active on the link. The default is
1819 `org-mouse-map'.
1821 :htmlize-link - A function for the htmlize-link. Defaults
1822 to (list :uri \"type:path\")
1824 :activate-func - A function to run at the end of font-lock
1825 activation. The function must accept (link-start link-end path bracketp)
1826 as arguments."
1827 :group 'org-link
1828 :type '(alist :tag "Link display parameters"
1829 :value-type plist))
1831 (defun org-link-get-parameter (type key)
1832 "Get TYPE link property for KEY.
1833 TYPE is a string and KEY is a plist keyword."
1834 (plist-get
1835 (cdr (assoc type org-link-parameters))
1836 key))
1838 (defun org-link-set-parameters (type &rest parameters)
1839 "Set link TYPE properties to PARAMETERS.
1840 PARAMETERS should be :key val pairs."
1841 (let ((data (assoc type org-link-parameters)))
1842 (if data (setcdr data (org-combine-plists (cdr data) parameters))
1843 (push (cons type parameters) org-link-parameters)
1844 (org-make-link-regexps)
1845 (org-element-update-syntax))))
1847 (defun org-link-types ()
1848 "Return a list of known link types."
1849 (mapcar #'car org-link-parameters))
1851 (defcustom org-link-abbrev-alist nil
1852 "Alist of link abbreviations.
1853 The car of each element is a string, to be replaced at the start of a link.
1854 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1855 links in Org buffers can have an optional tag after a double colon, e.g.,
1857 [[linkkey:tag][description]]
1859 The `linkkey' must be a single word, starting with a letter, followed
1860 by letters, numbers, `-' or `_'.
1862 If REPLACE is a string, the tag will simply be appended to create the link.
1863 If the string contains \"%s\", the tag will be inserted there. If the string
1864 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1865 at that point (see the function `url-hexify-string'). If the string contains
1866 the specifier \"%(my-function)\", then the custom function `my-function' will
1867 be invoked: this function takes the tag as its only argument and must return
1868 a string.
1870 REPLACE may also be a function that will be called with the tag as the
1871 only argument to create the link, which should be returned as a string.
1873 See the manual for examples."
1874 :group 'org-link
1875 :type '(repeat
1876 (cons
1877 (string :tag "Protocol")
1878 (choice
1879 (string :tag "Format")
1880 (function)))))
1882 (defcustom org-descriptive-links t
1883 "Non-nil means Org will display descriptive links.
1884 E.g. [[][Org website]] will be displayed as
1885 \"Org Website\", hiding the link itself and just displaying its
1886 description. When set to nil, Org will display the full links
1887 literally.
1889 You can interactively set the value of this variable by calling
1890 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1891 :group 'org-link
1892 :type 'boolean)
1894 (defcustom org-link-file-path-type 'adaptive
1895 "How the path name in file links should be stored.
1896 Valid values are:
1898 relative Relative to the current directory, i.e. the directory of the file
1899 into which the link is being inserted.
1900 absolute Absolute path, if possible with ~ for home directory.
1901 noabbrev Absolute path, no abbreviation of home directory.
1902 adaptive Use relative path for files in the current directory and sub-
1903 directories of it. For other files, use an absolute path."
1904 :group 'org-link
1905 :type '(choice
1906 (const relative)
1907 (const absolute)
1908 (const noabbrev)
1909 (const adaptive)))
1911 (defvaralias 'org-activate-links 'org-highlight-links)
1912 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1913 "Types of links that should be highlighted in Org files.
1915 This is a list of symbols, each one of them leading to the
1916 highlighting of a certain link type.
1918 You can still open links that are not highlighted.
1920 In principle, it does not hurt to turn on highlighting for all
1921 link types. There may be a small gain when turning off unused
1922 link types. The types are:
1924 bracket The recommended [[link][description]] or [[link]] links with hiding.
1925 angle Links in angular brackets that may contain whitespace like
1926 <bbdb:Carsten Dominik>.
1927 plain Plain links in normal text, no whitespace, like
1928 radio Text that is matched by a radio target, see manual for details.
1929 tag Tag settings in a headline (link to tag search).
1930 date Time stamps (link to calendar).
1931 footnote Footnote labels.
1933 If you set this variable during an Emacs session, use `org-mode-restart'
1934 in the Org buffer so that the change takes effect."
1935 :group 'org-link
1936 :group 'org-appearance
1937 :type '(set :greedy t
1938 (const :tag "Double bracket links" bracket)
1939 (const :tag "Angular bracket links" angle)
1940 (const :tag "Plain text links" plain)
1941 (const :tag "Radio target matches" radio)
1942 (const :tag "Tags" tag)
1943 (const :tag "Timestamps" date)
1944 (const :tag "Footnotes" footnote)))
1946 (defcustom org-make-link-description-function nil
1947 "Function to use for generating link descriptions from links.
1948 When nil, the link location will be used. This function must take
1949 two parameters: the first one is the link, the second one is the
1950 description generated by `org-insert-link'. The function should
1951 return the description to use."
1952 :group 'org-link
1953 :type '(choice (const nil) (function)))
1955 (defgroup org-link-store nil
1956 "Options concerning storing links in Org mode."
1957 :tag "Org Store Link"
1958 :group 'org-link)
1960 (defcustom org-url-hexify-p t
1961 "When non-nil, hexify URL when creating a link."
1962 :type 'boolean
1963 :version "24.3"
1964 :group 'org-link-store)
1966 (defcustom org-email-link-description-format "Email %c: %.30s"
1967 "Format of the description part of a link to an email or usenet message.
1968 The following %-escapes will be replaced by corresponding information:
1970 %F full \"From\" field
1971 %f name, taken from \"From\" field, address if no name
1972 %T full \"To\" field
1973 %t first name in \"To\" field, address if no name
1974 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1975 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1976 %s subject
1977 %d date
1978 %m message-id.
1980 You may use normal field width specification between the % and the letter.
1981 This is for example useful to limit the length of the subject.
1983 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1984 :group 'org-link-store
1985 :type 'string)
1987 (defcustom org-from-is-user-regexp
1988 (let (r1 r2)
1989 (when (and user-mail-address (not (string= user-mail-address "")))
1990 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1991 (when (and user-full-name (not (string= user-full-name "")))
1992 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1993 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1994 "Regexp matched against the \"From:\" header of an email or usenet message.
1995 It should match if the message is from the user him/herself."
1996 :group 'org-link-store
1997 :type 'regexp)
1999 (defcustom org-context-in-file-links t
2000 "Non-nil means file links from `org-store-link' contain context.
2001 \\<org-mode-map>
2002 A search string will be added to the file name with :: as separator
2003 and used to find the context when the link is activated by the command
2004 `org-open-at-point'. When this option is t, the entire active region
2005 will be placed in the search string of the file link. If set to a
2006 positive integer, only the first n lines of context will be stored.
2008 Using a prefix arg to the command `org-store-link' (`\\[universal-argument] \
2009 \\[org-store-link]')
2010 negates this setting for the duration of the command."
2011 :group 'org-link-store
2012 :type '(choice boolean integer))
2014 (defcustom org-keep-stored-link-after-insertion nil
2015 "Non-nil means keep link in list for entire session.
2016 \\<org-mode-map>
2017 The command `org-store-link' adds a link pointing to the current
2018 location to an internal list. These links accumulate during a session.
2019 The command `org-insert-link' can be used to insert links into any
2020 Org file (offering completion for all stored links).
2022 When this option is nil, every link which has been inserted once using
2023 `\\[org-insert-link]' will be removed from the list, to make completing the \
2024 unused
2025 links more efficient."
2026 :group 'org-link-store
2027 :type 'boolean)
2029 (defgroup org-link-follow nil
2030 "Options concerning following links in Org mode."
2031 :tag "Org Follow Link"
2032 :group 'org-link)
2034 (defcustom org-link-translation-function nil
2035 "Function to translate links with different syntax to Org syntax.
2036 This can be used to translate links created for example by the Planner
2037 or emacs-wiki packages to Org syntax.
2038 The function must accept two parameters, a TYPE containing the link
2039 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
2040 which is everything after the link protocol. It should return a cons
2041 with possibly modified values of type and path.
2042 Org contains a function for this, so if you set this variable to
2043 `org-translate-link-from-planner', you should be able follow many
2044 links created by planner."
2045 :group 'org-link-follow
2046 :type '(choice (const nil) (function)))
2048 (defcustom org-follow-link-hook nil
2049 "Hook that is run after a link has been followed."
2050 :group 'org-link-follow
2051 :type 'hook)
2053 (defcustom org-tab-follows-link nil
2054 "Non-nil means on links TAB will follow the link.
2055 Needs to be set before org.el is loaded.
2056 This really should not be used, it does not make sense, and the
2057 implementation is bad."
2058 :group 'org-link-follow
2059 :type 'boolean)
2061 (defcustom org-return-follows-link nil
2062 "Non-nil means on links RET will follow the link.
2063 In tables, the special behavior of RET has precedence."
2064 :group 'org-link-follow
2065 :type 'boolean)
2067 (defcustom org-mouse-1-follows-link
2068 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
2069 "Non-nil means mouse-1 on a link will follow the link.
2070 A longer mouse click will still set point. Needs to be set
2071 before org.el is loaded."
2072 :group 'org-link-follow
2073 :version "24.4"
2074 :package-version '(Org . "8.3")
2075 :type '(choice
2076 (const :tag "A double click follows the link" double)
2077 (const :tag "Unconditionally follow the link with mouse-1" t)
2078 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
2080 (defcustom org-mark-ring-length 4
2081 "Number of different positions to be recorded in the ring.
2082 Changing this requires a restart of Emacs to work correctly."
2083 :group 'org-link-follow
2084 :type 'integer)
2086 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2087 "Non-nil means internal fuzzy links can only match headlines.
2089 When nil, the a fuzzy link may point to a target or a named
2090 construct in the document. When set to the special value
2091 `query-to-create', offer to create a new headline when none
2092 matched.
2094 Spaces and statistics cookies are ignored during heading searches."
2095 :group 'org-link-follow
2096 :version "24.1"
2097 :type '(choice
2098 (const :tag "Use fuzzy text search" nil)
2099 (const :tag "Match only exact headline" t)
2100 (const :tag "Match exact headline or query to create it"
2101 query-to-create))
2102 :safe #'symbolp)
2104 (defcustom org-link-frame-setup
2105 '((vm . vm-visit-folder-other-frame)
2106 (vm-imap . vm-visit-imap-folder-other-frame)
2107 (gnus . org-gnus-no-new-news)
2108 (file . find-file-other-window)
2109 (wl . wl-other-frame))
2110 "Setup the frame configuration for following links.
2111 When following a link with Emacs, it may often be useful to display
2112 this link in another window or frame. This variable can be used to
2113 set this up for the different types of links.
2114 For VM, use any of
2115 `vm-visit-folder'
2116 `vm-visit-folder-other-window'
2117 `vm-visit-folder-other-frame'
2118 For Gnus, use any of
2119 `gnus'
2120 `gnus-other-frame'
2121 `org-gnus-no-new-news'
2122 For FILE, use any of
2123 `find-file'
2124 `find-file-other-window'
2125 `find-file-other-frame'
2126 For Wanderlust use any of
2127 `wl'
2128 `wl-other-frame'
2129 For the calendar, use the variable `calendar-setup'.
2130 For BBDB, it is currently only possible to display the matches in
2131 another window."
2132 :group 'org-link-follow
2133 :type '(list
2134 (cons (const vm)
2135 (choice
2136 (const vm-visit-folder)
2137 (const vm-visit-folder-other-window)
2138 (const vm-visit-folder-other-frame)))
2139 (cons (const vm-imap)
2140 (choice
2141 (const vm-visit-imap-folder)
2142 (const vm-visit-imap-folder-other-window)
2143 (const vm-visit-imap-folder-other-frame)))
2144 (cons (const gnus)
2145 (choice
2146 (const gnus)
2147 (const gnus-other-frame)
2148 (const org-gnus-no-new-news)))
2149 (cons (const file)
2150 (choice
2151 (const find-file)
2152 (const find-file-other-window)
2153 (const find-file-other-frame)))
2154 (cons (const wl)
2155 (choice
2156 (const wl)
2157 (const wl-other-frame)))))
2159 (defcustom org-display-internal-link-with-indirect-buffer nil
2160 "Non-nil means use indirect buffer to display infile links.
2161 Activating internal links (from one location in a file to another location
2162 in the same file) normally just jumps to the location. When the link is
2163 activated with a `\\[universal-argument]' prefix (or with mouse-3), the link \
2164 is displayed in
2165 another window. When this option is set, the other window actually displays
2166 an indirect buffer clone of the current buffer, to avoid any visibility
2167 changes to the current buffer."
2168 :group 'org-link-follow
2169 :type 'boolean)
2171 (defcustom org-open-non-existing-files nil
2172 "Non-nil means `org-open-file' will open non-existing files.
2173 When nil, an error will be generated.
2174 This variable applies only to external applications because they
2175 might choke on non-existing files. If the link is to a file that
2176 will be opened in Emacs, the variable is ignored."
2177 :group 'org-link-follow
2178 :type 'boolean)
2180 (defcustom org-open-directory-means-index-dot-org nil
2181 "Non-nil means a link to a directory really means to
2182 When nil, following a directory link will run dired or open a finder/explorer
2183 window on that directory."
2184 :group 'org-link-follow
2185 :type 'boolean)
2187 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2188 "Non-nil means ask for confirmation before executing shell links.
2189 Shell links can be dangerous: just think about a link
2191 [[shell:rm -rf ~/*][Google Search]]
2193 This link would show up in your Org document as \"Google Search\",
2194 but really it would remove your entire home directory.
2195 Therefore we advise against setting this variable to nil.
2196 Just change it to `y-or-n-p' if you want to confirm with a
2197 single keystroke rather than having to type \"yes\"."
2198 :group 'org-link-follow
2199 :type '(choice
2200 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2201 (const :tag "with y-or-n (faster)" y-or-n-p)
2202 (const :tag "no confirmation (dangerous)" nil)))
2203 (put 'org-confirm-shell-link-function
2204 'safe-local-variable
2205 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2207 (defcustom org-confirm-shell-link-not-regexp ""
2208 "A regexp to skip confirmation for shell links."
2209 :group 'org-link-follow
2210 :version "24.1"
2211 :type 'regexp)
2213 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2214 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2215 Elisp links can be dangerous: just think about a link
2217 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2219 This link would show up in your Org document as \"Google Search\",
2220 but really it would remove your entire home directory.
2221 Therefore we advise against setting this variable to nil.
2222 Just change it to `y-or-n-p' if you want to confirm with a
2223 single keystroke rather than having to type \"yes\"."
2224 :group 'org-link-follow
2225 :type '(choice
2226 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2227 (const :tag "with y-or-n (faster)" y-or-n-p)
2228 (const :tag "no confirmation (dangerous)" nil)))
2229 (put 'org-confirm-shell-link-function
2230 'safe-local-variable
2231 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2233 (defcustom org-confirm-elisp-link-not-regexp ""
2234 "A regexp to skip confirmation for Elisp links."
2235 :group 'org-link-follow
2236 :version "24.1"
2237 :type 'regexp)
2239 (defconst org-file-apps-defaults-gnu
2240 '((remote . emacs)
2241 (system . mailcap)
2242 (t . mailcap))
2243 "Default file applications on a UNIX or GNU/Linux system.
2244 See `org-file-apps'.")
2246 (defconst org-file-apps-defaults-macosx
2247 '((remote . emacs)
2248 (system . "open %s")
2249 ("ps.gz" . "gv %s")
2250 ("eps.gz" . "gv %s")
2251 ("dvi" . "xdvi %s")
2252 ("fig" . "xfig %s")
2253 (t . "open %s"))
2254 "Default file applications on a macOS system.
2255 The system \"open\" is known as a default, but we use X11 applications
2256 for some files for which the OS does not have a good default.
2257 See `org-file-apps'.")
2259 (defconst org-file-apps-defaults-windowsnt
2260 (list '(remote . emacs)
2261 (cons 'system (lambda (file _path)
2262 (with-no-warnings (w32-shell-execute "open" file))))
2263 (cons t (lambda (file _path)
2264 (with-no-warnings (w32-shell-execute "open" file)))))
2265 "Default file applications on a Windows NT system.
2266 The system \"open\" is used for most files.
2267 See `org-file-apps'.")
2269 (defcustom org-file-apps
2270 '((auto-mode . emacs)
2271 ("\\.mm\\'" . default)
2272 ("\\.x?html?\\'" . default)
2273 ("\\.pdf\\'" . default))
2274 "External applications for opening `file:path' items in a document.
2275 \\<org-mode-map>\
2277 Org mode uses system defaults for different file types, but
2278 you can use this variable to set the application for a given file
2279 extension. The entries in this list are cons cells where the car identifies
2280 files and the cdr the corresponding command.
2282 Possible values for the file identifier are:
2284 \"string\" A string as a file identifier can be interpreted in different
2285 ways, depending on its contents:
2287 - Alphanumeric characters only:
2288 Match links with this file extension.
2289 Example: (\"pdf\" . \"evince %s\")
2290 to open PDFs with evince.
2292 - Regular expression: Match links where the
2293 filename matches the regexp. If you want to
2294 use groups here, use shy groups.
2296 Example: (\"\\\\.x?html\\\\\\='\" . \"firefox %s\")
2297 (\"\\\\(?:xhtml\\\\|html\\\\)\\\\\\='\" . \"firefox %s\")
2298 to open *.html and *.xhtml with firefox.
2300 - Regular expression which contains (non-shy) groups:
2301 Match links where the whole link, including \"::\", and
2302 anything after that, matches the regexp.
2303 In a custom command string, %1, %2, etc. are replaced with
2304 the parts of the link that were matched by the groups.
2305 For backwards compatibility, if a command string is given
2306 that does not use any of the group matches, this case is
2307 handled identically to the second one (i.e. match against
2308 file name only).
2309 In a custom function, you can access the group matches with
2310 (match-string n link).
2312 Example: (\"\\\\.pdf::\\\\(\\\\d+\\\\)\\\\\\='\" . \
2313 \"evince -p %1 %s\")
2314 to open [[file:document.pdf::5]] with evince at page 5.
2316 `directory' Matches a directory
2317 `remote' Matches a remote file, accessible through tramp or efs.
2318 Remote files most likely should be visited through Emacs
2319 because external applications cannot handle such paths.
2320 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2321 so all files Emacs knows how to handle. Using this with
2322 command `emacs' will open most files in Emacs. Beware that this
2323 will also open html files inside Emacs, unless you add
2324 (\"html\" . default) to the list as well.
2325 `system' The system command to open files, like `open' on Windows
2326 and macOS, and mailcap under GNU/Linux. This is the command
2327 that will be selected if you call `org-open-at-point' with a
2328 double prefix argument (`\\[universal-argument] \
2329 \\[universal-argument] \\[org-open-at-point]').
2330 t Default for files not matched by any of the other options.
2332 Possible values for the command are:
2334 `emacs' The file will be visited by the current Emacs process.
2335 `default' Use the default application for this file type, which is the
2336 association for t in the list, most likely in the system-specific
2337 part. This can be used to overrule an unwanted setting in the
2338 system-specific variable.
2339 `system' Use the system command for opening files, like \"open\".
2340 This command is specified by the entry whose car is `system'.
2341 Most likely, the system-specific version of this variable
2342 does define this command, but you can overrule/replace it
2343 here.
2344 `mailcap' Use command specified in the mailcaps.
2345 string A command to be executed by a shell; %s will be replaced
2346 by the path to the file.
2347 function A Lisp function, which will be called with two arguments:
2348 the file path and the original link string, without the
2349 \"file:\" prefix.
2351 For more examples, see the system specific constants
2352 `org-file-apps-defaults-macosx'
2353 `org-file-apps-defaults-windowsnt'
2354 `org-file-apps-defaults-gnu'."
2355 :group 'org-link-follow
2356 :type '(repeat
2357 (cons (choice :value ""
2358 (string :tag "Extension")
2359 (const :tag "System command to open files" system)
2360 (const :tag "Default for unrecognized files" t)
2361 (const :tag "Remote file" remote)
2362 (const :tag "Links to a directory" directory)
2363 (const :tag "Any files that have Emacs modes"
2364 auto-mode))
2365 (choice :value ""
2366 (const :tag "Visit with Emacs" emacs)
2367 (const :tag "Use default" default)
2368 (const :tag "Use the system command" system)
2369 (string :tag "Command")
2370 (function :tag "Function")))))
2372 (defcustom org-doi-server-url ""
2373 "The URL of the DOI server."
2374 :type 'string
2375 :version "24.3"
2376 :group 'org-link-follow)
2378 (defgroup org-refile nil
2379 "Options concerning refiling entries in Org mode."
2380 :tag "Org Refile"
2381 :group 'org)
2383 (defcustom org-directory "~/org"
2384 "Directory with Org files.
2385 This is just a default location to look for Org files. There is no need
2386 at all to put your files into this directory. It is used in the
2387 following situations:
2389 1. When a capture template specifies a target file that is not an
2390 absolute path. The path will then be interpreted relative to
2391 `org-directory'
2392 2. When the value of variable `org-agenda-files' is a single file, any
2393 relative paths in this file will be taken as relative to
2394 `org-directory'."
2395 :group 'org-refile
2396 :group 'org-capture
2397 :type 'directory)
2399 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2400 "Default target for storing notes.
2401 Used as a fall back file for org-capture.el, for templates that
2402 do not specify a target file."
2403 :group 'org-refile
2404 :group 'org-capture
2405 :type 'file)
2407 (defcustom org-goto-interface 'outline
2408 "The default interface to be used for `org-goto'.
2409 Allowed values are:
2410 outline The interface shows an outline of the relevant file
2411 and the correct heading is found by moving through
2412 the outline or by searching with incremental search.
2413 outline-path-completion Headlines in the current buffer are offered via
2414 completion. This is the interface also used by
2415 the refile command."
2416 :group 'org-refile
2417 :type '(choice
2418 (const :tag "Outline" outline)
2419 (const :tag "Outline-path-completion" outline-path-completion)))
2421 (defcustom org-goto-max-level 5
2422 "Maximum target level when running `org-goto' with refile interface."
2423 :group 'org-refile
2424 :type 'integer)
2426 (defcustom org-reverse-note-order nil
2427 "Non-nil means store new notes at the beginning of a file or entry.
2428 When nil, new notes will be filed to the end of a file or entry.
2429 This can also be a list with cons cells of regular expressions that
2430 are matched against file names, and values."
2431 :group 'org-capture
2432 :group 'org-refile
2433 :type '(choice
2434 (const :tag "Reverse always" t)
2435 (const :tag "Reverse never" nil)
2436 (repeat :tag "By file name regexp"
2437 (cons regexp boolean))))
2439 (defcustom org-log-refile nil
2440 "Information to record when a task is refiled.
2442 Possible values are:
2444 nil Don't add anything
2445 time Add a time stamp to the task
2446 note Prompt for a note and add it with template `org-log-note-headings'
2448 This option can also be set with on a per-file-basis with
2450 #+STARTUP: nologrefile
2451 #+STARTUP: logrefile
2452 #+STARTUP: lognoterefile
2454 You can have local logging settings for a subtree by setting the LOGGING
2455 property to one or more of these keywords.
2457 When bulk-refiling from the agenda, the value `note' is forbidden and
2458 will temporarily be changed to `time'."
2459 :group 'org-refile
2460 :group 'org-progress
2461 :version "24.1"
2462 :type '(choice
2463 (const :tag "No logging" nil)
2464 (const :tag "Record timestamp" time)
2465 (const :tag "Record timestamp with note." note)))
2467 (defcustom org-refile-targets nil
2468 "Targets for refiling entries with `\\[org-refile]'.
2469 This is a list of cons cells. Each cell contains:
2470 - a specification of the files to be considered, either a list of files,
2471 or a symbol whose function or variable value will be used to retrieve
2472 a file name or a list of file names. If you use `org-agenda-files' for
2473 that, all agenda files will be scanned for targets. Nil means consider
2474 headings in the current buffer.
2475 - A specification of how to find candidate refile targets. This may be
2476 any of:
2477 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2478 This tag has to be present in all target headlines, inheritance will
2479 not be considered.
2480 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2481 todo keyword.
2482 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2483 headlines that are refiling targets.
2484 - a cons cell (:level . N). Any headline of level N is considered a target.
2485 Note that, when `org-odd-levels-only' is set, level corresponds to
2486 order in hierarchy, not to the number of stars.
2487 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2488 Note that, when `org-odd-levels-only' is set, level corresponds to
2489 order in hierarchy, not to the number of stars.
2491 Each element of this list generates a set of possible targets.
2492 The union of these sets is presented (with completion) to
2493 the user by `org-refile'.
2495 You can set the variable `org-refile-target-verify-function' to a function
2496 to verify each headline found by the simple criteria above.
2498 When this variable is nil, all top-level headlines in the current buffer
2499 are used, equivalent to the value `((nil . (:level . 1))'."
2500 :group 'org-refile
2501 :type '(repeat
2502 (cons
2503 (choice :value org-agenda-files
2504 (const :tag "All agenda files" org-agenda-files)
2505 (const :tag "Current buffer" nil)
2506 (function) (variable) (file))
2507 (choice :tag "Identify target headline by"
2508 (cons :tag "Specific tag" (const :value :tag) (string))
2509 (cons :tag "TODO keyword" (const :value :todo) (string))
2510 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2511 (cons :tag "Level number" (const :value :level) (integer))
2512 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2514 (defcustom org-refile-target-verify-function nil
2515 "Function to verify if the headline at point should be a refile target.
2516 The function will be called without arguments, with point at the
2517 beginning of the headline. It should return t and leave point
2518 where it is if the headline is a valid target for refiling.
2520 If the target should not be selected, the function must return nil.
2521 In addition to this, it may move point to a place from where the search
2522 should be continued. For example, the function may decide that the entire
2523 subtree of the current entry should be excluded and move point to the end
2524 of the subtree."
2525 :group 'org-refile
2526 :type '(choice
2527 (const nil)
2528 (function)))
2530 (defcustom org-refile-use-cache nil
2531 "Non-nil means cache refile targets to speed up the process.
2532 \\<org-mode-map>\
2533 The cache for a particular file will be updated automatically when
2534 the buffer has been killed, or when any of the marker used for flagging
2535 refile targets no longer points at a live buffer.
2536 If you have added new entries to a buffer that might themselves be targets,
2537 you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
2538 if you find that easier, \
2539 `\\[universal-argument] \\[universal-argument] \\[universal-argument] \
2540 \\[org-refile]'."
2541 :group 'org-refile
2542 :version "24.1"
2543 :type 'boolean)
2545 (defcustom org-refile-use-outline-path nil
2546 "Non-nil means provide refile targets as paths.
2547 So a level 3 headline will be available as level1/level2/level3.
2549 When the value is `file', also include the file name (without directory)
2550 into the path. In this case, you can also stop the completion after
2551 the file name, to get entries inserted as top level in the file.
2553 When `full-file-path', include the full file path."
2554 :group 'org-refile
2555 :type '(choice
2556 (const :tag "Not" nil)
2557 (const :tag "Yes" t)
2558 (const :tag "Start with file name" file)
2559 (const :tag "Start with full file path" full-file-path)))
2561 (defcustom org-outline-path-complete-in-steps t
2562 "Non-nil means complete the outline path in hierarchical steps.
2563 When Org uses the refile interface to select an outline path (see
2564 `org-refile-use-outline-path'), the completion of the path can be
2565 done in a single go, or it can be done in steps down the headline
2566 hierarchy. Going in steps is probably the best if you do not use
2567 a special completion package like `ido' or `icicles'. However,
2568 when using these packages, going in one step can be very fast,
2569 while still showing the whole path to the entry."
2570 :group 'org-refile
2571 :type 'boolean)
2573 (defcustom org-refile-allow-creating-parent-nodes nil
2574 "Non-nil means allow the creation of new nodes as refile targets.
2575 New nodes are then created by adding \"/new node name\" to the completion
2576 of an existing node. When the value of this variable is `confirm',
2577 new node creation must be confirmed by the user (recommended).
2578 When nil, the completion must match an existing entry.
2580 Note that, if the new heading is not seen by the criteria
2581 listed in `org-refile-targets', multiple instances of the same
2582 heading would be created by trying again to file under the new
2583 heading."
2584 :group 'org-refile
2585 :type '(choice
2586 (const :tag "Never" nil)
2587 (const :tag "Always" t)
2588 (const :tag "Prompt for confirmation" confirm)))
2590 (defcustom org-refile-active-region-within-subtree nil
2591 "Non-nil means also refile active region within a subtree.
2593 By default `org-refile' doesn't allow refiling regions if they
2594 don't contain a set of subtrees, but it might be convenient to
2595 do so sometimes: in that case, the first line of the region is
2596 converted to a headline before refiling."
2597 :group 'org-refile
2598 :version "24.1"
2599 :type 'boolean)
2601 (defgroup org-todo nil
2602 "Options concerning TODO items in Org mode."
2603 :tag "Org TODO"
2604 :group 'org)
2606 (defgroup org-progress nil
2607 "Options concerning Progress logging in Org mode."
2608 :tag "Org Progress"
2609 :group 'org-time)
2611 (defvar org-todo-interpretation-widgets
2612 '((:tag "Sequence (cycling hits every state)" sequence)
2613 (:tag "Type (cycling directly to DONE)" type))
2614 "The available interpretation symbols for customizing `org-todo-keywords'.
2615 Interested libraries should add to this list.")
2617 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2618 "List of TODO entry keyword sequences and their interpretation.
2619 \\<org-mode-map>This is a list of sequences.
2621 Each sequence starts with a symbol, either `sequence' or `type',
2622 indicating if the keywords should be interpreted as a sequence of
2623 action steps, or as different types of TODO items. The first
2624 keywords are states requiring action - these states will select a headline
2625 for inclusion into the global TODO list Org produces. If one of the
2626 \"keywords\" is the vertical bar, \"|\", the remaining keywords
2627 signify that no further action is necessary. If \"|\" is not found,
2628 the last keyword is treated as the only DONE state of the sequence.
2630 The command `\\[org-todo]' cycles an entry through these states, and one
2631 additional state where no keyword is present. For details about this
2632 cycling, see the manual.
2634 TODO keywords and interpretation can also be set on a per-file basis with
2635 the special #+SEQ_TODO and #+TYP_TODO lines.
2637 Each keyword can optionally specify a character for fast state selection
2638 \(in combination with the variable `org-use-fast-todo-selection')
2639 and specifiers for state change logging, using the same syntax that
2640 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2641 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2642 indicates to record a time stamp each time this state is selected.
2644 Each keyword may also specify if a timestamp or a note should be
2645 recorded when entering or leaving the state, by adding additional
2646 characters in the parenthesis after the keyword. This looks like this:
2647 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2648 record only the time of the state change. With X and Y being either
2649 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2650 Y when leaving the state if and only if the *target* state does not
2651 define X. You may omit any of the fast-selection key or X or /Y,
2652 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2654 For backward compatibility, this variable may also be just a list
2655 of keywords. In this case the interpretation (sequence or type) will be
2656 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2657 :group 'org-todo
2658 :group 'org-keywords
2659 :type '(choice
2660 (repeat :tag "Old syntax, just keywords"
2661 (string :tag "Keyword"))
2662 (repeat :tag "New syntax"
2663 (cons
2664 (choice
2665 :tag "Interpretation"
2666 ;;Quick and dirty way to see
2667 ;;`org-todo-interpretations'. This takes the
2668 ;;place of item arguments
2669 :convert-widget
2670 (lambda (widget)
2671 (widget-put widget
2672 :args (mapcar
2673 (lambda (x)
2674 (widget-convert
2675 (cons 'const x)))
2676 org-todo-interpretation-widgets))
2677 widget))
2678 (repeat
2679 (string :tag "Keyword"))))))
2681 (defvar-local org-todo-keywords-1 nil
2682 "All TODO and DONE keywords active in a buffer.")
2683 (defvar org-todo-keywords-for-agenda nil)
2684 (defvar org-done-keywords-for-agenda nil)
2685 (defvar org-todo-keyword-alist-for-agenda nil)
2686 (defvar org-tag-alist-for-agenda nil
2687 "Alist of all tags from all agenda files.")
2688 (defvar org-tag-groups-alist-for-agenda nil
2689 "Alist of all groups tags from all current agenda files.")
2690 (defvar-local org-tag-groups-alist nil)
2691 (defvar org-agenda-contributing-files nil)
2692 (defvar-local org-current-tag-alist nil
2693 "Alist of all tag groups in current buffer.
2694 This variable takes into consideration `org-tag-alist',
2695 `org-tag-persistent-alist' and TAGS keywords in the buffer.")
2696 (defvar-local org-not-done-keywords nil)
2697 (defvar-local org-done-keywords nil)
2698 (defvar-local org-todo-heads nil)
2699 (defvar-local org-todo-sets nil)
2700 (defvar-local org-todo-log-states nil)
2701 (defvar-local org-todo-kwd-alist nil)
2702 (defvar-local org-todo-key-alist nil)
2703 (defvar-local org-todo-key-trigger nil)
2705 (defcustom org-todo-interpretation 'sequence
2706 "Controls how TODO keywords are interpreted.
2707 This variable is in principle obsolete and is only used for
2708 backward compatibility, if the interpretation of todo keywords is
2709 not given already in `org-todo-keywords'. See that variable for
2710 more information."
2711 :group 'org-todo
2712 :group 'org-keywords
2713 :type '(choice (const sequence)
2714 (const type)))
2716 (defcustom org-use-fast-todo-selection t
2717 "\\<org-mode-map>\
2718 Non-nil means use the fast todo selection scheme with `\\[org-todo]'.
2719 This variable describes if and under what circumstances the cycling
2720 mechanism for TODO keywords will be replaced by a single-key, direct
2721 selection scheme.
2723 When nil, fast selection is never used.
2725 When the symbol `prefix', it will be used when `org-todo' is called
2726 with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
2727 in an Org buffer, and
2728 `\\[universal-argument] t' in an agenda buffer.
2730 When t, fast selection is used by default. In this case, the prefix
2731 argument forces cycling instead.
2733 In all cases, the special interface is only used if access keys have
2734 actually been assigned by the user, i.e. if keywords in the configuration
2735 are followed by a letter in parenthesis, like TODO(t)."
2736 :group 'org-todo
2737 :type '(choice
2738 (const :tag "Never" nil)
2739 (const :tag "By default" t)
2740 (const :tag "Only with C-u C-c C-t" prefix)))
2742 (defcustom org-provide-todo-statistics t
2743 "Non-nil means update todo statistics after insert and toggle.
2744 ALL-HEADLINES means update todo statistics by including headlines
2745 with no TODO keyword as well, counting them as not done.
2746 A list of TODO keywords means the same, but skip keywords that are
2747 not in this list.
2748 When set to a list of two lists, the first list contains keywords
2749 to consider as TODO keywords, the second list contains keywords
2750 to consider as DONE keywords.
2752 When this is set, todo statistics is updated in the parent of the
2753 current entry each time a todo state is changed."
2754 :group 'org-todo
2755 :type '(choice
2756 (const :tag "Yes, only for TODO entries" t)
2757 (const :tag "Yes, including all entries" all-headlines)
2758 (repeat :tag "Yes, for TODOs in this list"
2759 (string :tag "TODO keyword"))
2760 (list :tag "Yes, for TODOs and DONEs in these lists"
2761 (repeat (string :tag "TODO keyword"))
2762 (repeat (string :tag "DONE keyword")))
2763 (other :tag "No TODO statistics" nil)))
2765 (defcustom org-hierarchical-todo-statistics t
2766 "Non-nil means TODO statistics covers just direct children.
2767 When nil, all entries in the subtree are considered.
2768 This has only an effect if `org-provide-todo-statistics' is set.
2769 To set this to nil for only a single subtree, use a COOKIE_DATA
2770 property and include the word \"recursive\" into the value."
2771 :group 'org-todo
2772 :type 'boolean)
2774 (defcustom org-after-todo-state-change-hook nil
2775 "Hook which is run after the state of a TODO item was changed.
2776 The new state (a string with a TODO keyword, or nil) is available in the
2777 Lisp variable `org-state'."
2778 :group 'org-todo
2779 :type 'hook)
2781 (defvar org-blocker-hook nil
2782 "Hook for functions that are allowed to block a state change.
2784 Functions in this hook should not modify the buffer.
2785 Each function gets as its single argument a property list,
2786 see `org-trigger-hook' for more information about this list.
2788 If any of the functions in this hook returns nil, the state change
2789 is blocked.")
2791 (defvar org-trigger-hook nil
2792 "Hook for functions that are triggered by a state change.
2794 Each function gets as its single argument a property list with at
2795 least the following elements:
2797 (:type type-of-change :position pos-at-entry-start
2798 :from old-state :to new-state)
2800 Depending on the type, more properties may be present.
2802 This mechanism is currently implemented for:
2804 TODO state changes
2805 ------------------
2806 :type todo-state-change
2807 :from previous state (keyword as a string), or nil, or a symbol
2808 `todo' or `done', to indicate the general type of state.
2809 :to new state, like in :from")
2811 (defcustom org-enforce-todo-dependencies nil
2812 "Non-nil means undone TODO entries will block switching the parent to DONE.
2813 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2814 be blocked if any prior sibling is not yet done.
2815 Finally, if the parent is blocked because of ordered siblings of its own,
2816 the child will also be blocked."
2817 :set (lambda (var val)
2818 (set var val)
2819 (if val
2820 (add-hook 'org-blocker-hook
2821 'org-block-todo-from-children-or-siblings-or-parent)
2822 (remove-hook 'org-blocker-hook
2823 'org-block-todo-from-children-or-siblings-or-parent)))
2824 :group 'org-todo
2825 :type 'boolean)
2827 (defcustom org-enforce-todo-checkbox-dependencies nil
2828 "Non-nil means unchecked boxes will block switching the parent to DONE.
2829 When this is nil, checkboxes have no influence on switching TODO states.
2830 When non-nil, you first need to check off all check boxes before the TODO
2831 entry can be switched to DONE.
2832 This variable needs to be set before org.el is loaded, and you need to
2833 restart Emacs after a change to make the change effective. The only way
2834 to change is while Emacs is running is through the customize interface."
2835 :set (lambda (var val)
2836 (set var val)
2837 (if val
2838 (add-hook 'org-blocker-hook
2839 'org-block-todo-from-checkboxes)
2840 (remove-hook 'org-blocker-hook
2841 'org-block-todo-from-checkboxes)))
2842 :group 'org-todo
2843 :type 'boolean)
2845 (defcustom org-treat-insert-todo-heading-as-state-change nil
2846 "Non-nil means inserting a TODO heading is treated as state change.
2847 So when the command `\\[org-insert-todo-heading]' is used, state change
2848 logging will apply if appropriate. When nil, the new TODO item will
2849 be inserted directly, and no logging will take place."
2850 :group 'org-todo
2851 :type 'boolean)
2853 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2854 "Non-nil means switching TODO states with S-cursor counts as state change.
2855 This is the default behavior. However, setting this to nil allows a
2856 convenient way to select a TODO state and bypass any logging associated
2857 with that."
2858 :group 'org-todo
2859 :type 'boolean)
2861 (defcustom org-todo-state-tags-triggers nil
2862 "Tag changes that should be triggered by TODO state changes.
2863 This is a list. Each entry is
2865 (state-change (tag . flag) .......)
2867 State-change can be a string with a state, and empty string to indicate the
2868 state that has no TODO keyword, or it can be one of the symbols `todo'
2869 or `done', meaning any not-done or done state, respectively."
2870 :group 'org-todo
2871 :group 'org-tags
2872 :type '(repeat
2873 (cons (choice :tag "When changing to"
2874 (const :tag "Not-done state" todo)
2875 (const :tag "Done state" done)
2876 (string :tag "State"))
2877 (repeat
2878 (cons :tag "Tag action"
2879 (string :tag "Tag")
2880 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2882 (defcustom org-log-done nil
2883 "Information to record when a task moves to the DONE state.
2885 Possible values are:
2887 nil Don't add anything, just change the keyword
2888 time Add a time stamp to the task
2889 note Prompt for a note and add it with template `org-log-note-headings'
2891 This option can also be set with on a per-file-basis with
2893 #+STARTUP: nologdone
2894 #+STARTUP: logdone
2895 #+STARTUP: lognotedone
2897 You can have local logging settings for a subtree by setting the LOGGING
2898 property to one or more of these keywords."
2899 :group 'org-todo
2900 :group 'org-progress
2901 :type '(choice
2902 (const :tag "No logging" nil)
2903 (const :tag "Record CLOSED timestamp" time)
2904 (const :tag "Record CLOSED timestamp with note." note)))
2906 ;; Normalize old uses of org-log-done.
2907 (cond
2908 ((eq org-log-done t) (setq org-log-done 'time))
2909 ((and (listp org-log-done) (memq 'done org-log-done))
2910 (setq org-log-done 'note)))
2912 (defcustom org-log-reschedule nil
2913 "Information to record when the scheduling date of a tasks is modified.
2915 Possible values are:
2917 nil Don't add anything, just change the date
2918 time Add a time stamp to the task
2919 note Prompt for a note and add it with template `org-log-note-headings'
2921 This option can also be set with on a per-file-basis with
2923 #+STARTUP: nologreschedule
2924 #+STARTUP: logreschedule
2925 #+STARTUP: lognotereschedule"
2926 :group 'org-todo
2927 :group 'org-progress
2928 :type '(choice
2929 (const :tag "No logging" nil)
2930 (const :tag "Record timestamp" time)
2931 (const :tag "Record timestamp with note." note)))
2933 (defcustom org-log-redeadline nil
2934 "Information to record when the deadline date of a tasks is modified.
2936 Possible values are:
2938 nil Don't add anything, just change the date
2939 time Add a time stamp to the task
2940 note Prompt for a note and add it with template `org-log-note-headings'
2942 This option can also be set with on a per-file-basis with
2944 #+STARTUP: nologredeadline
2945 #+STARTUP: logredeadline
2946 #+STARTUP: lognoteredeadline
2948 You can have local logging settings for a subtree by setting the LOGGING
2949 property to one or more of these keywords."
2950 :group 'org-todo
2951 :group 'org-progress
2952 :type '(choice
2953 (const :tag "No logging" nil)
2954 (const :tag "Record timestamp" time)
2955 (const :tag "Record timestamp with note." note)))
2957 (defcustom org-log-note-clock-out nil
2958 "Non-nil means record a note when clocking out of an item.
2959 This can also be configured on a per-file basis by adding one of
2960 the following lines anywhere in the buffer:
2962 #+STARTUP: lognoteclock-out
2963 #+STARTUP: nolognoteclock-out"
2964 :group 'org-todo
2965 :group 'org-progress
2966 :type 'boolean)
2968 (defcustom org-log-done-with-time t
2969 "Non-nil means the CLOSED time stamp will contain date and time.
2970 When nil, only the date will be recorded."
2971 :group 'org-progress
2972 :type 'boolean)
2974 (defcustom org-log-note-headings
2975 '((done . "CLOSING NOTE %t")
2976 (state . "State %-12s from %-12S %t")
2977 (note . "Note taken on %t")
2978 (reschedule . "Rescheduled from %S on %t")
2979 (delschedule . "Not scheduled, was %S on %t")
2980 (redeadline . "New deadline from %S on %t")
2981 (deldeadline . "Removed deadline, was %S on %t")
2982 (refile . "Refiled on %t")
2983 (clock-out . ""))
2984 "Headings for notes added to entries.
2986 The value is an alist, with the car being a symbol indicating the
2987 note context, and the cdr is the heading to be used. The heading
2988 may also be the empty string. The following placeholders can be
2989 used:
2991 %t a time stamp.
2992 %T an active time stamp instead the default inactive one
2993 %d a short-format time stamp.
2994 %D an active short-format time stamp.
2995 %s the new TODO state or time stamp (inactive), in double quotes.
2996 %S the old TODO state or time stamp (inactive), in double quotes.
2997 %u the user name.
2998 %U full user name.
3000 In fact, it is not a good idea to change the `state' entry,
3001 because Agenda Log mode depends on the format of these entries."
3002 :group 'org-todo
3003 :group 'org-progress
3004 :type '(list :greedy t
3005 (cons (const :tag "Heading when closing an item" done) string)
3006 (cons (const :tag
3007 "Heading when changing todo state (todo sequence only)"
3008 state) string)
3009 (cons (const :tag "Heading when just taking a note" note) string)
3010 (cons (const :tag "Heading when rescheduling" reschedule) string)
3011 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
3012 (cons (const :tag "Heading when changing deadline" redeadline) string)
3013 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
3014 (cons (const :tag "Heading when refiling" refile) string)
3015 (cons (const :tag "Heading when clocking out" clock-out) string)))
3017 (unless (assq 'note org-log-note-headings)
3018 (push '(note . "%t") org-log-note-headings))
3020 (defcustom org-log-into-drawer nil
3021 "Non-nil means insert state change notes and time stamps into a drawer.
3022 When nil, state changes notes will be inserted after the headline and
3023 any scheduling and clock lines, but not inside a drawer.
3025 The value of this variable should be the name of the drawer to use.
3026 LOGBOOK is proposed as the default drawer for this purpose, you can
3027 also set this to a string to define the drawer of your choice.
3029 A value of t is also allowed, representing \"LOGBOOK\".
3031 A value of t or nil can also be set with on a per-file-basis with
3033 #+STARTUP: logdrawer
3034 #+STARTUP: nologdrawer
3036 If this variable is set, `org-log-state-notes-insert-after-drawers'
3037 will be ignored.
3039 You can set the property LOG_INTO_DRAWER to overrule this setting for
3040 a subtree.
3042 Do not check directly this variable in a Lisp program. Call
3043 function `org-log-into-drawer' instead."
3044 :group 'org-todo
3045 :group 'org-progress
3046 :type '(choice
3047 (const :tag "Not into a drawer" nil)
3048 (const :tag "LOGBOOK" t)
3049 (string :tag "Other")))
3051 (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
3053 (defun org-log-into-drawer ()
3054 "Name of the log drawer, as a string, or nil.
3055 This is the value of `org-log-into-drawer'. However, if the
3056 current entry has or inherits a LOG_INTO_DRAWER property, it will
3057 be used instead of the default value."
3058 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
3059 (cond ((equal p "nil") nil)
3060 ((equal p "t") "LOGBOOK")
3061 ((stringp p) p)
3062 (p "LOGBOOK")
3063 ((stringp org-log-into-drawer) org-log-into-drawer)
3064 (org-log-into-drawer "LOGBOOK"))))
3066 (defcustom org-log-state-notes-insert-after-drawers nil
3067 "Non-nil means insert state change notes after any drawers in entry.
3068 Only the drawers that *immediately* follow the headline and the
3069 deadline/scheduled line are skipped.
3070 When nil, insert notes right after the heading and perhaps the line
3071 with deadline/scheduling if present.
3073 This variable will have no effect if `org-log-into-drawer' is
3074 set."
3075 :group 'org-todo
3076 :group 'org-progress
3077 :type 'boolean)
3079 (defcustom org-log-states-order-reversed t
3080 "Non-nil means the latest state note will be directly after heading.
3081 When nil, the state change notes will be ordered according to time.
3083 This option can also be set with on a per-file-basis with
3085 #+STARTUP: logstatesreversed
3086 #+STARTUP: nologstatesreversed"
3087 :group 'org-todo
3088 :group 'org-progress
3089 :type 'boolean)
3091 (defcustom org-todo-repeat-to-state nil
3092 "The TODO state to which a repeater should return the repeating task.
3093 By default this is the first task in a TODO sequence, or the previous state
3094 in a TODO_TYP set. But you can specify another task here.
3095 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3096 :group 'org-todo
3097 :version "24.1"
3098 :type '(choice (const :tag "Head of sequence" nil)
3099 (string :tag "Specific state")))
3101 (defcustom org-log-repeat 'time
3102 "Non-nil means record moving through the DONE state when triggering repeat.
3103 An auto-repeating task is immediately switched back to TODO when
3104 marked DONE. If you are not logging state changes (by adding \"@\"
3105 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3106 record a closing note, there will be no record of the task moving
3107 through DONE. This variable forces taking a note anyway.
3109 nil Don't force a record
3110 time Record a time stamp
3111 note Prompt for a note and add it with template `org-log-note-headings'
3113 This option can also be set with on a per-file-basis with
3115 #+STARTUP: nologrepeat
3116 #+STARTUP: logrepeat
3117 #+STARTUP: lognoterepeat
3119 You can have local logging settings for a subtree by setting the LOGGING
3120 property to one or more of these keywords."
3121 :group 'org-todo
3122 :group 'org-progress
3123 :type '(choice
3124 (const :tag "Don't force a record" nil)
3125 (const :tag "Force recording the DONE state" time)
3126 (const :tag "Force recording a note with the DONE state" note)))
3129 (defgroup org-priorities nil
3130 "Priorities in Org mode."
3131 :tag "Org Priorities"
3132 :group 'org-todo)
3134 (defcustom org-enable-priority-commands t
3135 "Non-nil means priority commands are active.
3136 When nil, these commands will be disabled, so that you never accidentally
3137 set a priority."
3138 :group 'org-priorities
3139 :type 'boolean)
3141 (defcustom org-highest-priority ?A
3142 "The highest priority of TODO items. A character like ?A, ?B etc.
3143 Must have a smaller ASCII number than `org-lowest-priority'."
3144 :group 'org-priorities
3145 :type 'character)
3147 (defcustom org-lowest-priority ?C
3148 "The lowest priority of TODO items. A character like ?A, ?B etc.
3149 Must have a larger ASCII number than `org-highest-priority'."
3150 :group 'org-priorities
3151 :type 'character)
3153 (defcustom org-default-priority ?B
3154 "The default priority of TODO items.
3155 This is the priority an item gets if no explicit priority is given.
3156 When starting to cycle on an empty priority the first step in the cycle
3157 depends on `org-priority-start-cycle-with-default'. The resulting first
3158 step priority must not exceed the range from `org-highest-priority' to
3159 `org-lowest-priority' which means that `org-default-priority' has to be
3160 in this range exclusive or inclusive the range boundaries. Else the
3161 first step refuses to set the default and the second will fall back
3162 to (depending on the command used) the highest or lowest priority."
3163 :group 'org-priorities
3164 :type 'character)
3166 (defcustom org-priority-start-cycle-with-default t
3167 "Non-nil means start with default priority when starting to cycle.
3168 When this is nil, the first step in the cycle will be (depending on the
3169 command used) one higher or lower than the default priority.
3170 See also `org-default-priority'."
3171 :group 'org-priorities
3172 :type 'boolean)
3174 (defcustom org-get-priority-function nil
3175 "Function to extract the priority from a string.
3176 The string is normally the headline. If this is nil Org computes the
3177 priority from the priority cookie like [#A] in the headline. It returns
3178 an integer, increasing by 1000 for each priority level.
3179 The user can set a different function here, which should take a string
3180 as an argument and return the numeric priority."
3181 :group 'org-priorities
3182 :version "24.1"
3183 :type '(choice
3184 (const nil)
3185 (function)))
3187 (defgroup org-time nil
3188 "Options concerning time stamps and deadlines in Org mode."
3189 :tag "Org Time"
3190 :group 'org)
3192 (defcustom org-time-stamp-rounding-minutes '(0 5)
3193 "Number of minutes to round time stamps to.
3194 \\<org-mode-map>\
3195 These are two values, the first applies when first creating a time stamp.
3196 The second applies when changing it with the commands `S-up' and `S-down'.
3197 When changing the time stamp, this means that it will change in steps
3198 of N minutes, as given by the second value.
3200 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3201 numbers should be factors of 60, so for example 5, 10, 15.
3203 When this is larger than 1, you can still force an exact time stamp by using
3204 a double prefix argument to a time stamp command like \
3205 `\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
3206 and by using a prefix arg to `S-up/down' to specify the exact number
3207 of minutes to shift."
3208 :group 'org-time
3209 :get (lambda (var) ; Make sure both elements are there
3210 (if (integerp (default-value var))
3211 (list (default-value var) 5)
3212 (default-value var)))
3213 :type '(list
3214 (integer :tag "when inserting times")
3215 (integer :tag "when modifying times")))
3217 ;; Normalize old customizations of this variable.
3218 (when (integerp org-time-stamp-rounding-minutes)
3219 (setq org-time-stamp-rounding-minutes
3220 (list org-time-stamp-rounding-minutes
3221 org-time-stamp-rounding-minutes)))
3223 (defcustom org-display-custom-times nil
3224 "Non-nil means overlay custom formats over all time stamps.
3225 The formats are defined through the variable `org-time-stamp-custom-formats'.
3226 To turn this on on a per-file basis, insert anywhere in the file:
3227 #+STARTUP: customtime"
3228 :group 'org-time
3229 :set 'set-default
3230 :type 'sexp)
3231 (make-variable-buffer-local 'org-display-custom-times)
3233 (defcustom org-time-stamp-custom-formats
3234 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3235 "Custom formats for time stamps. See `format-time-string' for the syntax.
3236 These are overlaid over the default ISO format if the variable
3237 `org-display-custom-times' is set. Time like %H:%M should be at the
3238 end of the second format. The custom formats are also honored by export
3239 commands, if custom time display is turned on at the time of export."
3240 :group 'org-time
3241 :type 'sexp)
3243 (defun org-time-stamp-format (&optional long inactive)
3244 "Get the right format for a time string."
3245 (let ((f (if long (cdr org-time-stamp-formats)
3246 (car org-time-stamp-formats))))
3247 (if inactive
3248 (concat "[" (substring f 1 -1) "]")
3249 f)))
3251 (defcustom org-time-clocksum-format
3252 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3253 "The format string used when creating CLOCKSUM lines.
3254 This is also used when Org mode generates a time duration.
3256 The value can be a single format string containing two
3257 %-sequences, which will be filled with the number of hours and
3258 minutes in that order.
3260 Alternatively, the value can be a plist associating any of the
3261 keys :years, :months, :weeks, :days, :hours or :minutes with
3262 format strings. The time duration is formatted using only the
3263 time components that are needed and concatenating the results.
3264 If a time unit in absent, it falls back to the next smallest
3265 unit.
3267 The keys :require-years, :require-months, :require-days,
3268 :require-weeks, :require-hours, :require-minutes are also
3269 meaningful. A non-nil value for these keys indicates that the
3270 corresponding time component should always be included, even if
3271 its value is 0.
3274 For example,
3276 (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3277 :require-minutes t)
3279 means durations longer than a day will be expressed in days,
3280 hours and minutes, and durations less than a day will always be
3281 expressed in hours and minutes (even for durations less than an
3282 hour).
3284 The value
3286 (:days \"%dd\" :minutes \"%dm\")
3288 means durations longer than a day will be expressed in days and
3289 minutes, and durations less than a day will be expressed entirely
3290 in minutes (even for durations longer than an hour)."
3291 :group 'org-time
3292 :group 'org-clock
3293 :version "24.4"
3294 :package-version '(Org . "8.0")
3295 :type '(choice (string :tag "Format string")
3296 (set :tag "Plist"
3297 (group :inline t (const :tag "Years" :years)
3298 (string :tag "Format string"))
3299 (group :inline t
3300 (const :tag "Always show years" :require-years)
3301 (const t))
3302 (group :inline t (const :tag "Months" :months)
3303 (string :tag "Format string"))
3304 (group :inline t
3305 (const :tag "Always show months" :require-months)
3306 (const t))
3307 (group :inline t (const :tag "Weeks" :weeks)
3308 (string :tag "Format string"))
3309 (group :inline t
3310 (const :tag "Always show weeks" :require-weeks)
3311 (const t))
3312 (group :inline t (const :tag "Days" :days)
3313 (string :tag "Format string"))
3314 (group :inline t
3315 (const :tag "Always show days" :require-days)
3316 (const t))
3317 (group :inline t (const :tag "Hours" :hours)
3318 (string :tag "Format string"))
3319 (group :inline t
3320 (const :tag "Always show hours" :require-hours)
3321 (const t))
3322 (group :inline t (const :tag "Minutes" :minutes)
3323 (string :tag "Format string"))
3324 (group :inline t
3325 (const :tag "Always show minutes" :require-minutes)
3326 (const t)))))
3328 (defcustom org-time-clocksum-use-fractional nil
3329 "When non-nil, `\\[org-clock-display]' uses fractional times.
3330 See `org-time-clocksum-format' for more on time clock formats."
3331 :group 'org-time
3332 :group 'org-clock
3333 :version "24.3"
3334 :type 'boolean)
3336 (defcustom org-time-clocksum-use-effort-durations nil
3337 "When non-nil, `\\[org-clock-display]' uses effort durations.
3338 E.g. by default, one day is considered to be a 8 hours effort,
3339 so a task that has been clocked for 16 hours will be displayed
3340 as during 2 days in the clock display or in the clocktable.
3342 See `org-effort-durations' on how to set effort durations
3343 and `org-time-clocksum-format' for more on time clock formats."
3344 :group 'org-time
3345 :group 'org-clock
3346 :version "24.4"
3347 :package-version '(Org . "8.0")
3348 :type 'boolean)
3350 (defcustom org-time-clocksum-fractional-format "%.2f"
3351 "The format string used when creating CLOCKSUM lines,
3352 or when Org mode generates a time duration, if
3353 `org-time-clocksum-use-fractional' is enabled.
3355 The value can be a single format string containing one
3356 %-sequence, which will be filled with the number of hours as
3357 a float.
3359 Alternatively, the value can be a plist associating any of the
3360 keys :years, :months, :weeks, :days, :hours or :minutes with
3361 a format string. The time duration is formatted using the
3362 largest time unit which gives a non-zero integer part. If all
3363 specified formats have zero integer part, the smallest time unit
3364 is used."
3365 :group 'org-time
3366 :type '(choice (string :tag "Format string")
3367 (set (group :inline t (const :tag "Years" :years)
3368 (string :tag "Format string"))
3369 (group :inline t (const :tag "Months" :months)
3370 (string :tag "Format string"))
3371 (group :inline t (const :tag "Weeks" :weeks)
3372 (string :tag "Format string"))
3373 (group :inline t (const :tag "Days" :days)
3374 (string :tag "Format string"))
3375 (group :inline t (const :tag "Hours" :hours)
3376 (string :tag "Format string"))
3377 (group :inline t (const :tag "Minutes" :minutes)
3378 (string :tag "Format string")))))
3380 (defcustom org-deadline-warning-days 14
3381 "Number of days before expiration during which a deadline becomes active.
3382 This variable governs the display in sparse trees and in the agenda.
3383 When 0 or negative, it means use this number (the absolute value of it)
3384 even if a deadline has a different individual lead time specified.
3386 Custom commands can set this variable in the options section."
3387 :group 'org-time
3388 :group 'org-agenda-daily/weekly
3389 :type 'integer)
3391 (defcustom org-scheduled-delay-days 0
3392 "Number of days before a scheduled item becomes active.
3393 This variable governs the display in sparse trees and in the agenda.
3394 The default value (i.e. 0) means: don't delay scheduled item.
3395 When negative, it means use this number (the absolute value of it)
3396 even if a scheduled item has a different individual delay time
3397 specified.
3399 Custom commands can set this variable in the options section."
3400 :group 'org-time
3401 :group 'org-agenda-daily/weekly
3402 :version "24.4"
3403 :package-version '(Org . "8.0")
3404 :type 'integer)
3406 (defcustom org-read-date-prefer-future t
3407 "Non-nil means assume future for incomplete date input from user.
3408 This affects the following situations:
3409 1. The user gives a month but not a year.
3410 For example, if it is April and you enter \"feb 2\", this will be read
3411 as Feb 2, *next* year. \"May 5\", however, will be this year.
3412 2. The user gives a day, but no month.
3413 For example, if today is the 15th, and you enter \"3\", Org will read
3414 this as the third of *next* month. However, if you enter \"17\",
3415 it will be considered as *this* month.
3417 If you set this variable to the symbol `time', then also the following
3418 will work:
3420 3. If the user gives a time.
3421 If the time is before now, it will be interpreted as tomorrow.
3423 Currently none of this works for ISO week specifications.
3425 When this option is nil, the current day, month and year will always be
3426 used as defaults.
3428 See also `org-agenda-jump-prefer-future'."
3429 :group 'org-time
3430 :type '(choice
3431 (const :tag "Never" nil)
3432 (const :tag "Check month and day" t)
3433 (const :tag "Check month, day, and time" time)))
3435 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3436 "Should the agenda jump command prefer the future for incomplete dates?
3437 The default is to do the same as configured in `org-read-date-prefer-future'.
3438 But you can also set a deviating value here.
3439 This may t or nil, or the symbol `org-read-date-prefer-future'."
3440 :group 'org-agenda
3441 :group 'org-time
3442 :version "24.1"
3443 :type '(choice
3444 (const :tag "Use org-read-date-prefer-future"
3445 org-read-date-prefer-future)
3446 (const :tag "Never" nil)
3447 (const :tag "Always" t)))
3449 (defcustom org-read-date-force-compatible-dates t
3450 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3452 Depending on the system Emacs is running on, certain dates cannot
3453 be represented with the type used internally to represent time.
3454 Dates between 1970-1-1 and 2038-1-1 can always be represented
3455 correctly. Some systems allow for earlier dates, some for later,
3456 some for both. One way to find out it to insert any date into an
3457 Org buffer, putting the cursor on the year and hitting S-up and
3458 S-down to test the range.
3460 When this variable is set to t, the date/time prompt will not let
3461 you specify dates outside the 1970-2037 range, so it is certain that
3462 these dates will work in whatever version of Emacs you are
3463 running, and also that you can move a file from one Emacs implementation
3464 to another. WHenever Org is forcing the year for you, it will display
3465 a message and beep.
3467 When this variable is nil, Org will check if the date is
3468 representable in the specific Emacs implementation you are using.
3469 If not, it will force a year, usually the current year, and beep
3470 to remind you. Currently this setting is not recommended because
3471 the likelihood that you will open your Org files in an Emacs that
3472 has limited date range is not negligible.
3474 A workaround for this problem is to use diary sexp dates for time
3475 stamps outside of this range."
3476 :group 'org-time
3477 :version "24.1"
3478 :type 'boolean)
3480 (defcustom org-read-date-display-live t
3481 "Non-nil means display current interpretation of date prompt live.
3482 This display will be in an overlay, in the minibuffer."
3483 :group 'org-time
3484 :type 'boolean)
3486 (defcustom org-read-date-popup-calendar t
3487 "Non-nil means pop up a calendar when prompting for a date.
3488 In the calendar, the date can be selected with mouse-1. However, the
3489 minibuffer will also be active, and you can simply enter the date as well.
3490 When nil, only the minibuffer will be available."
3491 :group 'org-time
3492 :type 'boolean)
3493 (defvaralias 'org-popup-calendar-for-date-prompt
3494 'org-read-date-popup-calendar)
3496 (defcustom org-extend-today-until 0
3497 "The hour when your day really ends. Must be an integer.
3498 This has influence for the following applications:
3499 - When switching the agenda to \"today\". It it is still earlier than
3500 the time given here, the day recognized as TODAY is actually yesterday.
3501 - When a date is read from the user and it is still before the time given
3502 here, the current date and time will be assumed to be yesterday, 23:59.
3503 Also, timestamps inserted in capture templates follow this rule.
3505 IMPORTANT: This is a feature whose implementation is and likely will
3506 remain incomplete. Really, it is only here because past midnight seems to
3507 be the favorite working time of John Wiegley :-)"
3508 :group 'org-time
3509 :type 'integer)
3511 (defcustom org-use-effective-time nil
3512 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3513 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3514 \"effective time\" of any timestamps between midnight and 8am will be
3515 23:59 of the previous day."
3516 :group 'org-time
3517 :version "24.1"
3518 :type 'boolean)
3520 (defcustom org-use-last-clock-out-time-as-effective-time nil
3521 "When non-nil, use the last clock out time for `org-todo'.
3522 Note that this option has precedence over the combined use of
3523 `org-use-effective-time' and `org-extend-today-until'."
3524 :group 'org-time
3525 :version "24.4"
3526 :package-version '(Org . "8.0")
3527 :type 'boolean)
3529 (defcustom org-edit-timestamp-down-means-later nil
3530 "Non-nil means S-down will increase the time in a time stamp.
3531 When nil, S-up will increase."
3532 :group 'org-time
3533 :type 'boolean)
3535 (defcustom org-calendar-follow-timestamp-change t
3536 "Non-nil means make the calendar window follow timestamp changes.
3537 When a timestamp is modified and the calendar window is visible, it will be
3538 moved to the new date."
3539 :group 'org-time
3540 :type 'boolean)
3542 (defgroup org-tags nil
3543 "Options concerning tags in Org mode."
3544 :tag "Org Tags"
3545 :group 'org)
3547 (defcustom org-tag-alist nil
3548 "Default tags available in Org files.
3550 The value of this variable is an alist. Associations either:
3552 (TAG)
3553 (TAG . SELECT)
3554 (SPECIAL)
3556 where TAG is a tag as a string, SELECT is character, used to
3557 select that tag through the fast tag selection interface, and
3558 SPECIAL is one of the following keywords: `:startgroup',
3559 `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
3560 `:newline'. These keywords are used to define a hierarchy of
3561 tags. See manual for details.
3563 When this variable is nil, Org mode bases tag input on what is
3564 already in the buffer. The value can be overridden locally by
3565 using a TAGS keyword, e.g.,
3567 #+TAGS: tag1 tag2
3569 See also `org-tag-persistent-alist' to sidestep this behavior."
3570 :group 'org-tags
3571 :type '(repeat
3572 (choice
3573 (cons (string :tag "Tag name")
3574 (character :tag "Access char"))
3575 (const :tag "Start radio group" (:startgroup))
3576 (const :tag "Start tag group, non distinct" (:startgrouptag))
3577 (const :tag "Group tags delimiter" (:grouptags))
3578 (const :tag "End radio group" (:endgroup))
3579 (const :tag "End tag group, non distinct" (:endgrouptag))
3580 (const :tag "New line" (:newline)))))
3582 (defcustom org-tag-persistent-alist nil
3583 "Tags always available in Org files.
3585 The value of this variable is an alist. Associations either:
3587 (TAG)
3588 (TAG . SELECT)
3589 (SPECIAL)
3591 where TAG is a tag as a string, SELECT is a character, used to
3592 select that tag through the fast tag selection interface, and
3593 SPECIAL is one of the following keywords: `:startgroup',
3594 `:startgrouptag', `:grouptags', `:engroup', `:endgrouptag' or
3595 `:newline'. These keywords are used to define a hierarchy of
3596 tags. See manual for details.
3598 Unlike to `org-tag-alist', tags defined in this variable do not
3599 depend on a local TAGS keyword. Instead, to disable these tags
3600 on a per-file basis, insert anywhere in the file:
3602 #+STARTUP: noptag"
3603 :group 'org-tags
3604 :type '(repeat
3605 (choice
3606 (cons (string :tag "Tag name")
3607 (character :tag "Access char"))
3608 (const :tag "Start radio group" (:startgroup))
3609 (const :tag "Start tag group, non distinct" (:startgrouptag))
3610 (const :tag "Group tags delimiter" (:grouptags))
3611 (const :tag "End radio group" (:endgroup))
3612 (const :tag "End tag group, non distinct" (:endgrouptag))
3613 (const :tag "New line" (:newline)))))
3615 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3616 "If non-nil, always offer completion for all tags of all agenda files.
3617 Instead of customizing this variable directly, you might want to
3618 set it locally for capture buffers, because there no list of
3619 tags in that file can be created dynamically (there are none).
3621 (add-hook \\='org-capture-mode-hook
3622 (lambda ()
3623 (setq-local org-complete-tags-always-offer-all-agenda-tags t)))"
3624 :group 'org-tags
3625 :version "24.1"
3626 :type 'boolean)
3628 (defvar org-file-tags nil
3629 "List of tags that can be inherited by all entries in the file.
3630 The tags will be inherited if the variable `org-use-tag-inheritance'
3631 says they should be.
3632 This variable is populated from #+FILETAGS lines.")
3634 (defcustom org-use-fast-tag-selection 'auto
3635 "Non-nil means use fast tag selection scheme.
3636 This is a special interface to select and deselect tags with single keys.
3637 When nil, fast selection is never used.
3638 When the symbol `auto', fast selection is used if and only if selection
3639 characters for tags have been configured, either through the variable
3640 `org-tag-alist' or through a #+TAGS line in the buffer.
3641 When t, fast selection is always used and selection keys are assigned
3642 automatically if necessary."
3643 :group 'org-tags
3644 :type '(choice
3645 (const :tag "Always" t)
3646 (const :tag "Never" nil)
3647 (const :tag "When selection characters are configured" auto)))
3649 (defcustom org-fast-tag-selection-single-key nil
3650 "Non-nil means fast tag selection exits after first change.
3651 When nil, you have to press RET to exit it.
3652 During fast tag selection, you can toggle this flag with `C-c'.
3653 This variable can also have the value `expert'. In this case, the window
3654 displaying the tags menu is not even shown, until you press C-c again."
3655 :group 'org-tags
3656 :type '(choice
3657 (const :tag "No" nil)
3658 (const :tag "Yes" t)
3659 (const :tag "Expert" expert)))
3661 (defvar org-fast-tag-selection-include-todo nil
3662 "Non-nil means fast tags selection interface will also offer TODO states.
3663 This is an undocumented feature, you should not rely on it.")
3665 (defcustom org-tags-column -77
3666 "The column to which tags should be indented in a headline.
3667 If this number is positive, it specifies the column. If it is negative,
3668 it means that the tags should be flushright to that column. For example,
3669 -80 works well for a normal 80 character screen.
3670 When 0, place tags directly after headline text, with only one space in
3671 between."
3672 :group 'org-tags
3673 :type 'integer)
3675 (defcustom org-auto-align-tags t
3676 "Non-nil keeps tags aligned when modifying headlines.
3677 Some operations (i.e. demoting) change the length of a headline and
3678 therefore shift the tags around. With this option turned on, after
3679 each such operation the tags are again aligned to `org-tags-column'."
3680 :group 'org-tags
3681 :type 'boolean)
3683 (defcustom org-use-tag-inheritance t
3684 "Non-nil means tags in levels apply also for sublevels.
3685 When nil, only the tags directly given in a specific line apply there.
3686 This may also be a list of tags that should be inherited, or a regexp that
3687 matches tags that should be inherited. Additional control is possible
3688 with the variable `org-tags-exclude-from-inheritance' which gives an
3689 explicit list of tags to be excluded from inheritance, even if the value of
3690 `org-use-tag-inheritance' would select it for inheritance.
3692 If this option is t, a match early-on in a tree can lead to a large
3693 number of matches in the subtree when constructing the agenda or creating
3694 a sparse tree. If you only want to see the first match in a tree during
3695 a search, check out the variable `org-tags-match-list-sublevels'."
3696 :group 'org-tags
3697 :type '(choice
3698 (const :tag "Not" nil)
3699 (const :tag "Always" t)
3700 (repeat :tag "Specific tags" (string :tag "Tag"))
3701 (regexp :tag "Tags matched by regexp")))
3703 (defcustom org-tags-exclude-from-inheritance nil
3704 "List of tags that should never be inherited.
3705 This is a way to exclude a few tags from inheritance. For way to do
3706 the opposite, to actively allow inheritance for selected tags,
3707 see the variable `org-use-tag-inheritance'."
3708 :group 'org-tags
3709 :type '(repeat (string :tag "Tag")))
3711 (defun org-tag-inherit-p (tag)
3712 "Check if TAG is one that should be inherited."
3713 (cond
3714 ((member tag org-tags-exclude-from-inheritance) nil)
3715 ((eq org-use-tag-inheritance t) t)
3716 ((not org-use-tag-inheritance) nil)
3717 ((stringp org-use-tag-inheritance)
3718 (string-match org-use-tag-inheritance tag))
3719 ((listp org-use-tag-inheritance)
3720 (member tag org-use-tag-inheritance))
3721 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3723 (defcustom org-tags-match-list-sublevels t
3724 "Non-nil means list also sublevels of headlines matching a search.
3725 This variable applies to tags/property searches, and also to stuck
3726 projects because this search is based on a tags match as well.
3728 When set to the symbol `indented', sublevels are indented with
3729 leading dots.
3731 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3732 the sublevels of a headline matching a tag search often also match
3733 the same search. Listing all of them can create very long lists.
3734 Setting this variable to nil causes subtrees of a match to be skipped.
3736 This variable is semi-obsolete and probably should always be true. It
3737 is better to limit inheritance to certain tags using the variables
3738 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3739 :group 'org-tags
3740 :type '(choice
3741 (const :tag "No, don't list them" nil)
3742 (const :tag "Yes, do list them" t)
3743 (const :tag "List them, indented with leading dots" indented)))
3745 (defcustom org-tags-sort-function nil
3746 "When set, tags are sorted using this function as a comparator."
3747 :group 'org-tags
3748 :type '(choice
3749 (const :tag "No sorting" nil)
3750 (const :tag "Alphabetical" string<)
3751 (const :tag "Reverse alphabetical" string>)
3752 (function :tag "Custom function" nil)))
3754 (defvar org-tags-history nil
3755 "History of minibuffer reads for tags.")
3756 (defvar org-last-tags-completion-table nil
3757 "The last used completion table for tags.")
3758 (defvar org-after-tags-change-hook nil
3759 "Hook that is run after the tags in a line have changed.")
3761 (defgroup org-properties nil
3762 "Options concerning properties in Org mode."
3763 :tag "Org Properties"
3764 :group 'org)
3766 (defcustom org-property-format "%-10s %s"
3767 "How property key/value pairs should be formatted by `indent-line'.
3768 When `indent-line' hits a property definition, it will format the line
3769 according to this format, mainly to make sure that the values are
3770 lined-up with respect to each other."
3771 :group 'org-properties
3772 :type 'string)
3774 (defcustom org-properties-postprocess-alist nil
3775 "Alist of properties and functions to adjust inserted values.
3776 Elements of this alist must be of the form
3778 ([string] [function])
3780 where [string] must be a property name and [function] must be a
3781 lambda expression: this lambda expression must take one argument,
3782 the value to adjust, and return the new value as a string.
3784 For example, this element will allow the property \"Remaining\"
3785 to be updated wrt the relation between the \"Effort\" property
3786 and the clock summary:
3788 ((\"Remaining\" (lambda(value)
3789 (let ((clocksum (org-clock-sum-current-item))
3790 (effort (org-duration-string-to-minutes
3791 (org-entry-get (point) \"Effort\"))))
3792 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3793 :group 'org-properties
3794 :version "24.1"
3795 :type '(alist :key-type (string :tag "Property")
3796 :value-type (function :tag "Function")))
3798 (defcustom org-use-property-inheritance nil
3799 "Non-nil means properties apply also for sublevels.
3801 This setting is chiefly used during property searches. Turning it on can
3802 cause significant overhead when doing a search, which is why it is not
3803 on by default.
3805 When nil, only the properties directly given in the current entry count.
3806 When t, every property is inherited. The value may also be a list of
3807 properties that should have inheritance, or a regular expression matching
3808 properties that should be inherited.
3810 However, note that some special properties use inheritance under special
3811 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3812 and the properties ending in \"_ALL\" when they are used as descriptor
3813 for valid values of a property.
3815 Note for programmers:
3816 When querying an entry with `org-entry-get', you can control if inheritance
3817 should be used. By default, `org-entry-get' looks only at the local
3818 properties. You can request inheritance by setting the inherit argument
3819 to t (to force inheritance) or to `selective' (to respect the setting
3820 in this variable)."
3821 :group 'org-properties
3822 :type '(choice
3823 (const :tag "Not" nil)
3824 (const :tag "Always" t)
3825 (repeat :tag "Specific properties" (string :tag "Property"))
3826 (regexp :tag "Properties matched by regexp")))
3828 (defun org-property-inherit-p (property)
3829 "Check if PROPERTY is one that should be inherited."
3830 (cond
3831 ((eq org-use-property-inheritance t) t)
3832 ((not org-use-property-inheritance) nil)
3833 ((stringp org-use-property-inheritance)
3834 (string-match org-use-property-inheritance property))
3835 ((listp org-use-property-inheritance)
3836 (member property org-use-property-inheritance))
3837 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3839 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3840 "The default column format, if no other format has been defined.
3841 This variable can be set on the per-file basis by inserting a line
3843 #+COLUMNS: %25ITEM ....."
3844 :group 'org-properties
3845 :type 'string)
3847 (defcustom org-columns-ellipses ".."
3848 "The ellipses to be used when a field in column view is truncated.
3849 When this is the empty string, as many characters as possible are shown,
3850 but then there will be no visual indication that the field has been truncated.
3851 When this is a string of length N, the last N characters of a truncated
3852 field are replaced by this string. If the column is narrower than the
3853 ellipses string, only part of the ellipses string will be shown."
3854 :group 'org-properties
3855 :type 'string)
3857 (defconst org-global-properties-fixed
3858 '(("VISIBILITY_ALL" . "folded children content all")
3859 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3860 "List of property/value pairs that can be inherited by any entry.
3862 These are fixed values, for the preset properties. The user variable
3863 that can be used to add to this list is `org-global-properties'.
3865 The entries in this list are cons cells where the car is a property
3866 name and cdr is a string with the value. If the value represents
3867 multiple items like an \"_ALL\" property, separate the items by
3868 spaces.")
3870 (defcustom org-global-properties nil
3871 "List of property/value pairs that can be inherited by any entry.
3873 This list will be combined with the constant `org-global-properties-fixed'.
3875 The entries in this list are cons cells where the car is a property
3876 name and cdr is a string with the value.
3878 You can set buffer-local values for the same purpose in the variable
3879 `org-file-properties' this by adding lines like
3882 :group 'org-properties
3883 :type '(repeat
3884 (cons (string :tag "Property")
3885 (string :tag "Value"))))
3887 (defvar-local org-file-properties nil
3888 "List of property/value pairs that can be inherited by any entry.
3889 Valid for the current buffer.
3890 This variable is populated from #+PROPERTY lines.")
3892 (defgroup org-agenda nil
3893 "Options concerning agenda views in Org mode."
3894 :tag "Org Agenda"
3895 :group 'org)
3897 (defvar-local org-category nil
3898 "Variable used by org files to set a category for agenda display.
3899 Such files should use a file variable to set it, for example
3901 # -*- mode: org; org-category: \"ELisp\"
3903 or contain a special line
3905 #+CATEGORY: ELisp
3907 If the file does not specify a category, then file's base name
3908 is used instead.")
3909 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3911 (defcustom org-agenda-files nil
3912 "The files to be used for agenda display.
3914 If an entry is a directory, all files in that directory that are matched
3915 by `org-agenda-file-regexp' will be part of the file list.
3917 If the value of the variable is not a list but a single file name, then
3918 the list of agenda files is actually stored and maintained in that file,
3919 one agenda file per line. In this file paths can be given relative to
3920 `org-directory'. Tilde expansion and environment variable substitution
3921 are also made.
3923 Entries may be added to this list with `\\[org-agenda-file-to-front]'
3924 and removed with `\\[org-remove-file]'."
3925 :group 'org-agenda
3926 :type '(choice
3927 (repeat :tag "List of files and directories" file)
3928 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3930 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3931 "Regular expression to match files for `org-agenda-files'.
3932 If any element in the list in that variable contains a directory instead
3933 of a normal file, all files in that directory that are matched by this
3934 regular expression will be included."
3935 :group 'org-agenda
3936 :type 'regexp)
3938 (defcustom org-agenda-text-search-extra-files nil
3939 "List of extra files to be searched by text search commands.
3940 These files will be searched in addition to the agenda files by the
3941 commands `org-search-view' (`\\[org-agenda] s') \
3942 and `org-occur-in-agenda-files'.
3943 Note that these files will only be searched for text search commands,
3944 not for the other agenda views like todo lists, tag searches or the weekly
3945 agenda. This variable is intended to list notes and possibly archive files
3946 that should also be searched by these two commands.
3947 In fact, if the first element in the list is the symbol `agenda-archives',
3948 then all archive files of all agenda files will be added to the search
3949 scope."
3950 :group 'org-agenda
3951 :type '(set :greedy t
3952 (const :tag "Agenda Archives" agenda-archives)
3953 (repeat :inline t (file))))
3955 (defvaralias 'org-agenda-multi-occur-extra-files
3956 'org-agenda-text-search-extra-files)
3958 (defcustom org-agenda-skip-unavailable-files nil
3959 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3960 A nil value means to remove them, after a query, from the list."
3961 :group 'org-agenda
3962 :type 'boolean)
3964 (defcustom org-calendar-to-agenda-key [?c]
3965 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3966 The command `org-calendar-goto-agenda' will be bound to this key. The
3967 default is the character `c' because then `c' can be used to switch back and
3968 forth between agenda and calendar."
3969 :group 'org-agenda
3970 :type 'sexp)
3972 (defcustom org-calendar-insert-diary-entry-key [?i]
3973 "The key to be installed in `calendar-mode-map' for adding diary entries.
3974 This option is irrelevant until `org-agenda-diary-file' has been configured
3975 to point to an Org file. When that is the case, the command
3976 `org-agenda-diary-entry' will be bound to the key given here, by default
3977 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3978 if you want to continue doing this, you need to change this to a different
3979 key."
3980 :group 'org-agenda
3981 :type 'sexp)
3983 (defcustom org-agenda-diary-file 'diary-file
3984 "File to which to add new entries with the `i' key in agenda and calendar.
3985 When this is the symbol `diary-file', the functionality in the Emacs
3986 calendar will be used to add entries to the `diary-file'. But when this
3987 points to a file, `org-agenda-diary-entry' will be used instead."
3988 :group 'org-agenda
3989 :type '(choice
3990 (const :tag "The standard Emacs diary file" diary-file)
3991 (file :tag "Special Org file diary entries")))
3993 (eval-after-load "calendar"
3994 '(progn
3995 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3996 'org-calendar-goto-agenda)
3997 (add-hook 'calendar-mode-hook
3998 (lambda ()
3999 (unless (eq org-agenda-diary-file 'diary-file)
4000 (define-key calendar-mode-map
4001 org-calendar-insert-diary-entry-key
4002 'org-agenda-diary-entry))))))
4004 (defgroup org-latex nil
4005 "Options for embedding LaTeX code into Org mode."
4006 :tag "Org LaTeX"
4007 :group 'org)
4009 (defcustom org-format-latex-options
4010 '(:foreground default :background default :scale 1.0
4011 :html-foreground "Black" :html-background "Transparent"
4012 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
4013 "Options for creating images from LaTeX fragments.
4014 This is a property list with the following properties:
4015 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
4016 `default' means use the foreground of the default face.
4017 `auto' means use the foreground from the text face.
4018 :background the background color, or \"Transparent\".
4019 `default' means use the background of the default face.
4020 `auto' means use the background from the text face.
4021 :scale a scaling factor for the size of the images, to get more pixels
4022 :html-foreground, :html-background, :html-scale
4023 the same numbers for HTML export.
4024 :matchers a list indicating which matchers should be used to
4025 find LaTeX fragments. Valid members of this list are:
4026 \"begin\" find environments
4027 \"$1\" find single characters surrounded by $.$
4028 \"$\" find math expressions surrounded by $...$
4029 \"$$\" find math expressions surrounded by $$....$$
4030 \"\\(\" find math expressions surrounded by \\(...\\)
4031 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
4032 :group 'org-latex
4033 :type 'plist)
4035 (defcustom org-format-latex-signal-error t
4036 "Non-nil means signal an error when image creation of LaTeX snippets fails.
4037 When nil, just push out a message."
4038 :group 'org-latex
4039 :version "24.1"
4040 :type 'boolean)
4042 (defcustom org-latex-to-mathml-jar-file nil
4043 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
4044 Use this to specify additional executable file say a jar file.
4046 When using MathToWeb as the converter, specify the full-path to
4047 your mathtoweb.jar file."
4048 :group 'org-latex
4049 :version "24.1"
4050 :type '(choice
4051 (const :tag "None" nil)
4052 (file :tag "JAR file" :must-match t)))
4054 (defcustom org-latex-to-mathml-convert-command nil
4055 "Command to convert LaTeX fragments to MathML.
4056 Replace format-specifiers in the command as noted below and use
4057 `shell-command' to convert LaTeX to MathML.
4058 %j: Executable file in fully expanded form as specified by
4059 `org-latex-to-mathml-jar-file'.
4060 %I: Input LaTeX file in fully expanded form.
4061 %i: The latex fragment to be converted.
4062 %o: Output MathML file.
4064 This command is used by `org-create-math-formula'.
4066 When using MathToWeb as the converter, set this option to
4067 \"java -jar %j -unicode -force -df %o %I\".
4069 When using LaTeXML set this option to
4070 \"latexmlmath \"%i\" --presentationmathml=%o\"."
4071 :group 'org-latex
4072 :version "24.1"
4073 :type '(choice
4074 (const :tag "None" nil)
4075 (string :tag "\nShell command")))
4077 (defcustom org-preview-latex-default-process 'dvipng
4078 "The default process to convert LaTeX fragments to image files.
4079 All available processes and theirs documents can be found in
4080 `org-preview-latex-process-alist', which see."
4081 :group 'org-latex
4082 :version "25.2"
4083 :package-version '(Org . "9.0")
4084 :type 'symbol)
4086 (defcustom org-preview-latex-process-alist
4087 '((dvipng
4088 :programs ("latex" "dvipng")
4089 :description "dvi > png"
4090 :message "you need to install the programs: latex and dvipng."
4091 :image-input-type "dvi"
4092 :image-output-type "png"
4093 :image-size-adjust (1.0 . 1.0)
4094 :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
4095 :image-converter ("dvipng -fg %F -bg %B -D %D -T tight -o %O %f"))
4096 (dvisvgm
4097 :programs ("latex" "dvisvgm")
4098 :description "dvi > svg"
4099 :message "you need to install the programs: latex and dvisvgm."
4100 :use-xcolor t
4101 :image-input-type "dvi"
4102 :image-output-type "svg"
4103 :image-size-adjust (1.7 . 1.5)
4104 :latex-compiler ("latex -interaction nonstopmode -output-directory %o %f")
4105 :image-converter ("dvisvgm %f -n -b min -c %S -o %O"))
4106 (imagemagick
4107 :programs ("latex" "convert")
4108 :description "pdf > png"
4109 :message "you need to install the programs: latex and imagemagick."
4110 :use-xcolor t
4111 :image-input-type "pdf"
4112 :image-output-type "png"
4113 :image-size-adjust (1.0 . 1.0)
4114 :latex-compiler ("pdflatex -interaction nonstopmode -output-directory %o %f")
4115 :image-converter
4116 ("convert -density %D -trim -antialias %f -quality 100 %O")))
4117 "Definitions of external processes for LaTeX previewing.
4118 Org mode can use some external commands to generate TeX snippet's images for
4119 previewing or inserting into HTML files, e.g., \"dvipng\". This variable tells
4120 `org-create-formula-image' how to call them.
4122 The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
4123 PROPERTIES accepts the following attributes:
4125 :programs list of strings, required programs.
4126 :description string, describe the process.
4127 :message string, message it when required programs cannot be found.
4128 :image-input-type string, input file type of image converter (e.g., \"dvi\").
4129 :image-output-type string, output file type of image converter (e.g., \"png\").
4130 :use-xcolor boolean, when non-nil, LaTeX \"xcolor\" macro is used to
4131 deal with background and foreground color of image.
4132 Otherwise, dvipng style background and foregroud color
4133 format are generated. You may then refer to them in
4134 command options with \"%F\" and \"%B\".
4135 :image-size-adjust cons of numbers, the car element is used to adjust LaTeX
4136 image size showed in buffer and the cdr element is for
4137 HTML file. This option is only useful for process
4138 developers, users should use variable
4139 `org-format-latex-options' instead.
4140 :post-clean list of strings, files matched are to be cleaned up once
4141 the image is generated. When nil, the files with \".dvi\",
4142 \".xdv\", \".pdf\", \".tex\", \".aux\", \".log\", \".svg\",
4143 \".png\", \".jpg\", \".jpeg\" or \".out\" extension will
4144 be cleaned up.
4145 :latex-header list of strings, the LaTeX header of the snippet file.
4146 When nil, the fallback value is used instead, which is
4147 controlled by `org-format-latex-header',
4148 `org-latex-default-packages-alist' and
4149 `org-latex-packages-alist', which see.
4150 :latex-compiler list of LaTeX commands, as strings. Each of them is given
4151 to the shell. Place-holders \"%t\", \"%b\" and \"%o\" are
4152 replaced with values defined below.
4153 :image-converter list of image converter commands strings. Each of them is
4154 given to the shell and supports any of the following
4155 place-holders defined below.
4157 Place-holders used by `:image-converter' and `:latex-compiler':
4159 %f input file name
4160 %b base name of input file
4161 %o base directory of input file
4162 %O absolute output file name
4164 Place-holders only used by `:image-converter':
4166 %F foreground of image
4167 %B background of image
4168 %D dpi, which is used to adjust image size by some processing commands.
4169 %S the image size scale ratio, which is used to adjust image size by some
4170 processing commands."
4171 :group 'org-latex
4172 :version "25.2"
4173 :package-version '(Org . "9.0")
4174 :type '(alist :tag "LaTeX to image backends"
4175 :value-type (plist)))
4177 (defcustom org-preview-latex-image-directory "ltximg/"
4178 "Path to store latex preview images.
4179 A relative path here creates many directories relative to the
4180 processed org files paths. An absolute path puts all preview
4181 images at the same place."
4182 :group 'org-latex
4183 :version "25.2"
4184 :package-version '(Org . "9.0")
4185 :type 'string)
4187 (defun org-format-latex-mathml-available-p ()
4188 "Return t if `org-latex-to-mathml-convert-command' is usable."
4189 (save-match-data
4190 (when (and (boundp 'org-latex-to-mathml-convert-command)
4191 org-latex-to-mathml-convert-command)
4192 (let ((executable (car (split-string
4193 org-latex-to-mathml-convert-command))))
4194 (when (executable-find executable)
4195 (if (string-match
4196 "%j" org-latex-to-mathml-convert-command)
4197 (file-readable-p org-latex-to-mathml-jar-file)
4198 t))))))
4200 (defcustom org-format-latex-header "\\documentclass{article}
4201 \\usepackage[usenames]{color}
4202 \[PACKAGES]
4204 \\pagestyle{empty} % do not remove
4205 % The settings below are copied from fullpage.sty
4206 \\setlength{\\textwidth}{\\paperwidth}
4207 \\addtolength{\\textwidth}{-3cm}
4208 \\setlength{\\oddsidemargin}{1.5cm}
4209 \\addtolength{\\oddsidemargin}{-2.54cm}
4210 \\setlength{\\evensidemargin}{\\oddsidemargin}
4211 \\setlength{\\textheight}{\\paperheight}
4212 \\addtolength{\\textheight}{-\\headheight}
4213 \\addtolength{\\textheight}{-\\headsep}
4214 \\addtolength{\\textheight}{-\\footskip}
4215 \\addtolength{\\textheight}{-3cm}
4216 \\setlength{\\topmargin}{1.5cm}
4217 \\addtolength{\\topmargin}{-2.54cm}"
4218 "The document header used for processing LaTeX fragments.
4219 It is imperative that this header make sure that no page number
4220 appears on the page. The package defined in the variables
4221 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4222 will either replace the placeholder \"[PACKAGES]\" in this
4223 header, or they will be appended."
4224 :group 'org-latex
4225 :type 'string)
4227 (defun org-set-packages-alist (var val)
4228 "Set the packages alist and make sure it has 3 elements per entry."
4229 (set var (mapcar (lambda (x)
4230 (if (and (consp x) (= (length x) 2))
4231 (list (car x) (nth 1 x) t)
4233 val)))
4235 (defun org-get-packages-alist (var)
4236 "Get the packages alist and make sure it has 3 elements per entry."
4237 (mapcar (lambda (x)
4238 (if (and (consp x) (= (length x) 2))
4239 (list (car x) (nth 1 x) t)
4241 (default-value var)))
4243 (defcustom org-latex-default-packages-alist
4244 '(("AUTO" "inputenc" t ("pdflatex"))
4245 ("T1" "fontenc" t ("pdflatex"))
4246 ("" "graphicx" t)
4247 ("" "grffile" t)
4248 ("" "longtable" nil)
4249 ("" "wrapfig" nil)
4250 ("" "rotating" nil)
4251 ("normalem" "ulem" t)
4252 ("" "amsmath" t)
4253 ("" "textcomp" t)
4254 ("" "amssymb" t)
4255 ("" "capt-of" nil)
4256 ("" "hyperref" nil))
4257 "Alist of default packages to be inserted in the header.
4259 Change this only if one of the packages here causes an
4260 incompatibility with another package you are using.
4262 The packages in this list are needed by one part or another of
4263 Org mode to function properly:
4265 - inputenc, fontenc: for basic font and character selection
4266 - graphicx: for including images
4267 - grffile: allow periods and spaces in graphics file names
4268 - longtable: For multipage tables
4269 - wrapfig: for figure placement
4270 - rotating: for sideways figures and tables
4271 - ulem: for underline and strike-through
4272 - amsmath: for subscript and superscript and math environments
4273 - textcomp, amssymb: for various symbols used
4274 for interpreting the entities in `org-entities'. You can skip
4275 some of these packages if you don't use any of their symbols.
4276 - capt-of: for captions outside of floats
4277 - hyperref: for cross references
4279 Therefore you should not modify this variable unless you know
4280 what you are doing. The one reason to change it anyway is that
4281 you might be loading some other package that conflicts with one
4282 of the default packages. Each element is either a cell or
4283 a string.
4285 A cell is of the format
4287 (\"options\" \"package\" SNIPPET-FLAG COMPILERS)
4289 If SNIPPET-FLAG is non-nil, the package also needs to be included
4290 when compiling LaTeX snippets into images for inclusion into
4291 non-LaTeX output. COMPILERS is a list of compilers that should
4292 include the package, see `org-latex-compiler'. If the document
4293 compiler is not in the list, and the list is non-nil, the package
4294 will not be inserted in the final document.
4296 A string will be inserted as-is in the header of the document."
4297 :group 'org-latex
4298 :group 'org-export-latex
4299 :set 'org-set-packages-alist
4300 :get 'org-get-packages-alist
4301 :version "25.2"
4302 :package-version '(Org . "8.3")
4303 :type '(repeat
4304 (choice
4305 (list :tag "options/package pair"
4306 (string :tag "options")
4307 (string :tag "package")
4308 (boolean :tag "Snippet"))
4309 (string :tag "A line of LaTeX"))))
4311 (defcustom org-latex-packages-alist nil
4312 "Alist of packages to be inserted in every LaTeX header.
4314 These will be inserted after `org-latex-default-packages-alist'.
4315 Each element is either a cell or a string.
4317 A cell is of the format:
4319 (\"options\" \"package\" SNIPPET-FLAG)
4321 SNIPPET-FLAG, when non-nil, indicates that this package is also
4322 needed when turning LaTeX snippets into images for inclusion into
4323 non-LaTeX output.
4325 A string will be inserted as-is in the header of the document.
4327 Make sure that you only list packages here which:
4329 - you want in every file;
4330 - do not conflict with the setup in `org-format-latex-header';
4331 - do not conflict with the default packages in
4332 `org-latex-default-packages-alist'."
4333 :group 'org-latex
4334 :group 'org-export-latex
4335 :set 'org-set-packages-alist
4336 :get 'org-get-packages-alist
4337 :type '(repeat
4338 (choice
4339 (list :tag "options/package pair"
4340 (string :tag "options")
4341 (string :tag "package")
4342 (boolean :tag "Snippet"))
4343 (string :tag "A line of LaTeX"))))
4345 (defgroup org-appearance nil
4346 "Settings for Org mode appearance."
4347 :tag "Org Appearance"
4348 :group 'org)
4350 (defcustom org-level-color-stars-only nil
4351 "Non-nil means fontify only the stars in each headline.
4352 When nil, the entire headline is fontified.
4353 Changing it requires restart of `font-lock-mode' to become effective
4354 also in regions already fontified."
4355 :group 'org-appearance
4356 :type 'boolean)
4358 (defcustom org-hide-leading-stars nil
4359 "Non-nil means hide the first N-1 stars in a headline.
4360 This works by using the face `org-hide' for these stars. This
4361 face is white for a light background, and black for a dark
4362 background. You may have to customize the face `org-hide' to
4363 make this work.
4364 Changing it requires restart of `font-lock-mode' to become effective
4365 also in regions already fontified.
4366 You may also set this on a per-file basis by adding one of the following
4367 lines to the buffer:
4369 #+STARTUP: hidestars
4370 #+STARTUP: showstars"
4371 :group 'org-appearance
4372 :type 'boolean)
4374 (defcustom org-hidden-keywords nil
4375 "List of symbols corresponding to keywords to be hidden the org buffer.
4376 For example, a value \\='(title) for this list will make the document's title
4377 appear in the buffer without the initial #+TITLE: keyword."
4378 :group 'org-appearance
4379 :version "24.1"
4380 :type '(set (const :tag "#+AUTHOR" author)
4381 (const :tag "#+DATE" date)
4382 (const :tag "#+EMAIL" email)
4383 (const :tag "#+TITLE" title)))
4385 (defcustom org-custom-properties nil
4386 "List of properties (as strings) with a special meaning.
4387 The default use of these custom properties is to let the user
4388 hide them with `org-toggle-custom-properties-visibility'."
4389 :group 'org-properties
4390 :group 'org-appearance
4391 :version "24.3"
4392 :type '(repeat (string :tag "Property Name")))
4394 (defcustom org-fontify-done-headline nil
4395 "Non-nil means change the face of a headline if it is marked DONE.
4396 Normally, only the TODO/DONE keyword indicates the state of a headline.
4397 When this is non-nil, the headline after the keyword is set to the
4398 `org-headline-done' as an additional indication."
4399 :group 'org-appearance
4400 :type 'boolean)
4402 (defcustom org-fontify-emphasized-text t
4403 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4404 Changing this variable requires a restart of Emacs to take effect."
4405 :group 'org-appearance
4406 :type 'boolean)
4408 (defcustom org-fontify-whole-heading-line nil
4409 "Non-nil means fontify the whole line for headings.
4410 This is useful when setting a background color for the
4411 org-level-* faces."
4412 :group 'org-appearance
4413 :type 'boolean)
4415 (defcustom org-highlight-latex-and-related nil
4416 "Non-nil means highlight LaTeX related syntax in the buffer.
4417 When non nil, the value should be a list containing any of the
4418 following symbols:
4419 `latex' Highlight LaTeX snippets and environments.
4420 `script' Highlight subscript and superscript.
4421 `entities' Highlight entities."
4422 :group 'org-appearance
4423 :version "24.4"
4424 :package-version '(Org . "8.0")
4425 :type '(choice
4426 (const :tag "No highlighting" nil)
4427 (set :greedy t :tag "Highlight"
4428 (const :tag "LaTeX snippets and environments" latex)
4429 (const :tag "Subscript and superscript" script)
4430 (const :tag "Entities" entities))))
4432 (defcustom org-hide-emphasis-markers nil
4433 "Non-nil mean font-lock should hide the emphasis marker characters."
4434 :group 'org-appearance
4435 :type 'boolean)
4437 (defcustom org-hide-macro-markers nil
4438 "Non-nil mean font-lock should hide the brackets marking macro calls."
4439 :group 'org-appearance
4440 :type 'boolean)
4442 (defcustom org-pretty-entities nil
4443 "Non-nil means show entities as UTF8 characters.
4444 When nil, the \\name form remains in the buffer."
4445 :group 'org-appearance
4446 :version "24.1"
4447 :type 'boolean)
4449 (defcustom org-pretty-entities-include-sub-superscripts t
4450 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4451 :group 'org-appearance
4452 :version "24.1"
4453 :type 'boolean)
4455 (defvar org-emph-re nil
4456 "Regular expression for matching emphasis.
4457 After a match, the match groups contain these elements:
4458 0 The match of the full regular expression, including the characters
4459 before and after the proper match
4460 1 The character before the proper match, or empty at beginning of line
4461 2 The proper match, including the leading and trailing markers
4462 3 The leading marker like * or /, indicating the type of highlighting
4463 4 The text between the emphasis markers, not including the markers
4464 5 The character after the match, empty at the end of a line")
4465 (defvar org-verbatim-re nil
4466 "Regular expression for matching verbatim text.")
4467 (defvar org-emphasis-regexp-components) ; defined just below
4468 (defvar org-emphasis-alist) ; defined just below
4469 (defun org-set-emph-re (var val)
4470 "Set variable and compute the emphasis regular expression."
4471 (set var val)
4472 (when (and (boundp 'org-emphasis-alist)
4473 (boundp 'org-emphasis-regexp-components)
4474 org-emphasis-alist org-emphasis-regexp-components)
4475 (let* ((e org-emphasis-regexp-components)
4476 (pre (car e))
4477 (post (nth 1 e))
4478 (border (nth 2 e))
4479 (body (nth 3 e))
4480 (nl (nth 4 e))
4481 (body1 (concat body "*?"))
4482 (markers (mapconcat 'car org-emphasis-alist ""))
4483 (vmarkers (mapconcat
4484 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4485 org-emphasis-alist "")))
4486 ;; make sure special characters appear at the right position in the class
4487 (if (string-match "\\^" markers)
4488 (setq markers (concat (replace-match "" t t markers) "^")))
4489 (if (string-match "-" markers)
4490 (setq markers (concat (replace-match "" t t markers) "-")))
4491 (if (string-match "\\^" vmarkers)
4492 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4493 (if (string-match "-" vmarkers)
4494 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4495 (if (> nl 0)
4496 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4497 (int-to-string nl) "\\}")))
4498 ;; Make the regexp
4499 (setq org-emph-re
4500 (concat "\\([" pre "]\\|^\\)"
4501 "\\("
4502 "\\([" markers "]\\)"
4503 "\\("
4504 "[^" border "]\\|"
4505 "[^" border "]"
4506 body1
4507 "[^" border "]"
4508 "\\)"
4509 "\\3\\)"
4510 "\\([" post "]\\|$\\)"))
4511 (setq org-verbatim-re
4512 (concat "\\([" pre "]\\|^\\)"
4513 "\\("
4514 "\\([" vmarkers "]\\)"
4515 "\\("
4516 "[^" border "]\\|"
4517 "[^" border "]"
4518 body1
4519 "[^" border "]"
4520 "\\)"
4521 "\\3\\)"
4522 "\\([" post "]\\|$\\)")))))
4524 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4525 ;; set this option proved cumbersome. See this message/thread:
4526 ;;
4527 (defvar org-emphasis-regexp-components
4528 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n" "." 1)
4529 "Components used to build the regular expression for emphasis.
4530 This is a list with five entries. Terminology: In an emphasis string
4531 like \" *strong word* \", we call the initial space PREMATCH, the final
4532 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4533 and \"trong wor\" is the body. The different components in this variable
4534 specify what is allowed/forbidden in each part:
4536 pre Chars allowed as prematch. Beginning of line will be allowed too.
4537 post Chars allowed as postmatch. End of line will be allowed too.
4538 border The chars *forbidden* as border characters.
4539 body-regexp A regexp like \".\" to match a body character. Don't use
4540 non-shy groups here, and don't allow newline here.
4541 newline The maximum number of newlines allowed in an emphasis exp.
4543 You need to reload Org or to restart Emacs after customizing this.")
4545 (defcustom org-emphasis-alist
4546 '(("*" bold)
4547 ("/" italic)
4548 ("_" underline)
4549 ("=" org-verbatim verbatim)
4550 ("~" org-code verbatim)
4551 ("+" (:strike-through t)))
4552 "Alist of characters and faces to emphasize text.
4553 Text starting and ending with a special character will be emphasized,
4554 for example *bold*, _underlined_ and /italic/. This variable sets the
4555 marker characters and the face to be used by font-lock for highlighting
4556 in Org buffers.
4558 You need to reload Org or to restart Emacs after customizing this."
4559 :group 'org-appearance
4560 :set 'org-set-emph-re
4561 :version "24.4"
4562 :package-version '(Org . "8.0")
4563 :type '(repeat
4564 (list
4565 (string :tag "Marker character")
4566 (choice
4567 (face :tag "Font-lock-face")
4568 (plist :tag "Face property list"))
4569 (option (const verbatim)))))
4571 (defvar org-protecting-blocks '("src" "example" "export")
4572 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4573 This is needed for font-lock setup.")
4575 ;;; Functions and variables from their packages
4576 ;; Declared here to avoid compiler warnings
4577 (defvar mark-active)
4579 ;; Various packages
4580 (declare-function calc-eval "calc" (str &optional separator &rest args))
4581 (declare-function calendar-forward-day "cal-move" (arg))
4582 (declare-function calendar-goto-date "cal-move" (date))
4583 (declare-function calendar-goto-today "cal-move" ())
4584 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4585 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4586 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4587 (declare-function cdlatex-tab "ext:cdlatex" ())
4588 (declare-function dired-get-filename
4589 "dired"
4590 (&optional localp no-error-if-not-filep))
4591 (declare-function iswitchb-read-buffer
4592 "iswitchb"
4593 (prompt &optional
4594 default require-match _predicate start matches-set))
4595 (declare-function org-agenda-change-all-lines
4596 "org-agenda"
4597 (newhead hdmarker &optional fixface just-this))
4598 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4599 "org-agenda"
4600 (&optional end))
4601 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4602 (declare-function org-agenda-format-item
4603 "org-agenda"
4604 (extra txt &optional level category tags dotime
4605 remove-re habitp))
4606 (declare-function org-agenda-maybe-redo "org-agenda" ())
4607 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4608 (declare-function org-agenda-save-markers-for-cut-and-paste
4609 "org-agenda"
4610 (beg end))
4611 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4612 (declare-function org-agenda-skip "org-agenda" ())
4613 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4614 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4615 (declare-function org-indent-mode "org-indent" (&optional arg))
4616 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4617 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4618 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4619 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4620 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4621 (declare-function parse-time-string "parse-time" (string))
4622 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4624 (defvar align-mode-rules-list)
4625 (defvar calc-embedded-close-formula)
4626 (defvar calc-embedded-open-formula)
4627 (defvar calc-embedded-open-mode)
4628 (defvar font-lock-unfontify-region-function)
4629 (defvar iswitchb-temp-buflist)
4630 (defvar org-agenda-tags-todo-honor-ignore-options)
4631 (defvar remember-data-file)
4632 (defvar texmathp-why)
4634 ;;;###autoload
4635 (defun turn-on-orgtbl ()
4636 "Unconditionally turn on `orgtbl-mode'."
4637 (require 'org-table)
4638 (orgtbl-mode 1))
4640 (defun org-at-table-p (&optional table-type)
4641 "Non-nil if the cursor is inside an Org table.
4642 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4643 If `org-enable-table-editor' is nil, return nil unconditionally."
4644 (and
4645 org-enable-table-editor
4646 (save-excursion
4647 (beginning-of-line)
4648 (looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4649 (or (not (derived-mode-p 'org-mode))
4650 (let ((e (org-element-lineage (org-element-at-point) '(table) t)))
4651 (and e (or table-type (eq (org-element-property :type e) 'org)))))))
4653 (defun org-at-table.el-p ()
4654 "Non-nil when point is at a table.el table."
4655 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4656 (let ((element (org-element-at-point)))
4657 (and (eq (org-element-type element) 'table)
4658 (eq (org-element-property :type element) 'table.el)))))