org.texi: ob-languages and multiple sessions support
[org-mode.git] / lisp / org.el
blob9807e933e68ad396eaaaa7413ecd2071f67e6757
1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2015 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
10 ;;
11 ;; This file is part of GNU Emacs.
12 ;;
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/>.
25 ;;
26 ;;; Commentary:
27 ;;
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.
30 ;;
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.
45 ;;
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
49 ;;
50 ;; http://orgmode.org/org.html#Installation
51 ;;
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 etc/ directory of Emacs 22.
59 ;;
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
62 ;;
63 ;;; Code:
65 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local)
70 ;;;; Require other packages
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (or (equal this-command 'eval-buffer)
81 (condition-case nil
82 (load (concat (file-name-directory load-file-name)
83 "org-loaddefs.el")
84 nil t t t)
85 (error
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
87 (sit-for 3)
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
89 (sit-for 3))))
91 (require 'org-macs)
92 (require 'org-compat)
94 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
95 ;; some places -- e.g. see the macro `org-with-limited-levels'.
96 ;;
97 ;; In Org buffers, the value of `outline-regexp' is that of
98 ;; `org-outline-regexp'. The only function still directly relying on
99 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
100 ;; job when `orgstruct-mode' is active.
101 (defvar org-outline-regexp "\\*+ "
102 "Regexp to match Org headlines.")
104 (defvar org-outline-regexp-bol "^\\*+ "
105 "Regexp to match Org headlines.
106 This is similar to `org-outline-regexp' but additionally makes
107 sure that we are at the beginning of the line.")
109 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
110 "Matches a headline, putting stars and text into groups.
111 Stars are put in group 1 and the trimmed body in group 2.")
113 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
114 (unless (boundp 'calendar-view-holidays-initially-flag)
115 (org-defvaralias 'calendar-view-holidays-initially-flag
116 'view-calendar-holidays-initially))
117 (unless (boundp 'calendar-view-diary-initially-flag)
118 (org-defvaralias 'calendar-view-diary-initially-flag
119 'view-diary-entries-initially))
120 (unless (boundp 'diary-fancy-buffer)
121 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
123 (declare-function cdlatex-environment "ext:cdlatex" (environment item))
124 (declare-function org-add-archive-files "org-archive" (files))
125 (declare-function org-agenda-entry-get-agenda-timestamp "org-agenda" (pom))
126 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
127 (declare-function org-agenda-redo "org-agenda" (&optional all))
128 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
129 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
132 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
133 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
134 (declare-function org-clock-sum "org-clock" (&optional tstart tend headline-filter propname))
135 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
136 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
137 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
138 (declare-function org-clock-update-time-maybe "org-clock" ())
139 (declare-function org-clocktable-shift "org-clock" (dir n))
140 (declare-function org-element-at-point "org-element" ())
141 (declare-function org-element-cache-refresh "org-element" (pos))
142 (declare-function org-element-cache-reset "org-element" (&optional all))
143 (declare-function org-element-contents "org-element" (element))
144 (declare-function org-element-context "org-element" (&optional element))
145 (declare-function org-element-copy "org-element" (datum))
146 (declare-function org-element-interpret-data "org-element" (data &optional parent))
147 (declare-function org-element-lineage "org-element" (blob &optional types with-self))
148 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
149 (declare-function org-element-parse-buffer "org-element" (&optional granularity visible-only))
150 (declare-function org-element-property "org-element" (property element))
151 (declare-function org-element-put-property "org-element" (element property value))
152 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
153 (declare-function org-element-type "org-element" (element))
154 (declare-function org-element-update-syntax "org-element" ())
155 (declare-function org-id-find-id-file "org-id" (id))
156 (declare-function org-id-get-create "org-id" (&optional force))
157 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
158 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
159 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
160 (declare-function org-plot/gnuplot "org-plot" (&optional params))
161 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
162 (declare-function org-table-align "org-table" ())
163 (declare-function org-table-begin "org-table" (&optional table-type))
164 (declare-function org-table-beginning-of-field "org-table" (&optional n))
165 (declare-function org-table-blank-field "org-table" ())
166 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
167 (declare-function org-table-edit-field "org-table" (arg))
168 (declare-function org-table-end "org-table" (&optional table-type))
169 (declare-function org-table-end-of-field "org-table" (&optional n))
170 (declare-function org-table-insert-row "org-table" (&optional arg))
171 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
172 (declare-function org-table-maybe-eval-formula "org-table" ())
173 (declare-function org-table-maybe-recalculate-line "org-table" ())
174 (declare-function org-table-next-row "org-table" ())
175 (declare-function org-table-paste-rectangle "org-table" ())
176 (declare-function org-table-wrap-region "org-table" (arg))
177 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
178 (declare-function orgtbl-ascii-plot "org-table" (&optional ask))
179 (declare-function orgtbl-mode "org-table" (&optional arg))
181 (defsubst org-uniquify (list)
182 "Non-destructively remove duplicate elements from LIST."
183 (let ((res (copy-sequence list))) (delete-dups res)))
185 (defsubst org-get-at-bol (property)
186 "Get text property PROPERTY at the beginning of line."
187 (get-text-property (point-at-bol) property))
189 (defsubst org-trim (s)
190 "Remove whitespace at the beginning and the end of string S."
191 (replace-regexp-in-string
192 "\\`[ \t\n\r]+" ""
193 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s)))
195 ;; load languages based on value of `org-babel-load-languages'
196 (defvar org-babel-load-languages)
198 ;;;###autoload
199 (defun org-babel-do-load-languages (sym value)
200 "Load the languages defined in `org-babel-load-languages'."
201 (set-default sym value)
202 (mapc (lambda (pair)
203 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
204 (if active
205 (progn
206 (require (intern (concat "ob-" lang))))
207 (progn
208 (funcall 'fmakunbound
209 (intern (concat "org-babel-execute:" lang)))
210 (funcall 'fmakunbound
211 (intern (concat "org-babel-expand-body:" lang)))))))
212 org-babel-load-languages))
214 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
215 ;;;###autoload
216 (defun org-babel-load-file (file &optional compile)
217 "Load Emacs Lisp source code blocks in the Org-mode FILE.
218 This function exports the source code using `org-babel-tangle'
219 and then loads the resulting file using `load-file'. With prefix
220 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
221 file to byte-code before it is loaded."
222 (interactive "fFile to load: \nP")
223 (let* ((age (lambda (file)
224 (float-time
225 (time-subtract (current-time)
226 (nth 5 (or (file-attributes (file-truename file))
227 (file-attributes file)))))))
228 (base-name (file-name-sans-extension file))
229 (exported-file (concat base-name ".el")))
230 ;; tangle if the org-mode file is newer than the elisp file
231 (unless (and (file-exists-p exported-file)
232 (> (funcall age file) (funcall age exported-file)))
233 ;; Tangle-file traversal returns reversed list of tangled files
234 ;; and we want to evaluate the first target.
235 (setq exported-file
236 (car (last (org-babel-tangle-file file exported-file "emacs-lisp")))))
237 (message "%s %s"
238 (if compile
239 (progn (byte-compile-file exported-file 'load)
240 "Compiled and loaded")
241 (progn (load-file exported-file) "Loaded"))
242 exported-file)))
244 (defcustom org-babel-load-languages '((emacs-lisp . t))
245 "Languages which can be evaluated in Org-mode buffers.
246 This list can be used to load support for any of the languages
247 below, note that each language will depend on a different set of
248 system executables and/or Emacs modes. When a language is
249 \"loaded\", then code blocks in that language can be evaluated
250 with `org-babel-execute-src-block' bound by default to C-c
251 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
252 be set to remove code block evaluation from the C-c C-c
253 keybinding. By default only Emacs Lisp (which has no
254 requirements) is loaded."
255 :group 'org-babel
256 :set 'org-babel-do-load-languages
257 :version "24.1"
258 :type '(alist :tag "Babel Languages"
259 :key-type
260 (choice
261 (const :tag "Awk" awk)
262 (const :tag "C" C)
263 (const :tag "R" R)
264 (const :tag "Asymptote" asymptote)
265 (const :tag "Calc" calc)
266 (const :tag "Clojure" clojure)
267 (const :tag "CSS" css)
268 (const :tag "Ditaa" ditaa)
269 (const :tag "Dot" dot)
270 (const :tag "Emacs Lisp" emacs-lisp)
271 (const :tag "Forth" forth)
272 (const :tag "Fortran" fortran)
273 (const :tag "Gnuplot" gnuplot)
274 (const :tag "Haskell" haskell)
275 (const :tag "IO" io)
276 (const :tag "J" J)
277 (const :tag "Java" java)
278 (const :tag "Javascript" js)
279 (const :tag "LaTeX" latex)
280 (const :tag "Ledger" ledger)
281 (const :tag "Lilypond" lilypond)
282 (const :tag "Lisp" lisp)
283 (const :tag "Makefile" makefile)
284 (const :tag "Maxima" maxima)
285 (const :tag "Matlab" matlab)
286 (const :tag "Mscgen" mscgen)
287 (const :tag "Ocaml" ocaml)
288 (const :tag "Octave" octave)
289 (const :tag "Org" org)
290 (const :tag "Perl" perl)
291 (const :tag "Pico Lisp" picolisp)
292 (const :tag "PlantUML" plantuml)
293 (const :tag "Python" python)
294 (const :tag "Ruby" ruby)
295 (const :tag "Sass" sass)
296 (const :tag "Scala" scala)
297 (const :tag "Scheme" scheme)
298 (const :tag "Screen" screen)
299 (const :tag "Shell Script" shell)
300 (const :tag "Shen" shen)
301 (const :tag "Sql" sql)
302 (const :tag "Sqlite" sqlite)
303 (const :tag "ebnf2ps" ebnf2ps))
304 :value-type (boolean :tag "Activate" :value t)))
306 ;;;; Customization variables
307 (defcustom org-clone-delete-id nil
308 "Remove ID property of clones of a subtree.
309 When non-nil, clones of a subtree don't inherit the ID property.
310 Otherwise they inherit the ID property with a new unique
311 identifier."
312 :type 'boolean
313 :version "24.1"
314 :group 'org-id)
316 ;;; Version
317 (org-check-version)
319 ;;;###autoload
320 (defun org-version (&optional here full message)
321 "Show the org-mode version.
322 Interactively, or when MESSAGE is non-nil, show it in echo area.
323 With prefix argument, or when HERE is non-nil, insert it at point.
324 In non-interactive uses, a reduced version string is output unless
325 FULL is given."
326 (interactive (list current-prefix-arg t (not current-prefix-arg)))
327 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
328 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
329 (load-suffixes (list ".el"))
330 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
331 (org-trash (or
332 (and (fboundp 'org-release) (fboundp 'org-git-version))
333 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
334 (load-suffixes save-load-suffixes)
335 (org-version (org-release))
336 (git-version (org-git-version))
337 (version (format "Org-mode version %s (%s @ %s)"
338 org-version
339 git-version
340 (if org-install-dir
341 (if (string= org-dir org-install-dir)
342 org-install-dir
343 (concat "mixed installation! " org-install-dir " and " org-dir))
344 "org-loaddefs.el can not be found!")))
345 (version1 (if full version org-version)))
346 (when here (insert version1))
347 (when message (message "%s" version1))
348 version1))
350 (defconst org-version (org-version))
352 \f
353 ;;; Syntax Constants
355 ;;;; Block
357 (defconst org-block-regexp
358 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
359 "Regular expression for hiding blocks.")
361 (defconst org-dblock-start-re
362 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
363 "Matches the start line of a dynamic block, with parameters.")
365 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
366 "Matches the end of a dynamic block.")
368 ;;;; Clock and Planning
370 (defconst org-clock-string "CLOCK:"
371 "String used as prefix for timestamps clocking work hours on an item.")
373 (defvar org-closed-string "CLOSED:"
374 "String used as the prefix for timestamps logging closing a TODO entry.")
376 (defvar org-deadline-string "DEADLINE:"
377 "String to mark deadline entries.
378 A deadline 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-deadline].")
382 (defvar org-scheduled-string "SCHEDULED:"
383 "String to mark scheduled TODO entries.
384 A schedule is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-schedule].")
388 (defconst org-ds-keyword-length
389 (+ 2
390 (apply #'max
391 (mapcar #'length
392 (list org-deadline-string org-scheduled-string
393 org-clock-string org-closed-string))))
394 "Maximum length of the DEADLINE and SCHEDULED keywords.")
396 (defconst org-planning-line-re
397 (concat "^[ \t]*"
398 (regexp-opt
399 (list org-closed-string org-deadline-string org-scheduled-string)
400 t))
401 "Matches a line with planning info.
402 Matched keyword is in group 1.")
404 (defconst org-clock-line-re
405 (concat "^[ \t]*" org-clock-string)
406 "Matches a line with clock info.")
408 (defconst org-deadline-regexp (concat "\\<" org-deadline-string)
409 "Matches the DEADLINE keyword.")
411 (defconst org-deadline-time-regexp
412 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
413 "Matches the DEADLINE keyword together with a time stamp.")
415 (defconst org-deadline-time-hour-regexp
416 (concat "\\<" org-deadline-string
417 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
418 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
420 (defconst org-deadline-line-regexp
421 (concat "\\<\\(" org-deadline-string "\\).*")
422 "Matches the DEADLINE keyword and the rest of the line.")
424 (defconst org-scheduled-regexp (concat "\\<" org-scheduled-string)
425 "Matches the SCHEDULED keyword.")
427 (defconst org-scheduled-time-regexp
428 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
429 "Matches the SCHEDULED keyword together with a time stamp.")
431 (defconst org-scheduled-time-hour-regexp
432 (concat "\\<" org-scheduled-string
433 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
434 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
436 (defconst org-closed-time-regexp
437 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
438 "Matches the CLOSED keyword together with a time stamp.")
440 (defconst org-keyword-time-regexp
441 (concat "\\<"
442 (regexp-opt
443 (list org-scheduled-string org-deadline-string org-closed-string
444 org-clock-string)
445 t)
446 " *[[<]\\([^]>]+\\)[]>]")
447 "Matches any of the 4 keywords, together with the time stamp.")
449 (defconst org-keyword-time-not-clock-regexp
450 (concat
451 "\\<"
452 (regexp-opt
453 (list org-scheduled-string org-deadline-string org-closed-string) t)
454 " *[[<]\\([^]>]+\\)[]>]")
455 "Matches any of the 3 keywords, together with the time stamp.")
457 (defconst org-maybe-keyword-time-regexp
458 (concat "\\(\\<"
459 (regexp-opt
460 (list org-scheduled-string org-deadline-string org-closed-string
461 org-clock-string)
462 t)
463 "\\)?"
464 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
465 "\\|"
466 "<%%([^\r\n>]*>\\)")
467 "Matches a timestamp, possibly preceded by a keyword.")
469 (defconst org-all-time-keywords
470 (mapcar (lambda (w) (substring w 0 -1))
471 (list org-scheduled-string org-deadline-string
472 org-clock-string org-closed-string))
473 "List of time keywords.")
475 ;;;; Drawer
477 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
478 "Matches first or last line of a hidden block.
479 Group 1 contains drawer's name or \"END\".")
481 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
482 "Regular expression matching the first line of a property drawer.")
484 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
485 "Regular expression matching the last line of a property drawer.")
487 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
488 "Regular expression matching the first line of a clock drawer.")
490 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a clock drawer.")
493 (defconst org-property-drawer-re
494 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
495 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
496 "[ \t]*:END:[ \t]*$")
497 "Matches an entire property drawer.")
499 (defconst org-clock-drawer-re
500 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
501 org-clock-drawer-end-re "\\)\n?")
502 "Matches an entire clock drawer.")
504 ;;;; Headline
506 (defconst org-heading-keyword-regexp-format
507 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
508 "Printf format for a regexp matching a headline with some keyword.
509 This regexp will match the headline of any node which has the
510 exact keyword that is put into the format. The keyword isn't in
511 any group by default, but the stars and the body are.")
513 (defconst org-heading-keyword-maybe-regexp-format
514 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
515 "Printf format for a regexp matching a headline, possibly with some keyword.
516 This regexp can match any headline with the specified keyword, or
517 without a keyword. The keyword isn't in any group by default,
518 but the stars and the body are.")
520 (defconst org-archive-tag "ARCHIVE"
521 "The tag that marks a subtree as archived.
522 An archived subtree does not open during visibility cycling, and does
523 not contribute to the agenda listings.")
525 (defconst org-comment-string "COMMENT"
526 "Entries starting with this keyword will never be exported.
527 An entry can be toggled between COMMENT and normal with
528 \\[org-toggle-comment].")
531 ;;;; LaTeX Environments and Fragments
533 (defconst org-latex-regexps
534 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
535 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
536 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
537 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
538 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|\000\\|$\\)" 2 nil)
539 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
540 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
541 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
542 "Regular expressions for matching embedded LaTeX.")
544 ;;;; Node Property
546 (defconst org-effort-property "Effort"
547 "The property that is being used to keep track of effort estimates.
548 Effort estimates given in this property need to have the format H:MM.")
550 ;;;; Table
552 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
553 "Detect an org-type or table-type table.")
555 (defconst org-table-line-regexp "^[ \t]*|"
556 "Detect an org-type table line.")
558 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
559 "Detect an org-type table line.")
561 (defconst org-table-hline-regexp "^[ \t]*|-"
562 "Detect an org-type table hline.")
564 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
565 "Detect a table-type table hline.")
567 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
568 "Detect the first line outside a table when searching from within it.
569 This works for both table types.")
571 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
572 "Detect a #+TBLFM line.")
574 ;;;; Timestamp
576 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
577 "Regular expression for fast time stamp matching.")
579 (defconst org-ts-regexp-inactive
580 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
581 "Regular expression for fast inactive time stamp matching.")
583 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
584 "Regular expression for fast time stamp matching.")
586 (defconst org-ts-regexp0
587 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
588 "Regular expression matching time strings for analysis.
589 This one does not require the space after the date, so it can be used
590 on a string that terminates immediately after the date.")
592 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
593 "Regular expression matching time strings for analysis.")
595 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
596 "Regular expression matching time stamps, with groups.")
598 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
599 "Regular expression matching time stamps (also [..]), with groups.")
601 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
602 "Regular expression matching a time stamp range.")
604 (defconst org-tr-regexp-both
605 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
606 "Regular expression matching a time stamp range.")
608 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
609 org-ts-regexp "\\)?")
610 "Regular expression matching a time stamp or time stamp range.")
612 (defconst org-tsr-regexp-both
613 (concat org-ts-regexp-both "\\(--?-?"
614 org-ts-regexp-both "\\)?")
615 "Regular expression matching a time stamp or time stamp range.
616 The time stamps may be either active or inactive.")
618 (defconst org-repeat-re
619 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
620 "Regular expression for specifying repeated events.
621 After a match, group 1 contains the repeat expression.")
623 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
624 "Formats for `format-time-string' which are used for time stamps.")
626 \f
627 ;;; The custom variables
629 (defgroup org nil
630 "Outline-based notes management and organizer."
631 :tag "Org"
632 :group 'outlines
633 :group 'calendar)
635 (defcustom org-mode-hook nil
636 "Mode hook for Org-mode, run after the mode was turned on."
637 :group 'org
638 :type 'hook)
640 (defcustom org-load-hook nil
641 "Hook that is run after org.el has been loaded."
642 :group 'org
643 :type 'hook)
645 (defcustom org-log-buffer-setup-hook nil
646 "Hook that is run after an Org log buffer is created."
647 :group 'org
648 :version "24.1"
649 :type 'hook)
651 (defvar org-modules) ; defined below
652 (defvar org-modules-loaded nil
653 "Have the modules been loaded already?")
655 (defun org-load-modules-maybe (&optional force)
656 "Load all extensions listed in `org-modules'."
657 (when (or force (not org-modules-loaded))
658 (mapc (lambda (ext)
659 (condition-case nil (require ext)
660 (error (message "Problems while trying to load feature `%s'" ext))))
661 org-modules)
662 (setq org-modules-loaded t)))
664 (defun org-set-modules (var value)
665 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
666 (set var value)
667 (when (featurep 'org)
668 (org-load-modules-maybe 'force)
669 (org-element-cache-reset 'all)))
671 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
672 "Modules that should always be loaded together with org.el.
674 If a description starts with <C>, the file is not part of Emacs
675 and loading it will require that you have downloaded and properly
676 installed the Org mode distribution.
678 You can also use this system to load external packages (i.e. neither Org
679 core modules, nor modules from the CONTRIB directory). Just add symbols
680 to the end of the list. If the package is called org-xyz.el, then you need
681 to add the symbol `xyz', and the package must have a call to:
683 \(provide 'org-xyz)
685 For export specific modules, see also `org-export-backends'."
686 :group 'org
687 :set 'org-set-modules
688 :version "24.4"
689 :package-version '(Org . "8.0")
690 :type
691 '(set :greedy t
692 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
693 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
694 (const :tag " crypt: Encryption of subtrees" org-crypt)
695 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
696 (const :tag " docview: Links to doc-view buffers" org-docview)
697 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
698 (const :tag " habit: Track your consistency with habits" org-habit)
699 (const :tag " id: Global IDs for identifying entries" org-id)
700 (const :tag " info: Links to Info nodes" org-info)
701 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
702 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
703 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
704 (const :tag " mouse: Additional mouse support" org-mouse)
705 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
706 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
707 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
709 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
710 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
711 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
712 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
713 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
714 (const :tag "C collector: Collect properties into tables" org-collector)
715 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
716 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
717 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
718 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
719 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
720 (const :tag "C eval: Include command output as text" org-eval)
721 (const :tag "C eww: Store link to url of eww" org-eww)
722 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
723 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
724 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
725 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
726 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
727 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
728 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
729 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
730 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
731 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
732 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
733 (const :tag "C mew: Links to Mew folders/messages" org-mew)
734 (const :tag "C mtags: Support for muse-like tags" org-mtags)
735 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
736 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
737 (const :tag "C registry: A registry for Org-mode links" org-registry)
738 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
739 (const :tag "C secretary: Team management with org-mode" org-secretary)
740 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
741 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
742 (const :tag "C track: Keep up with Org-mode development" org-track)
743 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
744 (const :tag "C vm: Links to VM folders/messages" org-vm)
745 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
746 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
747 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
749 (defvar org-export-registered-backends) ; From ox.el.
750 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
751 (declare-function org-export-backend-name "ox" (backend))
752 (defcustom org-export-backends '(ascii html icalendar latex)
753 "List of export back-ends that should be always available.
755 If a description starts with <C>, the file is not part of Emacs
756 and loading it will require that you have downloaded and properly
757 installed the Org mode distribution.
759 Unlike to `org-modules', libraries in this list will not be
760 loaded along with Org, but only once the export framework is
761 needed.
763 This variable needs to be set before org.el is loaded. If you
764 need to make a change while Emacs is running, use the customize
765 interface or run the following code, where VAL stands for the new
766 value of the variable, after updating it:
768 \(progn
769 \(setq org-export-registered-backends
770 \(org-remove-if-not
771 \(lambda (backend)
772 \(let ((name (org-export-backend-name backend)))
773 \(or (memq name val)
774 \(catch 'parentp
775 \(dolist (b val)
776 \(and (org-export-derived-backend-p b name)
777 \(throw 'parentp t)))))))
778 org-export-registered-backends))
779 \(let ((new-list (mapcar #'org-export-backend-name
780 org-export-registered-backends)))
781 \(dolist (backend val)
782 \(cond
783 \((not (load (format \"ox-%s\" backend) t t))
784 \(message \"Problems while trying to load export back-end `%s'\"
785 backend))
786 \((not (memq backend new-list)) (push backend new-list))))
787 \(set-default 'org-export-backends new-list)))
789 Adding a back-end to this list will also pull the back-end it
790 depends on, if any."
791 :group 'org
792 :group 'org-export
793 :version "24.4"
794 :package-version '(Org . "8.0")
795 :initialize 'custom-initialize-set
796 :set (lambda (var val)
797 (if (not (featurep 'ox)) (set-default var val)
798 ;; Any back-end not required anymore (not present in VAL and not
799 ;; a parent of any back-end in the new value) is removed from the
800 ;; list of registered back-ends.
801 (setq org-export-registered-backends
802 (org-remove-if-not
803 (lambda (backend)
804 (let ((name (org-export-backend-name backend)))
805 (or (memq name val)
806 (catch 'parentp
807 (dolist (b val)
808 (and (org-export-derived-backend-p b name)
809 (throw 'parentp t)))))))
810 org-export-registered-backends))
811 ;; Now build NEW-LIST of both new back-ends and required
812 ;; parents.
813 (let ((new-list (mapcar #'org-export-backend-name
814 org-export-registered-backends)))
815 (dolist (backend val)
816 (cond
817 ((not (load (format "ox-%s" backend) t t))
818 (message "Problems while trying to load export back-end `%s'"
819 backend))
820 ((not (memq backend new-list)) (push backend new-list))))
821 ;; Set VAR to that list with fixed dependencies.
822 (set-default var new-list))))
823 :type '(set :greedy t
824 (const :tag " ascii Export buffer to ASCII format" ascii)
825 (const :tag " beamer Export buffer to Beamer presentation" beamer)
826 (const :tag " html Export buffer to HTML format" html)
827 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
828 (const :tag " latex Export buffer to LaTeX format" latex)
829 (const :tag " man Export buffer to MAN format" man)
830 (const :tag " md Export buffer to Markdown format" md)
831 (const :tag " odt Export buffer to ODT format" odt)
832 (const :tag " org Export buffer to Org format" org)
833 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
834 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
835 (const :tag "C deck Export buffer to deck.js presentations" deck)
836 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
837 (const :tag "C groff Export buffer to Groff format" groff)
838 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
839 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
840 (const :tag "C s5 Export buffer to s5 presentations" s5)
841 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
843 (eval-after-load 'ox
844 '(mapc
845 (lambda (backend)
846 (condition-case nil (require (intern (format "ox-%s" backend)))
847 (error (message "Problems while trying to load export back-end `%s'"
848 backend))))
849 org-export-backends))
851 (defcustom org-support-shift-select nil
852 "Non-nil means make shift-cursor commands select text when possible.
854 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
855 start selecting a region, or enlarge regions started in this way.
856 In Org-mode, in special contexts, these same keys are used for
857 other purposes, important enough to compete with shift selection.
858 Org tries to balance these needs by supporting `shift-select-mode'
859 outside these special contexts, under control of this variable.
861 The default of this variable is nil, to avoid confusing behavior. Shifted
862 cursor keys will then execute Org commands in the following contexts:
863 - on a headline, changing TODO state (left/right) and priority (up/down)
864 - on a time stamp, changing the time
865 - in a plain list item, changing the bullet type
866 - in a property definition line, switching between allowed values
867 - in the BEGIN line of a clock table (changing the time block).
868 Outside these contexts, the commands will throw an error.
870 When this variable is t and the cursor is not in a special
871 context, Org-mode will support shift-selection for making and
872 enlarging regions. To make this more effective, the bullet
873 cycling will no longer happen anywhere in an item line, but only
874 if the cursor is exactly on the bullet.
876 If you set this variable to the symbol `always', then the keys
877 will not be special in headlines, property lines, and item lines,
878 to make shift selection work there as well. If this is what you
879 want, you can use the following alternative commands: `C-c C-t'
880 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
881 can be used to switch TODO sets, `C-c -' to cycle item bullet
882 types, and properties can be edited by hand or in column view.
884 However, when the cursor is on a timestamp, shift-cursor commands
885 will still edit the time stamp - this is just too good to give up.
887 XEmacs user should have this variable set to nil, because
888 `shift-select-mode' is in Emacs 23 or later only."
889 :group 'org
890 :type '(choice
891 (const :tag "Never" nil)
892 (const :tag "When outside special context" t)
893 (const :tag "Everywhere except timestamps" always)))
895 (defcustom org-loop-over-headlines-in-active-region nil
896 "Shall some commands act upon headlines in the active region?
898 When set to `t', some commands will be performed in all headlines
899 within the active region.
901 When set to `start-level', some commands will be performed in all
902 headlines within the active region, provided that these headlines
903 are of the same level than the first one.
905 When set to a string, those commands will be performed on the
906 matching headlines within the active region. Such string must be
907 a tags/property/todo match as it is used in the agenda tags view.
909 The list of commands is: `org-schedule', `org-deadline',
910 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
911 `org-archive-to-archive-sibling'. The archiving commands skip
912 already archived entries."
913 :type '(choice (const :tag "Don't loop" nil)
914 (const :tag "All headlines in active region" t)
915 (const :tag "In active region, headlines at the same level than the first one" start-level)
916 (string :tag "Tags/Property/Todo matcher"))
917 :version "24.1"
918 :group 'org-todo
919 :group 'org-archive)
921 (defgroup org-startup nil
922 "Options concerning startup of Org-mode."
923 :tag "Org Startup"
924 :group 'org)
926 (defcustom org-startup-folded t
927 "Non-nil means entering Org-mode will switch to OVERVIEW.
928 This can also be configured on a per-file basis by adding one of
929 the following lines anywhere in the buffer:
931 #+STARTUP: fold (or `overview', this is equivalent)
932 #+STARTUP: nofold (or `showall', this is equivalent)
933 #+STARTUP: content
934 #+STARTUP: showeverything
936 By default, this option is ignored when Org opens agenda files
937 for the first time. If you want the agenda to honor the startup
938 option, set `org-agenda-inhibit-startup' to nil."
939 :group 'org-startup
940 :type '(choice
941 (const :tag "nofold: show all" nil)
942 (const :tag "fold: overview" t)
943 (const :tag "content: all headlines" content)
944 (const :tag "show everything, even drawers" showeverything)))
946 (defcustom org-startup-truncated t
947 "Non-nil means entering Org-mode will set `truncate-lines'.
948 This is useful since some lines containing links can be very long and
949 uninteresting. Also tables look terrible when wrapped."
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 you run XEmacs or if `window-system'
1070 is nil. This variable lets you do the same manually. You must
1071 set it before loading org.
1073 Example: on Carbon Emacs 22 running graphically, with an external
1074 keyboard on a Powerbook, the default way of setting M-left might
1075 not work for either Alt or ESC. Setting this variable will make
1076 it work for ESC."
1077 :group 'org-startup
1078 :type 'boolean)
1080 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
1082 (defcustom org-disputed-keys
1083 '(([(shift up)] . [(meta p)])
1084 ([(shift down)] . [(meta n)])
1085 ([(shift left)] . [(meta -)])
1086 ([(shift right)] . [(meta +)])
1087 ([(control shift right)] . [(meta shift +)])
1088 ([(control shift left)] . [(meta shift -)]))
1089 "Keys for which Org-mode and other modes compete.
1090 This is an alist, cars are the default keys, second element specifies
1091 the alternative to use when `org-replace-disputed-keys' is t.
1093 Keys can be specified in any syntax supported by `define-key'.
1094 The value of this option takes effect only at Org-mode's startup,
1095 therefore you'll have to restart Emacs to apply it after changing."
1096 :group 'org-startup
1097 :type 'alist)
1099 (defun org-key (key)
1100 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1101 Or return the original if not disputed.
1102 Also apply the translations defined in `org-xemacs-key-equivalents'."
1103 (when org-replace-disputed-keys
1104 (let* ((nkey (key-description key))
1105 (x (org-find-if (lambda (x)
1106 (equal (key-description (car x)) nkey))
1107 org-disputed-keys)))
1108 (setq key (if x (cdr x) key))))
1109 (when (featurep 'xemacs)
1110 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1111 key)
1113 (defun org-find-if (predicate seq)
1114 (catch 'exit
1115 (while seq
1116 (if (funcall predicate (car seq))
1117 (throw 'exit (car seq))
1118 (pop seq)))))
1120 (defun org-defkey (keymap key def)
1121 "Define a key, possibly translated, as returned by `org-key'."
1122 (define-key keymap (org-key key) def))
1124 (defcustom org-ellipsis nil
1125 "The ellipsis to use in the Org-mode outline.
1126 When nil, just use the standard three dots.
1127 When a string, use that string instead.
1128 When a face, use the standard 3 dots, but with the specified face.
1129 The change affects only Org-mode (which will then use its own display table).
1130 Changing this requires executing \\[org-mode] in a buffer to become
1131 effective."
1132 :group 'org-startup
1133 :type '(choice (const :tag "Default" nil)
1134 (face :tag "Face" :value org-warning)
1135 (string :tag "String" :value "...#")))
1137 (defvar org-display-table nil
1138 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1140 (defgroup org-keywords nil
1141 "Keywords in Org-mode."
1142 :tag "Org Keywords"
1143 :group 'org)
1145 (defcustom org-closed-keep-when-no-todo nil
1146 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1147 :group 'org-todo
1148 :group 'org-keywords
1149 :version "24.4"
1150 :package-version '(Org . "8.0")
1151 :type 'boolean)
1153 (defgroup org-structure nil
1154 "Options concerning the general structure of Org-mode files."
1155 :tag "Org Structure"
1156 :group 'org)
1158 (defgroup org-reveal-location nil
1159 "Options about how to make context of a location visible."
1160 :tag "Org Reveal Location"
1161 :group 'org-structure)
1163 (defcustom org-show-context-detail '((isearch . lineage)
1164 (bookmark-jump . lineage)
1165 (default . ancestors))
1166 "Alist between context and visibility span when revealing a location.
1168 \\<org-mode-map>Some actions may move point into invisible
1169 locations. As a consequence, Org always expose a neighborhood
1170 around point. How much is shown depends on the initial action,
1171 or context. Valid contexts are
1173 agenda when exposing an entry from the agenda
1174 org-goto when using the command `org-goto' (\\[org-goto])
1175 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1176 tags-tree when constructing a sparse tree based on tags matches
1177 link-search when exposing search matches associated with a link
1178 mark-goto when exposing the jump goal of a mark
1179 bookmark-jump when exposing a bookmark location
1180 isearch when exiting from an incremental search
1181 default default for all contexts not set explicitly
1183 Allowed visibility spans are
1185 minimal show current headline; if point is not on headline,
1186 also show entry
1188 local show current headline, entry and next headline
1190 ancestors show current headline and its direct ancestors; if
1191 point is not on headline, also show entry
1193 lineage show current headline, its direct ancestors and all
1194 their children; if point is not on headline, also show
1195 entry and first child
1197 tree show current headline, its direct ancestors and all
1198 their children; if point is not on headline, also show
1199 entry and all children
1201 canonical show current headline, its direct ancestors along with
1202 their entries and children; if point is not located on
1203 the headline, also show current entry and all children
1205 As special cases, a nil or t value means show all contexts in
1206 `minimal' or `canonical' view, respectively.
1208 Some views can make displayed information very compact, but also
1209 make it harder to edit the location of the match. In such
1210 a case, use the command `org-reveal' (\\[org-reveal]) to show
1211 more context."
1212 :group 'org-reveal-location
1213 :version "25.1"
1214 :package-version '(Org . "8.3")
1215 :type '(choice
1216 (const :tag "Canonical" t)
1217 (const :tag "Minimal" nil)
1218 (repeat :greedy t :tag "Individual contexts"
1219 (cons
1220 (choice :tag "Context"
1221 (const agenda)
1222 (const org-goto)
1223 (const occur-tree)
1224 (const tags-tree)
1225 (const link-search)
1226 (const mark-goto)
1227 (const bookmark-jump)
1228 (const isearch)
1229 (const default))
1230 (choice :tag "Detail level"
1231 (const minimal)
1232 (const local)
1233 (const ancestors)
1234 (const lineage)
1235 (const tree)
1236 (const canonical))))))
1238 (defcustom org-indirect-buffer-display 'other-window
1239 "How should indirect tree buffers be displayed?
1240 This applies to indirect buffers created with the commands
1241 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1242 Valid values are:
1243 current-window Display in the current window
1244 other-window Just display in another window.
1245 dedicated-frame Create one new frame, and re-use it each time.
1246 new-frame Make a new frame each time. Note that in this case
1247 previously-made indirect buffers are kept, and you need to
1248 kill these buffers yourself."
1249 :group 'org-structure
1250 :group 'org-agenda-windows
1251 :type '(choice
1252 (const :tag "In current window" current-window)
1253 (const :tag "In current frame, other window" other-window)
1254 (const :tag "Each time a new frame" new-frame)
1255 (const :tag "One dedicated frame" dedicated-frame)))
1257 (defcustom org-use-speed-commands nil
1258 "Non-nil means activate single letter commands at beginning of a headline.
1259 This may also be a function to test for appropriate locations where speed
1260 commands should be active.
1262 For example, to activate speed commands when the point is on any
1263 star at the beginning of the headline, you can do this:
1265 (setq org-use-speed-commands
1266 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1267 :group 'org-structure
1268 :type '(choice
1269 (const :tag "Never" nil)
1270 (const :tag "At beginning of headline stars" t)
1271 (function)))
1273 (defcustom org-speed-commands-user nil
1274 "Alist of additional speed commands.
1275 This list will be checked before `org-speed-commands-default'
1276 when the variable `org-use-speed-commands' is non-nil
1277 and when the cursor is at the beginning of a headline.
1278 The car if each entry is a string with a single letter, which must
1279 be assigned to `self-insert-command' in the global map.
1280 The cdr is either a command to be called interactively, a function
1281 to be called, or a form to be evaluated.
1282 An entry that is just a list with a single string will be interpreted
1283 as a descriptive headline that will be added when listing the speed
1284 commands in the Help buffer using the `?' speed command."
1285 :group 'org-structure
1286 :type '(repeat :value ("k" . ignore)
1287 (choice :value ("k" . ignore)
1288 (list :tag "Descriptive Headline" (string :tag "Headline"))
1289 (cons :tag "Letter and Command"
1290 (string :tag "Command letter")
1291 (choice
1292 (function)
1293 (sexp))))))
1295 (defcustom org-bookmark-names-plist
1296 '(:last-capture "org-capture-last-stored"
1297 :last-refile "org-refile-last-stored"
1298 :last-capture-marker "org-capture-last-stored-marker")
1299 "Names for bookmarks automatically set by some Org commands.
1300 This can provide strings as names for a number of bookmarks Org sets
1301 automatically. The following keys are currently implemented:
1302 :last-capture
1303 :last-capture-marker
1304 :last-refile
1305 When a key does not show up in the property list, the corresponding bookmark
1306 is not set."
1307 :group 'org-structure
1308 :type 'plist)
1310 (defgroup org-cycle nil
1311 "Options concerning visibility cycling in Org-mode."
1312 :tag "Org Cycle"
1313 :group 'org-structure)
1315 (defcustom org-cycle-skip-children-state-if-no-children t
1316 "Non-nil means skip CHILDREN state in entries that don't have any."
1317 :group 'org-cycle
1318 :type 'boolean)
1320 (defcustom org-cycle-max-level nil
1321 "Maximum level which should still be subject to visibility cycling.
1322 Levels higher than this will, for cycling, be treated as text, not a headline.
1323 When `org-odd-levels-only' is set, a value of N in this variable actually
1324 means 2N-1 stars as the limiting headline.
1325 When nil, cycle all levels.
1326 Note that the limiting level of cycling is also influenced by
1327 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1328 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1329 than its value."
1330 :group 'org-cycle
1331 :type '(choice
1332 (const :tag "No limit" nil)
1333 (integer :tag "Maximum level")))
1335 (defcustom org-hide-block-startup nil
1336 "Non-nil means entering Org-mode will fold all blocks.
1337 This can also be set in on a per-file basis with
1339 #+STARTUP: hideblocks
1340 #+STARTUP: showblocks"
1341 :group 'org-startup
1342 :group 'org-cycle
1343 :type 'boolean)
1345 (defcustom org-cycle-global-at-bob nil
1346 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1347 This makes it possible to do global cycling without having to use S-TAB or
1348 \\[universal-argument] TAB. For this special case to work, the first line
1349 of the buffer must not be a headline -- it may be empty or some other text.
1350 When used in this way, `org-cycle-hook' is disabled temporarily to make
1351 sure the cursor stays at the beginning of the buffer. When this option is
1352 nil, don't do anything special at the beginning of the buffer."
1353 :group 'org-cycle
1354 :type 'boolean)
1356 (defcustom org-cycle-level-after-item/entry-creation t
1357 "Non-nil means cycle entry level or item indentation in new empty entries.
1359 When the cursor is at the end of an empty headline, i.e., with only stars
1360 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1361 and then all possible ancestor states, before returning to the original state.
1362 This makes data entry extremely fast: M-RET to create a new headline,
1363 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1365 When the cursor is at the end of an empty plain list item, one TAB will
1366 make it a subitem, two or more tabs will back up to make this an item
1367 higher up in the item hierarchy."
1368 :group 'org-cycle
1369 :type 'boolean)
1371 (defcustom org-cycle-emulate-tab t
1372 "Where should `org-cycle' emulate TAB.
1373 nil Never
1374 white Only in completely white lines
1375 whitestart Only at the beginning of lines, before the first non-white char
1376 t Everywhere except in headlines
1377 exc-hl-bol Everywhere except at the start of a headline
1378 If TAB is used in a place where it does not emulate TAB, the current subtree
1379 visibility is cycled."
1380 :group 'org-cycle
1381 :type '(choice (const :tag "Never" nil)
1382 (const :tag "Only in completely white lines" white)
1383 (const :tag "Before first char in a line" whitestart)
1384 (const :tag "Everywhere except in headlines" t)
1385 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1387 (defcustom org-cycle-separator-lines 2
1388 "Number of empty lines needed to keep an empty line between collapsed trees.
1389 If you leave an empty line between the end of a subtree and the following
1390 headline, this empty line is hidden when the subtree is folded.
1391 Org-mode will leave (exactly) one empty line visible if the number of
1392 empty lines is equal or larger to the number given in this variable.
1393 So the default 2 means at least 2 empty lines after the end of a subtree
1394 are needed to produce free space between a collapsed subtree and the
1395 following headline.
1397 If the number is negative, and the number of empty lines is at least -N,
1398 all empty lines are shown.
1400 Special case: when 0, never leave empty lines in collapsed view."
1401 :group 'org-cycle
1402 :type 'integer)
1403 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1405 (defcustom org-pre-cycle-hook nil
1406 "Hook that is run before visibility cycling is happening.
1407 The function(s) in this hook must accept a single argument which indicates
1408 the new state that will be set right after running this hook. The
1409 argument is a symbol. Before a global state change, it can have the values
1410 `overview', `content', or `all'. Before a local state change, it can have
1411 the values `folded', `children', or `subtree'."
1412 :group 'org-cycle
1413 :type 'hook)
1415 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1416 org-cycle-hide-drawers
1417 org-cycle-show-empty-lines
1418 org-optimize-window-after-visibility-change)
1419 "Hook that is run after `org-cycle' has changed the buffer visibility.
1420 The function(s) in this hook must accept a single argument which indicates
1421 the new state that was set by the most recent `org-cycle' command. The
1422 argument is a symbol. After a global state change, it can have the values
1423 `overview', `contents', or `all'. After a local state change, it can have
1424 the values `folded', `children', or `subtree'."
1425 :group 'org-cycle
1426 :type 'hook
1427 :version "25.1"
1428 :package-version '(Org . "8.3"))
1430 (defgroup org-edit-structure nil
1431 "Options concerning structure editing in Org-mode."
1432 :tag "Org Edit Structure"
1433 :group 'org-structure)
1435 (defcustom org-odd-levels-only nil
1436 "Non-nil means skip even levels and only use odd levels for the outline.
1437 This has the effect that two stars are being added/taken away in
1438 promotion/demotion commands. It also influences how levels are
1439 handled by the exporters.
1440 Changing it requires restart of `font-lock-mode' to become effective
1441 for fontification also in regions already fontified.
1442 You may also set this on a per-file basis by adding one of the following
1443 lines to the buffer:
1445 #+STARTUP: odd
1446 #+STARTUP: oddeven"
1447 :group 'org-edit-structure
1448 :group 'org-appearance
1449 :type 'boolean)
1451 (defcustom org-adapt-indentation t
1452 "Non-nil means adapt indentation to outline node level.
1454 When this variable is set, Org assumes that you write outlines by
1455 indenting text in each node to align with the headline (after the
1456 stars). The following issues are influenced by this variable:
1458 - The indentation is increased by one space in a demotion
1459 command, and decreased by one in a promotion command. However,
1460 in the latter case, if shifting some line in the entry body
1461 would alter document structure (e.g., insert a new headline),
1462 indentation is not changed at all.
1464 - Property drawers and planning information is inserted indented
1465 when this variable is set. When nil, they will not be indented.
1467 - TAB indents a line relative to current level. The lines below
1468 a headline will be indented when this variable is set.
1470 Note that this is all about true indentation, by adding and
1471 removing space characters. See also `org-indent.el' which does
1472 level-dependent indentation in a virtual way, i.e. at display
1473 time in Emacs."
1474 :group 'org-edit-structure
1475 :type 'boolean)
1477 (defcustom org-special-ctrl-a/e nil
1478 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1480 When t, `C-a' will bring back the cursor to the beginning of the
1481 headline text, i.e. after the stars and after a possible TODO
1482 keyword. In an item, this will be the position after bullet and
1483 check-box, if any. When the cursor is already at that position,
1484 another `C-a' will bring it to the beginning of the line.
1486 `C-e' will jump to the end of the headline, ignoring the presence
1487 of tags in the headline. A second `C-e' will then jump to the
1488 true end of the line, after any tags. This also means that, when
1489 this variable is non-nil, `C-e' also will never jump beyond the
1490 end of the heading of a folded section, i.e. not after the
1491 ellipses.
1493 When set to the symbol `reversed', the first `C-a' or `C-e' works
1494 normally, going to the true line boundary first. Only a directly
1495 following, identical keypress will bring the cursor to the
1496 special positions.
1498 This may also be a cons cell where the behavior for `C-a' and
1499 `C-e' is set separately."
1500 :group 'org-edit-structure
1501 :type '(choice
1502 (const :tag "off" nil)
1503 (const :tag "on: after stars/bullet and before tags first" t)
1504 (const :tag "reversed: true line boundary first" reversed)
1505 (cons :tag "Set C-a and C-e separately"
1506 (choice :tag "Special C-a"
1507 (const :tag "off" nil)
1508 (const :tag "on: after stars/bullet first" t)
1509 (const :tag "reversed: before stars/bullet first" reversed))
1510 (choice :tag "Special C-e"
1511 (const :tag "off" nil)
1512 (const :tag "on: before tags first" t)
1513 (const :tag "reversed: after tags first" reversed)))))
1514 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1516 (defcustom org-special-ctrl-k nil
1517 "Non-nil means `C-k' will behave specially in headlines.
1518 When nil, `C-k' will call the default `kill-line' command.
1519 When t, the following will happen while the cursor is in the headline:
1521 - When the cursor is at the beginning of a headline, kill the entire
1522 line and possible the folded subtree below the line.
1523 - When in the middle of the headline text, kill the headline up to the tags.
1524 - When after the headline text, kill the tags."
1525 :group 'org-edit-structure
1526 :type 'boolean)
1528 (defcustom org-ctrl-k-protect-subtree nil
1529 "Non-nil means, do not delete a hidden subtree with C-k.
1530 When set to the symbol `error', simply throw an error when C-k is
1531 used to kill (part-of) a headline that has hidden text behind it.
1532 Any other non-nil value will result in a query to the user, if it is
1533 OK to kill that hidden subtree. When nil, kill without remorse."
1534 :group 'org-edit-structure
1535 :version "24.1"
1536 :type '(choice
1537 (const :tag "Do not protect hidden subtrees" nil)
1538 (const :tag "Protect hidden subtrees with a security query" t)
1539 (const :tag "Never kill a hidden subtree with C-k" error)))
1541 (defcustom org-special-ctrl-o t
1542 "Non-nil means, make `C-o' insert a row in tables."
1543 :group 'org-edit-structure
1544 :type 'boolean)
1546 (defcustom org-catch-invisible-edits nil
1547 "Check if in invisible region before inserting or deleting a character.
1548 Valid values are:
1550 nil Do not check, so just do invisible edits.
1551 error Throw an error and do nothing.
1552 show Make point visible, and do the requested edit.
1553 show-and-error Make point visible, then throw an error and abort the edit.
1554 smart Make point visible, and do insertion/deletion if it is
1555 adjacent to visible text and the change feels predictable.
1556 Never delete a previously invisible character or add in the
1557 middle or right after an invisible region. Basically, this
1558 allows insertion and backward-delete right before ellipses.
1559 FIXME: maybe in this case we should not even show?"
1560 :group 'org-edit-structure
1561 :version "24.1"
1562 :type '(choice
1563 (const :tag "Do not check" nil)
1564 (const :tag "Throw error when trying to edit" error)
1565 (const :tag "Unhide, but do not do the edit" show-and-error)
1566 (const :tag "Show invisible part and do the edit" show)
1567 (const :tag "Be smart and do the right thing" smart)))
1569 (defcustom org-yank-folded-subtrees t
1570 "Non-nil means when yanking subtrees, fold them.
1571 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1572 it starts with a heading and all other headings in it are either children
1573 or siblings, then fold all the subtrees. However, do this only if no
1574 text after the yank would be swallowed into a folded tree by this action."
1575 :group 'org-edit-structure
1576 :type 'boolean)
1578 (defcustom org-yank-adjusted-subtrees nil
1579 "Non-nil means when yanking subtrees, adjust the level.
1580 With this setting, `org-paste-subtree' is used to insert the subtree, see
1581 this function for details."
1582 :group 'org-edit-structure
1583 :type 'boolean)
1585 (defcustom org-M-RET-may-split-line '((default . t))
1586 "Non-nil means M-RET will split the line at the cursor position.
1587 When nil, it will go to the end of the line before making a
1588 new line.
1589 You may also set this option in a different way for different
1590 contexts. Valid contexts are:
1592 headline when creating a new headline
1593 item when creating a new item
1594 table in a table field
1595 default the value to be used for all contexts not explicitly
1596 customized"
1597 :group 'org-structure
1598 :group 'org-table
1599 :type '(choice
1600 (const :tag "Always" t)
1601 (const :tag "Never" nil)
1602 (repeat :greedy t :tag "Individual contexts"
1603 (cons
1604 (choice :tag "Context"
1605 (const headline)
1606 (const item)
1607 (const table)
1608 (const default))
1609 (boolean)))))
1612 (defcustom org-insert-heading-respect-content nil
1613 "Non-nil means insert new headings after the current subtree.
1614 When nil, the new heading is created directly after the current line.
1615 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1616 this variable on for the duration of the command."
1617 :group 'org-structure
1618 :type 'boolean)
1620 (defcustom org-blank-before-new-entry '((heading . auto)
1621 (plain-list-item . auto))
1622 "Should `org-insert-heading' leave a blank line before new heading/item?
1623 The value is an alist, with `heading' and `plain-list-item' as CAR,
1624 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1625 which case Org will look at the surrounding headings/items and try to
1626 make an intelligent decision whether to insert a blank line or not.
1628 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1629 the setting here is ignored and no empty line is inserted to avoid breaking
1630 the list structure."
1631 :group 'org-edit-structure
1632 :type '(list
1633 (cons (const heading)
1634 (choice (const :tag "Never" nil)
1635 (const :tag "Always" t)
1636 (const :tag "Auto" auto)))
1637 (cons (const plain-list-item)
1638 (choice (const :tag "Never" nil)
1639 (const :tag "Always" t)
1640 (const :tag "Auto" auto)))))
1642 (defcustom org-insert-heading-hook nil
1643 "Hook being run after inserting a new heading."
1644 :group 'org-edit-structure
1645 :type 'hook)
1647 (defcustom org-enable-fixed-width-editor t
1648 "Non-nil means lines starting with \":\" are treated as fixed-width.
1649 This currently only means they are never auto-wrapped.
1650 When nil, such lines will be treated like ordinary lines."
1651 :group 'org-edit-structure
1652 :type 'boolean)
1654 (defcustom org-goto-auto-isearch t
1655 "Non-nil means typing characters in `org-goto' starts incremental search.
1656 When nil, you can use these keybindings to navigate the buffer:
1658 q Quit the org-goto interface
1659 n Go to the next visible heading
1660 p Go to the previous visible heading
1661 f Go one heading forward on same level
1662 b Go one heading backward on same level
1663 u Go one heading up"
1664 :group 'org-edit-structure
1665 :type 'boolean)
1667 (defgroup org-sparse-trees nil
1668 "Options concerning sparse trees in Org-mode."
1669 :tag "Org Sparse Trees"
1670 :group 'org-structure)
1672 (defcustom org-highlight-sparse-tree-matches t
1673 "Non-nil means highlight all matches that define a sparse tree.
1674 The highlights will automatically disappear the next time the buffer is
1675 changed by an edit command."
1676 :group 'org-sparse-trees
1677 :type 'boolean)
1679 (defcustom org-remove-highlights-with-change t
1680 "Non-nil means any change to the buffer will remove temporary highlights.
1681 Such highlights are created by `org-occur' and `org-clock-display'.
1682 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1683 The highlights created by `org-toggle-latex-fragment' always need
1684 `C-c C-x C-l' to be removed."
1685 :group 'org-sparse-trees
1686 :group 'org-time
1687 :type 'boolean)
1690 (defcustom org-occur-hook '(org-first-headline-recenter)
1691 "Hook that is run after `org-occur' has constructed a sparse tree.
1692 This can be used to recenter the window to show as much of the structure
1693 as possible."
1694 :group 'org-sparse-trees
1695 :type 'hook)
1697 (defgroup org-imenu-and-speedbar nil
1698 "Options concerning imenu and speedbar in Org-mode."
1699 :tag "Org Imenu and Speedbar"
1700 :group 'org-structure)
1702 (defcustom org-imenu-depth 2
1703 "The maximum level for Imenu access to Org-mode headlines.
1704 This also applied for speedbar access."
1705 :group 'org-imenu-and-speedbar
1706 :type 'integer)
1708 (defgroup org-table nil
1709 "Options concerning tables in Org-mode."
1710 :tag "Org Table"
1711 :group 'org)
1713 (defcustom org-enable-table-editor 'optimized
1714 "Non-nil means lines starting with \"|\" are handled by the table editor.
1715 When nil, such lines will be treated like ordinary lines.
1717 When equal to the symbol `optimized', the table editor will be optimized to
1718 do the following:
1719 - Automatic overwrite mode in front of whitespace in table fields.
1720 This makes the structure of the table stay in tact as long as the edited
1721 field does not exceed the column width.
1722 - Minimize the number of realigns. Normally, the table is aligned each time
1723 TAB or RET are pressed to move to another field. With optimization this
1724 happens only if changes to a field might have changed the column width.
1725 Optimization requires replacing the functions `self-insert-command',
1726 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1727 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1728 very good at guessing when a re-align will be necessary, but you can always
1729 force one with \\[org-ctrl-c-ctrl-c].
1731 If you would like to use the optimized version in Org-mode, but the
1732 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1734 This variable can be used to turn on and off the table editor during a session,
1735 but in order to toggle optimization, a restart is required.
1737 See also the variable `org-table-auto-blank-field'."
1738 :group 'org-table
1739 :type '(choice
1740 (const :tag "off" nil)
1741 (const :tag "on" t)
1742 (const :tag "on, optimized" optimized)))
1744 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1745 (version<= emacs-version "24.1"))
1746 "Non-nil means cluster self-insert commands for undo when possible.
1747 If this is set, then, like in the Emacs command loop, 20 consecutive
1748 characters will be undone together.
1749 This is configurable, because there is some impact on typing performance."
1750 :group 'org-table
1751 :type 'boolean)
1753 (defcustom org-table-tab-recognizes-table.el t
1754 "Non-nil means TAB will automatically notice a table.el table.
1755 When it sees such a table, it moves point into it and - if necessary -
1756 calls `table-recognize-table'."
1757 :group 'org-table-editing
1758 :type 'boolean)
1760 (defgroup org-link nil
1761 "Options concerning links in Org-mode."
1762 :tag "Org Link"
1763 :group 'org)
1765 (defvar org-link-abbrev-alist-local nil
1766 "Buffer-local version of `org-link-abbrev-alist', which see.
1767 The value of this is taken from the #+LINK lines.")
1768 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1770 (defcustom org-link-abbrev-alist nil
1771 "Alist of link abbreviations.
1772 The car of each element is a string, to be replaced at the start of a link.
1773 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1774 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1776 [[linkkey:tag][description]]
1778 The 'linkkey' must be a word word, starting with a letter, followed
1779 by letters, numbers, '-' or '_'.
1781 If REPLACE is a string, the tag will simply be appended to create the link.
1782 If the string contains \"%s\", the tag will be inserted there. If the string
1783 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1784 at that point (see the function `url-hexify-string'). If the string contains
1785 the specifier \"%(my-function)\", then the custom function `my-function' will
1786 be invoked: this function takes the tag as its only argument and must return
1787 a string.
1789 REPLACE may also be a function that will be called with the tag as the
1790 only argument to create the link, which should be returned as a string.
1792 See the manual for examples."
1793 :group 'org-link
1794 :type '(repeat
1795 (cons
1796 (string :tag "Protocol")
1797 (choice
1798 (string :tag "Format")
1799 (function)))))
1801 (defcustom org-descriptive-links t
1802 "Non-nil means Org will display descriptive links.
1803 E.g. [[http://orgmode.org][Org website]] will be displayed as
1804 \"Org Website\", hiding the link itself and just displaying its
1805 description. When set to `nil', Org will display the full links
1806 literally.
1808 You can interactively set the value of this variable by calling
1809 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1810 :group 'org-link
1811 :type 'boolean)
1813 (defcustom org-link-file-path-type 'adaptive
1814 "How the path name in file links should be stored.
1815 Valid values are:
1817 relative Relative to the current directory, i.e. the directory of the file
1818 into which the link is being inserted.
1819 absolute Absolute path, if possible with ~ for home directory.
1820 noabbrev Absolute path, no abbreviation of home directory.
1821 adaptive Use relative path for files in the current directory and sub-
1822 directories of it. For other files, use an absolute path."
1823 :group 'org-link
1824 :type '(choice
1825 (const relative)
1826 (const absolute)
1827 (const noabbrev)
1828 (const adaptive)))
1830 (defvaralias 'org-activate-links 'org-highlight-links)
1831 (defcustom org-highlight-links '(bracket angle plain radio tag date footnote)
1832 "Types of links that should be highlighted in Org-mode files.
1834 This is a list of symbols, each one of them leading to the
1835 highlighting of a certain link type.
1837 You can still open links that are not highlighted.
1839 In principle, it does not hurt to turn on highlighting for all
1840 link types. There may be a small gain when turning off unused
1841 link types. The types are:
1843 bracket The recommended [[link][description]] or [[link]] links with hiding.
1844 angle Links in angular brackets that may contain whitespace like
1845 <bbdb:Carsten Dominik>.
1846 plain Plain links in normal text, no whitespace, like http://google.com.
1847 radio Text that is matched by a radio target, see manual for details.
1848 tag Tag settings in a headline (link to tag search).
1849 date Time stamps (link to calendar).
1850 footnote Footnote labels.
1852 If you set this variable during an Emacs session, use `org-mode-restart'
1853 in the Org buffer so that the change takes effect."
1854 :group 'org-link
1855 :group 'org-appearance
1856 :type '(set :greedy t
1857 (const :tag "Double bracket links" bracket)
1858 (const :tag "Angular bracket links" angle)
1859 (const :tag "Plain text links" plain)
1860 (const :tag "Radio target matches" radio)
1861 (const :tag "Tags" tag)
1862 (const :tag "Timestamps" date)
1863 (const :tag "Footnotes" footnote)))
1865 (defcustom org-make-link-description-function nil
1866 "Function to use for generating link descriptions from links.
1867 When nil, the link location will be used. This function must take
1868 two parameters: the first one is the link, the second one is the
1869 description generated by `org-insert-link'. The function should
1870 return the description to use."
1871 :group 'org-link
1872 :type '(choice (const nil) (function)))
1874 (defgroup org-link-store nil
1875 "Options concerning storing links in Org-mode."
1876 :tag "Org Store Link"
1877 :group 'org-link)
1879 (defcustom org-url-hexify-p t
1880 "When non-nil, hexify URL when creating a link."
1881 :type 'boolean
1882 :version "24.3"
1883 :group 'org-link-store)
1885 (defcustom org-email-link-description-format "Email %c: %.30s"
1886 "Format of the description part of a link to an email or usenet message.
1887 The following %-escapes will be replaced by corresponding information:
1889 %F full \"From\" field
1890 %f name, taken from \"From\" field, address if no name
1891 %T full \"To\" field
1892 %t first name in \"To\" field, address if no name
1893 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1894 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1895 %s subject
1896 %d date
1897 %m message-id.
1899 You may use normal field width specification between the % and the letter.
1900 This is for example useful to limit the length of the subject.
1902 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1903 :group 'org-link-store
1904 :type 'string)
1906 (defcustom org-from-is-user-regexp
1907 (let (r1 r2)
1908 (when (and user-mail-address (not (string= user-mail-address "")))
1909 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1910 (when (and user-full-name (not (string= user-full-name "")))
1911 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1912 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1913 "Regexp matched against the \"From:\" header of an email or usenet message.
1914 It should match if the message is from the user him/herself."
1915 :group 'org-link-store
1916 :type 'regexp)
1918 (defcustom org-context-in-file-links t
1919 "Non-nil means file links from `org-store-link' contain context.
1920 A search string will be added to the file name with :: as separator and
1921 used to find the context when the link is activated by the command
1922 `org-open-at-point'. When this option is t, the entire active region
1923 will be placed in the search string of the file link. If set to a
1924 positive integer, only the first n lines of context will be stored.
1926 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1927 negates this setting for the duration of the command."
1928 :group 'org-link-store
1929 :type '(choice boolean integer))
1931 (defcustom org-keep-stored-link-after-insertion nil
1932 "Non-nil means keep link in list for entire session.
1934 The command `org-store-link' adds a link pointing to the current
1935 location to an internal list. These links accumulate during a session.
1936 The command `org-insert-link' can be used to insert links into any
1937 Org-mode file (offering completion for all stored links). When this
1938 option is nil, every link which has been inserted once using \\[org-insert-link]
1939 will be removed from the list, to make completing the unused links
1940 more efficient."
1941 :group 'org-link-store
1942 :type 'boolean)
1944 (defgroup org-link-follow nil
1945 "Options concerning following links in Org-mode."
1946 :tag "Org Follow Link"
1947 :group 'org-link)
1949 (defcustom org-link-translation-function nil
1950 "Function to translate links with different syntax to Org syntax.
1951 This can be used to translate links created for example by the Planner
1952 or emacs-wiki packages to Org syntax.
1953 The function must accept two parameters, a TYPE containing the link
1954 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1955 which is everything after the link protocol. It should return a cons
1956 with possibly modified values of type and path.
1957 Org contains a function for this, so if you set this variable to
1958 `org-translate-link-from-planner', you should be able follow many
1959 links created by planner."
1960 :group 'org-link-follow
1961 :type '(choice (const nil) (function)))
1963 (defcustom org-follow-link-hook nil
1964 "Hook that is run after a link has been followed."
1965 :group 'org-link-follow
1966 :type 'hook)
1968 (defcustom org-tab-follows-link nil
1969 "Non-nil means on links TAB will follow the link.
1970 Needs to be set before org.el is loaded.
1971 This really should not be used, it does not make sense, and the
1972 implementation is bad."
1973 :group 'org-link-follow
1974 :type 'boolean)
1976 (defcustom org-return-follows-link nil
1977 "Non-nil means on links RET will follow the link.
1978 In tables, the special behavior of RET has precedence."
1979 :group 'org-link-follow
1980 :type 'boolean)
1982 (defcustom org-mouse-1-follows-link
1983 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1984 "Non-nil means mouse-1 on a link will follow the link.
1985 A longer mouse click will still set point. Does not work on XEmacs.
1986 Needs to be set before org.el is loaded."
1987 :group 'org-link-follow
1988 :version "24.4"
1989 :package-version '(Org . "8.3")
1990 :type '(choice
1991 (const :tag "A double click follows the link" double)
1992 (const :tag "Unconditionally follow the link with mouse-1" t)
1993 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1995 (defcustom org-mark-ring-length 4
1996 "Number of different positions to be recorded in the ring.
1997 Changing this requires a restart of Emacs to work correctly."
1998 :group 'org-link-follow
1999 :type 'integer)
2001 (defcustom org-link-search-must-match-exact-headline 'query-to-create
2002 "Non-nil means internal links in Org files must exactly match a headline.
2003 When nil, the link search tries to match a phrase with all words
2004 in the search text."
2005 :group 'org-link-follow
2006 :version "24.1"
2007 :type '(choice
2008 (const :tag "Use fuzzy text search" nil)
2009 (const :tag "Match only exact headline" t)
2010 (const :tag "Match exact headline or query to create it"
2011 query-to-create)))
2013 (defcustom org-link-frame-setup
2014 '((vm . vm-visit-folder-other-frame)
2015 (vm-imap . vm-visit-imap-folder-other-frame)
2016 (gnus . org-gnus-no-new-news)
2017 (file . find-file-other-window)
2018 (wl . wl-other-frame))
2019 "Setup the frame configuration for following links.
2020 When following a link with Emacs, it may often be useful to display
2021 this link in another window or frame. This variable can be used to
2022 set this up for the different types of links.
2023 For VM, use any of
2024 `vm-visit-folder'
2025 `vm-visit-folder-other-window'
2026 `vm-visit-folder-other-frame'
2027 For Gnus, use any of
2028 `gnus'
2029 `gnus-other-frame'
2030 `org-gnus-no-new-news'
2031 For FILE, use any of
2032 `find-file'
2033 `find-file-other-window'
2034 `find-file-other-frame'
2035 For Wanderlust use any of
2036 `wl'
2037 `wl-other-frame'
2038 For the calendar, use the variable `calendar-setup'.
2039 For BBDB, it is currently only possible to display the matches in
2040 another window."
2041 :group 'org-link-follow
2042 :type '(list
2043 (cons (const vm)
2044 (choice
2045 (const vm-visit-folder)
2046 (const vm-visit-folder-other-window)
2047 (const vm-visit-folder-other-frame)))
2048 (cons (const vm-imap)
2049 (choice
2050 (const vm-visit-imap-folder)
2051 (const vm-visit-imap-folder-other-window)
2052 (const vm-visit-imap-folder-other-frame)))
2053 (cons (const gnus)
2054 (choice
2055 (const gnus)
2056 (const gnus-other-frame)
2057 (const org-gnus-no-new-news)))
2058 (cons (const file)
2059 (choice
2060 (const find-file)
2061 (const find-file-other-window)
2062 (const find-file-other-frame)))
2063 (cons (const wl)
2064 (choice
2065 (const wl)
2066 (const wl-other-frame)))))
2068 (defcustom org-display-internal-link-with-indirect-buffer nil
2069 "Non-nil means use indirect buffer to display infile links.
2070 Activating internal links (from one location in a file to another location
2071 in the same file) normally just jumps to the location. When the link is
2072 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2073 is displayed in
2074 another window. When this option is set, the other window actually displays
2075 an indirect buffer clone of the current buffer, to avoid any visibility
2076 changes to the current buffer."
2077 :group 'org-link-follow
2078 :type 'boolean)
2080 (defcustom org-open-non-existing-files nil
2081 "Non-nil means `org-open-file' will open non-existing files.
2082 When nil, an error will be generated.
2083 This variable applies only to external applications because they
2084 might choke on non-existing files. If the link is to a file that
2085 will be opened in Emacs, the variable is ignored."
2086 :group 'org-link-follow
2087 :type 'boolean)
2089 (defcustom org-open-directory-means-index-dot-org nil
2090 "Non-nil means a link to a directory really means to index.org.
2091 When nil, following a directory link will run dired or open a finder/explorer
2092 window on that directory."
2093 :group 'org-link-follow
2094 :type 'boolean)
2096 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2097 "Non-nil means ask for confirmation before executing shell links.
2098 Shell links can be dangerous: just think about a link
2100 [[shell:rm -rf ~/*][Google Search]]
2102 This link would show up in your Org-mode document as \"Google Search\",
2103 but really it would remove your entire home directory.
2104 Therefore we advise against setting this variable to nil.
2105 Just change it to `y-or-n-p' if you want to confirm with a
2106 single keystroke rather than having to type \"yes\"."
2107 :group 'org-link-follow
2108 :type '(choice
2109 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2110 (const :tag "with y-or-n (faster)" y-or-n-p)
2111 (const :tag "no confirmation (dangerous)" nil)))
2112 (put 'org-confirm-shell-link-function
2113 'safe-local-variable
2114 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2116 (defcustom org-confirm-shell-link-not-regexp ""
2117 "A regexp to skip confirmation for shell links."
2118 :group 'org-link-follow
2119 :version "24.1"
2120 :type 'regexp)
2122 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2123 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2124 Elisp links can be dangerous: just think about a link
2126 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2128 This link would show up in your Org-mode document as \"Google Search\",
2129 but really it would remove your entire home directory.
2130 Therefore we advise against setting this variable to nil.
2131 Just change it to `y-or-n-p' if you want to confirm with a
2132 single keystroke rather than having to type \"yes\"."
2133 :group 'org-link-follow
2134 :type '(choice
2135 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2136 (const :tag "with y-or-n (faster)" y-or-n-p)
2137 (const :tag "no confirmation (dangerous)" nil)))
2138 (put 'org-confirm-shell-link-function
2139 'safe-local-variable
2140 (lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2142 (defcustom org-confirm-elisp-link-not-regexp ""
2143 "A regexp to skip confirmation for Elisp links."
2144 :group 'org-link-follow
2145 :version "24.1"
2146 :type 'regexp)
2148 (defconst org-file-apps-defaults-gnu
2149 '((remote . emacs)
2150 (system . mailcap)
2151 (t . mailcap))
2152 "Default file applications on a UNIX or GNU/Linux system.
2153 See `org-file-apps'.")
2155 (defconst org-file-apps-defaults-macosx
2156 '((remote . emacs)
2157 (t . "open %s")
2158 (system . "open %s")
2159 ("ps.gz" . "gv %s")
2160 ("eps.gz" . "gv %s")
2161 ("dvi" . "xdvi %s")
2162 ("fig" . "xfig %s"))
2163 "Default file applications on a MacOS X system.
2164 The system \"open\" is known as a default, but we use X11 applications
2165 for some files for which the OS does not have a good default.
2166 See `org-file-apps'.")
2168 (defconst org-file-apps-defaults-windowsnt
2169 (list
2170 '(remote . emacs)
2171 (cons t
2172 (list (if (featurep 'xemacs)
2173 'mswindows-shell-execute
2174 'w32-shell-execute)
2175 "open" 'file))
2176 (cons 'system
2177 (list (if (featurep 'xemacs)
2178 'mswindows-shell-execute
2179 'w32-shell-execute)
2180 "open" 'file)))
2181 "Default file applications on a Windows NT system.
2182 The system \"open\" is used for most files.
2183 See `org-file-apps'.")
2185 (defcustom org-file-apps
2186 '((auto-mode . emacs)
2187 ("\\.mm\\'" . default)
2188 ("\\.x?html?\\'" . default)
2189 ("\\.pdf\\'" . default))
2190 "External applications for opening `file:path' items in a document.
2191 Org-mode uses system defaults for different file types, but
2192 you can use this variable to set the application for a given file
2193 extension. The entries in this list are cons cells where the car identifies
2194 files and the cdr the corresponding command. Possible values for the
2195 file identifier are
2196 \"string\" A string as a file identifier can be interpreted in different
2197 ways, depending on its contents:
2199 - Alphanumeric characters only:
2200 Match links with this file extension.
2201 Example: (\"pdf\" . \"evince %s\")
2202 to open PDFs with evince.
2204 - Regular expression: Match links where the
2205 filename matches the regexp. If you want to
2206 use groups here, use shy groups.
2208 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2209 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2210 to open *.html and *.xhtml with firefox.
2212 - Regular expression which contains (non-shy) groups:
2213 Match links where the whole link, including \"::\", and
2214 anything after that, matches the regexp.
2215 In a custom command string, %1, %2, etc. are replaced with
2216 the parts of the link that were matched by the groups.
2217 For backwards compatibility, if a command string is given
2218 that does not use any of the group matches, this case is
2219 handled identically to the second one (i.e. match against
2220 file name only).
2221 In a custom lisp form, you can access the group matches with
2222 (match-string n link).
2224 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2225 to open [[file:document.pdf::5]] with evince at page 5.
2227 `directory' Matches a directory
2228 `remote' Matches a remote file, accessible through tramp or efs.
2229 Remote files most likely should be visited through Emacs
2230 because external applications cannot handle such paths.
2231 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2232 so all files Emacs knows how to handle. Using this with
2233 command `emacs' will open most files in Emacs. Beware that this
2234 will also open html files inside Emacs, unless you add
2235 (\"html\" . default) to the list as well.
2236 t Default for files not matched by any of the other options.
2237 `system' The system command to open files, like `open' on Windows
2238 and Mac OS X, and mailcap under GNU/Linux. This is the command
2239 that will be selected if you call `C-c C-o' with a double
2240 \\[universal-argument] \\[universal-argument] prefix.
2242 Possible values for the command are:
2243 `emacs' The file will be visited by the current Emacs process.
2244 `default' Use the default application for this file type, which is the
2245 association for t in the list, most likely in the system-specific
2246 part.
2247 This can be used to overrule an unwanted setting in the
2248 system-specific variable.
2249 `system' Use the system command for opening files, like \"open\".
2250 This command is specified by the entry whose car is `system'.
2251 Most likely, the system-specific version of this variable
2252 does define this command, but you can overrule/replace it
2253 here.
2254 string A command to be executed by a shell; %s will be replaced
2255 by the path to the file.
2256 sexp A Lisp form which will be evaluated. The file path will
2257 be available in the Lisp variable `file'.
2258 For more examples, see the system specific constants
2259 `org-file-apps-defaults-macosx'
2260 `org-file-apps-defaults-windowsnt'
2261 `org-file-apps-defaults-gnu'."
2262 :group 'org-link-follow
2263 :type '(repeat
2264 (cons (choice :value ""
2265 (string :tag "Extension")
2266 (const :tag "System command to open files" system)
2267 (const :tag "Default for unrecognized files" t)
2268 (const :tag "Remote file" remote)
2269 (const :tag "Links to a directory" directory)
2270 (const :tag "Any files that have Emacs modes"
2271 auto-mode))
2272 (choice :value ""
2273 (const :tag "Visit with Emacs" emacs)
2274 (const :tag "Use default" default)
2275 (const :tag "Use the system command" system)
2276 (string :tag "Command")
2277 (sexp :tag "Lisp form")))))
2279 (defcustom org-doi-server-url "http://dx.doi.org/"
2280 "The URL of the DOI server."
2281 :type 'string
2282 :version "24.3"
2283 :group 'org-link-follow)
2285 (defgroup org-refile nil
2286 "Options concerning refiling entries in Org-mode."
2287 :tag "Org Refile"
2288 :group 'org)
2290 (defcustom org-directory "~/org"
2291 "Directory with org files.
2292 This is just a default location to look for Org files. There is no need
2293 at all to put your files into this directory. It is only used in the
2294 following situations:
2296 1. When a capture template specifies a target file that is not an
2297 absolute path. The path will then be interpreted relative to
2298 `org-directory'
2299 2. When a capture note is filed away in an interactive way (when exiting the
2300 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2301 with `org-directory' as the default path."
2302 :group 'org-refile
2303 :group 'org-capture
2304 :type 'directory)
2306 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2307 "Default target for storing notes.
2308 Used as a fall back file for org-capture.el, for templates that
2309 do not specify a target file."
2310 :group 'org-refile
2311 :group 'org-capture
2312 :type 'file)
2314 (defcustom org-goto-interface 'outline
2315 "The default interface to be used for `org-goto'.
2316 Allowed values are:
2317 outline The interface shows an outline of the relevant file
2318 and the correct heading is found by moving through
2319 the outline or by searching with incremental search.
2320 outline-path-completion Headlines in the current buffer are offered via
2321 completion. This is the interface also used by
2322 the refile command."
2323 :group 'org-refile
2324 :type '(choice
2325 (const :tag "Outline" outline)
2326 (const :tag "Outline-path-completion" outline-path-completion)))
2328 (defcustom org-goto-max-level 5
2329 "Maximum target level when running `org-goto' with refile interface."
2330 :group 'org-refile
2331 :type 'integer)
2333 (defcustom org-reverse-note-order nil
2334 "Non-nil means store new notes at the beginning of a file or entry.
2335 When nil, new notes will be filed to the end of a file or entry.
2336 This can also be a list with cons cells of regular expressions that
2337 are matched against file names, and values."
2338 :group 'org-capture
2339 :group 'org-refile
2340 :type '(choice
2341 (const :tag "Reverse always" t)
2342 (const :tag "Reverse never" nil)
2343 (repeat :tag "By file name regexp"
2344 (cons regexp boolean))))
2346 (defcustom org-log-refile nil
2347 "Information to record when a task is refiled.
2349 Possible values are:
2351 nil Don't add anything
2352 time Add a time stamp to the task
2353 note Prompt for a note and add it with template `org-log-note-headings'
2355 This option can also be set with on a per-file-basis with
2357 #+STARTUP: nologrefile
2358 #+STARTUP: logrefile
2359 #+STARTUP: lognoterefile
2361 You can have local logging settings for a subtree by setting the LOGGING
2362 property to one or more of these keywords.
2364 When bulk-refiling from the agenda, the value `note' is forbidden and
2365 will temporarily be changed to `time'."
2366 :group 'org-refile
2367 :group 'org-progress
2368 :version "24.1"
2369 :type '(choice
2370 (const :tag "No logging" nil)
2371 (const :tag "Record timestamp" time)
2372 (const :tag "Record timestamp with note." note)))
2374 (defcustom org-refile-targets nil
2375 "Targets for refiling entries with \\[org-refile].
2376 This is a list of cons cells. Each cell contains:
2377 - a specification of the files to be considered, either a list of files,
2378 or a symbol whose function or variable value will be used to retrieve
2379 a file name or a list of file names. If you use `org-agenda-files' for
2380 that, all agenda files will be scanned for targets. Nil means consider
2381 headings in the current buffer.
2382 - A specification of how to find candidate refile targets. This may be
2383 any of:
2384 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2385 This tag has to be present in all target headlines, inheritance will
2386 not be considered.
2387 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2388 todo keyword.
2389 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2390 headlines that are refiling targets.
2391 - a cons cell (:level . N). Any headline of level N is considered a target.
2392 Note that, when `org-odd-levels-only' is set, level corresponds to
2393 order in hierarchy, not to the number of stars.
2394 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2395 Note that, when `org-odd-levels-only' is set, level corresponds to
2396 order in hierarchy, not to the number of stars.
2398 Each element of this list generates a set of possible targets.
2399 The union of these sets is presented (with completion) to
2400 the user by `org-refile'.
2402 You can set the variable `org-refile-target-verify-function' to a function
2403 to verify each headline found by the simple criteria above.
2405 When this variable is nil, all top-level headlines in the current buffer
2406 are used, equivalent to the value `((nil . (:level . 1))'."
2407 :group 'org-refile
2408 :type '(repeat
2409 (cons
2410 (choice :value org-agenda-files
2411 (const :tag "All agenda files" org-agenda-files)
2412 (const :tag "Current buffer" nil)
2413 (function) (variable) (file))
2414 (choice :tag "Identify target headline by"
2415 (cons :tag "Specific tag" (const :value :tag) (string))
2416 (cons :tag "TODO keyword" (const :value :todo) (string))
2417 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2418 (cons :tag "Level number" (const :value :level) (integer))
2419 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2421 (defcustom org-refile-target-verify-function nil
2422 "Function to verify if the headline at point should be a refile target.
2423 The function will be called without arguments, with point at the
2424 beginning of the headline. It should return t and leave point
2425 where it is if the headline is a valid target for refiling.
2427 If the target should not be selected, the function must return nil.
2428 In addition to this, it may move point to a place from where the search
2429 should be continued. For example, the function may decide that the entire
2430 subtree of the current entry should be excluded and move point to the end
2431 of the subtree."
2432 :group 'org-refile
2433 :type '(choice
2434 (const nil)
2435 (function)))
2437 (defcustom org-refile-use-cache nil
2438 "Non-nil means cache refile targets to speed up the process.
2439 The cache for a particular file will be updated automatically when
2440 the buffer has been killed, or when any of the marker used for flagging
2441 refile targets no longer points at a live buffer.
2442 If you have added new entries to a buffer that might themselves be targets,
2443 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2444 find that easier, `C-u C-u C-u C-c C-w'."
2445 :group 'org-refile
2446 :version "24.1"
2447 :type 'boolean)
2449 (defcustom org-refile-use-outline-path nil
2450 "Non-nil means provide refile targets as paths.
2451 So a level 3 headline will be available as level1/level2/level3.
2453 When the value is `file', also include the file name (without directory)
2454 into the path. In this case, you can also stop the completion after
2455 the file name, to get entries inserted as top level in the file.
2457 When `full-file-path', include the full file path."
2458 :group 'org-refile
2459 :type '(choice
2460 (const :tag "Not" nil)
2461 (const :tag "Yes" t)
2462 (const :tag "Start with file name" file)
2463 (const :tag "Start with full file path" full-file-path)))
2465 (defcustom org-outline-path-complete-in-steps t
2466 "Non-nil means complete the outline path in hierarchical steps.
2467 When Org-mode uses the refile interface to select an outline path
2468 \(see variable `org-refile-use-outline-path'), the completion of
2469 the path can be done in a single go, or it can be done in steps down
2470 the headline hierarchy. Going in steps is probably the best if you
2471 do not use a special completion package like `ido' or `icicles'.
2472 However, when using these packages, going in one step can be very
2473 fast, while still showing the whole path to the entry."
2474 :group 'org-refile
2475 :type 'boolean)
2477 (defcustom org-refile-allow-creating-parent-nodes nil
2478 "Non-nil means allow to create new nodes as refile targets.
2479 New nodes are then created by adding \"/new node name\" to the completion
2480 of an existing node. When the value of this variable is `confirm',
2481 new node creation must be confirmed by the user (recommended).
2482 When nil, the completion must match an existing entry.
2484 Note that, if the new heading is not seen by the criteria
2485 listed in `org-refile-targets', multiple instances of the same
2486 heading would be created by trying again to file under the new
2487 heading."
2488 :group 'org-refile
2489 :type '(choice
2490 (const :tag "Never" nil)
2491 (const :tag "Always" t)
2492 (const :tag "Prompt for confirmation" confirm)))
2494 (defcustom org-refile-active-region-within-subtree nil
2495 "Non-nil means also refile active region within a subtree.
2497 By default `org-refile' doesn't allow refiling regions if they
2498 don't contain a set of subtrees, but it might be convenient to
2499 do so sometimes: in that case, the first line of the region is
2500 converted to a headline before refiling."
2501 :group 'org-refile
2502 :version "24.1"
2503 :type 'boolean)
2505 (defgroup org-todo nil
2506 "Options concerning TODO items in Org-mode."
2507 :tag "Org TODO"
2508 :group 'org)
2510 (defgroup org-progress nil
2511 "Options concerning Progress logging in Org-mode."
2512 :tag "Org Progress"
2513 :group 'org-time)
2515 (defvar org-todo-interpretation-widgets
2516 '((:tag "Sequence (cycling hits every state)" sequence)
2517 (:tag "Type (cycling directly to DONE)" type))
2518 "The available interpretation symbols for customizing `org-todo-keywords'.
2519 Interested libraries should add to this list.")
2521 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2522 "List of TODO entry keyword sequences and their interpretation.
2523 \\<org-mode-map>This is a list of sequences.
2525 Each sequence starts with a symbol, either `sequence' or `type',
2526 indicating if the keywords should be interpreted as a sequence of
2527 action steps, or as different types of TODO items. The first
2528 keywords are states requiring action - these states will select a headline
2529 for inclusion into the global TODO list Org-mode produces. If one of
2530 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2531 signify that no further action is necessary. If \"|\" is not found,
2532 the last keyword is treated as the only DONE state of the sequence.
2534 The command \\[org-todo] cycles an entry through these states, and one
2535 additional state where no keyword is present. For details about this
2536 cycling, see the manual.
2538 TODO keywords and interpretation can also be set on a per-file basis with
2539 the special #+SEQ_TODO and #+TYP_TODO lines.
2541 Each keyword can optionally specify a character for fast state selection
2542 \(in combination with the variable `org-use-fast-todo-selection')
2543 and specifiers for state change logging, using the same syntax that
2544 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2545 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2546 indicates to record a time stamp each time this state is selected.
2548 Each keyword may also specify if a timestamp or a note should be
2549 recorded when entering or leaving the state, by adding additional
2550 characters in the parenthesis after the keyword. This looks like this:
2551 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2552 record only the time of the state change. With X and Y being either
2553 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2554 Y when leaving the state if and only if the *target* state does not
2555 define X. You may omit any of the fast-selection key or X or /Y,
2556 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2558 For backward compatibility, this variable may also be just a list
2559 of keywords. In this case the interpretation (sequence or type) will be
2560 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2561 :group 'org-todo
2562 :group 'org-keywords
2563 :type '(choice
2564 (repeat :tag "Old syntax, just keywords"
2565 (string :tag "Keyword"))
2566 (repeat :tag "New syntax"
2567 (cons
2568 (choice
2569 :tag "Interpretation"
2570 ;;Quick and dirty way to see
2571 ;;`org-todo-interpretations'. This takes the
2572 ;;place of item arguments
2573 :convert-widget
2574 (lambda (widget)
2575 (widget-put widget
2576 :args (mapcar
2577 (lambda (x)
2578 (widget-convert
2579 (cons 'const x)))
2580 org-todo-interpretation-widgets))
2581 widget))
2582 (repeat
2583 (string :tag "Keyword"))))))
2585 (defvar org-todo-keywords-1 nil
2586 "All TODO and DONE keywords active in a buffer.")
2587 (make-variable-buffer-local 'org-todo-keywords-1)
2588 (defvar org-todo-keywords-for-agenda nil)
2589 (defvar org-done-keywords-for-agenda nil)
2590 (defvar org-todo-keyword-alist-for-agenda nil)
2591 (defvar org-tag-alist-for-agenda nil
2592 "Alist of all tags from all agenda files.")
2593 (defvar org-tag-groups-alist-for-agenda nil
2594 "Alist of all groups tags from all current agenda files.")
2595 (defvar org-tag-groups-alist nil)
2596 (make-variable-buffer-local 'org-tag-groups-alist)
2597 (defvar org-agenda-contributing-files nil)
2598 (defvar org-not-done-keywords nil)
2599 (make-variable-buffer-local 'org-not-done-keywords)
2600 (defvar org-done-keywords nil)
2601 (make-variable-buffer-local 'org-done-keywords)
2602 (defvar org-todo-heads nil)
2603 (make-variable-buffer-local 'org-todo-heads)
2604 (defvar org-todo-sets nil)
2605 (make-variable-buffer-local 'org-todo-sets)
2606 (defvar org-todo-log-states nil)
2607 (make-variable-buffer-local 'org-todo-log-states)
2608 (defvar org-todo-kwd-alist nil)
2609 (make-variable-buffer-local 'org-todo-kwd-alist)
2610 (defvar org-todo-key-alist nil)
2611 (make-variable-buffer-local 'org-todo-key-alist)
2612 (defvar org-todo-key-trigger nil)
2613 (make-variable-buffer-local 'org-todo-key-trigger)
2615 (defcustom org-todo-interpretation 'sequence
2616 "Controls how TODO keywords are interpreted.
2617 This variable is in principle obsolete and is only used for
2618 backward compatibility, if the interpretation of todo keywords is
2619 not given already in `org-todo-keywords'. See that variable for
2620 more information."
2621 :group 'org-todo
2622 :group 'org-keywords
2623 :type '(choice (const sequence)
2624 (const type)))
2626 (defcustom org-use-fast-todo-selection t
2627 "Non-nil means use the fast todo selection scheme with C-c C-t.
2628 This variable describes if and under what circumstances the cycling
2629 mechanism for TODO keywords will be replaced by a single-key, direct
2630 selection scheme.
2632 When nil, fast selection is never used.
2634 When the symbol `prefix', it will be used when `org-todo' is called
2635 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2636 `C-u t' in an agenda buffer.
2638 When t, fast selection is used by default. In this case, the prefix
2639 argument forces cycling instead.
2641 In all cases, the special interface is only used if access keys have
2642 actually been assigned by the user, i.e. if keywords in the configuration
2643 are followed by a letter in parenthesis, like TODO(t)."
2644 :group 'org-todo
2645 :type '(choice
2646 (const :tag "Never" nil)
2647 (const :tag "By default" t)
2648 (const :tag "Only with C-u C-c C-t" prefix)))
2650 (defcustom org-provide-todo-statistics t
2651 "Non-nil means update todo statistics after insert and toggle.
2652 ALL-HEADLINES means update todo statistics by including headlines
2653 with no TODO keyword as well, counting them as not done.
2654 A list of TODO keywords means the same, but skip keywords that are
2655 not in this list.
2656 When set to a list of two lists, the first list contains keywords
2657 to consider as TODO keywords, the second list contains keywords
2658 to consider as DONE keywords.
2660 When this is set, todo statistics is updated in the parent of the
2661 current entry each time a todo state is changed."
2662 :group 'org-todo
2663 :type '(choice
2664 (const :tag "Yes, only for TODO entries" t)
2665 (const :tag "Yes, including all entries" all-headlines)
2666 (repeat :tag "Yes, for TODOs in this list"
2667 (string :tag "TODO keyword"))
2668 (list :tag "Yes, for TODOs and DONEs in these lists"
2669 (repeat (string :tag "TODO keyword"))
2670 (repeat (string :tag "DONE keyword")))
2671 (other :tag "No TODO statistics" nil)))
2673 (defcustom org-hierarchical-todo-statistics t
2674 "Non-nil means TODO statistics covers just direct children.
2675 When nil, all entries in the subtree are considered.
2676 This has only an effect if `org-provide-todo-statistics' is set.
2677 To set this to nil for only a single subtree, use a COOKIE_DATA
2678 property and include the word \"recursive\" into the value."
2679 :group 'org-todo
2680 :type 'boolean)
2682 (defcustom org-after-todo-state-change-hook nil
2683 "Hook which is run after the state of a TODO item was changed.
2684 The new state (a string with a TODO keyword, or nil) is available in the
2685 Lisp variable `org-state'."
2686 :group 'org-todo
2687 :type 'hook)
2689 (defvar org-blocker-hook nil
2690 "Hook for functions that are allowed to block a state change.
2692 Functions in this hook should not modify the buffer.
2693 Each function gets as its single argument a property list,
2694 see `org-trigger-hook' for more information about this list.
2696 If any of the functions in this hook returns nil, the state change
2697 is blocked.")
2699 (defvar org-trigger-hook nil
2700 "Hook for functions that are triggered by a state change.
2702 Each function gets as its single argument a property list with at
2703 least the following elements:
2705 (:type type-of-change :position pos-at-entry-start
2706 :from old-state :to new-state)
2708 Depending on the type, more properties may be present.
2710 This mechanism is currently implemented for:
2712 TODO state changes
2713 ------------------
2714 :type todo-state-change
2715 :from previous state (keyword as a string), or nil, or a symbol
2716 'todo' or 'done', to indicate the general type of state.
2717 :to new state, like in :from")
2719 (defcustom org-enforce-todo-dependencies nil
2720 "Non-nil means undone TODO entries will block switching the parent to DONE.
2721 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2722 be blocked if any prior sibling is not yet done.
2723 Finally, if the parent is blocked because of ordered siblings of its own,
2724 the child will also be blocked."
2725 :set (lambda (var val)
2726 (set var val)
2727 (if val
2728 (add-hook 'org-blocker-hook
2729 'org-block-todo-from-children-or-siblings-or-parent)
2730 (remove-hook 'org-blocker-hook
2731 'org-block-todo-from-children-or-siblings-or-parent)))
2732 :group 'org-todo
2733 :type 'boolean)
2735 (defcustom org-enforce-todo-checkbox-dependencies nil
2736 "Non-nil means unchecked boxes will block switching the parent to DONE.
2737 When this is nil, checkboxes have no influence on switching TODO states.
2738 When non-nil, you first need to check off all check boxes before the TODO
2739 entry can be switched to DONE.
2740 This variable needs to be set before org.el is loaded, and you need to
2741 restart Emacs after a change to make the change effective. The only way
2742 to change is while Emacs is running is through the customize interface."
2743 :set (lambda (var val)
2744 (set var val)
2745 (if val
2746 (add-hook 'org-blocker-hook
2747 'org-block-todo-from-checkboxes)
2748 (remove-hook 'org-blocker-hook
2749 'org-block-todo-from-checkboxes)))
2750 :group 'org-todo
2751 :type 'boolean)
2753 (defcustom org-treat-insert-todo-heading-as-state-change nil
2754 "Non-nil means inserting a TODO heading is treated as state change.
2755 So when the command \\[org-insert-todo-heading] is used, state change
2756 logging will apply if appropriate. When nil, the new TODO item will
2757 be inserted directly, and no logging will take place."
2758 :group 'org-todo
2759 :type 'boolean)
2761 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2762 "Non-nil means switching TODO states with S-cursor counts as state change.
2763 This is the default behavior. However, setting this to nil allows a
2764 convenient way to select a TODO state and bypass any logging associated
2765 with that."
2766 :group 'org-todo
2767 :type 'boolean)
2769 (defcustom org-todo-state-tags-triggers nil
2770 "Tag changes that should be triggered by TODO state changes.
2771 This is a list. Each entry is
2773 (state-change (tag . flag) .......)
2775 State-change can be a string with a state, and empty string to indicate the
2776 state that has no TODO keyword, or it can be one of the symbols `todo'
2777 or `done', meaning any not-done or done state, respectively."
2778 :group 'org-todo
2779 :group 'org-tags
2780 :type '(repeat
2781 (cons (choice :tag "When changing to"
2782 (const :tag "Not-done state" todo)
2783 (const :tag "Done state" done)
2784 (string :tag "State"))
2785 (repeat
2786 (cons :tag "Tag action"
2787 (string :tag "Tag")
2788 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2790 (defcustom org-log-done nil
2791 "Information to record when a task moves to the DONE state.
2793 Possible values are:
2795 nil Don't add anything, just change the keyword
2796 time Add a time stamp to the task
2797 note Prompt for a note and add it with template `org-log-note-headings'
2799 This option can also be set with on a per-file-basis with
2801 #+STARTUP: nologdone
2802 #+STARTUP: logdone
2803 #+STARTUP: lognotedone
2805 You can have local logging settings for a subtree by setting the LOGGING
2806 property to one or more of these keywords."
2807 :group 'org-todo
2808 :group 'org-progress
2809 :type '(choice
2810 (const :tag "No logging" nil)
2811 (const :tag "Record CLOSED timestamp" time)
2812 (const :tag "Record CLOSED timestamp with note." note)))
2814 ;; Normalize old uses of org-log-done.
2815 (cond
2816 ((eq org-log-done t) (setq org-log-done 'time))
2817 ((and (listp org-log-done) (memq 'done org-log-done))
2818 (setq org-log-done 'note)))
2820 (defcustom org-log-reschedule nil
2821 "Information to record when the scheduling date of a tasks is modified.
2823 Possible values are:
2825 nil Don't add anything, just change the date
2826 time Add a time stamp to the task
2827 note Prompt for a note and add it with template `org-log-note-headings'
2829 This option can also be set with on a per-file-basis with
2831 #+STARTUP: nologreschedule
2832 #+STARTUP: logreschedule
2833 #+STARTUP: lognotereschedule"
2834 :group 'org-todo
2835 :group 'org-progress
2836 :type '(choice
2837 (const :tag "No logging" nil)
2838 (const :tag "Record timestamp" time)
2839 (const :tag "Record timestamp with note." note)))
2841 (defcustom org-log-redeadline nil
2842 "Information to record when the deadline date of a tasks is modified.
2844 Possible values are:
2846 nil Don't add anything, just change the date
2847 time Add a time stamp to the task
2848 note Prompt for a note and add it with template `org-log-note-headings'
2850 This option can also be set with on a per-file-basis with
2852 #+STARTUP: nologredeadline
2853 #+STARTUP: logredeadline
2854 #+STARTUP: lognoteredeadline
2856 You can have local logging settings for a subtree by setting the LOGGING
2857 property to one or more of these keywords."
2858 :group 'org-todo
2859 :group 'org-progress
2860 :type '(choice
2861 (const :tag "No logging" nil)
2862 (const :tag "Record timestamp" time)
2863 (const :tag "Record timestamp with note." note)))
2865 (defcustom org-log-note-clock-out nil
2866 "Non-nil means record a note when clocking out of an item.
2867 This can also be configured on a per-file basis by adding one of
2868 the following lines anywhere in the buffer:
2870 #+STARTUP: lognoteclock-out
2871 #+STARTUP: nolognoteclock-out"
2872 :group 'org-todo
2873 :group 'org-progress
2874 :type 'boolean)
2876 (defcustom org-log-done-with-time t
2877 "Non-nil means the CLOSED time stamp will contain date and time.
2878 When nil, only the date will be recorded."
2879 :group 'org-progress
2880 :type 'boolean)
2882 (defcustom org-log-note-headings
2883 '((done . "CLOSING NOTE %t")
2884 (state . "State %-12s from %-12S %t")
2885 (note . "Note taken on %t")
2886 (reschedule . "Rescheduled from %S on %t")
2887 (delschedule . "Not scheduled, was %S on %t")
2888 (redeadline . "New deadline from %S on %t")
2889 (deldeadline . "Removed deadline, was %S on %t")
2890 (refile . "Refiled on %t")
2891 (clock-out . ""))
2892 "Headings for notes added to entries.
2894 The value is an alist, with the car being a symbol indicating the
2895 note context, and the cdr is the heading to be used. The heading
2896 may also be the empty string. The following placeholders can be
2897 used:
2899 %t a time stamp.
2900 %T an active time stamp instead the default inactive one
2901 %d a short-format time stamp.
2902 %D an active short-format time stamp.
2903 %s the new TODO state or time stamp (inactive), in double quotes.
2904 %S the old TODO state or time stamp (inactive), in double quotes.
2905 %u the user name.
2906 %U full user name.
2908 In fact, it is not a good idea to change the `state' entry,
2909 because Agenda Log mode depends on the format of these entries."
2910 :group 'org-todo
2911 :group 'org-progress
2912 :type '(list :greedy t
2913 (cons (const :tag "Heading when closing an item" done) string)
2914 (cons (const :tag
2915 "Heading when changing todo state (todo sequence only)"
2916 state) string)
2917 (cons (const :tag "Heading when just taking a note" note) string)
2918 (cons (const :tag "Heading when rescheduling" reschedule) string)
2919 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2920 (cons (const :tag "Heading when changing deadline" redeadline) string)
2921 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2922 (cons (const :tag "Heading when refiling" refile) string)
2923 (cons (const :tag "Heading when clocking out" clock-out) string)))
2925 (unless (assq 'note org-log-note-headings)
2926 (push '(note . "%t") org-log-note-headings))
2928 (defcustom org-log-into-drawer nil
2929 "Non-nil means insert state change notes and time stamps into a drawer.
2930 When nil, state changes notes will be inserted after the headline and
2931 any scheduling and clock lines, but not inside a drawer.
2933 The value of this variable should be the name of the drawer to use.
2934 LOGBOOK is proposed as the default drawer for this purpose, you can
2935 also set this to a string to define the drawer of your choice.
2937 A value of t is also allowed, representing \"LOGBOOK\".
2939 A value of t or nil can also be set with on a per-file-basis with
2941 #+STARTUP: logdrawer
2942 #+STARTUP: nologdrawer
2944 If this variable is set, `org-log-state-notes-insert-after-drawers'
2945 will be ignored.
2947 You can set the property LOG_INTO_DRAWER to overrule this setting for
2948 a subtree.
2950 Do not check directly this variable in a Lisp program. Call
2951 function `org-log-into-drawer' instead."
2952 :group 'org-todo
2953 :group 'org-progress
2954 :type '(choice
2955 (const :tag "Not into a drawer" nil)
2956 (const :tag "LOGBOOK" t)
2957 (string :tag "Other")))
2959 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2961 (defun org-log-into-drawer ()
2962 "Name of the log drawer, as a string, or nil.
2963 This is the value of `org-log-into-drawer'. However, if the
2964 current entry has or inherits a LOG_INTO_DRAWER property, it will
2965 be used instead of the default value."
2966 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2967 (cond ((equal p "nil") nil)
2968 ((equal p "t") "LOGBOOK")
2969 ((stringp p) p)
2970 (p "LOGBOOK")
2971 ((stringp org-log-into-drawer) org-log-into-drawer)
2972 (org-log-into-drawer "LOGBOOK"))))
2974 (defcustom org-log-state-notes-insert-after-drawers nil
2975 "Non-nil means insert state change notes after any drawers in entry.
2976 Only the drawers that *immediately* follow the headline and the
2977 deadline/scheduled line are skipped.
2978 When nil, insert notes right after the heading and perhaps the line
2979 with deadline/scheduling if present.
2981 This variable will have no effect if `org-log-into-drawer' is
2982 set."
2983 :group 'org-todo
2984 :group 'org-progress
2985 :type 'boolean)
2987 (defcustom org-log-states-order-reversed t
2988 "Non-nil means the latest state note will be directly after heading.
2989 When nil, the state change notes will be ordered according to time.
2991 This option can also be set with on a per-file-basis with
2993 #+STARTUP: logstatesreversed
2994 #+STARTUP: nologstatesreversed"
2995 :group 'org-todo
2996 :group 'org-progress
2997 :type 'boolean)
2999 (defcustom org-todo-repeat-to-state nil
3000 "The TODO state to which a repeater should return the repeating task.
3001 By default this is the first task in a TODO sequence, or the previous state
3002 in a TODO_TYP set. But you can specify another task here.
3003 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3004 :group 'org-todo
3005 :version "24.1"
3006 :type '(choice (const :tag "Head of sequence" nil)
3007 (string :tag "Specific state")))
3009 (defcustom org-log-repeat 'time
3010 "Non-nil means record moving through the DONE state when triggering repeat.
3011 An auto-repeating task is immediately switched back to TODO when
3012 marked DONE. If you are not logging state changes (by adding \"@\"
3013 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3014 record a closing note, there will be no record of the task moving
3015 through DONE. This variable forces taking a note anyway.
3017 nil Don't force a record
3018 time Record a time stamp
3019 note Prompt for a note and add it with template `org-log-note-headings'
3021 This option can also be set with on a per-file-basis with
3023 #+STARTUP: nologrepeat
3024 #+STARTUP: logrepeat
3025 #+STARTUP: lognoterepeat
3027 You can have local logging settings for a subtree by setting the LOGGING
3028 property to one or more of these keywords."
3029 :group 'org-todo
3030 :group 'org-progress
3031 :type '(choice
3032 (const :tag "Don't force a record" nil)
3033 (const :tag "Force recording the DONE state" time)
3034 (const :tag "Force recording a note with the DONE state" note)))
3037 (defgroup org-priorities nil
3038 "Priorities in Org-mode."
3039 :tag "Org Priorities"
3040 :group 'org-todo)
3042 (defcustom org-enable-priority-commands t
3043 "Non-nil means priority commands are active.
3044 When nil, these commands will be disabled, so that you never accidentally
3045 set a priority."
3046 :group 'org-priorities
3047 :type 'boolean)
3049 (defcustom org-highest-priority ?A
3050 "The highest priority of TODO items. A character like ?A, ?B etc.
3051 Must have a smaller ASCII number than `org-lowest-priority'."
3052 :group 'org-priorities
3053 :type 'character)
3055 (defcustom org-lowest-priority ?C
3056 "The lowest priority of TODO items. A character like ?A, ?B etc.
3057 Must have a larger ASCII number than `org-highest-priority'."
3058 :group 'org-priorities
3059 :type 'character)
3061 (defcustom org-default-priority ?B
3062 "The default priority of TODO items.
3063 This is the priority an item gets if no explicit priority is given.
3064 When starting to cycle on an empty priority the first step in the cycle
3065 depends on `org-priority-start-cycle-with-default'. The resulting first
3066 step priority must not exceed the range from `org-highest-priority' to
3067 `org-lowest-priority' which means that `org-default-priority' has to be
3068 in this range exclusive or inclusive the range boundaries. Else the
3069 first step refuses to set the default and the second will fall back
3070 to (depending on the command used) the highest or lowest priority."
3071 :group 'org-priorities
3072 :type 'character)
3074 (defcustom org-priority-start-cycle-with-default t
3075 "Non-nil means start with default priority when starting to cycle.
3076 When this is nil, the first step in the cycle will be (depending on the
3077 command used) one higher or lower than the default priority.
3078 See also `org-default-priority'."
3079 :group 'org-priorities
3080 :type 'boolean)
3082 (defcustom org-get-priority-function nil
3083 "Function to extract the priority from a string.
3084 The string is normally the headline. If this is nil Org computes the
3085 priority from the priority cookie like [#A] in the headline. It returns
3086 an integer, increasing by 1000 for each priority level.
3087 The user can set a different function here, which should take a string
3088 as an argument and return the numeric priority."
3089 :group 'org-priorities
3090 :version "24.1"
3091 :type '(choice
3092 (const nil)
3093 (function)))
3095 (defgroup org-time nil
3096 "Options concerning time stamps and deadlines in Org-mode."
3097 :tag "Org Time"
3098 :group 'org)
3100 (defcustom org-time-stamp-rounding-minutes '(0 5)
3101 "Number of minutes to round time stamps to.
3102 These are two values, the first applies when first creating a time stamp.
3103 The second applies when changing it with the commands `S-up' and `S-down'.
3104 When changing the time stamp, this means that it will change in steps
3105 of N minutes, as given by the second value.
3107 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3108 numbers should be factors of 60, so for example 5, 10, 15.
3110 When this is larger than 1, you can still force an exact time stamp by using
3111 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3112 and by using a prefix arg to `S-up/down' to specify the exact number
3113 of minutes to shift."
3114 :group 'org-time
3115 :get (lambda (var) ; Make sure both elements are there
3116 (if (integerp (default-value var))
3117 (list (default-value var) 5)
3118 (default-value var)))
3119 :type '(list
3120 (integer :tag "when inserting times")
3121 (integer :tag "when modifying times")))
3123 ;; Normalize old customizations of this variable.
3124 (when (integerp org-time-stamp-rounding-minutes)
3125 (setq org-time-stamp-rounding-minutes
3126 (list org-time-stamp-rounding-minutes
3127 org-time-stamp-rounding-minutes)))
3129 (defcustom org-display-custom-times nil
3130 "Non-nil means overlay custom formats over all time stamps.
3131 The formats are defined through the variable `org-time-stamp-custom-formats'.
3132 To turn this on on a per-file basis, insert anywhere in the file:
3133 #+STARTUP: customtime"
3134 :group 'org-time
3135 :set 'set-default
3136 :type 'sexp)
3137 (make-variable-buffer-local 'org-display-custom-times)
3139 (defcustom org-time-stamp-custom-formats
3140 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3141 "Custom formats for time stamps. See `format-time-string' for the syntax.
3142 These are overlaid over the default ISO format if the variable
3143 `org-display-custom-times' is set. Time like %H:%M should be at the
3144 end of the second format. The custom formats are also honored by export
3145 commands, if custom time display is turned on at the time of export."
3146 :group 'org-time
3147 :type 'sexp)
3149 (defun org-time-stamp-format (&optional long inactive)
3150 "Get the right format for a time string."
3151 (let ((f (if long (cdr org-time-stamp-formats)
3152 (car org-time-stamp-formats))))
3153 (if inactive
3154 (concat "[" (substring f 1 -1) "]")
3155 f)))
3157 (defcustom org-time-clocksum-format
3158 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3159 "The format string used when creating CLOCKSUM lines.
3160 This is also used when Org mode generates a time duration.
3162 The value can be a single format string containing two
3163 %-sequences, which will be filled with the number of hours and
3164 minutes in that order.
3166 Alternatively, the value can be a plist associating any of the
3167 keys :years, :months, :weeks, :days, :hours or :minutes with
3168 format strings. The time duration is formatted using only the
3169 time components that are needed and concatenating the results.
3170 If a time unit in absent, it falls back to the next smallest
3171 unit.
3173 The keys :require-years, :require-months, :require-days,
3174 :require-weeks, :require-hours, :require-minutes are also
3175 meaningful. A non-nil value for these keys indicates that the
3176 corresponding time component should always be included, even if
3177 its value is 0.
3180 For example,
3182 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3183 :require-minutes t)
3185 means durations longer than a day will be expressed in days,
3186 hours and minutes, and durations less than a day will always be
3187 expressed in hours and minutes (even for durations less than an
3188 hour).
3190 The value
3192 \(:days \"%dd\" :minutes \"%dm\")
3194 means durations longer than a day will be expressed in days and
3195 minutes, and durations less than a day will be expressed entirely
3196 in minutes (even for durations longer than an hour)."
3197 :group 'org-time
3198 :group 'org-clock
3199 :version "24.4"
3200 :package-version '(Org . "8.0")
3201 :type '(choice (string :tag "Format string")
3202 (set :tag "Plist"
3203 (group :inline t (const :tag "Years" :years)
3204 (string :tag "Format string"))
3205 (group :inline t
3206 (const :tag "Always show years" :require-years)
3207 (const t))
3208 (group :inline t (const :tag "Months" :months)
3209 (string :tag "Format string"))
3210 (group :inline t
3211 (const :tag "Always show months" :require-months)
3212 (const t))
3213 (group :inline t (const :tag "Weeks" :weeks)
3214 (string :tag "Format string"))
3215 (group :inline t
3216 (const :tag "Always show weeks" :require-weeks)
3217 (const t))
3218 (group :inline t (const :tag "Days" :days)
3219 (string :tag "Format string"))
3220 (group :inline t
3221 (const :tag "Always show days" :require-days)
3222 (const t))
3223 (group :inline t (const :tag "Hours" :hours)
3224 (string :tag "Format string"))
3225 (group :inline t
3226 (const :tag "Always show hours" :require-hours)
3227 (const t))
3228 (group :inline t (const :tag "Minutes" :minutes)
3229 (string :tag "Format string"))
3230 (group :inline t
3231 (const :tag "Always show minutes" :require-minutes)
3232 (const t)))))
3234 (defcustom org-time-clocksum-use-fractional nil
3235 "When non-nil, \\[org-clock-display] uses fractional times.
3236 See `org-time-clocksum-format' for more on time clock formats."
3237 :group 'org-time
3238 :group 'org-clock
3239 :version "24.3"
3240 :type 'boolean)
3242 (defcustom org-time-clocksum-use-effort-durations nil
3243 "When non-nil, \\[org-clock-display] uses effort durations.
3244 E.g. by default, one day is considered to be a 8 hours effort,
3245 so a task that has been clocked for 16 hours will be displayed
3246 as during 2 days in the clock display or in the clocktable.
3248 See `org-effort-durations' on how to set effort durations
3249 and `org-time-clocksum-format' for more on time clock formats."
3250 :group 'org-time
3251 :group 'org-clock
3252 :version "24.4"
3253 :package-version '(Org . "8.0")
3254 :type 'boolean)
3256 (defcustom org-time-clocksum-fractional-format "%.2f"
3257 "The format string used when creating CLOCKSUM lines,
3258 or when Org mode generates a time duration, if
3259 `org-time-clocksum-use-fractional' is enabled.
3261 The value can be a single format string containing one
3262 %-sequence, which will be filled with the number of hours as
3263 a float.
3265 Alternatively, the value can be a plist associating any of the
3266 keys :years, :months, :weeks, :days, :hours or :minutes with
3267 a format string. The time duration is formatted using the
3268 largest time unit which gives a non-zero integer part. If all
3269 specified formats have zero integer part, the smallest time unit
3270 is used."
3271 :group 'org-time
3272 :type '(choice (string :tag "Format string")
3273 (set (group :inline t (const :tag "Years" :years)
3274 (string :tag "Format string"))
3275 (group :inline t (const :tag "Months" :months)
3276 (string :tag "Format string"))
3277 (group :inline t (const :tag "Weeks" :weeks)
3278 (string :tag "Format string"))
3279 (group :inline t (const :tag "Days" :days)
3280 (string :tag "Format string"))
3281 (group :inline t (const :tag "Hours" :hours)
3282 (string :tag "Format string"))
3283 (group :inline t (const :tag "Minutes" :minutes)
3284 (string :tag "Format string")))))
3286 (defcustom org-deadline-warning-days 14
3287 "Number of days before expiration during which a deadline becomes active.
3288 This variable governs the display in sparse trees and in the agenda.
3289 When 0 or negative, it means use this number (the absolute value of it)
3290 even if a deadline has a different individual lead time specified.
3292 Custom commands can set this variable in the options section."
3293 :group 'org-time
3294 :group 'org-agenda-daily/weekly
3295 :type 'integer)
3297 (defcustom org-scheduled-delay-days 0
3298 "Number of days before a scheduled item becomes active.
3299 This variable governs the display in sparse trees and in the agenda.
3300 The default value (i.e. 0) means: don't delay scheduled item.
3301 When negative, it means use this number (the absolute value of it)
3302 even if a scheduled item has a different individual delay time
3303 specified.
3305 Custom commands can set this variable in the options section."
3306 :group 'org-time
3307 :group 'org-agenda-daily/weekly
3308 :version "24.4"
3309 :package-version '(Org . "8.0")
3310 :type 'integer)
3312 (defcustom org-read-date-prefer-future t
3313 "Non-nil means assume future for incomplete date input from user.
3314 This affects the following situations:
3315 1. The user gives a month but not a year.
3316 For example, if it is April and you enter \"feb 2\", this will be read
3317 as Feb 2, *next* year. \"May 5\", however, will be this year.
3318 2. The user gives a day, but no month.
3319 For example, if today is the 15th, and you enter \"3\", Org-mode will
3320 read this as the third of *next* month. However, if you enter \"17\",
3321 it will be considered as *this* month.
3323 If you set this variable to the symbol `time', then also the following
3324 will work:
3326 3. If the user gives a time.
3327 If the time is before now, it will be interpreted as tomorrow.
3329 Currently none of this works for ISO week specifications.
3331 When this option is nil, the current day, month and year will always be
3332 used as defaults.
3334 See also `org-agenda-jump-prefer-future'."
3335 :group 'org-time
3336 :type '(choice
3337 (const :tag "Never" nil)
3338 (const :tag "Check month and day" t)
3339 (const :tag "Check month, day, and time" time)))
3341 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3342 "Should the agenda jump command prefer the future for incomplete dates?
3343 The default is to do the same as configured in `org-read-date-prefer-future'.
3344 But you can also set a deviating value here.
3345 This may t or nil, or the symbol `org-read-date-prefer-future'."
3346 :group 'org-agenda
3347 :group 'org-time
3348 :version "24.1"
3349 :type '(choice
3350 (const :tag "Use org-read-date-prefer-future"
3351 org-read-date-prefer-future)
3352 (const :tag "Never" nil)
3353 (const :tag "Always" t)))
3355 (defcustom org-read-date-force-compatible-dates t
3356 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3358 Depending on the system Emacs is running on, certain dates cannot
3359 be represented with the type used internally to represent time.
3360 Dates between 1970-1-1 and 2038-1-1 can always be represented
3361 correctly. Some systems allow for earlier dates, some for later,
3362 some for both. One way to find out it to insert any date into an
3363 Org buffer, putting the cursor on the year and hitting S-up and
3364 S-down to test the range.
3366 When this variable is set to t, the date/time prompt will not let
3367 you specify dates outside the 1970-2037 range, so it is certain that
3368 these dates will work in whatever version of Emacs you are
3369 running, and also that you can move a file from one Emacs implementation
3370 to another. WHenever Org is forcing the year for you, it will display
3371 a message and beep.
3373 When this variable is nil, Org will check if the date is
3374 representable in the specific Emacs implementation you are using.
3375 If not, it will force a year, usually the current year, and beep
3376 to remind you. Currently this setting is not recommended because
3377 the likelihood that you will open your Org files in an Emacs that
3378 has limited date range is not negligible.
3380 A workaround for this problem is to use diary sexp dates for time
3381 stamps outside of this range."
3382 :group 'org-time
3383 :version "24.1"
3384 :type 'boolean)
3386 (defcustom org-read-date-display-live t
3387 "Non-nil means display current interpretation of date prompt live.
3388 This display will be in an overlay, in the minibuffer."
3389 :group 'org-time
3390 :type 'boolean)
3392 (defcustom org-read-date-popup-calendar t
3393 "Non-nil means pop up a calendar when prompting for a date.
3394 In the calendar, the date can be selected with mouse-1. However, the
3395 minibuffer will also be active, and you can simply enter the date as well.
3396 When nil, only the minibuffer will be available."
3397 :group 'org-time
3398 :type 'boolean)
3399 (org-defvaralias 'org-popup-calendar-for-date-prompt
3400 'org-read-date-popup-calendar)
3402 (make-obsolete-variable
3403 'org-read-date-minibuffer-setup-hook
3404 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3405 (defcustom org-read-date-minibuffer-setup-hook nil
3406 "Hook to be used to set up keys for the date/time interface.
3407 Add key definitions to `minibuffer-local-map', which will be a
3408 temporary copy.
3410 WARNING: This option is obsolete, you should use
3411 `org-read-date-minibuffer-local-map' to set up keys."
3412 :group 'org-time
3413 :type 'hook)
3415 (defcustom org-extend-today-until 0
3416 "The hour when your day really ends. Must be an integer.
3417 This has influence for the following applications:
3418 - When switching the agenda to \"today\". It it is still earlier than
3419 the time given here, the day recognized as TODAY is actually yesterday.
3420 - When a date is read from the user and it is still before the time given
3421 here, the current date and time will be assumed to be yesterday, 23:59.
3422 Also, timestamps inserted in capture templates follow this rule.
3424 IMPORTANT: This is a feature whose implementation is and likely will
3425 remain incomplete. Really, it is only here because past midnight seems to
3426 be the favorite working time of John Wiegley :-)"
3427 :group 'org-time
3428 :type 'integer)
3430 (defcustom org-use-effective-time nil
3431 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3432 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3433 \"effective time\" of any timestamps between midnight and 8am will be
3434 23:59 of the previous day."
3435 :group 'org-time
3436 :version "24.1"
3437 :type 'boolean)
3439 (defcustom org-use-last-clock-out-time-as-effective-time nil
3440 "When non-nil, use the last clock out time for `org-todo'.
3441 Note that this option has precedence over the combined use of
3442 `org-use-effective-time' and `org-extend-today-until'."
3443 :group 'org-time
3444 :version "24.4"
3445 :package-version '(Org . "8.0")
3446 :type 'boolean)
3448 (defcustom org-edit-timestamp-down-means-later nil
3449 "Non-nil means S-down will increase the time in a time stamp.
3450 When nil, S-up will increase."
3451 :group 'org-time
3452 :type 'boolean)
3454 (defcustom org-calendar-follow-timestamp-change t
3455 "Non-nil means make the calendar window follow timestamp changes.
3456 When a timestamp is modified and the calendar window is visible, it will be
3457 moved to the new date."
3458 :group 'org-time
3459 :type 'boolean)
3461 (defgroup org-tags nil
3462 "Options concerning tags in Org-mode."
3463 :tag "Org Tags"
3464 :group 'org)
3466 (defcustom org-tag-alist nil
3467 "List of tags allowed in Org-mode files.
3468 When this list is nil, Org-mode will base TAG input on what is already in the
3469 buffer.
3470 The value of this variable is an alist, the car of each entry must be a
3471 keyword as a string, the cdr may be a character that is used to select
3472 that tag through the fast-tag-selection interface.
3473 See the manual for details."
3474 :group 'org-tags
3475 :type '(repeat
3476 (choice
3477 (cons (string :tag "Tag name")
3478 (character :tag "Access char"))
3479 (list :tag "Start radio group"
3480 (const :startgroup)
3481 (option (string :tag "Group description")))
3482 (list :tag "Start tag group, non distinct"
3483 (const :startgrouptag)
3484 (option (string :tag "Group description")))
3485 (list :tag "Group tags delimiter"
3486 (const :grouptags))
3487 (list :tag "End radio group"
3488 (const :endgroup)
3489 (option (string :tag "Group description")))
3490 (list :tag "End tag group, non distinct"
3491 (const :endgrouptag)
3492 (option (string :tag "Group description")))
3493 (const :tag "New line" (:newline)))))
3495 (defcustom org-tag-persistent-alist nil
3496 "List of tags that will always appear in all Org-mode files.
3497 This is in addition to any in buffer settings or customizations
3498 of `org-tag-alist'.
3499 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3500 The value of this variable is an alist, the car of each entry must be a
3501 keyword as a string, the cdr may be a character that is used to select
3502 that tag through the fast-tag-selection interface.
3503 See the manual for details.
3504 To disable these tags on a per-file basis, insert anywhere in the file:
3505 #+STARTUP: noptag"
3506 :group 'org-tags
3507 :type '(repeat
3508 (choice
3509 (cons (string :tag "Tag name")
3510 (character :tag "Access char"))
3511 (const :tag "Start radio group" (:startgroup))
3512 (const :tag "Group tags delimiter" (:grouptags))
3513 (const :tag "End radio group" (:endgroup))
3514 (const :tag "New line" (:newline)))))
3516 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3517 "If non-nil, always offer completion for all tags of all agenda files.
3518 Instead of customizing this variable directly, you might want to
3519 set it locally for capture buffers, because there no list of
3520 tags in that file can be created dynamically (there are none).
3522 (add-hook 'org-capture-mode-hook
3523 (lambda ()
3524 (set (make-local-variable
3525 'org-complete-tags-always-offer-all-agenda-tags)
3526 t)))"
3527 :group 'org-tags
3528 :version "24.1"
3529 :type 'boolean)
3531 (defvar org-file-tags nil
3532 "List of tags that can be inherited by all entries in the file.
3533 The tags will be inherited if the variable `org-use-tag-inheritance'
3534 says they should be.
3535 This variable is populated from #+FILETAGS lines.")
3537 (defcustom org-use-fast-tag-selection 'auto
3538 "Non-nil means use fast tag selection scheme.
3539 This is a special interface to select and deselect tags with single keys.
3540 When nil, fast selection is never used.
3541 When the symbol `auto', fast selection is used if and only if selection
3542 characters for tags have been configured, either through the variable
3543 `org-tag-alist' or through a #+TAGS line in the buffer.
3544 When t, fast selection is always used and selection keys are assigned
3545 automatically if necessary."
3546 :group 'org-tags
3547 :type '(choice
3548 (const :tag "Always" t)
3549 (const :tag "Never" nil)
3550 (const :tag "When selection characters are configured" auto)))
3552 (defcustom org-fast-tag-selection-single-key nil
3553 "Non-nil means fast tag selection exits after first change.
3554 When nil, you have to press RET to exit it.
3555 During fast tag selection, you can toggle this flag with `C-c'.
3556 This variable can also have the value `expert'. In this case, the window
3557 displaying the tags menu is not even shown, until you press C-c again."
3558 :group 'org-tags
3559 :type '(choice
3560 (const :tag "No" nil)
3561 (const :tag "Yes" t)
3562 (const :tag "Expert" expert)))
3564 (defvar org-fast-tag-selection-include-todo nil
3565 "Non-nil means fast tags selection interface will also offer TODO states.
3566 This is an undocumented feature, you should not rely on it.")
3568 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3569 "The column to which tags should be indented in a headline.
3570 If this number is positive, it specifies the column. If it is negative,
3571 it means that the tags should be flushright to that column. For example,
3572 -80 works well for a normal 80 character screen.
3573 When 0, place tags directly after headline text, with only one space in
3574 between."
3575 :group 'org-tags
3576 :type 'integer)
3578 (defcustom org-auto-align-tags t
3579 "Non-nil keeps tags aligned when modifying headlines.
3580 Some operations (i.e. demoting) change the length of a headline and
3581 therefore shift the tags around. With this option turned on, after
3582 each such operation the tags are again aligned to `org-tags-column'."
3583 :group 'org-tags
3584 :type 'boolean)
3586 (defcustom org-use-tag-inheritance t
3587 "Non-nil means tags in levels apply also for sublevels.
3588 When nil, only the tags directly given in a specific line apply there.
3589 This may also be a list of tags that should be inherited, or a regexp that
3590 matches tags that should be inherited. Additional control is possible
3591 with the variable `org-tags-exclude-from-inheritance' which gives an
3592 explicit list of tags to be excluded from inheritance, even if the value of
3593 `org-use-tag-inheritance' would select it for inheritance.
3595 If this option is t, a match early-on in a tree can lead to a large
3596 number of matches in the subtree when constructing the agenda or creating
3597 a sparse tree. If you only want to see the first match in a tree during
3598 a search, check out the variable `org-tags-match-list-sublevels'."
3599 :group 'org-tags
3600 :type '(choice
3601 (const :tag "Not" nil)
3602 (const :tag "Always" t)
3603 (repeat :tag "Specific tags" (string :tag "Tag"))
3604 (regexp :tag "Tags matched by regexp")))
3606 (defcustom org-tags-exclude-from-inheritance nil
3607 "List of tags that should never be inherited.
3608 This is a way to exclude a few tags from inheritance. For way to do
3609 the opposite, to actively allow inheritance for selected tags,
3610 see the variable `org-use-tag-inheritance'."
3611 :group 'org-tags
3612 :type '(repeat (string :tag "Tag")))
3614 (defun org-tag-inherit-p (tag)
3615 "Check if TAG is one that should be inherited."
3616 (cond
3617 ((member tag org-tags-exclude-from-inheritance) nil)
3618 ((eq org-use-tag-inheritance t) t)
3619 ((not org-use-tag-inheritance) nil)
3620 ((stringp org-use-tag-inheritance)
3621 (string-match org-use-tag-inheritance tag))
3622 ((listp org-use-tag-inheritance)
3623 (member tag org-use-tag-inheritance))
3624 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3626 (defcustom org-tags-match-list-sublevels t
3627 "Non-nil means list also sublevels of headlines matching a search.
3628 This variable applies to tags/property searches, and also to stuck
3629 projects because this search is based on a tags match as well.
3631 When set to the symbol `indented', sublevels are indented with
3632 leading dots.
3634 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3635 the sublevels of a headline matching a tag search often also match
3636 the same search. Listing all of them can create very long lists.
3637 Setting this variable to nil causes subtrees of a match to be skipped.
3639 This variable is semi-obsolete and probably should always be true. It
3640 is better to limit inheritance to certain tags using the variables
3641 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3642 :group 'org-tags
3643 :type '(choice
3644 (const :tag "No, don't list them" nil)
3645 (const :tag "Yes, do list them" t)
3646 (const :tag "List them, indented with leading dots" indented)))
3648 (defcustom org-tags-sort-function nil
3649 "When set, tags are sorted using this function as a comparator."
3650 :group 'org-tags
3651 :type '(choice
3652 (const :tag "No sorting" nil)
3653 (const :tag "Alphabetical" string<)
3654 (const :tag "Reverse alphabetical" string>)
3655 (function :tag "Custom function" nil)))
3657 (defvar org-tags-history nil
3658 "History of minibuffer reads for tags.")
3659 (defvar org-last-tags-completion-table nil
3660 "The last used completion table for tags.")
3661 (defvar org-after-tags-change-hook nil
3662 "Hook that is run after the tags in a line have changed.")
3664 (defgroup org-properties nil
3665 "Options concerning properties in Org-mode."
3666 :tag "Org Properties"
3667 :group 'org)
3669 (defcustom org-property-format "%-10s %s"
3670 "How property key/value pairs should be formatted by `indent-line'.
3671 When `indent-line' hits a property definition, it will format the line
3672 according to this format, mainly to make sure that the values are
3673 lined-up with respect to each other."
3674 :group 'org-properties
3675 :type 'string)
3677 (defcustom org-properties-postprocess-alist nil
3678 "Alist of properties and functions to adjust inserted values.
3679 Elements of this alist must be of the form
3681 ([string] [function])
3683 where [string] must be a property name and [function] must be a
3684 lambda expression: this lambda expression must take one argument,
3685 the value to adjust, and return the new value as a string.
3687 For example, this element will allow the property \"Remaining\"
3688 to be updated wrt the relation between the \"Effort\" property
3689 and the clock summary:
3691 ((\"Remaining\" (lambda(value)
3692 (let ((clocksum (org-clock-sum-current-item))
3693 (effort (org-duration-string-to-minutes
3694 (org-entry-get (point) \"Effort\"))))
3695 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3696 :group 'org-properties
3697 :version "24.1"
3698 :type '(alist :key-type (string :tag "Property")
3699 :value-type (function :tag "Function")))
3701 (defcustom org-use-property-inheritance nil
3702 "Non-nil means properties apply also for sublevels.
3704 This setting is chiefly used during property searches. Turning it on can
3705 cause significant overhead when doing a search, which is why it is not
3706 on by default.
3708 When nil, only the properties directly given in the current entry count.
3709 When t, every property is inherited. The value may also be a list of
3710 properties that should have inheritance, or a regular expression matching
3711 properties that should be inherited.
3713 However, note that some special properties use inheritance under special
3714 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3715 and the properties ending in \"_ALL\" when they are used as descriptor
3716 for valid values of a property.
3718 Note for programmers:
3719 When querying an entry with `org-entry-get', you can control if inheritance
3720 should be used. By default, `org-entry-get' looks only at the local
3721 properties. You can request inheritance by setting the inherit argument
3722 to t (to force inheritance) or to `selective' (to respect the setting
3723 in this variable)."
3724 :group 'org-properties
3725 :type '(choice
3726 (const :tag "Not" nil)
3727 (const :tag "Always" t)
3728 (repeat :tag "Specific properties" (string :tag "Property"))
3729 (regexp :tag "Properties matched by regexp")))
3731 (defun org-property-inherit-p (property)
3732 "Check if PROPERTY is one that should be inherited."
3733 (cond
3734 ((eq org-use-property-inheritance t) t)
3735 ((not org-use-property-inheritance) nil)
3736 ((stringp org-use-property-inheritance)
3737 (string-match org-use-property-inheritance property))
3738 ((listp org-use-property-inheritance)
3739 (member property org-use-property-inheritance))
3740 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3742 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3743 "The default column format, if no other format has been defined.
3744 This variable can be set on the per-file basis by inserting a line
3746 #+COLUMNS: %25ITEM ....."
3747 :group 'org-properties
3748 :type 'string)
3750 (defcustom org-columns-ellipses ".."
3751 "The ellipses to be used when a field in column view is truncated.
3752 When this is the empty string, as many characters as possible are shown,
3753 but then there will be no visual indication that the field has been truncated.
3754 When this is a string of length N, the last N characters of a truncated
3755 field are replaced by this string. If the column is narrower than the
3756 ellipses string, only part of the ellipses string will be shown."
3757 :group 'org-properties
3758 :type 'string)
3760 (defcustom org-columns-modify-value-for-display-function nil
3761 "Function that modifies values for display in column view.
3762 For example, it can be used to cut out a certain part from a time stamp.
3763 The function must take 2 arguments:
3765 column-title The title of the column (*not* the property name)
3766 value The value that should be modified.
3768 The function should return the value that should be displayed,
3769 or nil if the normal value should be used."
3770 :group 'org-properties
3771 :type '(choice (const nil) (function)))
3773 (defconst org-global-properties-fixed
3774 '(("VISIBILITY_ALL" . "folded children content all")
3775 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3776 "List of property/value pairs that can be inherited by any entry.
3778 These are fixed values, for the preset properties. The user variable
3779 that can be used to add to this list is `org-global-properties'.
3781 The entries in this list are cons cells where the car is a property
3782 name and cdr is a string with the value. If the value represents
3783 multiple items like an \"_ALL\" property, separate the items by
3784 spaces.")
3786 (defcustom org-global-properties nil
3787 "List of property/value pairs that can be inherited by any entry.
3789 This list will be combined with the constant `org-global-properties-fixed'.
3791 The entries in this list are cons cells where the car is a property
3792 name and cdr is a string with the value.
3794 You can set buffer-local values for the same purpose in the variable
3795 `org-file-properties' this by adding lines like
3797 #+PROPERTY: NAME VALUE"
3798 :group 'org-properties
3799 :type '(repeat
3800 (cons (string :tag "Property")
3801 (string :tag "Value"))))
3803 (defvar org-file-properties nil
3804 "List of property/value pairs that can be inherited by any entry.
3805 Valid for the current buffer.
3806 This variable is populated from #+PROPERTY lines.")
3807 (make-variable-buffer-local 'org-file-properties)
3809 (defgroup org-agenda nil
3810 "Options concerning agenda views in Org-mode."
3811 :tag "Org Agenda"
3812 :group 'org)
3814 (defvar org-category nil
3815 "Variable used by org files to set a category for agenda display.
3816 Such files should use a file variable to set it, for example
3818 # -*- mode: org; org-category: \"ELisp\"
3820 or contain a special line
3822 #+CATEGORY: ELisp
3824 If the file does not specify a category, then file's base name
3825 is used instead.")
3826 (make-variable-buffer-local 'org-category)
3827 (put 'org-category 'safe-local-variable (lambda (x) (or (symbolp x) (stringp x))))
3829 (defcustom org-agenda-files nil
3830 "The files to be used for agenda display.
3831 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3832 \\[org-remove-file]. You can also use customize to edit the list.
3834 If an entry is a directory, all files in that directory that are matched by
3835 `org-agenda-file-regexp' will be part of the file list.
3837 If the value of the variable is not a list but a single file name, then
3838 the list of agenda files is actually stored and maintained in that file, one
3839 agenda file per line. In this file paths can be given relative to
3840 `org-directory'. Tilde expansion and environment variable substitution
3841 are also made."
3842 :group 'org-agenda
3843 :type '(choice
3844 (repeat :tag "List of files and directories" file)
3845 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3847 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3848 "Regular expression to match files for `org-agenda-files'.
3849 If any element in the list in that variable contains a directory instead
3850 of a normal file, all files in that directory that are matched by this
3851 regular expression will be included."
3852 :group 'org-agenda
3853 :type 'regexp)
3855 (defcustom org-agenda-text-search-extra-files nil
3856 "List of extra files to be searched by text search commands.
3857 These files will be searched in addition to the agenda files by the
3858 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3859 Note that these files will only be searched for text search commands,
3860 not for the other agenda views like todo lists, tag searches or the weekly
3861 agenda. This variable is intended to list notes and possibly archive files
3862 that should also be searched by these two commands.
3863 In fact, if the first element in the list is the symbol `agenda-archives',
3864 then all archive files of all agenda files will be added to the search
3865 scope."
3866 :group 'org-agenda
3867 :type '(set :greedy t
3868 (const :tag "Agenda Archives" agenda-archives)
3869 (repeat :inline t (file))))
3871 (org-defvaralias 'org-agenda-multi-occur-extra-files
3872 'org-agenda-text-search-extra-files)
3874 (defcustom org-agenda-skip-unavailable-files nil
3875 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3876 A nil value means to remove them, after a query, from the list."
3877 :group 'org-agenda
3878 :type 'boolean)
3880 (defcustom org-calendar-to-agenda-key [?c]
3881 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3882 The command `org-calendar-goto-agenda' will be bound to this key. The
3883 default is the character `c' because then `c' can be used to switch back and
3884 forth between agenda and calendar."
3885 :group 'org-agenda
3886 :type 'sexp)
3888 (defcustom org-calendar-insert-diary-entry-key [?i]
3889 "The key to be installed in `calendar-mode-map' for adding diary entries.
3890 This option is irrelevant until `org-agenda-diary-file' has been configured
3891 to point to an Org-mode file. When that is the case, the command
3892 `org-agenda-diary-entry' will be bound to the key given here, by default
3893 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3894 if you want to continue doing this, you need to change this to a different
3895 key."
3896 :group 'org-agenda
3897 :type 'sexp)
3899 (defcustom org-agenda-diary-file 'diary-file
3900 "File to which to add new entries with the `i' key in agenda and calendar.
3901 When this is the symbol `diary-file', the functionality in the Emacs
3902 calendar will be used to add entries to the `diary-file'. But when this
3903 points to a file, `org-agenda-diary-entry' will be used instead."
3904 :group 'org-agenda
3905 :type '(choice
3906 (const :tag "The standard Emacs diary file" diary-file)
3907 (file :tag "Special Org file diary entries")))
3909 (eval-after-load "calendar"
3910 '(progn
3911 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3912 'org-calendar-goto-agenda)
3913 (add-hook 'calendar-mode-hook
3914 (lambda ()
3915 (unless (eq org-agenda-diary-file 'diary-file)
3916 (define-key calendar-mode-map
3917 org-calendar-insert-diary-entry-key
3918 'org-agenda-diary-entry))))))
3920 (defgroup org-latex nil
3921 "Options for embedding LaTeX code into Org-mode."
3922 :tag "Org LaTeX"
3923 :group 'org)
3925 (defcustom org-format-latex-options
3926 '(:foreground default :background default :scale 1.0
3927 :html-foreground "Black" :html-background "Transparent"
3928 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3929 "Options for creating images from LaTeX fragments.
3930 This is a property list with the following properties:
3931 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3932 `default' means use the foreground of the default face.
3933 `auto' means use the foreground from the text face.
3934 :background the background color, or \"Transparent\".
3935 `default' means use the background of the default face.
3936 `auto' means use the background from the text face.
3937 :scale a scaling factor for the size of the images, to get more pixels
3938 :html-foreground, :html-background, :html-scale
3939 the same numbers for HTML export.
3940 :matchers a list indicating which matchers should be used to
3941 find LaTeX fragments. Valid members of this list are:
3942 \"begin\" find environments
3943 \"$1\" find single characters surrounded by $.$
3944 \"$\" find math expressions surrounded by $...$
3945 \"$$\" find math expressions surrounded by $$....$$
3946 \"\\(\" find math expressions surrounded by \\(...\\)
3947 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3948 :group 'org-latex
3949 :type 'plist)
3951 (defcustom org-format-latex-signal-error t
3952 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3953 When nil, just push out a message."
3954 :group 'org-latex
3955 :version "24.1"
3956 :type 'boolean)
3958 (defcustom org-latex-to-mathml-jar-file nil
3959 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3960 Use this to specify additional executable file say a jar file.
3962 When using MathToWeb as the converter, specify the full-path to
3963 your mathtoweb.jar file."
3964 :group 'org-latex
3965 :version "24.1"
3966 :type '(choice
3967 (const :tag "None" nil)
3968 (file :tag "JAR file" :must-match t)))
3970 (defcustom org-latex-to-mathml-convert-command nil
3971 "Command to convert LaTeX fragments to MathML.
3972 Replace format-specifiers in the command as noted below and use
3973 `shell-command' to convert LaTeX to MathML.
3974 %j: Executable file in fully expanded form as specified by
3975 `org-latex-to-mathml-jar-file'.
3976 %I: Input LaTeX file in fully expanded form.
3977 %i: The latex fragment to be converted.
3978 %o: Output MathML file.
3979 This command is used by `org-create-math-formula'.
3981 When using MathToWeb as the converter, set this to
3982 \"java -jar %j -unicode -force -df %o %I\".
3984 When using LaTeXML set this to
3985 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3986 :group 'org-latex
3987 :version "24.1"
3988 :type '(choice
3989 (const :tag "None" nil)
3990 (string :tag "\nShell command")))
3992 (defcustom org-latex-create-formula-image-program 'dvipng
3993 "Program to convert LaTeX fragments with.
3995 dvipng Process the LaTeX fragments to dvi file, then convert
3996 dvi files to png files using dvipng.
3997 This will also include processing of non-math environments.
3998 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3999 to convert pdf files to png files"
4000 :group 'org-latex
4001 :version "24.1"
4002 :type '(choice
4003 (const :tag "dvipng" dvipng)
4004 (const :tag "imagemagick" imagemagick)))
4006 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
4007 "Path to store latex preview images.
4008 A relative path here creates many directories relative to the
4009 processed org files paths. An absolute path puts all preview
4010 images at the same place."
4011 :group 'org-latex
4012 :version "24.3"
4013 :type 'string)
4015 (defun org-format-latex-mathml-available-p ()
4016 "Return t if `org-latex-to-mathml-convert-command' is usable."
4017 (save-match-data
4018 (when (and (boundp 'org-latex-to-mathml-convert-command)
4019 org-latex-to-mathml-convert-command)
4020 (let ((executable (car (split-string
4021 org-latex-to-mathml-convert-command))))
4022 (when (executable-find executable)
4023 (if (string-match
4024 "%j" org-latex-to-mathml-convert-command)
4025 (file-readable-p org-latex-to-mathml-jar-file)
4026 t))))))
4028 (defcustom org-format-latex-header "\\documentclass{article}
4029 \\usepackage[usenames]{color}
4030 \[PACKAGES]
4031 \[DEFAULT-PACKAGES]
4032 \\pagestyle{empty} % do not remove
4033 % The settings below are copied from fullpage.sty
4034 \\setlength{\\textwidth}{\\paperwidth}
4035 \\addtolength{\\textwidth}{-3cm}
4036 \\setlength{\\oddsidemargin}{1.5cm}
4037 \\addtolength{\\oddsidemargin}{-2.54cm}
4038 \\setlength{\\evensidemargin}{\\oddsidemargin}
4039 \\setlength{\\textheight}{\\paperheight}
4040 \\addtolength{\\textheight}{-\\headheight}
4041 \\addtolength{\\textheight}{-\\headsep}
4042 \\addtolength{\\textheight}{-\\footskip}
4043 \\addtolength{\\textheight}{-3cm}
4044 \\setlength{\\topmargin}{1.5cm}
4045 \\addtolength{\\topmargin}{-2.54cm}"
4046 "The document header used for processing LaTeX fragments.
4047 It is imperative that this header make sure that no page number
4048 appears on the page. The package defined in the variables
4049 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4050 will either replace the placeholder \"[PACKAGES]\" in this
4051 header, or they will be appended."
4052 :group 'org-latex
4053 :type 'string)
4055 (defun org-set-packages-alist (var val)
4056 "Set the packages alist and make sure it has 3 elements per entry."
4057 (set var (mapcar (lambda (x)
4058 (if (and (consp x) (= (length x) 2))
4059 (list (car x) (nth 1 x) t)
4060 x))
4061 val)))
4063 (defun org-get-packages-alist (var)
4064 "Get the packages alist and make sure it has 3 elements per entry."
4065 (mapcar (lambda (x)
4066 (if (and (consp x) (= (length x) 2))
4067 (list (car x) (nth 1 x) t)
4068 x))
4069 (default-value var)))
4071 (defcustom org-latex-default-packages-alist
4072 '(("AUTO" "inputenc" t)
4073 ("T1" "fontenc" t)
4074 ("" "fixltx2e" nil)
4075 ("" "graphicx" t)
4076 ("" "grffile" t)
4077 ("" "longtable" nil)
4078 ("" "wrapfig" nil)
4079 ("" "rotating" nil)
4080 ("normalem" "ulem" t)
4081 ("" "amsmath" t)
4082 ("" "textcomp" t)
4083 ("" "amssymb" t)
4084 ("" "capt-of" nil)
4085 ("" "hyperref" nil))
4086 "Alist of default packages to be inserted in the header.
4088 Change this only if one of the packages here causes an
4089 incompatibility with another package you are using.
4091 The packages in this list are needed by one part or another of
4092 Org mode to function properly:
4094 - inputenc, fontenc: for basic font and character selection
4095 - fixltx2e: Important patches of LaTeX itself
4096 - graphicx: for including images
4097 - grffile: allow periods and spaces in graphics file names
4098 - longtable: For multipage tables
4099 - wrapfig: for figure placement
4100 - rotating: for sideways figures and tables
4101 - ulem: for underline and strike-through
4102 - amsmath: for subscript and superscript and math environments
4103 - textcomp, amssymb: for various symbols used
4104 for interpreting the entities in `org-entities'. You can skip
4105 some of these packages if you don't use any of their symbols.
4106 - capt-of: for captions outside of floats
4107 - hyperref: for cross references
4109 Therefore you should not modify this variable unless you know
4110 what you are doing. The one reason to change it anyway is that
4111 you might be loading some other package that conflicts with one
4112 of the default packages. Each element is either a cell or
4113 a string.
4115 A cell is of the format
4117 \(\"options\" \"package\" SNIPPET-FLAG)
4119 If SNIPPET-FLAG is non-nil, the package also needs to be included
4120 when compiling LaTeX snippets into images for inclusion into
4121 non-LaTeX output.
4123 A string will be inserted as-is in the header of the document."
4124 :group 'org-latex
4125 :group 'org-export-latex
4126 :set 'org-set-packages-alist
4127 :get 'org-get-packages-alist
4128 :version "25.1"
4129 :package-version '(Org . "8.3")
4130 :type '(repeat
4131 (choice
4132 (list :tag "options/package pair"
4133 (string :tag "options")
4134 (string :tag "package")
4135 (boolean :tag "Snippet"))
4136 (string :tag "A line of LaTeX"))))
4138 (defcustom org-latex-packages-alist nil
4139 "Alist of packages to be inserted in every LaTeX header.
4141 These will be inserted after `org-latex-default-packages-alist'.
4142 Each element is either a cell or a string.
4144 A cell is of the format:
4146 \(\"options\" \"package\" SNIPPET-FLAG)
4148 SNIPPET-FLAG, when non-nil, indicates that this package is also
4149 needed when turning LaTeX snippets into images for inclusion into
4150 non-LaTeX output.
4152 A string will be inserted as-is in the header of the document.
4154 Make sure that you only list packages here which:
4156 - you want in every file;
4157 - do not conflict with the setup in `org-format-latex-header';
4158 - do not conflict with the default packages in
4159 `org-latex-default-packages-alist'."
4160 :group 'org-latex
4161 :group 'org-export-latex
4162 :set 'org-set-packages-alist
4163 :get 'org-get-packages-alist
4164 :type '(repeat
4165 (choice
4166 (list :tag "options/package pair"
4167 (string :tag "options")
4168 (string :tag "package")
4169 (boolean :tag "Snippet"))
4170 (string :tag "A line of LaTeX"))))
4172 (defgroup org-appearance nil
4173 "Settings for Org-mode appearance."
4174 :tag "Org Appearance"
4175 :group 'org)
4177 (defcustom org-level-color-stars-only nil
4178 "Non-nil means fontify only the stars in each headline.
4179 When nil, the entire headline is fontified.
4180 Changing it requires restart of `font-lock-mode' to become effective
4181 also in regions already fontified."
4182 :group 'org-appearance
4183 :type 'boolean)
4185 (defcustom org-hide-leading-stars nil
4186 "Non-nil means hide the first N-1 stars in a headline.
4187 This works by using the face `org-hide' for these stars. This
4188 face is white for a light background, and black for a dark
4189 background. You may have to customize the face `org-hide' to
4190 make this work.
4191 Changing it requires restart of `font-lock-mode' to become effective
4192 also in regions already fontified.
4193 You may also set this on a per-file basis by adding one of the following
4194 lines to the buffer:
4196 #+STARTUP: hidestars
4197 #+STARTUP: showstars"
4198 :group 'org-appearance
4199 :type 'boolean)
4201 (defcustom org-hidden-keywords nil
4202 "List of symbols corresponding to keywords to be hidden the org buffer.
4203 For example, a value '(title) for this list will make the document's title
4204 appear in the buffer without the initial #+TITLE: keyword."
4205 :group 'org-appearance
4206 :version "24.1"
4207 :type '(set (const :tag "#+AUTHOR" author)
4208 (const :tag "#+DATE" date)
4209 (const :tag "#+EMAIL" email)
4210 (const :tag "#+TITLE" title)))
4212 (defcustom org-custom-properties nil
4213 "List of properties (as strings) with a special meaning.
4214 The default use of these custom properties is to let the user
4215 hide them with `org-toggle-custom-properties-visibility'."
4216 :group 'org-properties
4217 :group 'org-appearance
4218 :version "24.3"
4219 :type '(repeat (string :tag "Property Name")))
4221 (defcustom org-fontify-done-headline nil
4222 "Non-nil means change the face of a headline if it is marked DONE.
4223 Normally, only the TODO/DONE keyword indicates the state of a headline.
4224 When this is non-nil, the headline after the keyword is set to the
4225 `org-headline-done' as an additional indication."
4226 :group 'org-appearance
4227 :type 'boolean)
4229 (defcustom org-fontify-emphasized-text t
4230 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4231 Changing this variable requires a restart of Emacs to take effect."
4232 :group 'org-appearance
4233 :type 'boolean)
4235 (defcustom org-fontify-whole-heading-line nil
4236 "Non-nil means fontify the whole line for headings.
4237 This is useful when setting a background color for the
4238 org-level-* faces."
4239 :group 'org-appearance
4240 :type 'boolean)
4242 (defcustom org-highlight-latex-and-related nil
4243 "Non-nil means highlight LaTeX related syntax in the buffer.
4244 When non nil, the value should be a list containing any of the
4245 following symbols:
4246 `latex' Highlight LaTeX snippets and environments.
4247 `script' Highlight subscript and superscript.
4248 `entities' Highlight entities."
4249 :group 'org-appearance
4250 :version "24.4"
4251 :package-version '(Org . "8.0")
4252 :type '(choice
4253 (const :tag "No highlighting" nil)
4254 (set :greedy t :tag "Highlight"
4255 (const :tag "LaTeX snippets and environments" latex)
4256 (const :tag "Subscript and superscript" script)
4257 (const :tag "Entities" entities))))
4259 (defcustom org-hide-emphasis-markers nil
4260 "Non-nil mean font-lock should hide the emphasis marker characters."
4261 :group 'org-appearance
4262 :type 'boolean)
4264 (defcustom org-hide-macro-markers nil
4265 "Non-nil mean font-lock should hide the brackets marking macro calls."
4266 :group 'org-appearance
4267 :type 'boolean)
4269 (defcustom org-pretty-entities nil
4270 "Non-nil means show entities as UTF8 characters.
4271 When nil, the \\name form remains in the buffer."
4272 :group 'org-appearance
4273 :version "24.1"
4274 :type 'boolean)
4276 (defcustom org-pretty-entities-include-sub-superscripts t
4277 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4278 :group 'org-appearance
4279 :version "24.1"
4280 :type 'boolean)
4282 (defvar org-emph-re nil
4283 "Regular expression for matching emphasis.
4284 After a match, the match groups contain these elements:
4285 0 The match of the full regular expression, including the characters
4286 before and after the proper match
4287 1 The character before the proper match, or empty at beginning of line
4288 2 The proper match, including the leading and trailing markers
4289 3 The leading marker like * or /, indicating the type of highlighting
4290 4 The text between the emphasis markers, not including the markers
4291 5 The character after the match, empty at the end of a line")
4292 (defvar org-verbatim-re nil
4293 "Regular expression for matching verbatim text.")
4294 (defvar org-emphasis-regexp-components) ; defined just below
4295 (defvar org-emphasis-alist) ; defined just below
4296 (defun org-set-emph-re (var val)
4297 "Set variable and compute the emphasis regular expression."
4298 (set var val)
4299 (when (and (boundp 'org-emphasis-alist)
4300 (boundp 'org-emphasis-regexp-components)
4301 org-emphasis-alist org-emphasis-regexp-components)
4302 (let* ((e org-emphasis-regexp-components)
4303 (pre (car e))
4304 (post (nth 1 e))
4305 (border (nth 2 e))
4306 (body (nth 3 e))
4307 (nl (nth 4 e))
4308 (body1 (concat body "*?"))
4309 (markers (mapconcat 'car org-emphasis-alist ""))
4310 (vmarkers (mapconcat
4311 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4312 org-emphasis-alist "")))
4313 ;; make sure special characters appear at the right position in the class
4314 (if (string-match "\\^" markers)
4315 (setq markers (concat (replace-match "" t t markers) "^")))
4316 (if (string-match "-" markers)
4317 (setq markers (concat (replace-match "" t t markers) "-")))
4318 (if (string-match "\\^" vmarkers)
4319 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4320 (if (string-match "-" vmarkers)
4321 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4322 (if (> nl 0)
4323 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4324 (int-to-string nl) "\\}")))
4325 ;; Make the regexp
4326 (setq org-emph-re
4327 (concat "\\([" pre "]\\|^\\)"
4328 "\\("
4329 "\\([" markers "]\\)"
4330 "\\("
4331 "[^" border "]\\|"
4332 "[^" border "]"
4333 body1
4334 "[^" border "]"
4335 "\\)"
4336 "\\3\\)"
4337 "\\([" post "]\\|$\\)"))
4338 (setq org-verbatim-re
4339 (concat "\\([" pre "]\\|^\\)"
4340 "\\("
4341 "\\([" vmarkers "]\\)"
4342 "\\("
4343 "[^" border "]\\|"
4344 "[^" border "]"
4345 body1
4346 "[^" border "]"
4347 "\\)"
4348 "\\3\\)"
4349 "\\([" post "]\\|$\\)")))))
4351 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4352 ;; set this option proved cumbersome. See this message/thread:
4353 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4354 (defvar org-emphasis-regexp-components
4355 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4356 "Components used to build the regular expression for emphasis.
4357 This is a list with five entries. Terminology: In an emphasis string
4358 like \" *strong word* \", we call the initial space PREMATCH, the final
4359 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4360 and \"trong wor\" is the body. The different components in this variable
4361 specify what is allowed/forbidden in each part:
4363 pre Chars allowed as prematch. Beginning of line will be allowed too.
4364 post Chars allowed as postmatch. End of line will be allowed too.
4365 border The chars *forbidden* as border characters.
4366 body-regexp A regexp like \".\" to match a body character. Don't use
4367 non-shy groups here, and don't allow newline here.
4368 newline The maximum number of newlines allowed in an emphasis exp.
4370 You need to reload Org or to restart Emacs after customizing this.")
4372 (defcustom org-emphasis-alist
4373 `(("*" bold)
4374 ("/" italic)
4375 ("_" underline)
4376 ("=" org-verbatim verbatim)
4377 ("~" org-code verbatim)
4378 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4379 "Alist of characters and faces to emphasize text.
4380 Text starting and ending with a special character will be emphasized,
4381 for example *bold*, _underlined_ and /italic/. This variable sets the
4382 marker characters and the face to be used by font-lock for highlighting
4383 in Org-mode Emacs buffers.
4385 You need to reload Org or to restart Emacs after customizing this."
4386 :group 'org-appearance
4387 :set 'org-set-emph-re
4388 :version "24.4"
4389 :package-version '(Org . "8.0")
4390 :type '(repeat
4391 (list
4392 (string :tag "Marker character")
4393 (choice
4394 (face :tag "Font-lock-face")
4395 (plist :tag "Face property list"))
4396 (option (const verbatim)))))
4398 (defvar org-protecting-blocks
4399 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4400 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4401 This is needed for font-lock setup.")
4403 ;;; Miscellaneous options
4405 (defgroup org-completion nil
4406 "Completion in Org-mode."
4407 :tag "Org Completion"
4408 :group 'org)
4410 (defcustom org-completion-use-ido nil
4411 "Non-nil means use ido completion wherever possible.
4412 Note that `ido-mode' must be active for this variable to be relevant.
4413 If you decide to turn this variable on, you might well want to turn off
4414 `org-outline-path-complete-in-steps'.
4415 See also `org-completion-use-iswitchb'."
4416 :group 'org-completion
4417 :type 'boolean)
4419 (defcustom org-completion-use-iswitchb nil
4420 "Non-nil means use iswitchb completion wherever possible.
4421 Note that `iswitchb-mode' must be active for this variable to be relevant.
4422 If you decide to turn this variable on, you might well want to turn off
4423 `org-outline-path-complete-in-steps'.
4424 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4425 :group 'org-completion
4426 :type 'boolean)
4428 (defcustom org-completion-fallback-command 'hippie-expand
4429 "The expansion command called by \\[pcomplete] in normal context.
4430 Normal means, no org-mode-specific context."
4431 :group 'org-completion
4432 :type 'function)
4434 ;;; Functions and variables from their packages
4435 ;; Declared here to avoid compiler warnings
4437 ;; XEmacs only
4438 (defvar outline-mode-menu-heading)
4439 (defvar outline-mode-menu-show)
4440 (defvar outline-mode-menu-hide)
4441 (defvar zmacs-regions) ; XEmacs regions
4443 ;; Emacs only
4444 (defvar mark-active)
4446 ;; Various packages
4447 (declare-function calendar-iso-to-absolute "cal-iso" (date))
4448 (declare-function calendar-forward-day "cal-move" (arg))
4449 (declare-function calendar-goto-date "cal-move" (date))
4450 (declare-function calendar-goto-today "cal-move" ())
4451 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4452 (defvar calc-embedded-close-formula)
4453 (defvar calc-embedded-open-formula)
4454 (declare-function cdlatex-tab "ext:cdlatex" ())
4455 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4456 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4457 (defvar font-lock-unfontify-region-function)
4458 (declare-function iswitchb-read-buffer "iswitchb"
4459 (prompt &optional default require-match start matches-set))
4460 (defvar iswitchb-temp-buflist)
4461 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4462 (defvar org-agenda-tags-todo-honor-ignore-options)
4463 (declare-function org-agenda-skip "org-agenda" ())
4464 (declare-function
4465 org-agenda-format-item "org-agenda"
4466 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4467 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4468 (declare-function org-agenda-change-all-lines "org-agenda"
4469 (newhead hdmarker &optional fixface just-this))
4470 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4471 (declare-function org-agenda-maybe-redo "org-agenda" ())
4472 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4473 (beg end))
4474 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4475 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4476 "org-agenda" (&optional end))
4477 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4478 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4479 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4480 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4481 (declare-function org-indent-mode "org-indent" (&optional arg))
4482 (declare-function parse-time-string "parse-time" (string))
4483 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4484 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4485 (defvar remember-data-file)
4486 (defvar texmathp-why)
4487 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4488 (declare-function table--at-cell-p "table" (position &optional object at-column))
4489 (declare-function calc-eval "calc" (str &optional separator &rest args))
4491 ;;;###autoload
4492 (defun turn-on-orgtbl ()
4493 "Unconditionally turn on `orgtbl-mode'."
4494 (require 'org-table)
4495 (orgtbl-mode 1))
4497 (defun org-at-table-p (&optional table-type)
4498 "Non-nil if the cursor is inside an Org table.
4499 If TABLE-TYPE is non-nil, also check for table.el-type tables.
4500 If `org-enable-table-editor' is nil, return nil unconditionally."
4501 (and org-enable-table-editor
4502 (save-excursion
4503 (beginning-of-line)
4504 (org-looking-at-p (if table-type "[ \t]*[|+]" "[ \t]*|")))
4505 (let ((element (org-element-lineage (org-element-at-point) '(table) t)))
4506 (and element
4507 (or table-type (eq (org-element-property :type element) 'org))))))
4508 (defsubst org-table-p () (org-at-table-p))
4510 (defun org-at-table.el-p ()
4511 "Non-nil when point is at a table.el table."
4512 (and (save-excursion (beginning-of-line) (looking-at "[ \t]*[|+]"))
4513 (let ((element (org-element-at-point)))
4514 (and (eq (org-element-type element) 'table)
4515 (eq (org-element-property :type element) 'table.el)))))
4517 (defun org-table-recognize-table.el ()
4518 "If there is a table.el table nearby, recognize it and move into it."
4519 (when (and org-table-tab-recognizes-table.el (org-at-table.el-p))
4520 (beginning-of-line)
4521 (unless (or (looking-at org-table-dataline-regexp)
4522 (not (looking-at org-table1-hline-regexp)))
4523 (forward-line)
4524 (when (looking-at org-table-any-border-regexp)
4525 (forward-line -2)))
4526 (if (re-search-forward "|" (org-table-end t) t)
4527 (progn
4528 (require 'table)
4529 (if (table--at-cell-p (point)) t
4530 (message "recognizing table.el table...")
4531 (table-recognize-table)
4532 (message "recognizing table.el table...done")))
4533 (error "This should not happen"))))
4535 (defun org-at-table-hline-p ()
4536 "Non-nil when point is inside a hline in a table.
4537 Assume point is already in a table. If `org-enable-table-editor'
4538 is nil, return nil unconditionally."
4539 (and org-enable-table-editor
4540 (save-excursion
4541 (beginning-of-line)
4542 (looking-at org-table-hline-regexp))))
4544 (defun org-table-map-tables (function &optional quietly)
4545 "Apply FUNCTION to the start of all tables in the buffer."
4546 (save-excursion
4547 (save-restriction
4548 (widen)
4549 (goto-char (point-min))
4550 (while (re-search-forward org-table-any-line-regexp nil t)
4551 (unless quietly
4552 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4553 (beginning-of-line 1)
4554 (when (and (looking-at org-table-line-regexp)
4555 ;; Exclude tables in src/example/verbatim/clocktable blocks
4556 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4557 (save-excursion (funcall function))
4558 (or (looking-at org-table-line-regexp)
4559 (forward-char 1)))
4560 (re-search-forward org-table-any-border-regexp nil 1))))
4561 (unless quietly (message "Mapping tables: done")))
4563 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4564 (declare-function org-clock-update-mode-line "org-clock" ())
4565 (declare-function org-resolve-clocks "org-clock"
4566 (&optional also-non-dangling-p prompt last-valid))
4568 (defun org-at-TBLFM-p (&optional pos)
4569 "Non-nil when point (or POS) is in #+TBLFM line."
4570 (save-excursion
4571 (goto-char (or pos (point)))
4572 (beginning-of-line)
4573 (and (eq (org-element-type (org-element-at-point)) 'table)
4574 (looking-at org-TBLFM-regexp))))
4576 (defvar org-clock-start-time)
4577 (defvar org-clock-marker (make-marker)
4578 "Marker recording the last clock-in.")
4579 (defvar org-clock-hd-marker (make-marker)
4580 "Marker recording the last clock-in, but the headline position.")
4581 (defvar org-clock-heading ""
4582 "The heading of the current clock entry.")
4583 (defun org-clock-is-active ()
4584 "Return the buffer where the clock is currently running.
4585 Return nil if no clock is running."
4586 (marker-buffer org-clock-marker))
4588 (defun org-check-running-clock ()
4589 "Check if the current buffer contains the running clock.
4590 If yes, offer to stop it and to save the buffer with the changes."
4591 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4592 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4593 (buffer-name))))
4594 (org-clock-out)
4595 (when (y-or-n-p "Save changed buffer?")
4596 (save-buffer))))
4598 (defun org-clocktable-try-shift (dir n)
4599 "Check if this line starts a clock table, if yes, shift the time block."
4600 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4601 (org-clocktable-shift dir n)))
4603 ;;;###autoload
4604 (defun org-clock-persistence-insinuate ()
4605 "Set up hooks for clock persistence."
4606 (require 'org-clock)