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