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