New customization variable: Loop over headlines in active region
[org-mode.git] / lisp / org.el
1 ;;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4 ;;
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Maintainer: Bastien Guerry <bzg at gnu dot org>
7 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; Homepage: http://orgmode.org
9 ;; Version: 7.7
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.
17
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.
22
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 ;;
27 ;;; Commentary:
28 ;;
29 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
30 ;; project planning with a fast and effective plain-text system.
31 ;;
32 ;; Org-mode develops organizational tasks around NOTES files that contain
33 ;; information about projects as plain text.  Org-mode is implemented on
34 ;; top of outline-mode, which makes it possible to keep the content of
35 ;; large files well structured.  Visibility cycling and structure editing
36 ;; help to work with the tree.  Tables are easily created with a built-in
37 ;; table editor.  Org-mode supports ToDo items, deadlines, time stamps,
38 ;; and scheduling.  It dynamically compiles entries into an agenda that
39 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
40 ;; Plain text URL-like links connect to websites, emails, Usenet
41 ;; messages, BBDB entries, and any files related to the projects.  For
42 ;; printing and sharing of notes, an Org-mode file can be exported as a
43 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
44 ;; iCalendar file.  It can also serve as a publishing tool for a set of
45 ;; linked webpages.
46 ;;
47 ;; Installation and Activation
48 ;; ---------------------------
49 ;; See the corresponding sections in the manual at
50 ;;
51 ;;   http://orgmode.org/org.html#Installation
52 ;;
53 ;; Documentation
54 ;; -------------
55 ;; The documentation of Org-mode can be found in the TeXInfo file.  The
56 ;; distribution also contains a PDF version of it.  At the homepage of
57 ;; Org-mode, you can read the same text online as HTML.  There is also an
58 ;; excellent reference card made by Philip Rooke.  This card can be found
59 ;; in the etc/ directory of Emacs 22.
60 ;;
61 ;; A list of recent changes can be found at
62 ;; http://orgmode.org/Changes.html
63 ;;
64 ;;; Code:
65
66 (defvar org-inhibit-highlight-removal nil) ; dynamically scoped param
67 (defvar org-table-formula-constants-local nil
68   "Local version of `org-table-formula-constants'.")
69 (make-variable-buffer-local 'org-table-formula-constants-local)
70
71 ;;;; Require other packages
72
73 (eval-when-compile
74   (require 'cl)
75   (require 'gnus-sum))
76
77 (require 'calendar)
78
79 ;; Emacs 22 calendar compatibility:  Make sure the new variables are available
80 (when (fboundp 'defvaralias)
81   (unless (boundp 'calendar-view-holidays-initially-flag)
82     (defvaralias 'calendar-view-holidays-initially-flag
83       'view-calendar-holidays-initially))
84   (unless (boundp 'calendar-view-diary-initially-flag)
85     (defvaralias 'calendar-view-diary-initially-flag
86       'view-diary-entries-initially))
87   (unless (boundp 'diary-fancy-buffer)
88     (defvaralias 'diary-fancy-buffer 'fancy-diary-buffer)))
89
90 (require 'outline) (require 'noutline)
91 ;; Other stuff we need.
92 (require 'time-date)
93 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
94 (require 'easymenu)
95 (require 'overlay)
96
97 (require 'org-macs)
98 (require 'org-entities)
99 (require 'org-compat)
100 (require 'org-faces)
101 (require 'org-list)
102 (require 'org-pcomplete)
103 (require 'org-src)
104 (require 'org-footnote)
105
106 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
107 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
108 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
109 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
110 (declare-function org-at-clock-log-p "org-clock" ())
111 (declare-function org-clock-timestamps-up "org-clock" ())
112 (declare-function org-clock-timestamps-down "org-clock" ())
113
114 ;; babel
115 (require 'ob)
116 (require 'ob-table)
117 (require 'ob-lob)
118 (require 'ob-ref)
119 (require 'ob-tangle)
120 (require 'ob-comint)
121 (require 'ob-keys)
122
123 ;; load languages based on value of `org-babel-load-languages'
124 (defvar org-babel-load-languages)
125 ;;;###autoload
126 (defun org-babel-do-load-languages (sym value)
127   "Load the languages defined in `org-babel-load-languages'."
128   (set-default sym value)
129   (mapc (lambda (pair)
130           (let ((active (cdr pair)) (lang (symbol-name (car pair))))
131             (if active
132                 (progn
133                   (require (intern (concat "ob-" lang))))
134               (progn
135                 (funcall 'fmakunbound
136                          (intern (concat "org-babel-execute:" lang)))
137                 (funcall 'fmakunbound
138                          (intern (concat "org-babel-expand-body:" lang)))))))
139         org-babel-load-languages))
140
141 (defcustom org-babel-load-languages '((emacs-lisp . t))
142   "Languages which can be evaluated in Org-mode buffers.
143 This list can be used to load support for any of the languages
144 below, note that each language will depend on a different set of
145 system executables and/or Emacs modes.  When a language is
146 \"loaded\", then code blocks in that language can be evaluated
147 with `org-babel-execute-src-block' bound by default to C-c
148 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
149 be set to remove code block evaluation from the C-c C-c
150 keybinding.  By default only Emacs Lisp (which has no
151 requirements) is loaded."
152   :group 'org-babel
153   :set 'org-babel-do-load-languages
154   :type '(alist :tag "Babel Languages"
155                 :key-type
156                 (choice
157                  (const :tag "Awk" awk)
158                  (const :tag "C" C)
159                  (const :tag "R" R)
160                  (const :tag "Asymptote" asymptote)
161                  (const :tag "Calc" calc)
162                  (const :tag "Clojure" clojure)
163                  (const :tag "CSS" css)
164                  (const :tag "Ditaa" ditaa)
165                  (const :tag "Dot" dot)
166                  (const :tag "Emacs Lisp" emacs-lisp)
167                  (const :tag "Gnuplot" gnuplot)
168                  (const :tag "Haskell" haskell)
169                  (const :tag "Java" java)
170                  (const :tag "Javascript" js)
171                  (const :tag "Latex" latex)
172                  (const :tag "Ledger" ledger)
173                  (const :tag "Lilypond" lilypond)
174                  (const :tag "Maxima" maxima)
175                  (const :tag "Matlab" matlab)
176                  (const :tag "Mscgen" mscgen)
177                  (const :tag "Ocaml" ocaml)
178                  (const :tag "Octave" octave)
179                  (const :tag "Org" org)
180                  (const :tag "Perl" perl)
181                  (const :tag "PlantUML" plantuml)
182                  (const :tag "Python" python)
183                  (const :tag "Ruby" ruby)
184                  (const :tag "Sass" sass)
185                  (const :tag "Scheme" scheme)
186                  (const :tag "Screen" screen)
187                  (const :tag "Shell Script" sh)
188                  (const :tag "Shen" shen)
189                  (const :tag "Sql" sql)
190                  (const :tag "Sqlite" sqlite))
191                 :value-type (boolean :tag "Activate" :value t)))
192
193 ;;;; Customization variables
194 (defcustom org-clone-delete-id nil
195   "Remove ID property of clones of a subtree.
196 When non-nil, clones of a subtree don't inherit the ID property.
197 Otherwise they inherit the ID property with a new unique
198 identifier."
199   :type 'boolean
200   :group 'org-id)
201
202 ;;; Version
203
204 (defconst org-version "7.7"
205   "The version number of the file org.el.")
206
207 (defun org-version (&optional here)
208   "Show the org-mode version in the echo area.
209 With prefix arg HERE, insert it at point."
210   (interactive "P")
211   (let* ((origin default-directory)
212          (version org-version)
213          (git-version)
214          (dir (concat (file-name-directory (locate-library "org")) "../" )))
215     (when (and (file-exists-p (expand-file-name ".git" dir))
216                (executable-find "git"))
217       (unwind-protect
218           (progn
219             (cd dir)
220             (when (eql 0 (shell-command "git describe --abbrev=4 HEAD"))
221               (with-current-buffer "*Shell Command Output*"
222                 (goto-char (point-min))
223                 (setq git-version (buffer-substring (point) (point-at-eol))))
224               (subst-char-in-string ?- ?. git-version t)
225               (when (string-match "\\S-"
226                                   (shell-command-to-string
227                                    "git diff-index --name-only HEAD --"))
228                 (setq git-version (concat git-version ".dirty")))
229               (setq version (concat version " (" git-version ")"))))
230         (cd origin)))
231     (setq version (format "Org-mode version %s" version))
232     (if here (insert version))
233     (message version)))
234
235 ;;; Compatibility constants
236
237 ;;; The custom variables
238
239 (defgroup org nil
240   "Outline-based notes management and organizer."
241   :tag "Org"
242   :group 'outlines
243   :group 'calendar)
244
245 (defcustom org-mode-hook nil
246   "Mode hook for Org-mode, run after the mode was turned on."
247   :group 'org
248   :type 'hook)
249
250 (defcustom org-load-hook nil
251   "Hook that is run after org.el has been loaded."
252   :group 'org
253   :type 'hook)
254
255 (defcustom org-log-buffer-setup-hook nil
256   "Hook that is run after an Org log buffer is created."
257   :group 'org
258   :type 'hook)
259
260 (defvar org-modules)  ; defined below
261 (defvar org-modules-loaded nil
262   "Have the modules been loaded already?")
263
264 (defun org-load-modules-maybe (&optional force)
265   "Load all extensions listed in `org-modules'."
266   (when (or force (not org-modules-loaded))
267     (mapc (lambda (ext)
268             (condition-case nil (require ext)
269               (error (message "Problems while trying to load feature `%s'" ext))))
270           org-modules)
271     (setq org-modules-loaded t)))
272
273 (defun org-set-modules (var value)
274   "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
275   (set var value)
276   (when (featurep 'org)
277     (org-load-modules-maybe 'force)))
278
279 (when (org-bound-and-true-p org-modules)
280   (let ((a (member 'org-infojs org-modules)))
281     (and a (setcar a 'org-jsinfo))))
282
283 (defcustom org-modules '(org-bbdb org-bibtex org-docview org-gnus org-info org-jsinfo org-irc org-mew org-mhe org-rmail org-vm org-w3m org-wl)
284   "Modules that should always be loaded together with org.el.
285 If a description starts with <C>, the file is not part of Emacs
286 and loading it will require that you have downloaded and properly installed
287 the org-mode distribution.
288
289 You can also use this system to load external packages (i.e. neither Org
290 core modules, nor modules from the CONTRIB directory).  Just add symbols
291 to the end of the list.  If the package is called org-xyz.el, then you need
292 to add the symbol `xyz', and the package must have a call to
293
294    (provide 'org-xyz)"
295   :group 'org
296   :set 'org-set-modules
297   :type
298   '(set :greedy t
299         (const :tag "   bbdb:              Links to BBDB entries" org-bbdb)
300         (const :tag "   bibtex:            Links to BibTeX entries" org-bibtex)
301         (const :tag "   crypt:             Encryption of subtrees" org-crypt)
302         (const :tag "   ctags:             Access to Emacs tags with links" org-ctags)
303         (const :tag "   docview:           Links to doc-view buffers" org-docview)
304         (const :tag "   gnus:              Links to GNUS folders/messages" org-gnus)
305         (const :tag "   id:                Global IDs for identifying entries" org-id)
306         (const :tag "   info:              Links to Info nodes" org-info)
307         (const :tag "   jsinfo:            Set up Sebastian Rose's JavaScript org-info.js" org-jsinfo)
308         (const :tag "   habit:             Track your consistency with habits" org-habit)
309         (const :tag "   inlinetask:        Tasks independent of outline hierarchy" org-inlinetask)
310         (const :tag "   irc:               Links to IRC/ERC chat sessions" org-irc)
311         (const :tag "   mac-message:       Links to messages in Apple Mail" org-mac-message)
312         (const :tag "   mew                Links to Mew folders/messages" org-mew)
313         (const :tag "   mhe:               Links to MHE folders/messages" org-mhe)
314         (const :tag "   protocol:          Intercept calls from emacsclient" org-protocol)
315         (const :tag "   rmail:             Links to RMAIL folders/messages" org-rmail)
316         (const :tag "   special-blocks:    Turn blocks into LaTeX envs and HTML divs" org-special-blocks)
317         (const :tag "   vm:                Links to VM folders/messages" org-vm)
318         (const :tag "   wl:                Links to Wanderlust folders/messages" org-wl)
319         (const :tag "   w3m:               Special cut/paste from w3m to Org-mode." org-w3m)
320         (const :tag "   mouse:             Additional mouse support" org-mouse)
321         (const :tag "   TaskJuggler:       Export tasks to a TaskJuggler project" org-taskjuggler)
322
323         (const :tag "C  annotate-file:     Annotate a file with org syntax" org-annotate-file)
324         (const :tag "C  bookmark:          Org-mode links to bookmarks" org-bookmark)
325         (const :tag "C  checklist:         Extra functions for checklists in repeated tasks" org-checklist)
326         (const :tag "C  choose:            Use TODO keywords to mark decisions states" org-choose)
327         (const :tag "C  collector:         Collect properties into tables" org-collector)
328         (const :tag "C  depend:            TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
329         (const :tag "C  drill:             Flashcards and spaced repetition for Org-mode" org-drill)
330         (const :tag "C  elisp-symbol:      Org-mode links to emacs-lisp symbols" org-elisp-symbol)
331         (const :tag "C  eshell             Support for links to working directories in eshell" org-eshell)
332         (const :tag "C  eval:              Include command output as text" org-eval)
333         (const :tag "C  eval-light:        Evaluate inbuffer-code on demand" org-eval-light)
334         (const :tag "C  expiry:            Expiry mechanism for Org-mode entries" org-expiry)
335         (const :tag "C  exp-bibtex:        Export citations using BibTeX" org-exp-bibtex)
336         (const :tag "C  git-link:          Provide org links to specific file version" org-git-link)
337         (const :tag "C  interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
338
339         (const :tag "C  invoice:           Help manage client invoices in Org-mode" org-invoice)
340
341         (const :tag "C  jira:              Add a jira:ticket protocol to Org-mode" org-jira)
342         (const :tag "C  learn:             SuperMemo's incremental learning algorithm" org-learn)
343         (const :tag "C  mairix:            Hook mairix search into Org-mode for different MUAs" org-mairix)
344         (const :tag "C  notmuch:           Provide org links to notmuch searches or messages" org-notmuch)
345         (const :tag "C  mac-iCal           Imports events from iCal.app to the Emacs diary" org-mac-iCal)
346         (const :tag "C  mac-link-grabber   Grab links and URLs from various Mac applications" org-mac-link-grabber)
347         (const :tag "C  man:               Support for links to manpages in Org-mode" org-man)
348         (const :tag "C  mtags:             Support for muse-like tags" org-mtags)
349         (const :tag "C  odt:               OpenDocumentText exporter for Org-mode" org-odt)
350         (const :tag "C  panel:             Simple routines for us with bad memory" org-panel)
351         (const :tag "C  registry:          A registry for Org-mode links" org-registry)
352         (const :tag "C  org2rem:           Convert org appointments into reminders" org2rem)
353         (const :tag "C  screen:            Visit screen sessions through Org-mode links" org-screen)
354         (const :tag "C  secretary:         Team management with org-mode" org-secretary)
355         (const :tag "C  sqlinsert:         Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
356         (const :tag "C  toc:               Table of contents for Org-mode buffer" org-toc)
357         (const :tag "C  track:             Keep up with Org-mode development" org-track)
358         (const :tag "C  velocity           Something like Notational Velocity for Org" org-velocity)
359         (const :tag "C  wikinodes:         CamelCase wiki-like links" org-wikinodes)
360         (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
361
362 (defcustom org-support-shift-select nil
363   "Non-nil means make shift-cursor commands select text when possible.
364
365 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
366 start selecting a region, or enlarge regions started in this way.
367 In Org-mode, in special contexts, these same keys are used for
368 other purposes, important enough to compete with shift selection.
369 Org tries to balance these needs by supporting `shift-select-mode'
370 outside these special contexts, under control of this variable.
371
372 The default of this variable is nil, to avoid confusing behavior.  Shifted
373 cursor keys will then execute Org commands in the following contexts:
374 - on a headline, changing TODO state (left/right) and priority (up/down)
375 - on a time stamp, changing the time
376 - in a plain list item, changing the bullet type
377 - in a property definition line, switching between allowed values
378 - in the BEGIN line of a clock table (changing the time block).
379 Outside these contexts, the commands will throw an error.
380
381 When this variable is t and the cursor is not in a special
382 context, Org-mode will support shift-selection for making and
383 enlarging regions.  To make this more effective, the bullet
384 cycling will no longer happen anywhere in an item line, but only
385 if the cursor is exactly on the bullet.
386
387 If you set this variable to the symbol `always', then the keys
388 will not be special in headlines, property lines, and item lines,
389 to make shift selection work there as well.  If this is what you
390 want, you can use the following alternative commands: `C-c C-t'
391 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
392 can be used to switch TODO sets, `C-c -' to cycle item bullet
393 types, and properties can be edited by hand or in column view.
394
395 However, when the cursor is on a timestamp, shift-cursor commands
396 will still edit the time stamp - this is just too good to give up.
397
398 XEmacs user should have this variable set to nil, because
399 `shift-select-mode' is in Emacs 23 or later only."
400   :group 'org
401   :type '(choice
402           (const :tag "Never" nil)
403           (const :tag "When outside special context" t)
404           (const :tag "Everywhere except timestamps" always)))
405
406 (defcustom org-loop-over-headlines-in-active-region nil
407   "Shall some commands act upon headlines in the active region?
408
409 When set to `t', some commands will be performed in all headlines
410 within the active region.
411
412 When set to a string, those commands will be performed on the
413 matching headlines within the active region.  Such string must be
414 a tags/property/todo match as it is used in the agenda tags view.
415
416 The list of commands is:
417 - `org-schedule'
418 - `org-deadline'"
419   :type '(choice (const :tag "Don't loop" nil)
420                  (const :tag "All headlines in active region" t)
421                  (string :tag "Tags/Property/Todo matcher"))
422   :group 'org-todo
423   :group 'org-archive)
424
425 (defgroup org-startup nil
426   "Options concerning startup of Org-mode."
427   :tag "Org Startup"
428   :group 'org)
429
430 (defcustom org-startup-folded t
431   "Non-nil means entering Org-mode will switch to OVERVIEW.
432 This can also be configured on a per-file basis by adding one of
433 the following lines anywhere in the buffer:
434
435    #+STARTUP: fold              (or `overview', this is equivalent)
436    #+STARTUP: nofold            (or `showall', this is equivalent)
437    #+STARTUP: content
438    #+STARTUP: showeverything"
439   :group 'org-startup
440   :type '(choice
441           (const :tag "nofold: show all" nil)
442           (const :tag "fold: overview" t)
443           (const :tag "content: all headlines" content)
444           (const :tag "show everything, even drawers" showeverything)))
445
446 (defcustom org-startup-truncated t
447   "Non-nil means entering Org-mode will set `truncate-lines'.
448 This is useful since some lines containing links can be very long and
449 uninteresting.  Also tables look terrible when wrapped."
450   :group 'org-startup
451   :type 'boolean)
452
453 (defcustom org-startup-indented nil
454   "Non-nil means turn on `org-indent-mode' on startup.
455 This can also be configured on a per-file basis by adding one of
456 the following lines anywhere in the buffer:
457
458    #+STARTUP: indent
459    #+STARTUP: noindent"
460   :group 'org-structure
461   :type '(choice
462           (const :tag "Not" nil)
463           (const :tag "Globally (slow on startup in large files)" t)))
464
465 (defcustom org-use-sub-superscripts t
466   "Non-nil means interpret \"_\" and \"^\" for export.
467 When this option is turned on, you can use TeX-like syntax for sub- and
468 superscripts.  Several characters after \"_\" or \"^\" will be
469 considered as a single item - so grouping with {} is normally not
470 needed.  For example, the following things will be parsed as single
471 sub- or superscripts.
472
473  10^24   or   10^tau     several digits will be considered 1 item.
474  10^-12  or   10^-tau    a leading sign with digits or a word
475  x^2-y^3                 will be read as x^2 - y^3, because items are
476                          terminated by almost any nonword/nondigit char.
477  x_{i^2} or   x^(2-i)    braces or parenthesis do grouping.
478
479 Still, ambiguity is possible - so when in doubt use {} to enclose the
480 sub/superscript.  If you set this variable to the symbol `{}',
481 the braces are *required* in order to trigger interpretations as
482 sub/superscript.  This can be helpful in documents that need \"_\"
483 frequently in plain text.
484
485 Not all export backends support this, but HTML does.
486
487 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
488   :group 'org-startup
489   :group 'org-export-translation
490   :type '(choice
491           (const :tag "Always interpret" t)
492           (const :tag "Only with braces" {})
493           (const :tag "Never interpret" nil)))
494
495 (if (fboundp 'defvaralias)
496     (defvaralias 'org-export-with-sub-superscripts 'org-use-sub-superscripts))
497
498
499 (defcustom org-startup-with-beamer-mode nil
500   "Non-nil means turn on `org-beamer-mode' on startup.
501 This can also be configured on a per-file basis by adding one of
502 the following lines anywhere in the buffer:
503
504    #+STARTUP: beamer"
505   :group 'org-startup
506   :type 'boolean)
507
508 (defcustom org-startup-align-all-tables nil
509   "Non-nil means align all tables when visiting a file.
510 This is useful when the column width in tables is forced with <N> cookies
511 in table fields.  Such tables will look correct only after the first re-align.
512 This can also be configured on a per-file basis by adding one of
513 the following lines anywhere in the buffer:
514    #+STARTUP: align
515    #+STARTUP: noalign"
516   :group 'org-startup
517   :type 'boolean)
518
519 (defcustom org-startup-with-inline-images nil
520   "Non-nil means show inline images when loading a new Org file.
521 This can also be configured on a per-file basis by adding one of
522 the following lines anywhere in the buffer:
523    #+STARTUP: inlineimages
524    #+STARTUP: noinlineimages"
525   :group 'org-startup
526   :type 'boolean)
527
528 (defcustom org-insert-mode-line-in-empty-file nil
529   "Non-nil means insert the first line setting Org-mode in empty files.
530 When the function `org-mode' is called interactively in an empty file, this
531 normally means that the file name does not automatically trigger Org-mode.
532 To ensure that the file will always be in Org-mode in the future, a
533 line enforcing Org-mode will be inserted into the buffer, if this option
534 has been set."
535   :group 'org-startup
536   :type 'boolean)
537
538 (defcustom org-replace-disputed-keys nil
539   "Non-nil means use alternative key bindings for some keys.
540 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
541 These keys are also used by other packages like shift-selection-mode'
542 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
543 If you want to use Org-mode together with one of these other modes,
544 or more generally if you would like to move some Org-mode commands to
545 other keys, set this variable and configure the keys with the variable
546 `org-disputed-keys'.
547
548 This option is only relevant at load-time of Org-mode, and must be set
549 *before* org.el is loaded.  Changing it requires a restart of Emacs to
550 become effective."
551   :group 'org-startup
552   :type 'boolean)
553
554 (defcustom org-use-extra-keys nil
555   "Non-nil means use extra key sequence definitions for certain commands.
556 This happens automatically if you run XEmacs or if `window-system'
557 is nil.  This variable lets you do the same manually.  You must
558 set it before loading org.
559
560 Example: on Carbon Emacs 22 running graphically, with an external
561 keyboard on a Powerbook, the default way of setting M-left might
562 not work for either Alt or ESC.  Setting this variable will make
563 it work for ESC."
564   :group 'org-startup
565   :type 'boolean)
566
567 (if (fboundp 'defvaralias)
568     (defvaralias 'org-CUA-compatible 'org-replace-disputed-keys))
569
570 (defcustom org-disputed-keys
571   '(([(shift up)]               . [(meta p)])
572     ([(shift down)]             . [(meta n)])
573     ([(shift left)]             . [(meta -)])
574     ([(shift right)]            . [(meta +)])
575     ([(control shift right)]    . [(meta shift +)])
576     ([(control shift left)]     . [(meta shift -)]))
577   "Keys for which Org-mode and other modes compete.
578 This is an alist, cars are the default keys, second element specifies
579 the alternative to use when `org-replace-disputed-keys' is t.
580
581 Keys can be specified in any syntax supported by `define-key'.
582 The value of this option takes effect only at Org-mode's startup,
583 therefore you'll have to restart Emacs to apply it after changing."
584   :group 'org-startup
585   :type 'alist)
586
587 (defun org-key (key)
588   "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
589 Or return the original if not disputed.
590 Also apply the translations defined in `org-xemacs-key-equivalents'."
591   (when org-replace-disputed-keys
592     (let* ((nkey (key-description key))
593            (x (org-find-if (lambda (x)
594                              (equal (key-description (car x)) nkey))
595                            org-disputed-keys)))
596       (setq key (if x (cdr x) key))))
597   (when (featurep 'xemacs)
598     (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
599   key)
600
601 (defun org-find-if (predicate seq)
602   (catch 'exit
603     (while seq
604       (if (funcall predicate (car seq))
605           (throw 'exit (car seq))
606         (pop seq)))))
607
608 (defun org-defkey (keymap key def)
609   "Define a key, possibly translated, as returned by `org-key'."
610   (define-key keymap (org-key key) def))
611
612 (defcustom org-ellipsis nil
613   "The ellipsis to use in the Org-mode outline.
614 When nil, just use the standard three dots.  When a string, use that instead,
615 When a face, use the standard 3 dots, but with the specified face.
616 The change affects only Org-mode (which will then use its own display table).
617 Changing this requires executing `M-x org-mode' in a buffer to become
618 effective."
619   :group 'org-startup
620   :type '(choice (const :tag "Default" nil)
621                  (face :tag "Face" :value org-warning)
622                  (string :tag "String" :value "...#")))
623
624 (defvar org-display-table nil
625   "The display table for org-mode, in case `org-ellipsis' is non-nil.")
626
627 (defgroup org-keywords nil
628   "Keywords in Org-mode."
629   :tag "Org Keywords"
630   :group 'org)
631
632 (defcustom org-deadline-string "DEADLINE:"
633   "String to mark deadline entries.
634 A deadline is this string, followed by a time stamp.  Should be a word,
635 terminated by a colon.  You can insert a schedule keyword and
636 a timestamp with \\[org-deadline].
637 Changes become only effective after restarting Emacs."
638   :group 'org-keywords
639   :type 'string)
640
641 (defcustom org-scheduled-string "SCHEDULED:"
642   "String to mark scheduled TODO entries.
643 A schedule is this string, followed by a time stamp.  Should be a word,
644 terminated by a colon.  You can insert a schedule keyword and
645 a timestamp with \\[org-schedule].
646 Changes become only effective after restarting Emacs."
647   :group 'org-keywords
648   :type 'string)
649
650 (defcustom org-closed-string "CLOSED:"
651   "String used as the prefix for timestamps logging closing a TODO entry."
652   :group 'org-keywords
653   :type 'string)
654
655 (defcustom org-clock-string "CLOCK:"
656   "String used as prefix for timestamps clocking work hours on an item."
657   :group 'org-keywords
658   :type 'string)
659
660 (defcustom org-comment-string "COMMENT"
661   "Entries starting with this keyword will never be exported.
662 An entry can be toggled between COMMENT and normal with
663 \\[org-toggle-comment].
664 Changes become only effective after restarting Emacs."
665   :group 'org-keywords
666   :type 'string)
667
668 (defcustom org-quote-string "QUOTE"
669   "Entries starting with this keyword will be exported in fixed-width font.
670 Quoting applies only to the text in the entry following the headline, and does
671 not extend beyond the next headline, even if that is lower level.
672 An entry can be toggled between QUOTE and normal with
673 \\[org-toggle-fixed-width-section]."
674   :group 'org-keywords
675   :type 'string)
676
677 (defconst org-repeat-re
678   "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[dwmy]\\(/[0-9]+[dwmy]\\)?\\)"
679   "Regular expression for specifying repeated events.
680 After a match, group 1 contains the repeat expression.")
681
682 (defgroup org-structure nil
683   "Options concerning the general structure of Org-mode files."
684   :tag "Org Structure"
685   :group 'org)
686
687 (defgroup org-reveal-location nil
688   "Options about how to make context of a location visible."
689   :tag "Org Reveal Location"
690   :group 'org-structure)
691
692 (defconst org-context-choice
693   '(choice
694     (const :tag "Always" t)
695     (const :tag "Never" nil)
696     (repeat :greedy t :tag "Individual contexts"
697             (cons
698              (choice :tag "Context"
699                      (const agenda)
700                      (const org-goto)
701                      (const occur-tree)
702                      (const tags-tree)
703                      (const link-search)
704                      (const mark-goto)
705                      (const bookmark-jump)
706                      (const isearch)
707                      (const default))
708              (boolean))))
709   "Contexts for the reveal options.")
710
711 (defcustom org-show-hierarchy-above '((default . t))
712   "Non-nil means show full hierarchy when revealing a location.
713 Org-mode often shows locations in an org-mode file which might have
714 been invisible before.  When this is set, the hierarchy of headings
715 above the exposed location is shown.
716 Turning this off for example for sparse trees makes them very compact.
717 Instead of t, this can also be an alist specifying this option for different
718 contexts.  Valid contexts are
719   agenda         when exposing an entry from the agenda
720   org-goto       when using the command `org-goto' on key C-c C-j
721   occur-tree     when using the command `org-occur' on key C-c /
722   tags-tree      when constructing a sparse tree based on tags matches
723   link-search    when exposing search matches associated with a link
724   mark-goto      when exposing the jump goal of a mark
725   bookmark-jump  when exposing a bookmark location
726   isearch        when exiting from an incremental search
727   default        default for all contexts not set explicitly"
728   :group 'org-reveal-location
729   :type org-context-choice)
730
731 (defcustom org-show-following-heading '((default . nil))
732   "Non-nil means show following heading when revealing a location.
733 Org-mode often shows locations in an org-mode file which might have
734 been invisible before.  When this is set, the heading following the
735 match is shown.
736 Turning this off for example for sparse trees makes them very compact,
737 but makes it harder to edit the location of the match.  In such a case,
738 use the command \\[org-reveal] to show more context.
739 Instead of t, this can also be an alist specifying this option for different
740 contexts.  See `org-show-hierarchy-above' for valid contexts."
741   :group 'org-reveal-location
742   :type org-context-choice)
743
744 (defcustom org-show-siblings '((default . nil) (isearch t))
745   "Non-nil means show all sibling heading when revealing a location.
746 Org-mode often shows locations in an org-mode file which might have
747 been invisible before.  When this is set, the sibling of the current entry
748 heading are all made visible.  If `org-show-hierarchy-above' is t,
749 the same happens on each level of the hierarchy above the current entry.
750
751 By default this is on for the isearch context, off for all other contexts.
752 Turning this off for example for sparse trees makes them very compact,
753 but makes it harder to edit the location of the match.  In such a case,
754 use the command \\[org-reveal] to show more context.
755 Instead of t, this can also be an alist specifying this option for different
756 contexts.  See `org-show-hierarchy-above' for valid contexts."
757   :group 'org-reveal-location
758   :type org-context-choice)
759
760 (defcustom org-show-entry-below '((default . nil))
761   "Non-nil means show the entry below a headline when revealing a location.
762 Org-mode often shows locations in an org-mode file which might have
763 been invisible before.  When this is set, the text below the headline that is
764 exposed is also shown.
765
766 By default this is off for all contexts.
767 Instead of t, this can also be an alist specifying this option for different
768 contexts.  See `org-show-hierarchy-above' for valid contexts."
769   :group 'org-reveal-location
770   :type org-context-choice)
771
772 (defcustom org-indirect-buffer-display 'other-window
773   "How should indirect tree buffers be displayed?
774 This applies to indirect buffers created with the commands
775 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
776 Valid values are:
777 current-window   Display in the current window
778 other-window     Just display in another window.
779 dedicated-frame  Create one new frame, and re-use it each time.
780 new-frame        Make a new frame each time.  Note that in this case
781                  previously-made indirect buffers are kept, and you need to
782                  kill these buffers yourself."
783   :group 'org-structure
784   :group 'org-agenda-windows
785   :type '(choice
786           (const :tag "In current window" current-window)
787           (const :tag "In current frame, other window" other-window)
788           (const :tag "Each time a new frame" new-frame)
789           (const :tag "One dedicated frame" dedicated-frame)))
790
791 (defcustom org-use-speed-commands nil
792   "Non-nil means activate single letter commands at beginning of a headline.
793 This may also be a function to test for appropriate locations where speed
794 commands should be active."
795   :group 'org-structure
796   :type '(choice
797           (const :tag "Never" nil)
798           (const :tag "At beginning of headline stars" t)
799           (function)))
800
801 (defcustom org-speed-commands-user nil
802     "Alist of additional speed commands.
803 This list will be checked before `org-speed-commands-default'
804 when the variable `org-use-speed-commands' is non-nil
805 and when the cursor is at the beginning of a headline.
806 The car if each entry is a string with a single letter, which must
807 be assigned to `self-insert-command' in the global map.
808 The cdr is either a command to be called interactively, a function
809 to be called, or a form to be evaluated.
810 An entry that is just a list with a single string will be interpreted
811 as a descriptive headline that will be added when listing the speed
812 commands in the Help buffer using the `?' speed command."
813     :group 'org-structure
814     :type '(repeat :value ("k" . ignore)
815             (choice :value ("k" . ignore)
816              (list :tag "Descriptive Headline" (string :tag "Headline"))
817              (cons :tag "Letter and Command"
818               (string :tag "Command letter")
819               (choice
820                (function)
821                (sexp))))))
822
823 (defgroup org-cycle nil
824   "Options concerning visibility cycling in Org-mode."
825   :tag "Org Cycle"
826   :group 'org-structure)
827
828 (defcustom org-cycle-skip-children-state-if-no-children t
829   "Non-nil means skip CHILDREN state in entries that don't have any."
830   :group 'org-cycle
831   :type 'boolean)
832
833 (defcustom org-cycle-max-level nil
834   "Maximum level which should still be subject to visibility cycling.
835 Levels higher than this will, for cycling, be treated as text, not a headline.
836 When `org-odd-levels-only' is set, a value of N in this variable actually
837 means 2N-1 stars as the limiting headline.
838 When nil, cycle all levels.
839 Note that the limiting level of cycling is also influenced by
840 `org-inlinetask-min-level'.  When `org-cycle-max-level' is not set but
841 `org-inlinetask-min-level' is, cycling will be limited to levels one less
842 than its value."
843   :group 'org-cycle
844   :type '(choice
845           (const :tag "No limit" nil)
846           (integer :tag "Maximum level")))
847
848 (defcustom org-drawers '("PROPERTIES" "CLOCK" "LOGBOOK")
849   "Names of drawers.  Drawers are not opened by cycling on the headline above.
850 Drawers only open with a TAB on the drawer line itself.  A drawer looks like
851 this:
852    :DRAWERNAME:
853    .....
854    :END:
855 The drawer \"PROPERTIES\" is special for capturing properties through
856 the property API.
857
858 Drawers can be defined on the per-file basis with a line like:
859
860 #+DRAWERS: HIDDEN STATE PROPERTIES"
861   :group 'org-structure
862   :group 'org-cycle
863   :type '(repeat (string :tag "Drawer Name")))
864
865 (defcustom org-hide-block-startup nil
866   "Non-nil means entering Org-mode will fold all blocks.
867 This can also be set in on a per-file basis with
868
869 #+STARTUP: hideblocks
870 #+STARTUP: showblocks"
871   :group 'org-startup
872   :group 'org-cycle
873   :type 'boolean)
874
875 (defcustom org-cycle-global-at-bob nil
876   "Cycle globally if cursor is at beginning of buffer and not at a headline.
877 This makes it possible to do global cycling without having to use S-TAB or
878 \\[universal-argument] TAB.  For this special case to work, the first line \
879 of the buffer
880 must not be a headline - it may be empty or some other text.  When used in
881 this way, `org-cycle-hook' is disables temporarily, to make sure the
882 cursor stays at the beginning of the buffer.
883 When this option is nil, don't do anything special at the beginning
884 of the buffer."
885   :group 'org-cycle
886   :type 'boolean)
887
888 (defcustom org-cycle-level-after-item/entry-creation t
889   "Non-nil means cycle entry level or item indentation in new empty entries.
890
891 When the cursor is at the end of an empty headline, i.e with only stars
892 and maybe a TODO keyword, TAB will then switch the entry to become a child,
893 and then all possible ancestor states, before returning to the original state.
894 This makes data entry extremely fast:  M-RET to create a new headline,
895 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
896
897 When the cursor is at the end of an empty plain list item, one TAB will
898 make it a subitem, two or more tabs will back up to make this an item
899 higher up in the item hierarchy."
900   :group 'org-cycle
901   :type 'boolean)
902
903 (defcustom org-cycle-emulate-tab t
904   "Where should `org-cycle' emulate TAB.
905 nil         Never
906 white       Only in completely white lines
907 whitestart  Only at the beginning of lines, before the first non-white char
908 t           Everywhere except in headlines
909 exc-hl-bol  Everywhere except at the start of a headline
910 If TAB is used in a place where it does not emulate TAB, the current subtree
911 visibility is cycled."
912   :group 'org-cycle
913   :type '(choice (const :tag "Never" nil)
914                  (const :tag "Only in completely white lines" white)
915                  (const :tag "Before first char in a line" whitestart)
916                  (const :tag "Everywhere except in headlines" t)
917                  (const :tag "Everywhere except at bol in headlines" exc-hl-bol)
918                  ))
919
920 (defcustom org-cycle-separator-lines 2
921   "Number of empty lines needed to keep an empty line between collapsed trees.
922 If you leave an empty line between the end of a subtree and the following
923 headline, this empty line is hidden when the subtree is folded.
924 Org-mode will leave (exactly) one empty line visible if the number of
925 empty lines is equal or larger to the number given in this variable.
926 So the default 2 means at least 2 empty lines after the end of a subtree
927 are needed to produce free space between a collapsed subtree and the
928 following headline.
929
930 If the number is negative, and the number of empty lines is at least -N,
931 all empty lines are shown.
932
933 Special case: when 0, never leave empty lines in collapsed view."
934   :group 'org-cycle
935   :type 'integer)
936 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
937
938 (defcustom org-pre-cycle-hook nil
939   "Hook that is run before visibility cycling is happening.
940 The function(s) in this hook must accept a single argument which indicates
941 the new state that will be set right after running this hook.  The
942 argument is a symbol.  Before a global state change, it can have the values
943 `overview', `content', or `all'.  Before a local state change, it can have
944 the values `folded', `children', or `subtree'."
945   :group 'org-cycle
946   :type 'hook)
947
948 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
949                             org-cycle-hide-drawers
950                             org-cycle-show-empty-lines
951                             org-optimize-window-after-visibility-change)
952   "Hook that is run after `org-cycle' has changed the buffer visibility.
953 The function(s) in this hook must accept a single argument which indicates
954 the new state that was set by the most recent `org-cycle' command.  The
955 argument is a symbol.  After a global state change, it can have the values
956 `overview', `content', or `all'.  After a local state change, it can have
957 the values `folded', `children', or `subtree'."
958   :group 'org-cycle
959   :type 'hook)
960
961 (defgroup org-edit-structure nil
962   "Options concerning structure editing in Org-mode."
963   :tag "Org Edit Structure"
964   :group 'org-structure)
965
966 (defcustom org-odd-levels-only nil
967   "Non-nil means skip even levels and only use odd levels for the outline.
968 This has the effect that two stars are being added/taken away in
969 promotion/demotion commands.  It also influences how levels are
970 handled by the exporters.
971 Changing it requires restart of `font-lock-mode' to become effective
972 for fontification also in regions already fontified.
973 You may also set this on a per-file basis by adding one of the following
974 lines to the buffer:
975
976    #+STARTUP: odd
977    #+STARTUP: oddeven"
978   :group 'org-edit-structure
979   :group 'org-appearance
980   :type 'boolean)
981
982 (defcustom org-adapt-indentation t
983   "Non-nil means adapt indentation to outline node level.
984
985 When this variable is set, Org assumes that you write outlines by
986 indenting text in each node to align with the headline (after the stars).
987 The following issues are influenced by this variable:
988
989 - When this is set and the *entire* text in an entry is indented, the
990   indentation is increased by one space in a demotion command, and
991   decreased by one in a promotion command.  If any line in the entry
992   body starts with text at column 0, indentation is not changed at all.
993
994 - Property drawers and planning information is inserted indented when
995   this variable s set.  When nil, they will not be indented.
996
997 - TAB indents a line relative to context.  The lines below a headline
998   will be indented when this variable is set.
999
1000 Note that this is all about true indentation, by adding and removing
1001 space characters.  See also `org-indent.el' which does level-dependent
1002 indentation in a virtual way, i.e. at display time in Emacs."
1003   :group 'org-edit-structure
1004   :type 'boolean)
1005
1006 (defcustom org-special-ctrl-a/e nil
1007   "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1008
1009 When t, `C-a' will bring back the cursor to the beginning of the
1010 headline text, i.e. after the stars and after a possible TODO keyword.
1011 In an item, this will be the position after the bullet.
1012 When the cursor is already at that position, another `C-a' will bring
1013 it to the beginning of the line.
1014
1015 `C-e' will jump to the end of the headline, ignoring the presence of tags
1016 in the headline.  A second `C-e' will then jump to the true end of the
1017 line, after any tags.  This also means that, when this variable is
1018 non-nil, `C-e' also will never jump beyond the end of the heading of a
1019 folded section, i.e. not after the ellipses.
1020
1021 When set to the symbol `reversed', the first `C-a' or `C-e' works normally,
1022 going to the true line boundary first.  Only a directly following, identical
1023 keypress will bring the cursor to the special positions.
1024
1025 This may also be a cons cell where the behavior for `C-a' and `C-e' is
1026 set separately."
1027   :group 'org-edit-structure
1028   :type '(choice
1029           (const :tag "off" nil)
1030           (const :tag "on: after stars/bullet and before tags first" t)
1031           (const :tag "reversed: true line boundary first" reversed)
1032           (cons :tag "Set C-a and C-e separately"
1033                 (choice :tag "Special C-a"
1034                         (const :tag "off" nil)
1035                         (const :tag "on: after  stars/bullet first" t)
1036                         (const :tag "reversed: before stars/bullet first" reversed))
1037                 (choice :tag "Special C-e"
1038                         (const :tag "off" nil)
1039                         (const :tag "on: before tags first" t)
1040                         (const :tag "reversed: after tags first" reversed)))))
1041 (if (fboundp 'defvaralias)
1042     (defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e))
1043
1044 (defcustom org-special-ctrl-k nil
1045   "Non-nil means `C-k' will behave specially in headlines.
1046 When nil, `C-k' will call the default `kill-line' command.
1047 When t, the following will happen while the cursor is in the headline:
1048
1049 - When the cursor is at the beginning of a headline, kill the entire
1050   line and possible the folded subtree below the line.
1051 - When in the middle of the headline text, kill the headline up to the tags.
1052 - When after the headline text, kill the tags."
1053   :group 'org-edit-structure
1054   :type 'boolean)
1055
1056 (defcustom org-ctrl-k-protect-subtree nil
1057   "Non-nil means, do not delete a hidden subtree with C-k.
1058 When set to the symbol `error', simply throw an error when C-k is
1059 used to kill (part-of) a headline that has hidden text behind it.
1060 Any other non-nil value will result in a query to the user, if it is
1061 OK to kill that hidden subtree.  When nil, kill without remorse."
1062   :group 'org-edit-structure
1063   :type '(choice
1064           (const :tag "Do not protect hidden subtrees" nil)
1065           (const :tag "Protect hidden subtrees with a security query" t)
1066           (const :tag "Never kill a hidden subtree with C-k" error)))
1067
1068 (defcustom org-yank-folded-subtrees t
1069   "Non-nil means when yanking subtrees, fold them.
1070 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1071 it starts with a heading and all other headings in it are either children
1072 or siblings, then fold all the subtrees.  However, do this only if no
1073 text after the yank would be swallowed into a folded tree by this action."
1074   :group 'org-edit-structure
1075   :type 'boolean)
1076
1077 (defcustom org-yank-adjusted-subtrees nil
1078   "Non-nil means when yanking subtrees, adjust the level.
1079 With this setting, `org-paste-subtree' is used to insert the subtree, see
1080 this function for details."
1081   :group 'org-edit-structure
1082   :type 'boolean)
1083
1084 (defcustom org-M-RET-may-split-line '((default . t))
1085   "Non-nil means M-RET will split the line at the cursor position.
1086 When nil, it will go to the end of the line before making a
1087 new line.
1088 You may also set this option in a different way for different
1089 contexts.  Valid contexts are:
1090
1091 headline  when creating a new headline
1092 item      when creating a new item
1093 table     in a table field
1094 default   the value to be used for all contexts not explicitly
1095           customized"
1096   :group 'org-structure
1097   :group 'org-table
1098   :type '(choice
1099           (const :tag "Always" t)
1100           (const :tag "Never" nil)
1101           (repeat :greedy t :tag "Individual contexts"
1102                   (cons
1103                    (choice :tag "Context"
1104                            (const headline)
1105                            (const item)
1106                            (const table)
1107                            (const default))
1108                    (boolean)))))
1109
1110
1111 (defcustom org-insert-heading-respect-content nil
1112   "Non-nil means insert new headings after the current subtree.
1113 When nil, the new heading is created directly after the current line.
1114 The commands \\[org-insert-heading-respect-content] and
1115 \\[org-insert-todo-heading-respect-content] turn this variable on
1116 for the duration of the command."
1117   :group 'org-structure
1118   :type 'boolean)
1119
1120 (defcustom org-blank-before-new-entry '((heading . auto)
1121                                         (plain-list-item . auto))
1122   "Should `org-insert-heading' leave a blank line before new heading/item?
1123 The value is an alist, with `heading' and `plain-list-item' as CAR,
1124 and a boolean flag as CDR.  The cdr may also be the symbol `auto', in
1125 which case Org will look at the surrounding headings/items and try to
1126 make an intelligent decision whether to insert a blank line or not.
1127
1128 For plain lists, if the variable `org-empty-line-terminates-plain-lists' is
1129 set, the setting here is ignored and no empty line is inserted, to avoid
1130 breaking the list structure."
1131   :group 'org-edit-structure
1132   :type '(list
1133           (cons (const heading)
1134                 (choice (const :tag "Never" nil)
1135                         (const :tag "Always" t)
1136                         (const :tag "Auto" auto)))
1137           (cons (const plain-list-item)
1138                 (choice (const :tag "Never" nil)
1139                         (const :tag "Always" t)
1140                         (const :tag "Auto" auto)))))
1141
1142 (defcustom org-insert-heading-hook nil
1143   "Hook being run after inserting a new heading."
1144   :group 'org-edit-structure
1145   :type 'hook)
1146
1147 (defcustom org-enable-fixed-width-editor t
1148   "Non-nil means lines starting with \":\" are treated as fixed-width.
1149 This currently only means they are never auto-wrapped.
1150 When nil, such lines will be treated like ordinary lines.
1151 See also the QUOTE keyword."
1152   :group 'org-edit-structure
1153   :type 'boolean)
1154
1155 (defcustom org-goto-auto-isearch t
1156   "Non-nil means typing characters in `org-goto' starts incremental search."
1157   :group 'org-edit-structure
1158   :type 'boolean)
1159
1160 (defgroup org-sparse-trees nil
1161   "Options concerning sparse trees in Org-mode."
1162   :tag "Org Sparse Trees"
1163   :group 'org-structure)
1164
1165 (defcustom org-highlight-sparse-tree-matches t
1166   "Non-nil means highlight all matches that define a sparse tree.
1167 The highlights will automatically disappear the next time the buffer is
1168 changed by an edit command."
1169   :group 'org-sparse-trees
1170   :type 'boolean)
1171
1172 (defcustom org-remove-highlights-with-change t
1173   "Non-nil means any change to the buffer will remove temporary highlights.
1174 Such highlights are created by `org-occur' and `org-clock-display'.
1175 When nil, `C-c C-c needs to be used to get rid of the highlights.
1176 The highlights created by `org-preview-latex-fragment' always need
1177 `C-c C-c' to be removed."
1178   :group 'org-sparse-trees
1179   :group 'org-time
1180   :type 'boolean)
1181
1182
1183 (defcustom org-occur-hook '(org-first-headline-recenter)
1184   "Hook that is run after `org-occur' has constructed a sparse tree.
1185 This can be used to recenter the window to show as much of the structure
1186 as possible."
1187   :group 'org-sparse-trees
1188   :type 'hook)
1189
1190 (defgroup org-imenu-and-speedbar nil
1191   "Options concerning imenu and speedbar in Org-mode."
1192   :tag "Org Imenu and Speedbar"
1193   :group 'org-structure)
1194
1195 (defcustom org-imenu-depth 2
1196   "The maximum level for Imenu access to Org-mode headlines.
1197 This also applied for speedbar access."
1198   :group 'org-imenu-and-speedbar
1199   :type 'integer)
1200
1201 (defgroup org-table nil
1202   "Options concerning tables in Org-mode."
1203   :tag "Org Table"
1204   :group 'org)
1205
1206 (defcustom org-enable-table-editor 'optimized
1207   "Non-nil means lines starting with \"|\" are handled by the table editor.
1208 When nil, such lines will be treated like ordinary lines.
1209
1210 When equal to the symbol `optimized', the table editor will be optimized to
1211 do the following:
1212 - Automatic overwrite mode in front of whitespace in table fields.
1213   This makes the structure of the table stay in tact as long as the edited
1214   field does not exceed the column width.
1215 - Minimize the number of realigns.  Normally, the table is aligned each time
1216   TAB or RET are pressed to move to another field.  With optimization this
1217   happens only if changes to a field might have changed the column width.
1218 Optimization requires replacing the functions `self-insert-command',
1219 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1220 slight (in fact: unnoticeable) speed impact for normal typing.  Org-mode is
1221 very good at guessing when a re-align will be necessary, but you can always
1222 force one with \\[org-ctrl-c-ctrl-c].
1223
1224 If you would like to use the optimized version in Org-mode, but the
1225 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1226
1227 This variable can be used to turn on and off the table editor during a session,
1228 but in order to toggle optimization, a restart is required.
1229
1230 See also the variable `org-table-auto-blank-field'."
1231   :group 'org-table
1232   :type '(choice
1233           (const :tag "off" nil)
1234           (const :tag "on" t)
1235           (const :tag "on, optimized" optimized)))
1236
1237 (defcustom org-self-insert-cluster-for-undo t
1238   "Non-nil means cluster self-insert commands for undo when possible.
1239 If this is set, then, like in the Emacs command loop, 20 consecutive
1240 characters will be undone together.
1241 This is configurable, because there is some impact on typing performance."
1242   :group 'org-table
1243   :type 'boolean)
1244
1245 (defcustom org-table-tab-recognizes-table.el t
1246   "Non-nil means TAB will automatically notice a table.el table.
1247 When it sees such a table, it moves point into it and - if necessary -
1248 calls `table-recognize-table'."
1249   :group 'org-table-editing
1250   :type 'boolean)
1251
1252 (defgroup org-link nil
1253   "Options concerning links in Org-mode."
1254   :tag "Org Link"
1255   :group 'org)
1256
1257 (defvar org-link-abbrev-alist-local nil
1258   "Buffer-local version of `org-link-abbrev-alist', which see.
1259 The value of this is taken from the #+LINK lines.")
1260 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1261
1262 (defcustom org-link-abbrev-alist nil
1263   "Alist of link abbreviations.
1264 The car of each element is a string, to be replaced at the start of a link.
1265 The cdrs are replacement values, like (\"linkkey\" . REPLACE).  Abbreviated
1266 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1267
1268      [[linkkey:tag][description]]
1269
1270 The 'linkkey' must be a word word, starting with a letter, followed
1271 by letters, numbers, '-' or '_'.
1272
1273 If REPLACE is a string, the tag will simply be appended to create the link.
1274 If the string contains \"%s\", the tag will be inserted there.  Alternatively,
1275 the placeholder \"%h\" will cause a url-encoded version of the tag to
1276 be inserted at that point (see the function `url-hexify-string').
1277
1278 REPLACE may also be a function that will be called with the tag as the
1279 only argument to create the link, which should be returned as a string.
1280
1281 See the manual for examples."
1282   :group 'org-link
1283   :type '(repeat
1284           (cons
1285            (string :tag "Protocol")
1286            (choice
1287             (string :tag "Format")
1288             (function)))))
1289
1290 (defcustom org-descriptive-links t
1291   "Non-nil means Org will display descriptive links.
1292 E.g. [[http://orgmode.org][Org website]] will be displayed as
1293 \"Org Website\", hiding the link itself and just displaying its
1294 description.  When set to `nil', Org will display the full links
1295 literally.
1296
1297 You can interactively set the value of this variable by calling
1298 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1299   :group 'org-link
1300   :type 'boolean)
1301
1302 (defcustom org-link-file-path-type 'adaptive
1303   "How the path name in file links should be stored.
1304 Valid values are:
1305
1306 relative  Relative to the current directory, i.e. the directory of the file
1307           into which the link is being inserted.
1308 absolute  Absolute path, if possible with ~ for home directory.
1309 noabbrev  Absolute path, no abbreviation of home directory.
1310 adaptive  Use relative path for files in the current directory and sub-
1311           directories of it.  For other files, use an absolute path."
1312   :group 'org-link
1313   :type '(choice
1314           (const relative)
1315           (const absolute)
1316           (const noabbrev)
1317           (const adaptive)))
1318
1319 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1320   "Types of links that should be activated in Org-mode files.
1321 This is a list of symbols, each leading to the activation of a certain link
1322 type.  In principle, it does not hurt to turn on most link types - there may
1323 be a small gain when turning off unused link types.  The types are:
1324
1325 bracket   The recommended [[link][description]] or [[link]] links with hiding.
1326 angle     Links in angular brackets that may contain whitespace like
1327           <bbdb:Carsten Dominik>.
1328 plain     Plain links in normal text, no whitespace, like http://google.com.
1329 radio     Text that is matched by a radio target, see manual for details.
1330 tag       Tag settings in a headline (link to tag search).
1331 date      Time stamps (link to calendar).
1332 footnote  Footnote labels.
1333
1334 Changing this variable requires a restart of Emacs to become effective."
1335   :group 'org-link
1336   :type '(set :greedy t
1337               (const :tag "Double bracket links" bracket)
1338               (const :tag "Angular bracket links" angle)
1339               (const :tag "Plain text links" plain)
1340               (const :tag "Radio target matches" radio)
1341               (const :tag "Tags" tag)
1342               (const :tag "Timestamps" date)
1343               (const :tag "Footnotes" footnote)))
1344
1345 (defcustom org-make-link-description-function nil
1346   "Function to use to generate link descriptions from links.
1347 If nil the link location will be used.  This function must take
1348 two parameters; the first is the link and the second the
1349 description `org-insert-link' has generated, and should return the
1350 description to use."
1351   :group 'org-link
1352   :type 'function)
1353
1354 (defgroup org-link-store nil
1355   "Options concerning storing links in Org-mode."
1356   :tag "Org Store Link"
1357   :group 'org-link)
1358
1359 (defcustom org-email-link-description-format "Email %c: %.30s"
1360   "Format of the description part of a link to an email or usenet message.
1361 The following %-escapes will be replaced by corresponding information:
1362
1363 %F   full \"From\" field
1364 %f   name, taken from \"From\" field, address if no name
1365 %T   full \"To\" field
1366 %t   first name in \"To\" field, address if no name
1367 %c   correspondent.  Usually \"from NAME\", but if you sent it yourself, it
1368      will be \"to NAME\".  See also the variable `org-from-is-user-regexp'.
1369 %s   subject
1370 %d   date
1371 %m   message-id.
1372
1373 You may use normal field width specification between the % and the letter.
1374 This is for example useful to limit the length of the subject.
1375
1376 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1377   :group 'org-link-store
1378   :type 'string)
1379
1380 (defcustom org-from-is-user-regexp
1381   (let (r1 r2)
1382     (when (and user-mail-address (not (string= user-mail-address "")))
1383       (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1384     (when (and user-full-name (not (string= user-full-name "")))
1385       (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1386     (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1387   "Regexp matched against the \"From:\" header of an email or usenet message.
1388 It should match if the message is from the user him/herself."
1389   :group 'org-link-store
1390   :type 'regexp)
1391
1392 (defcustom org-link-to-org-use-id 'create-if-interactive-and-no-custom-id
1393   "Non-nil means storing a link to an Org file will use entry IDs.
1394
1395 Note that before this variable is even considered, org-id must be loaded,
1396 so please customize `org-modules' and turn it on.
1397
1398 The variable can have the following values:
1399
1400 t     Create an ID if needed to make a link to the current entry.
1401
1402 create-if-interactive
1403       If `org-store-link' is called directly (interactively, as a user
1404       command), do create an ID to support the link.  But when doing the
1405       job for remember, only use the ID if it already exists.  The
1406       purpose of this setting is to avoid proliferation of unwanted
1407       IDs, just because you happen to be in an Org file when you
1408       call `org-remember' that automatically and preemptively
1409       creates a link.  If you do want to get an ID link in a remember
1410       template to an entry not having an ID, create it first by
1411       explicitly creating a link to it, using `C-c C-l' first.
1412
1413 create-if-interactive-and-no-custom-id
1414       Like create-if-interactive, but do not create an ID if there is
1415       a CUSTOM_ID property defined in the entry.  This is the default.
1416
1417 use-existing
1418       Use existing ID, do not create one.
1419
1420 nil   Never use an ID to make a link, instead link using a text search for
1421       the headline text."
1422   :group 'org-link-store
1423   :type '(choice
1424           (const :tag "Create ID to make link" t)
1425           (const :tag "Create if storing link interactively"
1426                  create-if-interactive)
1427           (const :tag "Create if storing link interactively and no CUSTOM_ID is present"
1428                  create-if-interactive-and-no-custom-id)
1429           (const :tag "Only use existing" use-existing)
1430           (const :tag "Do not use ID to create link" nil)))
1431
1432 (defcustom org-context-in-file-links t
1433   "Non-nil means file links from `org-store-link' contain context.
1434 A search string will be added to the file name with :: as separator and
1435 used to find the context when the link is activated by the command
1436 `org-open-at-point'.  When this option is t, the entire active region
1437 will be placed in the search string of the file link.  If set to a
1438 positive integer, only the first n lines of context will be stored.
1439
1440 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1441 negates this setting for the duration of the command."
1442   :group 'org-link-store
1443   :type '(choice boolean integer))
1444
1445 (defcustom org-keep-stored-link-after-insertion nil
1446   "Non-nil means keep link in list for entire session.
1447
1448 The command `org-store-link' adds a link pointing to the current
1449 location to an internal list.  These links accumulate during a session.
1450 The command `org-insert-link' can be used to insert links into any
1451 Org-mode file (offering completion for all stored links).  When this
1452 option is nil, every link which has been inserted once using \\[org-insert-link]
1453 will be removed from the list, to make completing the unused links
1454 more efficient."
1455   :group 'org-link-store
1456   :type 'boolean)
1457
1458 (defgroup org-link-follow nil
1459   "Options concerning following links in Org-mode."
1460   :tag "Org Follow Link"
1461   :group 'org-link)
1462
1463 (defcustom org-link-translation-function nil
1464   "Function to translate links with different syntax to Org syntax.
1465 This can be used to translate links created for example by the Planner
1466 or emacs-wiki packages to Org syntax.
1467 The function must accept two parameters, a TYPE containing the link
1468 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1469 which is everything after the link protocol.  It should return a cons
1470 with possibly modified values of type and path.
1471 Org contains a function for this, so if you set this variable to
1472 `org-translate-link-from-planner', you should be able follow many
1473 links created by planner."
1474   :group 'org-link-follow
1475   :type 'function)
1476
1477 (defcustom org-follow-link-hook nil
1478   "Hook that is run after a link has been followed."
1479   :group 'org-link-follow
1480   :type 'hook)
1481
1482 (defcustom org-tab-follows-link nil
1483   "Non-nil means on links TAB will follow the link.
1484 Needs to be set before org.el is loaded.
1485 This really should not be used, it does not make sense, and the
1486 implementation is bad."
1487   :group 'org-link-follow
1488   :type 'boolean)
1489
1490 (defcustom org-return-follows-link nil
1491   "Non-nil means on links RET will follow the link."
1492   :group 'org-link-follow
1493   :type 'boolean)
1494
1495 (defcustom org-mouse-1-follows-link
1496   (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1497   "Non-nil means mouse-1 on a link will follow the link.
1498 A longer mouse click will still set point.  Does not work on XEmacs.
1499 Needs to be set before org.el is loaded."
1500   :group 'org-link-follow
1501   :type 'boolean)
1502
1503 (defcustom org-mark-ring-length 4
1504   "Number of different positions to be recorded in the ring.
1505 Changing this requires a restart of Emacs to work correctly."
1506   :group 'org-link-follow
1507   :type 'integer)
1508
1509 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1510   "Non-nil means internal links in Org files must exactly match a headline.
1511 When nil, the link search tries to match a phrase with all words
1512 in the search text."
1513   :group 'org-link-follow
1514   :type '(choice
1515           (const :tag "Use fuzzy text search" nil)
1516           (const :tag "Match only exact headline" t)
1517           (const :tag "Match exact headline or query to create it"
1518                  query-to-create)))
1519
1520 (defcustom org-link-frame-setup
1521   '((vm . vm-visit-folder-other-frame)
1522     (gnus . org-gnus-no-new-news)
1523     (file . find-file-other-window)
1524     (wl . wl-other-frame))
1525   "Setup the frame configuration for following links.
1526 When following a link with Emacs, it may often be useful to display
1527 this link in another window or frame.  This variable can be used to
1528 set this up for the different types of links.
1529 For VM, use any of
1530     `vm-visit-folder'
1531     `vm-visit-folder-other-window'
1532     `vm-visit-folder-other-frame'
1533 For Gnus, use any of
1534     `gnus'
1535     `gnus-other-frame'
1536     `org-gnus-no-new-news'
1537 For FILE, use any of
1538     `find-file'
1539     `find-file-other-window'
1540     `find-file-other-frame'
1541 For Wanderlust use any of
1542     `wl'
1543     `wl-other-frame'
1544 For the calendar, use the variable `calendar-setup'.
1545 For BBDB, it is currently only possible to display the matches in
1546 another window."
1547   :group 'org-link-follow
1548   :type '(list
1549           (cons (const vm)
1550                 (choice
1551                  (const vm-visit-folder)
1552                  (const vm-visit-folder-other-window)
1553                  (const vm-visit-folder-other-frame)))
1554           (cons (const gnus)
1555                 (choice
1556                  (const gnus)
1557                  (const gnus-other-frame)
1558                  (const org-gnus-no-new-news)))
1559           (cons (const file)
1560                 (choice
1561                  (const find-file)
1562                  (const find-file-other-window)
1563                  (const find-file-other-frame)))
1564           (cons (const wl)
1565                 (choice
1566                  (const wl)
1567                  (const wl-other-frame)))))
1568
1569 (defcustom org-display-internal-link-with-indirect-buffer nil
1570   "Non-nil means use indirect buffer to display infile links.
1571 Activating internal links (from one location in a file to another location
1572 in the same file) normally just jumps to the location.  When the link is
1573 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1574 is displayed in
1575 another window.  When this option is set, the other window actually displays
1576 an indirect buffer clone of the current buffer, to avoid any visibility
1577 changes to the current buffer."
1578   :group 'org-link-follow
1579   :type 'boolean)
1580
1581 (defcustom org-open-non-existing-files nil
1582   "Non-nil means `org-open-file' will open non-existing files.
1583 When nil, an error will be generated.
1584 This variable applies only to external applications because they
1585 might choke on non-existing files.  If the link is to a file that
1586 will be opened in Emacs, the variable is ignored."
1587   :group 'org-link-follow
1588   :type 'boolean)
1589
1590 (defcustom org-open-directory-means-index-dot-org nil
1591   "Non-nil means a link to a directory really means to index.org.
1592 When nil, following a directory link will run dired or open a finder/explorer
1593 window on that directory."
1594   :group 'org-link-follow
1595   :type 'boolean)
1596
1597 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1598   "Function and arguments to call for following mailto links.
1599 This is a list with the first element being a Lisp function, and the
1600 remaining elements being arguments to the function.  In string arguments,
1601 %a will be replaced by the address, and %s will be replaced by the subject
1602 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1603   :group 'org-link-follow
1604   :type '(choice
1605           (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1606           (const :tag "compose-mail" (compose-mail "%a" "%s"))
1607           (const :tag "message-mail" (message-mail "%a" "%s"))
1608           (cons :tag "other" (function) (repeat :tag "argument" sexp))))
1609
1610 (defcustom org-confirm-shell-link-function 'yes-or-no-p
1611   "Non-nil means ask for confirmation before executing shell links.
1612 Shell links can be dangerous: just think about a link
1613
1614      [[shell:rm -rf ~/*][Google Search]]
1615
1616 This link would show up in your Org-mode document as \"Google Search\",
1617 but really it would remove your entire home directory.
1618 Therefore we advise against setting this variable to nil.
1619 Just change it to `y-or-n-p' if you want to confirm with a
1620 single keystroke rather than having to type \"yes\"."
1621   :group 'org-link-follow
1622   :type '(choice
1623           (const :tag "with yes-or-no (safer)" yes-or-no-p)
1624           (const :tag "with y-or-n (faster)" y-or-n-p)
1625           (const :tag "no confirmation (dangerous)" nil)))
1626 (put 'org-confirm-shell-link-function
1627      'safe-local-variable
1628      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1629
1630 (defcustom org-confirm-shell-link-not-regexp ""
1631   "A regexp to skip confirmation for shell links."
1632   :group 'org-link-follow
1633   :type 'regexp)
1634
1635 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
1636   "Non-nil means ask for confirmation before executing Emacs Lisp links.
1637 Elisp links can be dangerous: just think about a link
1638
1639      [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
1640
1641 This link would show up in your Org-mode document as \"Google Search\",
1642 but really it would remove your entire home directory.
1643 Therefore we advise against setting this variable to nil.
1644 Just change it to `y-or-n-p' if you want to confirm with a
1645 single keystroke rather than having to type \"yes\"."
1646   :group 'org-link-follow
1647   :type '(choice
1648           (const :tag "with yes-or-no (safer)" yes-or-no-p)
1649           (const :tag "with y-or-n (faster)" y-or-n-p)
1650           (const :tag "no confirmation (dangerous)" nil)))
1651 (put 'org-confirm-shell-link-function
1652      'safe-local-variable
1653      #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
1654
1655 (defcustom org-confirm-elisp-link-not-regexp ""
1656   "A regexp to skip confirmation for Elisp links."
1657   :group 'org-link-follow
1658   :type 'regexp)
1659
1660 (defconst org-file-apps-defaults-gnu
1661   '((remote . emacs)
1662     (system . mailcap)
1663     (t . mailcap))
1664   "Default file applications on a UNIX or GNU/Linux system.
1665 See `org-file-apps'.")
1666
1667 (defconst org-file-apps-defaults-macosx
1668   '((remote . emacs)
1669     (t . "open %s")
1670     (system . "open %s")
1671     ("ps.gz"  . "gv %s")
1672     ("eps.gz" . "gv %s")
1673     ("dvi"    . "xdvi %s")
1674     ("fig"    . "xfig %s"))
1675   "Default file applications on a MacOS X system.
1676 The system \"open\" is known as a default, but we use X11 applications
1677 for some files for which the OS does not have a good default.
1678 See `org-file-apps'.")
1679
1680 (defconst org-file-apps-defaults-windowsnt
1681   (list
1682    '(remote . emacs)
1683    (cons t
1684          (list (if (featurep 'xemacs)
1685                    'mswindows-shell-execute
1686                  'w32-shell-execute)
1687                "open" 'file))
1688    (cons 'system
1689          (list (if (featurep 'xemacs)
1690                    'mswindows-shell-execute
1691                  'w32-shell-execute)
1692                "open" 'file)))
1693   "Default file applications on a Windows NT system.
1694 The system \"open\" is used for most files.
1695 See `org-file-apps'.")
1696
1697 (defcustom org-file-apps
1698   '(
1699     (auto-mode . emacs)
1700     ("\\.mm\\'" . default)
1701     ("\\.x?html?\\'" . default)
1702     ("\\.pdf\\'" . default)
1703     )
1704   "External applications for opening `file:path' items in a document.
1705 Org-mode uses system defaults for different file types, but
1706 you can use this variable to set the application for a given file
1707 extension.  The entries in this list are cons cells where the car identifies
1708 files and the cdr the corresponding command.  Possible values for the
1709 file identifier are
1710  \"string\"    A string as a file identifier can be interpreted in different
1711                ways, depending on its contents:
1712
1713                - Alphanumeric characters only:
1714                  Match links with this file extension.
1715                  Example: (\"pdf\" . \"evince %s\")
1716                           to open PDFs with evince.
1717
1718                - Regular expression: Match links where the
1719                  filename matches the regexp.  If you want to
1720                  use groups here, use shy groups.
1721
1722                  Example: (\"\\.x?html\\'\" . \"firefox %s\")
1723                           (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
1724                           to open *.html and *.xhtml with firefox.
1725
1726                - Regular expression which contains (non-shy) groups:
1727                  Match links where the whole link, including \"::\", and
1728                  anything after that, matches the regexp.
1729                  In a custom command string, %1, %2, etc. are replaced with
1730                  the parts of the link that were matched by the groups.
1731                  For backwards compatibility, if a command string is given
1732                  that does not use any of the group matches, this case is
1733                  handled identically to the second one (i.e. match against
1734                  file name only).
1735                  In a custom lisp form, you can access the group matches with
1736                  (match-string n link).
1737
1738                  Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
1739                      to open [[file:document.pdf::5]] with evince at page 5.
1740
1741  `directory'   Matches a directory
1742  `remote'      Matches a remote file, accessible through tramp or efs.
1743                Remote files most likely should be visited through Emacs
1744                because external applications cannot handle such paths.
1745 `auto-mode'    Matches files that are matched by any entry in `auto-mode-alist',
1746                so all files Emacs knows how to handle.  Using this with
1747                command `emacs' will open most files in Emacs.  Beware that this
1748                will also open html files inside Emacs, unless you add
1749                (\"html\" . default) to the list as well.
1750  t             Default for files not matched by any of the other options.
1751  `system'      The system command to open files, like `open' on Windows
1752                and Mac OS X, and mailcap under GNU/Linux.  This is the command
1753                that will be selected if you call `C-c C-o' with a double
1754                \\[universal-argument] \\[universal-argument] prefix.
1755
1756 Possible values for the command are:
1757  `emacs'       The file will be visited by the current Emacs process.
1758  `default'     Use the default application for this file type, which is the
1759                association for t in the list, most likely in the system-specific
1760                part.
1761                This can be used to overrule an unwanted setting in the
1762                system-specific variable.
1763  `system'      Use the system command for opening files, like \"open\".
1764                This command is specified by the entry whose car is `system'.
1765                Most likely, the system-specific version of this variable
1766                does define this command, but you can overrule/replace it
1767                here.
1768  string        A command to be executed by a shell; %s will be replaced
1769                by the path to the file.
1770  sexp          A Lisp form which will be evaluated.  The file path will
1771                be available in the Lisp variable `file'.
1772 For more examples, see the system specific constants
1773 `org-file-apps-defaults-macosx'
1774 `org-file-apps-defaults-windowsnt'
1775 `org-file-apps-defaults-gnu'."
1776   :group 'org-link-follow
1777   :type '(repeat
1778           (cons (choice :value ""
1779                         (string :tag "Extension")
1780                         (const :tag "System command to open files" system)
1781                         (const :tag "Default for unrecognized files" t)
1782                         (const :tag "Remote file" remote)
1783                         (const :tag "Links to a directory" directory)
1784                         (const :tag "Any files that have Emacs modes"
1785                                auto-mode))
1786                 (choice :value ""
1787                         (const :tag "Visit with Emacs" emacs)
1788                         (const :tag "Use default" default)
1789                         (const :tag "Use the system command" system)
1790                         (string :tag "Command")
1791                         (sexp :tag "Lisp form")))))
1792
1793
1794
1795 (defgroup org-refile nil
1796   "Options concerning refiling entries in Org-mode."
1797   :tag "Org Refile"
1798   :group 'org)
1799
1800 (defcustom org-directory "~/org"
1801   "Directory with org files.
1802 This is just a default location to look for Org files.  There is no need
1803 at all to put your files into this directory.  It is only used in the
1804 following situations:
1805
1806 1. When a remember template specifies a target file that is not an
1807    absolute path.  The path will then be interpreted relative to
1808    `org-directory'
1809 2. When a remember note is filed away in an interactive way (when exiting the
1810    note buffer with `C-1 C-c C-c'.  The user is prompted for an org file,
1811    with `org-directory' as the default path."
1812   :group 'org-refile
1813   :group 'org-remember
1814   :type 'directory)
1815
1816 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
1817   "Default target for storing notes.
1818 Used as a fall back file for org-remember.el and org-capture.el, for
1819 templates that do not specify a target file."
1820   :group 'org-refile
1821   :group 'org-remember
1822   :type '(choice
1823           (const :tag "Default from remember-data-file" nil)
1824           file))
1825
1826 (defcustom org-goto-interface 'outline
1827   "The default interface to be used for `org-goto'.
1828 Allowed values are:
1829 outline                  The interface shows an outline of the relevant file
1830                          and the correct heading is found by moving through
1831                          the outline or by searching with incremental search.
1832 outline-path-completion  Headlines in the current buffer are offered via
1833                          completion.  This is the interface also used by
1834                          the refile command."
1835   :group 'org-refile
1836   :type '(choice
1837           (const :tag "Outline" outline)
1838           (const :tag "Outline-path-completion" outline-path-completion)))
1839
1840 (defcustom org-goto-max-level 5
1841   "Maximum target level when running `org-goto' with refile interface."
1842   :group 'org-refile
1843   :type 'integer)
1844
1845 (defcustom org-reverse-note-order nil
1846   "Non-nil means store new notes at the beginning of a file or entry.
1847 When nil, new notes will be filed to the end of a file or entry.
1848 This can also be a list with cons cells of regular expressions that
1849 are matched against file names, and values."
1850   :group 'org-remember
1851   :group 'org-refile
1852   :type '(choice
1853           (const :tag "Reverse always" t)
1854           (const :tag "Reverse never" nil)
1855           (repeat :tag "By file name regexp"
1856                   (cons regexp boolean))))
1857
1858 (defcustom org-log-refile nil
1859   "Information to record when a task is refiled.
1860
1861 Possible values are:
1862
1863 nil     Don't add anything
1864 time    Add a time stamp to the task
1865 note    Prompt for a note and add it with template `org-log-note-headings'
1866
1867 This option can also be set with on a per-file-basis with
1868
1869    #+STARTUP: nologrefile
1870    #+STARTUP: logrefile
1871    #+STARTUP: lognoterefile
1872
1873 You can have local logging settings for a subtree by setting the LOGGING
1874 property to one or more of these keywords.
1875
1876 When bulk-refiling from the agenda, the value `note' is forbidden and
1877 will temporarily be changed to `time'."
1878   :group 'org-refile
1879   :group 'org-progress
1880   :type '(choice
1881           (const :tag "No logging" nil)
1882           (const :tag "Record timestamp" time)
1883           (const :tag "Record timestamp with note." note)))
1884
1885 (defcustom org-refile-targets nil
1886   "Targets for refiling entries with \\[org-refile].
1887 This is a list of cons cells.  Each cell contains:
1888 - a specification of the files to be considered, either a list of files,
1889   or a symbol whose function or variable value will be used to retrieve
1890   a file name or a list of file names.  If you use `org-agenda-files' for
1891   that, all agenda files will be scanned for targets.  Nil means consider
1892   headings in the current buffer.
1893 - A specification of how to find candidate refile targets.  This may be
1894   any of:
1895   - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
1896     This tag has to be present in all target headlines, inheritance will
1897     not be considered.
1898   - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
1899     todo keyword.
1900   - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
1901     headlines that are refiling targets.
1902   - a cons cell (:level . N).  Any headline of level N is considered a target.
1903     Note that, when `org-odd-levels-only' is set, level corresponds to
1904     order in hierarchy, not to the number of stars.
1905   - a cons cell (:maxlevel . N).  Any headline with level <= N is a target.
1906     Note that, when `org-odd-levels-only' is set, level corresponds to
1907     order in hierarchy, not to the number of stars.
1908
1909 Each element of this list generates a set of possible targets.
1910 The union of these sets is presented (with completion) to
1911 the user by `org-refile'.
1912
1913 You can set the variable `org-refile-target-verify-function' to a function
1914 to verify each headline found by the simple criteria above.
1915
1916 When this variable is nil, all top-level headlines in the current buffer
1917 are used, equivalent to the value `((nil . (:level . 1))'."
1918   :group 'org-refile
1919   :type '(repeat
1920           (cons
1921            (choice :value org-agenda-files
1922                    (const :tag "All agenda files" org-agenda-files)
1923                    (const :tag "Current buffer" nil)
1924                    (function) (variable) (file))
1925            (choice :tag "Identify target headline by"
1926             (cons :tag "Specific tag" (const :value :tag) (string))
1927             (cons :tag "TODO keyword" (const :value :todo) (string))
1928             (cons :tag "Regular expression" (const :value :regexp) (regexp))
1929             (cons :tag "Level number" (const :value :level) (integer))
1930             (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
1931
1932 (defcustom org-refile-target-verify-function nil
1933   "Function to verify if the headline at point should be a refile target.
1934 The function will be called without arguments, with point at the
1935 beginning of the headline.  It should return t and leave point
1936 where it is if the headline is a valid target for refiling.
1937
1938 If the target should not be selected, the function must return nil.
1939 In addition to this, it may move point to a place from where the search
1940 should be continued.  For example, the function may decide that the entire
1941 subtree of the current entry should be excluded and move point to the end
1942 of the subtree."
1943   :group 'org-refile
1944   :type 'function)
1945
1946 (defcustom org-refile-use-cache nil
1947   "Non-nil means cache refile targets to speed up the process.
1948 The cache for a particular file will be updated automatically when
1949 the buffer has been killed, or when any of the marker used for flagging
1950 refile targets no longer points at a live buffer.
1951 If you have added new entries to a buffer that might themselves be targets,
1952 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
1953 find that easier, `C-u C-u C-u C-c C-w'."
1954   :group 'org-refile
1955   :type 'boolean)
1956
1957 (defcustom org-refile-use-outline-path nil
1958   "Non-nil means provide refile targets as paths.
1959 So a level 3 headline will be available as level1/level2/level3.
1960
1961 When the value is `file', also include the file name (without directory)
1962 into the path.  In this case, you can also stop the completion after
1963 the file name, to get entries inserted as top level in the file.
1964
1965 When `full-file-path', include the full file path."
1966   :group 'org-refile
1967   :type '(choice
1968           (const :tag "Not" nil)
1969           (const :tag "Yes" t)
1970           (const :tag "Start with file name" file)
1971           (const :tag "Start with full file path" full-file-path)))
1972
1973 (defcustom org-outline-path-complete-in-steps t
1974   "Non-nil means complete the outline path in hierarchical steps.
1975 When Org-mode uses the refile interface to select an outline path
1976 \(see variable `org-refile-use-outline-path'), the completion of
1977 the path can be done is a single go, or if can be done in steps down
1978 the headline hierarchy.  Going in steps is probably the best if you
1979 do not use a special completion package like `ido' or `icicles'.
1980 However, when using these packages, going in one step can be very
1981 fast, while still showing the whole path to the entry."
1982   :group 'org-refile
1983   :type 'boolean)
1984
1985 (defcustom org-refile-allow-creating-parent-nodes nil
1986   "Non-nil means allow to create new nodes as refile targets.
1987 New nodes are then created by adding \"/new node name\" to the completion
1988 of an existing node.  When the value of this variable is `confirm',
1989 new node creation must be confirmed by the user (recommended)
1990 When nil, the completion must match an existing entry.
1991
1992 Note that, if the new heading is not seen by the criteria
1993 listed in `org-refile-targets', multiple instances of the same
1994 heading would be created by trying again to file under the new
1995 heading."
1996   :group 'org-refile
1997   :type '(choice
1998           (const :tag "Never" nil)
1999           (const :tag "Always" t)
2000           (const :tag "Prompt for confirmation" confirm)))
2001
2002 (defcustom org-refile-active-region-within-subtree nil
2003   "Non-nil means also refile active region within a subtree.
2004
2005 By default `org-refile' doesn't allow refiling regions if they
2006 don't contain a set of subtrees, but it might be convenient to
2007 do so sometimes: in that case, the first line of the region is
2008 converted to a headline before refiling."
2009   :group 'org-refile
2010   :type 'boolean)
2011
2012 (defgroup org-todo nil
2013   "Options concerning TODO items in Org-mode."
2014   :tag "Org TODO"
2015   :group 'org)
2016
2017 (defgroup org-progress nil
2018   "Options concerning Progress logging in Org-mode."
2019   :tag "Org Progress"
2020   :group 'org-time)
2021
2022 (defvar org-todo-interpretation-widgets
2023   '((:tag "Sequence (cycling hits every state)" sequence)
2024     (:tag "Type     (cycling directly to DONE)" type))
2025   "The available interpretation symbols for customizing `org-todo-keywords'.
2026 Interested libraries should add to this list.")
2027
2028 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2029   "List of TODO entry keyword sequences and their interpretation.
2030 \\<org-mode-map>This is a list of sequences.
2031
2032 Each sequence starts with a symbol, either `sequence' or `type',
2033 indicating if the keywords should be interpreted as a sequence of
2034 action steps, or as different types of TODO items.  The first
2035 keywords are states requiring action - these states will select a headline
2036 for inclusion into the global TODO list Org-mode produces.  If one of
2037 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2038 signify that no further action is necessary.  If \"|\" is not found,
2039 the last keyword is treated as the only DONE state of the sequence.
2040
2041 The command \\[org-todo] cycles an entry through these states, and one
2042 additional state where no keyword is present.  For details about this
2043 cycling, see the manual.
2044
2045 TODO keywords and interpretation can also be set on a per-file basis with
2046 the special #+SEQ_TODO and #+TYP_TODO lines.
2047
2048 Each keyword can optionally specify a character for fast state selection
2049 \(in combination with the variable `org-use-fast-todo-selection')
2050 and specifiers for state change logging, using the same syntax
2051 that is used in the \"#+TODO:\" lines.  For example, \"WAIT(w)\" says
2052 that the WAIT state can be selected with the \"w\" key.  \"WAIT(w!)\"
2053 indicates to record a time stamp each time this state is selected.
2054
2055 Each keyword may also specify if a timestamp or a note should be
2056 recorded when entering or leaving the state, by adding additional
2057 characters in the parenthesis after the keyword.  This looks like this:
2058 \"WAIT(w@/!)\".  \"@\" means to add a note (with time), \"!\" means to
2059 record only the time of the state change.  With X and Y being either
2060 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2061 Y when leaving the state if and only if the *target* state does not
2062 define X.  You may omit any of the fast-selection key or X or /Y,
2063 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2064
2065 For backward compatibility, this variable may also be just a list
2066 of keywords - in this case the interpretation (sequence or type) will be
2067 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2068   :group 'org-todo
2069   :group 'org-keywords
2070   :type '(choice
2071           (repeat :tag "Old syntax, just keywords"
2072                   (string :tag "Keyword"))
2073           (repeat :tag "New syntax"
2074                   (cons
2075                    (choice
2076                     :tag "Interpretation"
2077                     ;;Quick and dirty way to see
2078                     ;;`org-todo-interpretations'.  This takes the
2079                     ;;place of item arguments
2080                     :convert-widget
2081                     (lambda (widget)
2082                       (widget-put widget
2083                                   :args (mapcar
2084                                          #'(lambda (x)
2085                                              (widget-convert
2086                                               (cons 'const x)))
2087                                          org-todo-interpretation-widgets))
2088                       widget))
2089                    (repeat
2090                     (string :tag "Keyword"))))))
2091
2092 (defvar org-todo-keywords-1 nil
2093   "All TODO and DONE keywords active in a buffer.")
2094 (make-variable-buffer-local 'org-todo-keywords-1)
2095 (defvar org-todo-keywords-for-agenda nil)
2096 (defvar org-done-keywords-for-agenda nil)
2097 (defvar org-drawers-for-agenda nil)
2098 (defvar org-todo-keyword-alist-for-agenda nil)
2099 (defvar org-tag-alist-for-agenda nil)
2100 (defvar org-agenda-contributing-files nil)
2101 (defvar org-not-done-keywords nil)
2102 (make-variable-buffer-local 'org-not-done-keywords)
2103 (defvar org-done-keywords nil)
2104 (make-variable-buffer-local 'org-done-keywords)
2105 (defvar org-todo-heads nil)
2106 (make-variable-buffer-local 'org-todo-heads)
2107 (defvar org-todo-sets nil)
2108 (make-variable-buffer-local 'org-todo-sets)
2109 (defvar org-todo-log-states nil)
2110 (make-variable-buffer-local 'org-todo-log-states)
2111 (defvar org-todo-kwd-alist nil)
2112 (make-variable-buffer-local 'org-todo-kwd-alist)
2113 (defvar org-todo-key-alist nil)
2114 (make-variable-buffer-local 'org-todo-key-alist)
2115 (defvar org-todo-key-trigger nil)
2116 (make-variable-buffer-local 'org-todo-key-trigger)
2117
2118 (defcustom org-todo-interpretation 'sequence
2119   "Controls how TODO keywords are interpreted.
2120 This variable is in principle obsolete and is only used for
2121 backward compatibility, if the interpretation of todo keywords is
2122 not given already in `org-todo-keywords'.  See that variable for
2123 more information."
2124   :group 'org-todo
2125   :group 'org-keywords
2126   :type '(choice (const sequence)
2127                  (const type)))
2128
2129 (defcustom org-use-fast-todo-selection t
2130   "Non-nil means use the fast todo selection scheme with C-c C-t.
2131 This variable describes if and under what circumstances the cycling
2132 mechanism for TODO keywords will be replaced by a single-key, direct
2133 selection scheme.
2134
2135 When nil, fast selection is never used.
2136
2137 When the symbol `prefix', it will be used when `org-todo' is called with
2138 a prefix argument,  i.e. `C-u C-c C-t' in an Org-mode buffer, and `C-u t'
2139 in an agenda buffer.
2140
2141 When t, fast selection is used by default.  In this case, the prefix
2142 argument forces cycling instead.
2143
2144 In all cases, the special interface is only used if access keys have actually
2145 been assigned by the user, i.e. if keywords in the configuration are followed
2146 by a letter in parenthesis, like TODO(t)."
2147   :group 'org-todo
2148   :type '(choice
2149           (const :tag "Never" nil)
2150           (const :tag "By default" t)
2151           (const :tag "Only with C-u C-c C-t" prefix)))
2152
2153 (defcustom org-provide-todo-statistics t
2154   "Non-nil means update todo statistics after insert and toggle.
2155 ALL-HEADLINES means update todo statistics by including headlines
2156 with no TODO keyword as well, counting them as not done.
2157 A list of TODO keywords means the same, but skip keywords that are
2158 not in this list.
2159
2160 When this is set, todo statistics is updated in the parent of the
2161 current entry each time a todo state is changed."
2162   :group 'org-todo
2163   :type '(choice
2164           (const :tag "Yes, only for TODO entries" t)
2165           (const :tag "Yes, including all entries" 'all-headlines)
2166           (repeat :tag "Yes, for TODOs in this list"
2167                   (string :tag "TODO keyword"))
2168           (other :tag "No TODO statistics" nil)))
2169
2170 (defcustom org-hierarchical-todo-statistics t
2171   "Non-nil means TODO statistics covers just direct children.
2172 When nil, all entries in the subtree are considered.
2173 This has only an effect if `org-provide-todo-statistics' is set.
2174 To set this to nil for only a single subtree, use a COOKIE_DATA
2175 property and include the word \"recursive\" into the value."
2176   :group 'org-todo
2177   :type 'boolean)
2178
2179 (defcustom org-after-todo-state-change-hook nil
2180   "Hook which is run after the state of a TODO item was changed.
2181 The new state (a string with a TODO keyword, or nil) is available in the
2182 Lisp variable `state'."
2183   :group 'org-todo
2184   :type 'hook)
2185
2186 (defvar org-blocker-hook nil
2187   "Hook for functions that are allowed to block a state change.
2188
2189 Each function gets as its single argument a property list, see
2190 `org-trigger-hook' for more information about this list.
2191
2192 If any of the functions in this hook returns nil, the state change
2193 is blocked.")
2194
2195 (defvar org-trigger-hook nil
2196   "Hook for functions that are triggered by a state change.
2197
2198 Each function gets as its single argument a property list with at least
2199 the following elements:
2200
2201  (:type type-of-change :position pos-at-entry-start
2202   :from old-state :to new-state)
2203
2204 Depending on the type, more properties may be present.
2205
2206 This mechanism is currently implemented for:
2207
2208 TODO state changes
2209 ------------------
2210 :type  todo-state-change
2211 :from  previous state (keyword as a string), or nil, or a symbol
2212        'todo' or 'done', to indicate the general type of state.
2213 :to    new state, like in :from")
2214
2215 (defcustom org-enforce-todo-dependencies nil
2216   "Non-nil means undone TODO entries will block switching the parent to DONE.
2217 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2218 be blocked if any prior sibling is not yet done.
2219 Finally, if the parent is blocked because of ordered siblings of its own,
2220 the child will also be blocked.
2221 This variable needs to be set before org.el is loaded, and you need to
2222 restart Emacs after a change to make the change effective.  The only way
2223 to change is while Emacs is running is through the customize interface."
2224   :set (lambda (var val)
2225          (set var val)
2226          (if val
2227              (add-hook 'org-blocker-hook
2228                        'org-block-todo-from-children-or-siblings-or-parent)
2229            (remove-hook 'org-blocker-hook
2230                         'org-block-todo-from-children-or-siblings-or-parent)))
2231   :group 'org-todo
2232   :type 'boolean)
2233
2234 (defcustom org-enforce-todo-checkbox-dependencies nil
2235   "Non-nil means unchecked boxes will block switching the parent to DONE.
2236 When this is nil, checkboxes have no influence on switching TODO states.
2237 When non-nil, you first need to check off all check boxes before the TODO
2238 entry can be switched to DONE.
2239 This variable needs to be set before org.el is loaded, and you need to
2240 restart Emacs after a change to make the change effective.  The only way
2241 to change is while Emacs is running is through the customize interface."
2242   :set (lambda (var val)
2243          (set var val)
2244          (if val
2245              (add-hook 'org-blocker-hook
2246                        'org-block-todo-from-checkboxes)
2247            (remove-hook 'org-blocker-hook
2248                         'org-block-todo-from-checkboxes)))
2249   :group 'org-todo
2250   :type 'boolean)
2251
2252 (defcustom org-treat-insert-todo-heading-as-state-change nil
2253   "Non-nil means inserting a TODO heading is treated as state change.
2254 So when the command \\[org-insert-todo-heading] is used, state change
2255 logging will apply if appropriate.  When nil, the new TODO item will
2256 be inserted directly, and no logging will take place."
2257   :group 'org-todo
2258   :type 'boolean)
2259
2260 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2261   "Non-nil means switching TODO states with S-cursor counts as state change.
2262 This is the default behavior.  However, setting this to nil allows a
2263 convenient way to select a TODO state and bypass any logging associated
2264 with that."
2265   :group 'org-todo
2266   :type 'boolean)
2267
2268 (defcustom org-todo-state-tags-triggers nil
2269   "Tag changes that should be triggered by TODO state changes.
2270 This is a list.  Each entry is
2271
2272   (state-change (tag . flag) .......)
2273
2274 State-change can be a string with a state, and empty string to indicate the
2275 state that has no TODO keyword, or it can be one of the symbols `todo'
2276 or `done', meaning any not-done or done state, respectively."
2277   :group 'org-todo
2278   :group 'org-tags
2279   :type '(repeat
2280           (cons (choice :tag "When changing to"
2281                  (const :tag "Not-done state" todo)
2282                  (const :tag "Done state" done)
2283                  (string :tag "State"))
2284                 (repeat
2285                  (cons :tag "Tag action"
2286                        (string :tag "Tag")
2287                        (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2288
2289 (defcustom org-log-done nil
2290   "Information to record when a task moves to the DONE state.
2291
2292 Possible values are:
2293
2294 nil     Don't add anything, just change the keyword
2295 time    Add a time stamp to the task
2296 note    Prompt for a note and add it with template `org-log-note-headings'
2297
2298 This option can also be set with on a per-file-basis with
2299
2300    #+STARTUP: nologdone
2301    #+STARTUP: logdone
2302    #+STARTUP: lognotedone
2303
2304 You can have local logging settings for a subtree by setting the LOGGING
2305 property to one or more of these keywords."
2306   :group 'org-todo
2307   :group 'org-progress
2308   :type '(choice
2309           (const :tag "No logging" nil)
2310           (const :tag "Record CLOSED timestamp" time)
2311           (const :tag "Record CLOSED timestamp with note." note)))
2312
2313 ;; Normalize old uses of org-log-done.
2314 (cond
2315  ((eq org-log-done t) (setq org-log-done 'time))
2316  ((and (listp org-log-done) (memq 'done org-log-done))
2317   (setq org-log-done 'note)))
2318
2319 (defcustom org-log-reschedule nil
2320   "Information to record when the scheduling date of a tasks is modified.
2321
2322 Possible values are:
2323
2324 nil     Don't add anything, just change the date
2325 time    Add a time stamp to the task
2326 note    Prompt for a note and add it with template `org-log-note-headings'
2327
2328 This option can also be set with on a per-file-basis with
2329
2330    #+STARTUP: nologreschedule
2331    #+STARTUP: logreschedule
2332    #+STARTUP: lognotereschedule"
2333   :group 'org-todo
2334   :group 'org-progress
2335   :type '(choice
2336           (const :tag "No logging" nil)
2337           (const :tag "Record timestamp" time)
2338           (const :tag "Record timestamp with note." note)))
2339
2340 (defcustom org-log-redeadline nil
2341   "Information to record when the deadline date of a tasks is modified.
2342
2343 Possible values are:
2344
2345 nil     Don't add anything, just change the date
2346 time    Add a time stamp to the task
2347 note    Prompt for a note and add it with template `org-log-note-headings'
2348
2349 This option can also be set with on a per-file-basis with
2350
2351    #+STARTUP: nologredeadline
2352    #+STARTUP: logredeadline
2353    #+STARTUP: lognoteredeadline
2354
2355 You can have local logging settings for a subtree by setting the LOGGING
2356 property to one or more of these keywords."
2357   :group 'org-todo
2358   :group 'org-progress
2359   :type '(choice
2360           (const :tag "No logging" nil)
2361           (const :tag "Record timestamp" time)
2362           (const :tag "Record timestamp with note." note)))
2363
2364 (defcustom org-log-note-clock-out nil
2365   "Non-nil means record a note when clocking out of an item.
2366 This can also be configured on a per-file basis by adding one of
2367 the following lines anywhere in the buffer:
2368
2369    #+STARTUP: lognoteclock-out
2370    #+STARTUP: nolognoteclock-out"
2371   :group 'org-todo
2372   :group 'org-progress
2373   :type 'boolean)
2374
2375 (defcustom org-log-done-with-time t
2376   "Non-nil means the CLOSED time stamp will contain date and time.
2377 When nil, only the date will be recorded."
2378   :group 'org-progress
2379   :type 'boolean)
2380
2381 (defcustom org-log-note-headings
2382   '((done .  "CLOSING NOTE %t")
2383     (state . "State %-12s from %-12S %t")
2384     (note .  "Note taken on %t")
2385     (reschedule .  "Rescheduled from %S on %t")
2386     (delschedule .  "Not scheduled, was %S on %t")
2387     (redeadline .  "New deadline from %S on %t")
2388     (deldeadline .  "Removed deadline, was %S on %t")
2389     (refile . "Refiled on %t")
2390     (clock-out . ""))
2391   "Headings for notes added to entries.
2392 The value is an alist, with the car being a symbol indicating the note
2393 context, and the cdr is the heading to be used.  The heading may also be the
2394 empty string.
2395 %t in the heading will be replaced by a time stamp.
2396 %T will be an active time stamp instead the default inactive one
2397 %d will be replaced by a short-format time stamp.
2398 %D will be replaced by an active short-format time stamp.
2399 %s will be replaced by the new TODO state, in double quotes.
2400 %S will be replaced by the old TODO state, in double quotes.
2401 %u will be replaced by the user name.
2402 %U will be replaced by the full user name.
2403
2404 In fact, it is not a good idea to change the `state' entry, because
2405 agenda log mode depends on the format of these entries."
2406   :group  'org-todo
2407   :group  'org-progress
2408   :type '(list :greedy t
2409           (cons (const :tag "Heading when closing an item" done) string)
2410           (cons (const :tag
2411                        "Heading when changing todo state (todo sequence only)"
2412                        state) string)
2413           (cons (const :tag "Heading when just taking a note" note) string)
2414           (cons (const :tag "Heading when clocking out" clock-out) string)
2415           (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2416           (cons (const :tag "Heading when rescheduling" reschedule) string)
2417           (cons (const :tag "Heading when changing deadline"  redeadline) string)
2418           (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2419           (cons (const :tag "Heading when refiling" refile) string)))
2420
2421 (unless (assq 'note org-log-note-headings)
2422   (push '(note . "%t") org-log-note-headings))
2423
2424 (defcustom org-log-into-drawer nil
2425   "Non-nil means insert state change notes and time stamps into a drawer.
2426 When nil, state changes notes will be inserted after the headline and
2427 any scheduling and clock lines, but not inside a drawer.
2428
2429 The value of this variable should be the name of the drawer to use.
2430 LOGBOOK is proposed as the default drawer for this purpose, you can
2431 also set this to a string to define the drawer of your choice.
2432
2433 A value of t is also allowed, representing \"LOGBOOK\".
2434
2435 If this variable is set, `org-log-state-notes-insert-after-drawers'
2436 will be ignored.
2437
2438 You can set the property LOG_INTO_DRAWER to overrule this setting for
2439 a subtree."
2440   :group 'org-todo
2441   :group 'org-progress
2442   :type '(choice
2443           (const :tag "Not into a drawer" nil)
2444           (const :tag "LOGBOOK" t)
2445           (string :tag "Other")))
2446
2447 (if (fboundp 'defvaralias)
2448     (defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer))
2449
2450 (defun org-log-into-drawer ()
2451   "Return the value of `org-log-into-drawer', but let properties overrule.
2452 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2453 used instead of the default value."
2454   (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
2455     (cond
2456      ((or (not p) (equal p "nil")) org-log-into-drawer)
2457      ((equal p "t") "LOGBOOK")
2458      (t p))))
2459
2460 (defcustom org-log-state-notes-insert-after-drawers nil
2461   "Non-nil means insert state change notes after any drawers in entry.
2462 Only the drawers that *immediately* follow the headline and the
2463 deadline/scheduled line are skipped.
2464 When nil, insert notes right after the heading and perhaps the line
2465 with deadline/scheduling if present.
2466
2467 This variable will have no effect if `org-log-into-drawer' is
2468 set."
2469   :group 'org-todo
2470   :group 'org-progress
2471   :type 'boolean)
2472
2473 (defcustom org-log-states-order-reversed t
2474   "Non-nil means the latest state note will be directly after heading.
2475 When nil, the state change notes will be ordered according to time."
2476   :group 'org-todo
2477   :group 'org-progress
2478   :type 'boolean)
2479
2480 (defcustom org-todo-repeat-to-state nil
2481   "The TODO state to which a repeater should return the repeating task.
2482 By default this is the first task in a TODO sequence, or the previous state
2483 in a TODO_TYP set.  But you can specify another task here.
2484 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2485   :group 'org-todo
2486   :type '(choice (const :tag "Head of sequence" nil)
2487                  (string :tag "Specific state")))
2488
2489 (defcustom org-log-repeat 'time
2490   "Non-nil means record moving through the DONE state when triggering repeat.
2491 An auto-repeating task is immediately switched back to TODO when
2492 marked DONE.  If you are not logging state changes (by adding \"@\"
2493 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2494 record a closing note, there will be no record of the task moving
2495 through DONE.  This variable forces taking a note anyway.
2496
2497 nil     Don't force a record
2498 time    Record a time stamp
2499 note    Record a note
2500
2501 This option can also be set with on a per-file-basis with
2502
2503    #+STARTUP: logrepeat
2504    #+STARTUP: lognoterepeat
2505    #+STARTUP: nologrepeat
2506
2507 You can have local logging settings for a subtree by setting the LOGGING
2508 property to one or more of these keywords."
2509   :group 'org-todo
2510   :group 'org-progress
2511   :type '(choice
2512           (const :tag "Don't force a record" nil)
2513           (const :tag "Force recording the DONE state" time)
2514           (const :tag "Force recording a note with the DONE state" note)))
2515
2516
2517 (defgroup org-priorities nil
2518   "Priorities in Org-mode."
2519   :tag "Org Priorities"
2520   :group 'org-todo)
2521
2522 (defcustom org-enable-priority-commands t
2523   "Non-nil means priority commands are active.
2524 When nil, these commands will be disabled, so that you never accidentally
2525 set a priority."
2526   :group 'org-priorities
2527   :type 'boolean)
2528
2529 (defcustom org-highest-priority ?A
2530   "The highest priority of TODO items.  A character like ?A, ?B etc.
2531 Must have a smaller ASCII number than `org-lowest-priority'."
2532   :group 'org-priorities
2533   :type 'character)
2534
2535 (defcustom org-lowest-priority ?C
2536   "The lowest priority of TODO items.  A character like ?A, ?B etc.
2537 Must have a larger ASCII number than `org-highest-priority'."
2538   :group 'org-priorities
2539   :type 'character)
2540
2541 (defcustom org-default-priority ?B
2542   "The default priority of TODO items.
2543 This is the priority an item gets if no explicit priority is given.
2544 When starting to cycle on an empty priority the first step in the cycle
2545 depends on `org-priority-start-cycle-with-default'.  The resulting first
2546 step priority must not exceed the range from `org-highest-priority' to
2547 `org-lowest-priority' which means that `org-default-priority' has to be
2548 in this range exclusive or inclusive the range boundaries.  Else the
2549 first step refuses to set the default and the second will fall back
2550 to (depending on the command used) the highest or lowest priority."
2551   :group 'org-priorities
2552   :type 'character)
2553
2554 (defcustom org-priority-start-cycle-with-default t
2555   "Non-nil means start with default priority when starting to cycle.
2556 When this is nil, the first step in the cycle will be (depending on the
2557 command used) one higher or lower than the default priority.
2558 See also `org-default-priority'."
2559   :group 'org-priorities
2560   :type 'boolean)
2561
2562 (defcustom org-get-priority-function nil
2563   "Function to extract the priority from a string.
2564 The string is normally the headline.  If this is nil Org computes the
2565 priority from the priority cookie like [#A] in the headline.  It returns
2566 an integer, increasing by 1000 for each priority level.
2567 The user can set a different function here, which should take a string
2568 as an argument and return the numeric priority."
2569   :group 'org-priorities
2570   :type 'function)
2571
2572 (defgroup org-time nil
2573   "Options concerning time stamps and deadlines in Org-mode."
2574   :tag "Org Time"
2575   :group 'org)
2576
2577 (defcustom org-insert-labeled-timestamps-at-point nil
2578   "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
2579 When nil, these labeled time stamps are forces into the second line of an
2580 entry, just after the headline.  When scheduling from the global TODO list,
2581 the time stamp will always be forced into the second line."
2582   :group 'org-time
2583   :type 'boolean)
2584
2585 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
2586   "Formats for `format-time-string' which are used for time stamps.
2587 It is not recommended to change this constant.")
2588
2589 (defcustom org-time-stamp-rounding-minutes '(0 5)
2590   "Number of minutes to round time stamps to.
2591 These are two values, the first applies when first creating a time stamp.
2592 The second applies when changing it with the commands `S-up' and `S-down'.
2593 When changing the time stamp, this means that it will change in steps
2594 of N minutes, as given by the second value.
2595
2596 When a setting is 0 or 1, insert the time unmodified.  Useful rounding
2597 numbers should be factors of 60, so for example 5, 10, 15.
2598
2599 When this is larger than 1, you can still force an exact time stamp by using
2600 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
2601 and by using a prefix arg to `S-up/down' to specify the exact number
2602 of minutes to shift."
2603   :group 'org-time
2604   :get #'(lambda (var) ; Make sure both elements are there
2605           (if (integerp (default-value var))
2606               (list (default-value var) 5)
2607             (default-value var)))
2608   :type '(list
2609           (integer :tag "when inserting times")
2610           (integer :tag "when modifying times")))
2611
2612 ;; Normalize old customizations of this variable.
2613 (when (integerp org-time-stamp-rounding-minutes)
2614   (setq org-time-stamp-rounding-minutes
2615         (list org-time-stamp-rounding-minutes
2616               org-time-stamp-rounding-minutes)))
2617
2618 (defcustom org-display-custom-times nil
2619   "Non-nil means overlay custom formats over all time stamps.
2620 The formats are defined through the variable `org-time-stamp-custom-formats'.
2621 To turn this on on a per-file basis, insert anywhere in the file:
2622    #+STARTUP: customtime"
2623   :group 'org-time
2624   :set 'set-default
2625   :type 'sexp)
2626 (make-variable-buffer-local 'org-display-custom-times)
2627
2628 (defcustom org-time-stamp-custom-formats
2629   '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
2630   "Custom formats for time stamps.  See `format-time-string' for the syntax.
2631 These are overlayed over the default ISO format if the variable
2632 `org-display-custom-times' is set.  Time like %H:%M should be at the
2633 end of the second format.  The custom formats are also honored by export
2634 commands, if custom time display is turned on at the time of export."
2635   :group 'org-time
2636   :type 'sexp)
2637
2638 (defun org-time-stamp-format (&optional long inactive)
2639   "Get the right format for a time string."
2640   (let ((f (if long (cdr org-time-stamp-formats)
2641              (car org-time-stamp-formats))))
2642     (if inactive
2643         (concat "[" (substring f 1 -1) "]")
2644       f)))
2645
2646 (defcustom org-time-clocksum-format "%d:%02d"
2647   "The format string used when creating CLOCKSUM lines.
2648 This is also used when org-mode generates a time duration."
2649   :group 'org-time
2650   :type 'string)
2651
2652 (defcustom org-time-clocksum-use-fractional nil
2653   "If non-nil, \\[org-clock-display] uses fractional times.
2654 org-mode generates a time duration."
2655   :group 'org-time
2656   :type 'boolean)
2657
2658 (defcustom org-time-clocksum-fractional-format "%.2f"
2659   "The format string used when creating CLOCKSUM lines, or when
2660 org-mode generates a time duration."
2661   :group 'org-time
2662   :type 'string)
2663
2664 (defcustom org-deadline-warning-days 14
2665   "No. of days before expiration during which a deadline becomes active.
2666 This variable governs the display in sparse trees and in the agenda.
2667 When 0 or negative, it means use this number (the absolute value of it)
2668 even if a deadline has a different individual lead time specified.
2669
2670 Custom commands can set this variable in the options section."
2671   :group 'org-time
2672   :group 'org-agenda-daily/weekly
2673   :type 'integer)
2674
2675 (defcustom org-read-date-prefer-future t
2676   "Non-nil means assume future for incomplete date input from user.
2677 This affects the following situations:
2678 1. The user gives a month but not a year.
2679    For example, if it is April and you enter \"feb 2\", this will be read
2680    as Feb 2, *next* year.  \"May 5\", however, will be this year.
2681 2. The user gives a day, but no month.
2682    For example, if today is the 15th, and you enter \"3\", Org-mode will
2683    read this as the third of *next* month.  However, if you enter \"17\",
2684    it will be considered as *this* month.
2685
2686 If you set this variable to the symbol `time', then also the following
2687 will work:
2688
2689 3. If the user gives a time, but no day.  If the time is before now,
2690    to will be interpreted as tomorrow.
2691
2692 Currently none of this works for ISO week specifications.
2693
2694 When this option is nil, the current day, month and year will always be
2695 used as defaults.
2696
2697 See also `org-agenda-jump-prefer-future'."
2698   :group 'org-time
2699   :type '(choice
2700           (const :tag "Never" nil)
2701           (const :tag "Check month and day" t)
2702           (const :tag "Check month, day, and time" time)))
2703
2704 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
2705   "Should the agenda jump command prefer the future for incomplete dates?
2706 The default is to do the same as configured in `org-read-date-prefer-future'.
2707 But you can also set a deviating value here.
2708 This may t or nil, or the symbol `org-read-date-prefer-future'."
2709   :group 'org-agenda
2710   :group 'org-time
2711   :type '(choice
2712           (const :tag "Use org-read-date-prefer-future"
2713                  org-read-date-prefer-future)
2714           (const :tag "Never" nil)
2715           (const :tag "Always" t)))
2716
2717 (defcustom org-read-date-force-compatible-dates t
2718   "Should date/time prompt force dates that are guaranteed to work in Emacs?
2719
2720 Depending on the system Emacs is running on, certain dates cannot
2721 be represented with the type used internally to represent time.
2722 Dates between 1970-1-1 and 2038-1-1 can always be represented
2723 correctly.  Some systems allow for earlier dates, some for later,
2724 some for both.  One way to find out it to insert any date into an
2725 Org buffer, putting the cursor on the year and hitting S-up and
2726 S-down to test the range.
2727
2728 When this variable is set to t, the date/time prompt will not let
2729 you specify dates outside the 1970-2037 range, so it is certain that
2730 these dates will work in whatever version of Emacs you are
2731 running, and also that you can move a file from one Emacs implementation
2732 to another.  WHenever Org is forcing the year for you, it will display
2733 a message and beep.
2734
2735 When this variable is nil, Org will check if the date is
2736 representable in the specific Emacs implementation you are using.
2737 If not, it will force a year, usually the current year, and beep
2738 to remind you.  Currently this setting is not recommended because
2739 the likelihood that you will open your Org files in an Emacs that
2740 has limited date range is not negligible.
2741
2742 A workaround for this problem is to use diary sexp dates for time
2743 stamps outside of this range."
2744   :group 'org-time
2745   :type 'boolean)
2746
2747 (defcustom org-read-date-display-live t
2748   "Non-nil means display current interpretation of date prompt live.
2749 This display will be in an overlay, in the minibuffer."
2750   :group 'org-time
2751   :type 'boolean)
2752
2753 (defcustom org-read-date-popup-calendar t
2754   "Non-nil means pop up a calendar when prompting for a date.
2755 In the calendar, the date can be selected with mouse-1.  However, the
2756 minibuffer will also be active, and you can simply enter the date as well.
2757 When nil, only the minibuffer will be available."
2758   :group 'org-time
2759   :type 'boolean)
2760 (if (fboundp 'defvaralias)
2761     (defvaralias 'org-popup-calendar-for-date-prompt
2762       'org-read-date-popup-calendar))
2763
2764 (defcustom org-read-date-minibuffer-setup-hook nil
2765   "Hook to be used to set up keys for the date/time interface.
2766 Add key definitions to `minibuffer-local-map', which will be a temporary
2767 copy."
2768   :group 'org-time
2769   :type 'hook)
2770
2771 (defcustom org-extend-today-until 0
2772   "The hour when your day really ends.  Must be an integer.
2773 This has influence for the following applications:
2774 - When switching the agenda to \"today\".  It it is still earlier than
2775   the time given here, the day recognized as TODAY is actually yesterday.
2776 - When a date is read from the user and it is still before the time given
2777   here, the current date and time will be assumed to be yesterday, 23:59.
2778   Also, timestamps inserted in remember templates follow this rule.
2779
2780 IMPORTANT:  This is a feature whose implementation is and likely will
2781 remain incomplete.  Really, it is only here because past midnight seems to
2782 be the favorite working time of John Wiegley :-)"
2783   :group 'org-time
2784   :type 'integer)
2785
2786 (defcustom org-use-effective-time nil
2787   "If non-nil, consider `org-extend-today-until' when creating timestamps.
2788 For example, if `org-extend-today-until' is 8, and it's 4am, then the
2789 \"effective time\" of any timestamps between midnight and 8am will be
2790 23:59 of the previous day."
2791   :group 'boolean
2792   :type 'integer)
2793
2794 (defcustom org-edit-timestamp-down-means-later nil
2795   "Non-nil means S-down will increase the time in a time stamp.
2796 When nil, S-up will increase."
2797   :group 'org-time
2798   :type 'boolean)
2799
2800 (defcustom org-calendar-follow-timestamp-change t
2801   "Non-nil means make the calendar window follow timestamp changes.
2802 When a timestamp is modified and the calendar window is visible, it will be
2803 moved to the new date."
2804   :group 'org-time
2805   :type 'boolean)
2806
2807 (defgroup org-tags nil
2808   "Options concerning tags in Org-mode."
2809   :tag "Org Tags"
2810   :group 'org)
2811
2812 (defcustom org-tag-alist nil
2813   "List of tags allowed in Org-mode files.
2814 When this list is nil, Org-mode will base TAG input on what is already in the
2815 buffer.
2816 The value of this variable is an alist, the car of each entry must be a
2817 keyword as a string, the cdr may be a character that is used to select
2818 that tag through the fast-tag-selection interface.
2819 See the manual for details."
2820   :group 'org-tags
2821   :type '(repeat
2822           (choice
2823            (cons   (string    :tag "Tag name")
2824                    (character :tag "Access char"))
2825            (list :tag "Start radio group"
2826                  (const :startgroup)
2827                  (option (string :tag "Group description")))
2828            (list :tag "End radio group"
2829                  (const :endgroup)
2830                  (option (string :tag "Group description")))
2831            (const :tag "New line" (:newline)))))
2832
2833 (defcustom org-tag-persistent-alist nil
2834   "List of tags that will always appear in all Org-mode files.
2835 This is in addition to any in buffer settings or customizations
2836 of `org-tag-alist'.
2837 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
2838 The value of this variable is an alist, the car of each entry must be a
2839 keyword as a string, the cdr may be a character that is used to select
2840 that tag through the fast-tag-selection interface.
2841 See the manual for details.
2842 To disable these tags on a per-file basis, insert anywhere in the file:
2843    #+STARTUP: noptag"
2844   :group 'org-tags
2845   :type '(repeat
2846           (choice
2847            (cons   (string    :tag "Tag name")
2848                    (character :tag "Access char"))
2849            (const :tag "Start radio group" (:startgroup))
2850            (const :tag "End radio group" (:endgroup))
2851            (const :tag "New line" (:newline)))))
2852
2853 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
2854   "If non-nil, always offer completion for all tags of all agenda files.
2855 Instead of customizing this variable directly, you might want to
2856 set it locally for capture buffers, because there no list of
2857 tags in that file can be created dynamically (there are none).
2858
2859   (add-hook 'org-capture-mode-hook
2860             (lambda ()
2861               (set (make-local-variable
2862                     'org-complete-tags-always-offer-all-agenda-tags)
2863                    t)))"
2864   :group 'org-tags
2865   :type 'boolean)
2866
2867 (defvar org-file-tags nil
2868   "List of tags that can be inherited by all entries in the file.
2869 The tags will be inherited if the variable `org-use-tag-inheritance'
2870 says they should be.
2871 This variable is populated from #+FILETAGS lines.")
2872
2873 (defcustom org-use-fast-tag-selection 'auto
2874   "Non-nil means use fast tag selection scheme.
2875 This is a special interface to select and deselect tags with single keys.
2876 When nil, fast selection is never used.
2877 When the symbol `auto', fast selection is used if and only if selection
2878 characters for tags have been configured, either through the variable
2879 `org-tag-alist' or through a #+TAGS line in the buffer.
2880 When t, fast selection is always used and selection keys are assigned
2881 automatically if necessary."
2882   :group 'org-tags
2883   :type '(choice
2884           (const :tag "Always" t)
2885           (const :tag "Never" nil)
2886           (const :tag "When selection characters are configured" 'auto)))
2887
2888 (defcustom org-fast-tag-selection-single-key nil
2889   "Non-nil means fast tag selection exits after first change.
2890 When nil, you have to press RET to exit it.
2891 During fast tag selection, you can toggle this flag with `C-c'.
2892 This variable can also have the value `expert'.  In this case, the window
2893 displaying the tags menu is not even shown, until you press C-c again."
2894   :group 'org-tags
2895   :type '(choice
2896           (const :tag "No" nil)
2897           (const :tag "Yes" t)
2898           (const :tag "Expert" expert)))
2899
2900 (defvar org-fast-tag-selection-include-todo nil
2901   "Non-nil means fast tags selection interface will also offer TODO states.
2902 This is an undocumented feature, you should not rely on it.")
2903
2904 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
2905   "The column to which tags should be indented in a headline.
2906 If this number is positive, it specifies the column.  If it is negative,
2907 it means that the tags should be flushright to that column.  For example,
2908 -80 works well for a normal 80 character screen.
2909 When 0, place tags directly after headline text, with only one space in
2910 between."
2911   :group 'org-tags
2912   :type 'integer)
2913
2914 (defcustom org-auto-align-tags t
2915   "Non-nil keeps tags aligned when modifying headlines.
2916 Some operations (i.e. demoting) change the length of a headline and
2917 therefore shift the tags around.  With this option turned on, after
2918 each such operation the tags are again aligned to `org-tags-column'."
2919   :group 'org-tags
2920   :type 'boolean)
2921
2922 (defcustom org-use-tag-inheritance t
2923   "Non-nil means tags in levels apply also for sublevels.
2924 When nil, only the tags directly given in a specific line apply there.
2925 This may also be a list of tags that should be inherited, or a regexp that
2926 matches tags that should be inherited.  Additional control is possible
2927 with the variable  `org-tags-exclude-from-inheritance' which gives an
2928 explicit list of tags to be excluded from inheritance., even if the value of
2929 `org-use-tag-inheritance' would select it for inheritance.
2930
2931 If this option is t, a match early-on in a tree can lead to a large
2932 number of matches in the subtree when constructing the agenda or creating
2933 a sparse tree.  If you only want to see the first match in a tree during
2934 a search, check out the variable `org-tags-match-list-sublevels'."
2935   :group 'org-tags
2936   :type '(choice
2937           (const :tag "Not" nil)
2938           (const :tag "Always" t)
2939           (repeat :tag "Specific tags" (string :tag "Tag"))
2940           (regexp :tag "Tags matched by regexp")))
2941
2942 (defcustom org-tags-exclude-from-inheritance nil
2943   "List of tags that should never be inherited.
2944 This is a way to exclude a few tags from inheritance.  For way to do
2945 the opposite, to actively allow inheritance for selected tags,
2946 see the variable `org-use-tag-inheritance'."
2947   :group 'org-tags
2948   :type '(repeat (string :tag "Tag")))
2949
2950 (defun org-tag-inherit-p (tag)
2951   "Check if TAG is one that should be inherited."
2952   (cond
2953    ((member tag org-tags-exclude-from-inheritance) nil)
2954    ((eq org-use-tag-inheritance t) t)
2955    ((not org-use-tag-inheritance) nil)
2956    ((stringp org-use-tag-inheritance)
2957     (string-match org-use-tag-inheritance tag))
2958    ((listp org-use-tag-inheritance)
2959     (member tag org-use-tag-inheritance))
2960    (t (error "Invalid setting of `org-use-tag-inheritance'"))))
2961
2962 (defcustom org-tags-match-list-sublevels t
2963   "Non-nil means list also sublevels of headlines matching a search.
2964 This variable applies to tags/property searches, and also to stuck
2965 projects because this search is based on a tags match as well.
2966
2967 When set to the symbol `indented', sublevels are indented with
2968 leading dots.
2969
2970 Because of tag inheritance (see variable `org-use-tag-inheritance'),
2971 the sublevels of a headline matching a tag search often also match
2972 the same search.  Listing all of them can create very long lists.
2973 Setting this variable to nil causes subtrees of a match to be skipped.
2974
2975 This variable is semi-obsolete and probably should always be true.  It
2976 is better to limit inheritance to certain tags using the variables
2977 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
2978   :group 'org-tags
2979   :type '(choice
2980           (const :tag "No, don't list them" nil)
2981           (const :tag "Yes, do list them" t)
2982           (const :tag "List them, indented with leading dots" indented)))
2983
2984 (defcustom org-tags-sort-function nil
2985   "When set, tags are sorted using this function as a comparator."
2986   :group 'org-tags
2987   :type '(choice
2988           (const :tag "No sorting" nil)
2989           (const :tag "Alphabetical" string<)
2990           (const :tag "Reverse alphabetical" string>)
2991           (function :tag "Custom function" nil)))
2992
2993 (defvar org-tags-history nil
2994   "History of minibuffer reads for tags.")
2995 (defvar org-last-tags-completion-table nil
2996   "The last used completion table for tags.")
2997 (defvar org-after-tags-change-hook nil
2998   "Hook that is run after the tags in a line have changed.")
2999
3000 (defgroup org-properties nil
3001   "Options concerning properties in Org-mode."
3002   :tag "Org Properties"
3003   :group 'org)
3004
3005 (defcustom org-property-format "%-10s %s"
3006   "How property key/value pairs should be formatted by `indent-line'.
3007 When `indent-line' hits a property definition, it will format the line
3008 according to this format, mainly to make sure that the values are
3009 lined-up with respect to each other."
3010   :group 'org-properties
3011   :type 'string)
3012
3013 (defcustom org-properties-postprocess-alist nil
3014   "Alist of properties and functions to adjust inserted values.
3015 Elements of this alist must be of the form
3016
3017   ([string] [function])
3018
3019 where [string] must be a property name and [function] must be a
3020 lambda expression: this lambda expression must take one argument,
3021 the value to adjust, and return the new value as a string.
3022
3023 For example, this element will allow the property \"Remaining\"
3024 to be updated wrt the relation between the \"Effort\" property
3025 and the clock summary:
3026
3027  ((\"Remaining\" (lambda(value)
3028                    (let ((clocksum (org-clock-sum-current-item))
3029                          (effort (org-duration-string-to-minutes
3030                                    (org-entry-get (point) \"Effort\"))))
3031                      (org-minutes-to-hh:mm-string (- effort clocksum))))))"
3032   :group 'org-properties
3033   :type 'alist)
3034
3035 (defcustom org-use-property-inheritance nil
3036   "Non-nil means properties apply also for sublevels.
3037
3038 This setting is chiefly used during property searches.  Turning it on can
3039 cause significant overhead when doing a search, which is why it is not
3040 on by default.
3041
3042 When nil, only the properties directly given in the current entry count.
3043 When t, every property is inherited.  The value may also be a list of
3044 properties that should have inheritance, or a regular expression matching
3045 properties that should be inherited.
3046
3047 However, note that some special properties use inheritance under special
3048 circumstances (not in searches).  Examples are CATEGORY, ARCHIVE, COLUMNS,
3049 and the properties ending in \"_ALL\" when they are used as descriptor
3050 for valid values of a property.
3051
3052 Note for programmers:
3053 When querying an entry with `org-entry-get',  you can control if inheritance
3054 should be used.  By default, `org-entry-get' looks only at the local
3055 properties.  You can request inheritance by setting the inherit argument
3056 to t (to force inheritance) or to `selective' (to respect the setting
3057 in this variable)."
3058   :group 'org-properties
3059   :type '(choice
3060           (const :tag "Not" nil)
3061           (const :tag "Always" t)
3062           (repeat :tag "Specific properties" (string :tag "Property"))
3063           (regexp :tag "Properties matched by regexp")))
3064
3065 (defun org-property-inherit-p (property)
3066   "Check if PROPERTY is one that should be inherited."
3067   (cond
3068    ((eq org-use-property-inheritance t) t)
3069    ((not org-use-property-inheritance) nil)
3070    ((stringp org-use-property-inheritance)
3071     (string-match org-use-property-inheritance property))
3072    ((listp org-use-property-inheritance)
3073     (member property org-use-property-inheritance))
3074    (t (error "Invalid setting of `org-use-property-inheritance'"))))
3075
3076 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3077   "The default column format, if no other format has been defined.
3078 This variable can be set on the per-file basis by inserting a line
3079
3080 #+COLUMNS: %25ITEM ....."
3081   :group 'org-properties
3082   :type 'string)
3083
3084 (defcustom org-columns-ellipses ".."
3085   "The ellipses to be used when a field in column view is truncated.
3086 When this is the empty string, as many characters as possible are shown,
3087 but then there will be no visual indication that the field has been truncated.
3088 When this is a string of length N, the last N characters of a truncated
3089 field are replaced by this string.  If the column is narrower than the
3090 ellipses string, only part of the ellipses string will be shown."
3091   :group 'org-properties
3092   :type 'string)
3093
3094 (defcustom org-columns-modify-value-for-display-function nil
3095   "Function that modifies values for display in column view.
3096 For example, it can be used to cut out a certain part from a time stamp.
3097 The function must take 2 arguments:
3098
3099 column-title    The title of the column (*not* the property name)
3100 value           The value that should be modified.
3101
3102 The function should return the value that should be displayed,
3103 or nil if the normal value should be used."
3104   :group 'org-properties
3105   :type 'function)
3106
3107 (defcustom org-effort-property "Effort"
3108   "The property that is being used to keep track of effort estimates.
3109 Effort estimates given in this property need to have the format H:MM."
3110   :group 'org-properties
3111   :group 'org-progress
3112   :type '(string :tag "Property"))
3113
3114 (defconst org-global-properties-fixed
3115   '(("VISIBILITY_ALL" . "folded children content all")
3116     ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3117   "List of property/value pairs that can be inherited by any entry.
3118
3119 These are fixed values, for the preset properties.  The user variable
3120 that can be used to add to this list is `org-global-properties'.
3121
3122 The entries in this list are cons cells where the car is a property
3123 name and cdr is a string with the value.  If the value represents
3124 multiple items like an \"_ALL\" property, separate the items by
3125 spaces.")
3126
3127 (defcustom org-global-properties nil
3128   "List of property/value pairs that can be inherited by any entry.
3129
3130 This list will be combined with the constant `org-global-properties-fixed'.
3131
3132 The entries in this list are cons cells where the car is a property
3133 name and cdr is a string with the value.
3134
3135 You can set buffer-local values for the same purpose in the variable
3136 `org-file-properties' this by adding lines like
3137
3138 #+PROPERTY: NAME VALUE"
3139   :group 'org-properties
3140   :type '(repeat
3141           (cons (string :tag "Property")
3142                 (string :tag "Value"))))
3143
3144 (defvar org-file-properties nil
3145   "List of property/value pairs that can be inherited by any entry.
3146 Valid for the current buffer.
3147 This variable is populated from #+PROPERTY lines.")
3148 (make-variable-buffer-local 'org-file-properties)
3149
3150 (defgroup org-agenda nil
3151   "Options concerning agenda views in Org-mode."
3152   :tag "Org Agenda"
3153   :group 'org)
3154
3155 (defvar org-category nil
3156   "Variable used by org files to set a category for agenda display.
3157 Such files should use a file variable to set it, for example
3158
3159 #   -*- mode: org; org-category: \"ELisp\"
3160
3161 or contain a special line
3162
3163 #+CATEGORY: ELisp
3164
3165 If the file does not specify a category, then file's base name
3166 is used instead.")
3167 (make-variable-buffer-local 'org-category)
3168 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3169
3170 (defcustom org-agenda-files nil
3171   "The files to be used for agenda display.
3172 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3173 \\[org-remove-file].  You can also use customize to edit the list.
3174
3175 If an entry is a directory, all files in that directory that are matched by
3176 `org-agenda-file-regexp' will be part of the file list.
3177
3178 If the value of the variable is not a list but a single file name, then
3179 the list of agenda files is actually stored and maintained in that file, one
3180 agenda file per line.  In this file paths can be given relative to
3181 `org-directory'.  Tilde expansion and environment variable substitution
3182 are also made."
3183   :group 'org-agenda
3184   :type '(choice
3185           (repeat :tag "List of files and directories" file)
3186           (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3187
3188 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3189   "Regular expression to match files for `org-agenda-files'.
3190 If any element in the list in that variable contains a directory instead
3191 of a normal file, all files in that directory that are matched by this
3192 regular expression will be included."
3193   :group 'org-agenda
3194   :type 'regexp)
3195
3196 (defcustom org-agenda-text-search-extra-files nil
3197   "List of extra files to be searched by text search commands.
3198 These files will be search in addition to the agenda files by the
3199 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3200 Note that these files will only be searched for text search commands,
3201 not for the other agenda views like todo lists, tag searches or the weekly
3202 agenda.  This variable is intended to list notes and possibly archive files
3203 that should also be searched by these two commands.
3204 In fact, if the first element in the list is the symbol `agenda-archives',
3205 than all archive files of all agenda files will be added to the search
3206 scope."
3207   :group 'org-agenda
3208   :type '(set :greedy t
3209            (const :tag "Agenda Archives" agenda-archives)
3210            (repeat :inline t (file))))
3211
3212 (if (fboundp 'defvaralias)
3213     (defvaralias 'org-agenda-multi-occur-extra-files
3214       'org-agenda-text-search-extra-files))
3215
3216 (defcustom org-agenda-skip-unavailable-files nil
3217   "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3218 A nil value means to remove them, after a query, from the list."
3219   :group 'org-agenda
3220   :type 'boolean)
3221
3222 (defcustom org-calendar-to-agenda-key [?c]
3223   "The key to be installed in `calendar-mode-map' for switching to the agenda.
3224 The command `org-calendar-goto-agenda' will be bound to this key.  The
3225 default is the character `c' because then `c' can be used to switch back and
3226 forth between agenda and calendar."
3227   :group 'org-agenda
3228   :type 'sexp)
3229
3230 (defcustom org-calendar-agenda-action-key [?k]
3231   "The key to be installed in `calendar-mode-map' for agenda-action.
3232 The command `org-agenda-action' will be bound to this key.  The
3233 default is the character `k' because we use the same key in the agenda."
3234   :group 'org-agenda
3235   :type 'sexp)
3236
3237 (defcustom org-calendar-insert-diary-entry-key [?i]
3238   "The key to be installed in `calendar-mode-map' for adding diary entries.
3239 This option is irrelevant until `org-agenda-diary-file' has been configured
3240 to point to an Org-mode file.  When that is the case, the command
3241 `org-agenda-diary-entry' will be bound to the key given here, by default
3242 `i'.  In the calendar, `i' normally adds entries to `diary-file'.  So
3243 if you want to continue doing this, you need to change this to a different
3244 key."
3245   :group 'org-agenda
3246   :type 'sexp)
3247
3248 (defcustom org-agenda-diary-file 'diary-file
3249   "File to which to add new entries with the `i' key in agenda and calendar.
3250 When this is the symbol `diary-file', the functionality in the Emacs
3251 calendar will be used to add entries to the `diary-file'.  But when this
3252 points to a file, `org-agenda-diary-entry' will be used instead."
3253   :group 'org-agenda
3254   :type '(choice
3255           (const :tag "The standard Emacs diary file" diary-file)
3256           (file :tag "Special Org file diary entries")))
3257
3258 (eval-after-load "calendar"
3259   '(progn
3260      (org-defkey calendar-mode-map org-calendar-to-agenda-key
3261                  'org-calendar-goto-agenda)
3262      (org-defkey calendar-mode-map org-calendar-agenda-action-key
3263                  'org-agenda-action)
3264      (add-hook 'calendar-mode-hook
3265                (lambda ()
3266                  (unless (eq org-agenda-diary-file 'diary-file)
3267                    (define-key calendar-mode-map
3268                      org-calendar-insert-diary-entry-key
3269                      'org-agenda-diary-entry))))))
3270
3271 (defgroup org-latex nil
3272   "Options for embedding LaTeX code into Org-mode."
3273   :tag "Org LaTeX"
3274   :group 'org)
3275
3276 (defcustom org-format-latex-options
3277   '(:foreground default :background default :scale 1.0
3278     :html-foreground "Black" :html-background "Transparent"
3279     :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3280   "Options for creating images from LaTeX fragments.
3281 This is a property list with the following properties:
3282 :foreground  the foreground color for images embedded in Emacs, e.g. \"Black\".
3283              `default' means use the foreground of the default face.
3284 :background  the background color, or \"Transparent\".
3285              `default' means use the background of the default face.
3286 :scale       a scaling factor for the size of the images, to get more pixels
3287 :html-foreground, :html-background, :html-scale
3288              the same numbers for HTML export.
3289 :matchers    a list indicating which matchers should be used to
3290              find LaTeX fragments.  Valid members of this list are:
3291              \"begin\"  find environments
3292              \"$1\"     find single characters surrounded by $.$
3293              \"$\"      find math expressions surrounded by $...$
3294              \"$$\"     find math expressions surrounded by $$....$$
3295              \"\\(\"     find math expressions surrounded by \\(...\\)
3296              \"\\ [\"    find math expressions surrounded by \\ [...\\]"
3297   :group 'org-latex
3298   :type 'plist)
3299
3300 (defcustom org-format-latex-signal-error t
3301   "Non-nil means signal an error when image creation of LaTeX snippets fails.
3302 When nil, just push out a message."
3303   :group 'org-latex
3304   :type 'boolean)
3305 (defcustom org-latex-to-mathml-jar-file nil
3306   "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3307 Use this to specify additional executable file say a jar file.
3308
3309 When using MathToWeb as the converter, specify the full-path to
3310 your mathtoweb.jar file."
3311   :group 'org-latex
3312   :type '(choice
3313           (const :tag "None" nil)
3314           (file :tag "JAR file" :must-match t)))
3315
3316 (defcustom org-latex-to-mathml-convert-command nil
3317   "Command to convert LaTeX fragments to MathML.
3318 Replace format-specifiers in the command as noted below and use
3319 `shell-command' to convert LaTeX to MathML.
3320 %j:     Executable file in fully expanded form as specified by
3321         `org-latex-to-mathml-jar-file'.
3322 %I:     Input LaTeX file in fully expanded form
3323 %o:     Output MathML file
3324 This command is used by `org-create-math-formula'.
3325
3326 When using MathToWeb as the converter, set this to
3327 \"java -jar %j -unicode -force -df %o %I\"."
3328   :group 'org-latex
3329   :type '(choice
3330           (const :tag "None" nil)
3331           (string :tag "\nShell command")))
3332
3333 (defun org-format-latex-mathml-available-p ()
3334   "Return t if `org-latex-to-mathml-convert-command' is usable."
3335   (save-match-data
3336     (when (and (boundp 'org-latex-to-mathml-convert-command)
3337                org-latex-to-mathml-convert-command)
3338       (let ((executable (car (split-string
3339                               org-latex-to-mathml-convert-command))))
3340         (when (executable-find executable)
3341           (if (string-match
3342                "%j" org-latex-to-mathml-convert-command)
3343               (file-readable-p org-latex-to-mathml-jar-file)
3344             t))))))
3345
3346 (defcustom org-format-latex-header "\\documentclass{article}
3347 \\usepackage[usenames]{color}
3348 \\usepackage{amsmath}
3349 \\usepackage[mathscr]{eucal}
3350 \\pagestyle{empty}             % do not remove
3351 \[PACKAGES]
3352 \[DEFAULT-PACKAGES]
3353 % The settings below are copied from fullpage.sty
3354 \\setlength{\\textwidth}{\\paperwidth}
3355 \\addtolength{\\textwidth}{-3cm}
3356 \\setlength{\\oddsidemargin}{1.5cm}
3357 \\addtolength{\\oddsidemargin}{-2.54cm}
3358 \\setlength{\\evensidemargin}{\\oddsidemargin}
3359 \\setlength{\\textheight}{\\paperheight}
3360 \\addtolength{\\textheight}{-\\headheight}
3361 \\addtolength{\\textheight}{-\\headsep}
3362 \\addtolength{\\textheight}{-\\footskip}
3363 \\addtolength{\\textheight}{-3cm}
3364 \\setlength{\\topmargin}{1.5cm}
3365 \\addtolength{\\topmargin}{-2.54cm}"
3366   "The document header used for processing LaTeX fragments.
3367 It is imperative that this header make sure that no page number
3368 appears on the page.  The package defined in the variables
3369 `org-export-latex-default-packages-alist' and `org-export-latex-packages-alist'
3370 will either replace the placeholder \"[PACKAGES]\" in this header, or they
3371 will be appended."
3372   :group 'org-latex
3373   :type 'string)
3374
3375 (defvar org-format-latex-header-extra nil)
3376
3377 (defun org-set-packages-alist (var val)
3378   "Set the packages alist and make sure it has 3 elements per entry."
3379   (set var (mapcar (lambda (x)
3380                      (if (and (consp x) (= (length x) 2))
3381                          (list (car x) (nth 1 x) t)
3382                        x))
3383                    val)))
3384
3385 (defun org-get-packages-alist (var)
3386
3387   "Get the packages alist and make sure it has 3 elements per entry."
3388   (mapcar (lambda (x)
3389             (if (and (consp x) (= (length x) 2))
3390                 (list (car x) (nth 1 x) t)
3391               x))
3392           (default-value var)))
3393
3394 ;; The following variables are defined here because is it also used
3395 ;; when formatting latex fragments.  Originally it was part of the
3396 ;; LaTeX exporter, which is why the name includes "export".
3397 (defcustom org-export-latex-default-packages-alist
3398   '(("AUTO" "inputenc"  t)
3399     ("T1"   "fontenc"   t)
3400     (""     "fixltx2e"  nil)
3401     (""     "graphicx"  t)
3402     (""     "longtable" nil)
3403     (""     "float"     nil)
3404     (""     "wrapfig"   nil)
3405     (""     "soul"      t)
3406     (""     "textcomp"  t)
3407     (""     "marvosym"  t)
3408     (""     "wasysym"   t)
3409     (""     "latexsym"  t)
3410     (""     "amssymb"   t)
3411     (""     "hyperref"  nil)
3412     "\\tolerance=1000"
3413     )
3414   "Alist of default packages to be inserted in the header.
3415 Change this only if one of the packages here causes an incompatibility
3416 with another package you are using.
3417 The packages in this list are needed by one part or another of Org-mode
3418 to function properly.
3419
3420 - inputenc, fontenc:  for basic font and character selection
3421 - textcomp, marvosymb, wasysym, latexsym, amssym: for various symbols used
3422   for interpreting the entities in `org-entities'.  You can skip some of these
3423   packages if you don't use any of the symbols in it.
3424 - graphicx: for including images
3425 - float, wrapfig: for figure placement
3426 - longtable: for long tables
3427 - hyperref: for cross references
3428
3429 Therefore you should not modify this variable unless you know what you
3430 are doing.  The one reason to change it anyway is that you might be loading
3431 some other package that conflicts with one of the default packages.
3432 Each cell is of the format \( \"options\" \"package\" snippet-flag\).
3433 If SNIPPET-FLAG is t, the package also needs to be included when
3434 compiling LaTeX snippets into images for inclusion into HTML."
3435   :group 'org-export-latex
3436   :set 'org-set-packages-alist
3437   :get 'org-get-packages-alist
3438   :type '(repeat
3439           (choice
3440            (list :tag "options/package pair"
3441                  (string :tag "options")
3442                  (string :tag "package")
3443                  (boolean :tag "Snippet"))
3444            (string :tag "A line of LaTeX"))))
3445
3446 (defcustom org-export-latex-packages-alist nil
3447   "Alist of packages to be inserted in every LaTeX header.
3448 These will be inserted after `org-export-latex-default-packages-alist'.
3449 Each cell is of the format \( \"options\" \"package\" snippet-flag \).
3450 SNIPPET-FLAG, when t, indicates that this package is also needed when
3451 turning LaTeX snippets into images for inclusion into HTML.
3452 Make sure that you only list packages here which:
3453 - you want in every file
3454 - do not conflict with the default packages in
3455   `org-export-latex-default-packages-alist'
3456 - do not conflict with the setup in `org-format-latex-header'."
3457   :group 'org-export-latex
3458   :set 'org-set-packages-alist
3459   :get 'org-get-packages-alist
3460   :type '(repeat
3461           (choice
3462            (list :tag "options/package pair"
3463                  (string :tag "options")
3464                  (string :tag "package")
3465                  (boolean :tag "Snippet"))
3466            (string :tag "A line of LaTeX"))))
3467
3468
3469 (defgroup org-appearance nil
3470   "Settings for Org-mode appearance."
3471   :tag "Org Appearance"
3472   :group 'org)
3473
3474 (defcustom org-level-color-stars-only nil
3475   "Non-nil means fontify only the stars in each headline.
3476 When nil, the entire headline is fontified.
3477 Changing it requires restart of `font-lock-mode' to become effective
3478 also in regions already fontified."
3479   :group 'org-appearance
3480   :type 'boolean)
3481
3482 (defcustom org-hide-leading-stars nil
3483   "Non-nil means hide the first N-1 stars in a headline.
3484 This works by using the face `org-hide' for these stars.  This
3485 face is white for a light background, and black for a dark
3486 background.  You may have to customize the face `org-hide' to
3487 make this work.
3488 Changing it requires restart of `font-lock-mode' to become effective
3489 also in regions already fontified.
3490 You may also set this on a per-file basis by adding one of the following
3491 lines to the buffer:
3492
3493    #+STARTUP: hidestars
3494    #+STARTUP: showstars"
3495   :group 'org-appearance
3496   :type 'boolean)
3497
3498 (defcustom org-hidden-keywords nil
3499   "List of symbols corresponding to keywords to be hidden the org buffer.
3500 For example, a value '(title) for this list will make the document's title
3501 appear in the buffer without the initial #+TITLE: keyword."
3502   :group 'org-appearance
3503   :type '(set (const :tag "#+AUTHOR" author)
3504               (const :tag "#+DATE" date)
3505               (const :tag "#+EMAIL" email)
3506               (const :tag "#+TITLE" title)))
3507
3508 (defcustom org-fontify-done-headline nil
3509   "Non-nil means change the face of a headline if it is marked DONE.
3510 Normally, only the TODO/DONE keyword indicates the state of a headline.
3511 When this is non-nil, the headline after the keyword is set to the
3512 `org-headline-done' as an additional indication."
3513   :group 'org-appearance
3514   :type 'boolean)
3515
3516 (defcustom org-fontify-emphasized-text t
3517   "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
3518 Changing this variable requires a restart of Emacs to take effect."
3519   :group 'org-appearance
3520   :type 'boolean)
3521
3522 (defcustom org-fontify-whole-heading-line nil
3523   "Non-nil means fontify the whole line for headings.
3524 This is useful when setting a background color for the
3525 org-level-* faces."
3526   :group 'org-appearance
3527   :type 'boolean)
3528
3529 (defcustom org-highlight-latex-fragments-and-specials nil
3530   "Non-nil means fontify what is treated specially by the exporters."
3531   :group 'org-appearance
3532   :type 'boolean)
3533
3534 (defcustom org-hide-emphasis-markers nil
3535   "Non-nil mean font-lock should hide the emphasis marker characters."
3536   :group 'org-appearance
3537   :type 'boolean)
3538
3539 (defcustom org-pretty-entities nil
3540   "Non-nil means show entities as UTF8 characters.
3541 When nil, the \\name form remains in the buffer."
3542   :group 'org-appearance
3543   :type 'boolean)
3544
3545 (defcustom org-pretty-entities-include-sub-superscripts t
3546   "Non-nil means, pretty entity display includes formatting sub/superscripts."
3547   :group 'org-appearance
3548   :type 'boolean)
3549
3550 (defvar org-emph-re nil
3551   "Regular expression for matching emphasis.
3552 After a match, the match groups contain these elements:
3553 0  The match of the full regular expression, including the characters
3554      before and after the proper match
3555 1  The character before the proper match, or empty at beginning of line
3556 2  The proper match, including the leading and trailing markers
3557 3  The leading marker like * or /, indicating the type of highlighting
3558 4  The text between the emphasis markers, not including the markers
3559 5  The character after the match, empty at the end of a line")
3560 (defvar org-verbatim-re nil
3561   "Regular expression for matching verbatim text.")
3562 (defvar org-emphasis-regexp-components) ; defined just below
3563 (defvar org-emphasis-alist) ; defined just below
3564 (defun org-set-emph-re (var val)
3565   "Set variable and compute the emphasis regular expression."
3566   (set var val)
3567   (when (and (boundp 'org-emphasis-alist)
3568              (boundp 'org-emphasis-regexp-components)
3569              org-emphasis-alist org-emphasis-regexp-components)
3570     (let* ((e org-emphasis-regexp-components)
3571            (pre (car e))
3572            (post (nth 1 e))
3573            (border (nth 2 e))
3574            (body (nth 3 e))
3575            (nl (nth 4 e))
3576            (body1 (concat body "*?"))
3577            (markers (mapconcat 'car org-emphasis-alist ""))
3578            (vmarkers (mapconcat
3579                       (lambda (x) (if (eq (nth 4 x) 'verbatim) (car x) ""))
3580                       org-emphasis-alist "")))
3581       ;; make sure special characters appear at the right position in the class
3582       (if (string-match "\\^" markers)
3583           (setq markers (concat (replace-match "" t t markers) "^")))
3584       (if (string-match "-" markers)
3585           (setq markers (concat (replace-match "" t t markers) "-")))
3586       (if (string-match "\\^" vmarkers)
3587           (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
3588       (if (string-match "-" vmarkers)
3589           (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
3590       (if (> nl 0)
3591           (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
3592                               (int-to-string nl) "\\}")))
3593       ;; Make the regexp
3594       (setq org-emph-re
3595             (concat "\\([" pre "]\\|^\\)"
3596                     "\\("
3597                     "\\([" markers "]\\)"
3598                     "\\("
3599                     "[^" border "]\\|"
3600                     "[^" border "]"
3601                     body1
3602                     "[^" border "]"
3603                     "\\)"
3604                     "\\3\\)"
3605                     "\\([" post "]\\|$\\)"))
3606       (setq org-verbatim-re
3607             (concat "\\([" pre "]\\|^\\)"
3608                     "\\("
3609                     "\\([" vmarkers "]\\)"
3610                     "\\("
3611                     "[^" border "]\\|"
3612                     "[^" border "]"
3613                     body1
3614                     "[^" border "]"
3615                     "\\)"
3616                     "\\3\\)"
3617                     "\\([" post  "]\\|$\\)")))))
3618
3619 (defcustom org-emphasis-regexp-components
3620   '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
3621   "Components used to build the regular expression for emphasis.
3622 This is a list with five entries.  Terminology:  In an emphasis string
3623 like \" *strong word* \", we call the initial space PREMATCH, the final
3624 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
3625 and \"trong wor\" is the body.  The different components in this variable
3626 specify what is allowed/forbidden in each part:
3627
3628 pre          Chars allowed as prematch.  Beginning of line will be allowed too.
3629 post         Chars allowed as postmatch.  End of line will be allowed too.
3630 border       The chars *forbidden* as border characters.
3631 body-regexp  A regexp like \".\" to match a body character.  Don't use
3632              non-shy groups here, and don't allow newline here.
3633 newline      The maximum number of newlines allowed in an emphasis exp.
3634
3635 Use customize to modify this, or restart Emacs after changing it."
3636   :group 'org-appearance
3637   :set 'org-set-emph-re
3638   :type '(list
3639           (sexp    :tag "Allowed chars in pre      ")
3640           (sexp    :tag "Allowed chars in post     ")
3641           (sexp    :tag "Forbidden chars in border ")
3642           (sexp    :tag "Regexp for body           ")
3643           (integer :tag "number of newlines allowed")
3644           (option (boolean :tag "Please ignore this button"))))
3645
3646 (defcustom org-emphasis-alist
3647   `(("*" bold "<b>" "</b>")
3648     ("/" italic "<i>" "</i>")
3649     ("_" underline "<span style=\"text-decoration:underline;\">" "</span>")
3650     ("=" org-code "<code>" "</code>" verbatim)
3651     ("~" org-verbatim "<code>" "</code>" verbatim)
3652     ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))
3653      "<del>" "</del>")
3654     )
3655   "Special syntax for emphasized text.
3656 Text starting and ending with a special character will be emphasized, for
3657 example *bold*, _underlined_ and /italic/.  This variable sets the marker
3658 characters, the face to be used by font-lock for highlighting in Org-mode
3659 Emacs buffers, and the HTML tags to be used for this.
3660 For LaTeX export, see the variable `org-export-latex-emphasis-alist'.
3661 For DocBook export, see the variable `org-export-docbook-emphasis-alist'.
3662 Use customize to modify this, or restart Emacs after changing it."
3663   :group 'org-appearance
3664   :set 'org-set-emph-re
3665   :type '(repeat
3666           (list
3667            (string :tag "Marker character")
3668            (choice
3669             (face :tag "Font-lock-face")
3670             (plist :tag "Face property list"))
3671            (string :tag "HTML start tag")
3672            (string :tag "HTML end tag")
3673            (option (const verbatim)))))
3674
3675 (defvar org-protecting-blocks
3676   '("src" "example" "latex" "ascii" "html" "docbook" "ditaa" "dot" "r" "R")
3677   "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
3678 This is needed for font-lock setup.")
3679
3680 ;;; Miscellaneous options
3681
3682 (defgroup org-completion nil
3683   "Completion in Org-mode."
3684   :tag "Org Completion"
3685   :group 'org)
3686
3687 (defcustom org-completion-use-ido nil
3688   "Non-nil means use ido completion wherever possible.
3689 Note that `ido-mode' must be active for this variable to be relevant.
3690 If you decide to turn this variable on, you might well want to turn off
3691 `org-outline-path-complete-in-steps'.
3692 See also `org-completion-use-iswitchb'."
3693   :group 'org-completion
3694   :type 'boolean)
3695
3696 (defcustom org-completion-use-iswitchb nil
3697   "Non-nil means use iswitchb completion wherever possible.
3698 Note that `iswitchb-mode' must be active for this variable to be relevant.
3699 If you decide to turn this variable on, you might well want to turn off
3700 `org-outline-path-complete-in-steps'.
3701 Note that this variable has only an effect if `org-completion-use-ido' is nil."
3702   :group 'org-completion
3703   :type 'boolean)
3704
3705 (defcustom org-completion-fallback-command 'hippie-expand
3706   "The expansion command called by \\[pcomplete] in normal context.
3707 Normal means, no org-mode-specific context."
3708   :group 'org-completion
3709   :type 'function)
3710
3711 ;;; Functions and variables from their packages
3712 ;;  Declared here to avoid compiler warnings
3713
3714 ;; XEmacs only
3715 (defvar outline-mode-menu-heading)
3716 (defvar outline-mode-menu-show)
3717 (defvar outline-mode-menu-hide)
3718 (defvar zmacs-regions) ; XEmacs regions
3719
3720 ;; Emacs only
3721 (defvar mark-active)
3722
3723 ;; Various packages
3724 (declare-function calendar-absolute-from-iso    "cal-iso"    (date))
3725 (declare-function calendar-forward-day          "cal-move"   (arg))
3726 (declare-function calendar-goto-date            "cal-move"   (date))
3727 (declare-function calendar-goto-today           "cal-move"   ())
3728 (declare-function calendar-iso-from-absolute    "cal-iso"    (date))
3729 (defvar calc-embedded-close-formula)
3730 (defvar calc-embedded-open-formula)
3731 (declare-function cdlatex-tab "ext:cdlatex" ())
3732 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
3733 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
3734 (defvar font-lock-unfontify-region-function)
3735 (declare-function iswitchb-read-buffer "iswitchb"
3736                   (prompt &optional default require-match start matches-set))
3737 (defvar iswitchb-temp-buflist)
3738 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
3739 (defvar org-agenda-tags-todo-honor-ignore-options)
3740 (declare-function org-agenda-skip "org-agenda" ())
3741 (declare-function
3742  org-agenda-format-item "org-agenda"
3743  (extra txt &optional category tags dotime noprefix remove-re habitp))
3744 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
3745 (declare-function org-agenda-change-all-lines "org-agenda"
3746                   (newhead hdmarker &optional fixface just-this))
3747 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
3748 (declare-function org-agenda-maybe-redo "org-agenda" ())
3749 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
3750                   (beg end))
3751 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
3752 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
3753                   "org-agenda" (&optional end))
3754 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
3755 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
3756 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
3757 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
3758 (declare-function org-indent-mode "org-indent" (&optional arg))
3759 (declare-function parse-time-string "parse-time" (string))
3760 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
3761 (declare-function org-export-latex-fix-inputenc "org-latex" ())
3762 (declare-function orgtbl-send-table "org-table" (&optional maybe))
3763 (defvar remember-data-file)
3764 (defvar texmathp-why)
3765 (declare-function speedbar-line-directory "speedbar" (&optional depth))
3766 (declare-function table--at-cell-p "table" (position &optional object at-column))
3767
3768 (defvar w3m-current-url)
3769 (defvar w3m-current-title)
3770
3771 (defvar org-latex-regexps)
3772
3773 ;;; Autoload and prepare some org modules
3774
3775 ;; Some table stuff that needs to be defined here, because it is used
3776 ;; by the functions setting up org-mode or checking for table context.
3777
3778 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
3779   "Detect an org-type or table-type table.")
3780 (defconst org-table-line-regexp "^[ \t]*|"
3781   "Detect an org-type table line.")
3782 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
3783   "Detect an org-type table line.")
3784 (defconst org-table-hline-regexp "^[ \t]*|-"
3785   "Detect an org-type table hline.")
3786 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
3787   "Detect a table-type table hline.")
3788 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
3789   "Detect the first line outside a table when searching from within it.
3790 This works for both table types.")
3791
3792 ;; Autoload the functions in org-table.el that are needed by functions here.
3793
3794 (eval-and-compile
3795   (org-autoload "org-table"
3796                 '(org-table-align org-table-begin org-table-blank-field
3797    org-table-convert org-table-convert-region org-table-copy-down
3798    org-table-copy-region org-table-create
3799    org-table-create-or-convert-from-region
3800    org-table-create-with-table.el org-table-current-dline
3801    org-table-cut-region org-table-delete-column org-table-edit-field
3802    org-table-edit-formulas org-table-end org-table-eval-formula
3803    org-table-export org-table-field-info
3804    org-table-get-stored-formulas org-table-goto-column
3805    org-table-hline-and-move org-table-import org-table-insert-column
3806    org-table-insert-hline org-table-insert-row org-table-iterate
3807    org-table-justify-field-maybe org-table-kill-row
3808    org-table-maybe-eval-formula org-table-maybe-recalculate-line
3809    org-table-move-column org-table-move-column-left
3810    org-table-move-column-right org-table-move-row
3811    org-table-move-row-down org-table-move-row-up
3812    org-table-next-field org-table-next-row org-table-paste-rectangle
3813    org-table-previous-field org-table-recalculate
3814    org-table-rotate-recalc-marks org-table-sort-lines org-table-sum
3815    org-table-toggle-coordinate-overlays
3816    org-table-toggle-formula-debugger org-table-wrap-region
3817    orgtbl-mode turn-on-orgtbl org-table-to-lisp
3818    orgtbl-to-generic orgtbl-to-tsv orgtbl-to-csv orgtbl-to-latex
3819    orgtbl-to-orgtbl orgtbl-to-html orgtbl-to-texinfo)))
3820
3821 (defun org-at-table-p (&optional table-type)
3822   "Return t if the cursor is inside an org-type table.
3823 If TABLE-TYPE is non-nil, also check for table.el-type tables."
3824   (if org-enable-table-editor
3825       (save-excursion
3826         (beginning-of-line 1)
3827         (looking-at (if table-type org-table-any-line-regexp
3828                       org-table-line-regexp)))
3829     nil))
3830 (defsubst org-table-p () (org-at-table-p))
3831
3832 (defun org-at-table.el-p ()
3833   "Return t if and only if we are at a table.el table."
3834   (and (org-at-table-p 'any)
3835        (save-excursion
3836          (goto-char (org-table-begin 'any))
3837          (looking-at org-table1-hline-regexp))))
3838 (defun org-table-recognize-table.el ()
3839   "If there is a table.el table nearby, recognize it and move into it."
3840   (if org-table-tab-recognizes-table.el
3841       (if (org-at-table.el-p)
3842           (progn
3843             (beginning-of-line 1)
3844             (if (looking-at org-table-dataline-regexp)
3845                 nil
3846               (if (looking-at org-table1-hline-regexp)
3847                   (progn
3848                     (beginning-of-line 2)
3849                     (if (looking-at org-table-any-border-regexp)
3850                         (beginning-of-line -1)))))
3851             (if (re-search-forward "|" (org-table-end t) t)
3852                 (progn
3853                   (require 'table)
3854                   (if (table--at-cell-p (point))
3855                       t
3856                     (message "recognizing table.el table...")
3857                     (table-recognize-table)
3858                     (message "recognizing table.el table...done")))
3859               (error "This should not happen"))
3860             t)
3861         nil)
3862     nil))
3863
3864 (defun org-at-table-hline-p ()
3865   "Return t if the cursor is inside a hline in a table."
3866   (if org-enable-table-editor
3867       (save-excursion
3868         (beginning-of-line 1)
3869         (looking-at org-table-hline-regexp))
3870     nil))
3871
3872 (defvar org-table-clean-did-remove-column nil)
3873
3874 (defun org-table-map-tables (function &optional quietly)
3875   "Apply FUNCTION to the start of all tables in the buffer."
3876   (save-excursion
3877     (save-restriction
3878       (widen)
3879       (goto-char (point-min))
3880       (while (re-search-forward org-table-any-line-regexp nil t)
3881         (unless quietly
3882           (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
3883         (beginning-of-line 1)
3884         (when (looking-at org-table-line-regexp)
3885           (save-excursion (funcall function))
3886           (or (looking-at org-table-line-regexp)
3887               (forward-char 1)))
3888         (re-search-forward org-table-any-border-regexp nil 1))))
3889   (unless quietly (message "Mapping tables: done")))
3890
3891 ;; Declare and autoload functions from org-exp.el  & Co
3892
3893 (declare-function org-default-export-plist "org-exp")
3894 (declare-function org-infile-export-plist "org-exp")
3895 (declare-function org-get-current-options "org-exp")
3896 (eval-and-compile
3897   (org-autoload "org-exp"
3898                 '(org-export org-export-visible
3899                              org-insert-export-options-template
3900                              org-table-clean-before-export))
3901   (org-autoload "org-ascii"
3902                 '(org-export-as-ascii org-export-ascii-preprocess
3903                   org-export-as-ascii-to-buffer org-replace-region-by-ascii
3904                   org-export-region-as-ascii))
3905   (org-autoload "org-latex"
3906                 '(org-export-as-latex-batch org-export-as-latex-to-buffer
3907                   org-replace-region-by-latex org-export-region-as-latex
3908                   org-export-as-latex org-export-as-pdf
3909                   org-export-as-pdf-and-open))
3910   (org-autoload "org-html"
3911                 '(org-export-as-html-and-open
3912                   org-export-as-html-batch org-export-as-html-to-buffer
3913                   org-replace-region-by-html org-export-region-as-html
3914                   org-export-as-html))
3915   (org-autoload "org-docbook"
3916                 '(org-export-as-docbook-batch org-export-as-docbook-to-buffer
3917                   org-replace-region-by-docbook org-export-region-as-docbook
3918                   org-export-as-docbook-pdf org-export-as-docbook-pdf-and-open
3919                   org-export-as-docbook))
3920   (org-autoload "org-icalendar"
3921                 '(org-export-icalendar-this-file
3922                   org-export-icalendar-all-agenda-files
3923                   org-export-icalendar-combine-agenda-files))
3924   (org-autoload "org-xoxo" '(org-export-as-xoxo))
3925   (org-autoload "org-beamer" '(org-beamer-mode org-beamer-sectioning)))
3926
3927 ;; Declare and autoload functions from org-agenda.el
3928
3929 (eval-and-compile
3930   (org-autoload "org-agenda"
3931                 '(org-agenda org-agenda-list org-search-view
3932    org-todo-list org-tags-view org-agenda-list-stuck-projects
3933    org-diary org-agenda-to-appt
3934    org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))
3935
3936 ;; Autoload org-remember
3937
3938 (eval-and-compile
3939   (org-autoload "org-remember"
3940                 '(org-remember-insinuate org-remember-annotation
3941    org-remember-apply-template org-remember org-remember-handler)))
3942
3943 (eval-and-compile
3944   (org-autoload "org-capture"
3945                 '(org-capture org-capture-insert-template-here
3946                   org-capture-import-remember-templates)))
3947
3948 ;; Autoload org-clock.el
3949
3950 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock"
3951                   (beg end))
3952 (declare-function org-clock-update-mode-line "org-clock" ())
3953 (declare-function org-resolve-clocks "org-clock"
3954                   (&optional also-non-dangling-p prompt last-valid))
3955 (defvar org-clock-start-time)
3956 (defvar org-clock-marker (make-marker)
3957   "Marker recording the last clock-in.")
3958 (defvar org-clock-hd-marker (make-marker)
3959   "Marker recording the last clock-in, but the headline position.")
3960 (defvar org-clock-heading ""
3961   "The heading of the current clock entry.")
3962 (defun org-clock-is-active ()
3963  "Return non-nil if clock is currently running.
3964 The return value is actually the clock marker."
3965  (marker-buffer org-clock-marker))
3966
3967 (eval-and-compile
3968   (org-autoload
3969    "org-clock"
3970    '(org-clock-in org-clock-out org-clock-cancel
3971                   org-clock-goto org-clock-sum org-clock-display
3972                   org-clock-remove-overlays org-clock-report
3973                   org-clocktable-shift org-dblock-write:clocktable
3974                   org-get-clocktable org-resolve-clocks)))
3975
3976 (defun org-clock-update-time-maybe ()
3977   "If this is a CLOCK line, update it and return t.
3978 Otherwise, return nil."
3979   (interactive)
3980   (save-excursion
3981     (beginning-of-line 1)
3982     (skip-chars-forward " \t")
3983     (when (looking-at org-clock-string)
3984       (let ((re (concat "[ \t]*" org-clock-string
3985                         " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
3986                         "\\([ \t]*=>.*\\)?\\)?"))
3987             ts te h m s neg)
3988         (cond
3989          ((not (looking-at re))
3990           nil)
3991          ((not (match-end 2))
3992           (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
3993                      (> org-clock-marker (point))
3994                      (<= org-clock-marker (point-at-eol)))
3995             ;; The clock is running here
3996             (setq org-clock-start-time
3997                   (apply 'encode-time
3998                          (org-parse-time-string (match-string 1))))
3999             (org-clock-update-mode-line)))
4000          (t
4001           (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
4002           (end-of-line 1)
4003           (setq ts (match-string 1)
4004                 te (match-string 3))
4005           (setq s (- (org-float-time
4006                       (apply 'encode-time (org-parse-time-string te)))
4007                      (org-float-time
4008                       (apply 'encode-time (org-parse-time-string ts))))
4009                 neg (< s 0)
4010                 s (abs s)
4011                 h (floor (/ s 3600))
4012                 s (- s (* 3600 h))
4013                 m (floor (/ s 60))
4014                 s (- s (* 60 s)))
4015           (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
4016           t))))))
4017
4018 (defun org-check-running-clock ()
4019   "Check if the current buffer contains the running clock.
4020 If yes, offer to stop it and to save the buffer with the changes."
4021   (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4022              (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4023                                (buffer-name))))
4024     (org-clock-out)
4025     (when (y-or-n-p "Save changed buffer?")
4026       (save-buffer))))
4027
4028 (defun org-clocktable-try-shift (dir n)
4029   "Check if this line starts a clock table, if yes, shift the time block."
4030   (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4031     (org-clocktable-shift dir n)))
4032
4033 ;; Autoload org-timer.el
4034
4035 (eval-and-compile
4036   (org-autoload
4037    "org-timer"
4038    '(org-timer-start org-timer org-timer-item
4039                      org-timer-change-times-in-region
4040                      org-timer-set-timer
4041                      org-timer-reset-timers
4042                      org-timer-show-remaining-time)))
4043
4044 ;; Autoload org-feed.el
4045
4046 (eval-and-compile
4047   (org-autoload
4048    "org-feed"
4049    '(org-feed-update org-feed-update-all org-feed-goto-inbox)))
4050
4051
4052 ;; Autoload org-indent.el
4053
4054 ;; Define the variable already here, to make sure we have it.
4055 (defvar org-indent-mode nil
4056   "Non-nil if Org-Indent mode is enabled.
4057 Use the command `org-indent-mode' to change this variable.")
4058
4059 (eval-and-compile
4060   (org-autoload
4061    "org-indent"
4062    '(org-indent-mode)))
4063
4064 ;; Autoload org-mobile.el
4065
4066 (eval-and-compile
4067   (org-autoload
4068    "org-mobile"
4069    '(org-mobile-push org-mobile-pull org-mobile-create-sumo-agenda)))
4070
4071 ;; Autoload archiving code
4072 ;; The stuff that is needed for cycling and tags has to be defined here.
4073
4074 (defgroup org-archive nil
4075   "Options concerning archiving in Org-mode."
4076   :tag "Org Archive"
4077   :group 'org-structure)
4078
4079 (defcustom org-archive-location "%s_archive::"
4080   "The location where subtrees should be archived.
4081
4082 The value of this variable is a string, consisting of two parts,
4083 separated by a double-colon.  The first part is a filename and
4084 the second part is a headline.
4085
4086 When the filename is omitted, archiving happens in the same file.
4087 %s in the filename will be replaced by the current file
4088 name (without the directory part).  Archiving to a different file
4089 is useful to keep archived entries from contributing to the
4090 Org-mode Agenda.
4091
4092 The archived entries will be filed as subtrees of the specified
4093 headline.  When the headline is omitted, the subtrees are simply
4094 filed away at the end of the file, as top-level entries.  Also in
4095 the heading you can use %s to represent the file name, this can be
4096 useful when using the same archive for a number of different files.
4097
4098 Here are a few examples:
4099 \"%s_archive::\"
4100         If the current file is Projects.org, archive in file
4101         Projects.org_archive, as top-level trees.  This is the default.
4102
4103 \"::* Archived Tasks\"
4104         Archive in the current file, under the top-level headline
4105         \"* Archived Tasks\".
4106
4107 \"~/org/archive.org::\"
4108         Archive in file ~/org/archive.org (absolute path), as top-level trees.
4109
4110 \"~/org/archive.org::* From %s\"
4111         Archive in file ~/org/archive.org (absolute path), under headlines