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