summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKyle Meyer <kyle@kyleam.com>2015-09-21 18:46:41 -0400
committerKyle Meyer <kyle@kyleam.com>2015-09-21 18:46:41 -0400
commit5362f63fadc23e4fc736999f50333764fccd81b2 (patch)
tree2db3798fb5dfcae46991f978f985b59d13048110
parent9ecec6613f2920ca62e57c49f94e0632df5b2657 (diff)
parentfbf4fa8cc786cf6c24ea4fcc9e38895cff46acbb (diff)
downloadorg-mode-5362f63fadc23e4fc736999f50333764fccd81b2.tar.gz
Merge branch 'maint'
-rw-r--r--lisp/ob-C.el6
-rw-r--r--lisp/ob-R.el8
-rw-r--r--lisp/ob-core.el32
-rw-r--r--lisp/ob-dot.el2
-rw-r--r--lisp/ob-exp.el4
-rw-r--r--lisp/ob-fortran.el2
-rw-r--r--lisp/ob-groovy.el4
-rw-r--r--lisp/ob-io.el4
-rw-r--r--lisp/ob-lilypond.el2
-rw-r--r--lisp/ob-lob.el8
-rw-r--r--lisp/ob-octave.el8
-rw-r--r--lisp/ob-perl.el4
-rw-r--r--lisp/ob-python.el14
-rw-r--r--lisp/ob-ref.el6
-rw-r--r--lisp/ob-ruby.el4
-rw-r--r--lisp/ob-scala.el4
-rw-r--r--lisp/ob-scheme.el2
-rw-r--r--lisp/ob-shell.el4
-rw-r--r--lisp/ob-sql.el4
-rw-r--r--lisp/ob-sqlite.el2
-rw-r--r--lisp/ob-table.el2
-rw-r--r--lisp/ob-tangle.el2
-rw-r--r--lisp/org-agenda.el81
-rw-r--r--lisp/org-bibtex.el4
-rw-r--r--lisp/org-capture.el6
-rw-r--r--lisp/org-clock.el22
-rw-r--r--lisp/org-compat.el4
-rw-r--r--lisp/org-crypt.el4
-rw-r--r--lisp/org-ctags.el9
-rw-r--r--lisp/org-docview.el2
-rw-r--r--lisp/org-element.el20
-rw-r--r--lisp/org-entities.el4
-rw-r--r--lisp/org-faces.el2
-rw-r--r--lisp/org-feed.el3
-rw-r--r--lisp/org-habit.el2
-rw-r--r--lisp/org-id.el3
-rw-r--r--lisp/org-irc.el4
-rw-r--r--lisp/org-list.el28
-rw-r--r--lisp/org-macs.el2
-rw-r--r--lisp/org-mouse.el10
-rw-r--r--lisp/org-plot.el2
-rw-r--r--lisp/org-protocol.el24
-rw-r--r--lisp/org-src.el4
-rw-r--r--lisp/org-table.el28
-rwxr-xr-xlisp/org.el143
-rw-r--r--lisp/ox-html.el10
-rw-r--r--lisp/ox-icalendar.el2
-rw-r--r--lisp/ox-latex.el34
-rw-r--r--lisp/ox-man.el4
-rw-r--r--lisp/ox-odt.el38
-rw-r--r--lisp/ox-org.el2
-rw-r--r--lisp/ox-publish.el8
-rw-r--r--lisp/ox-texinfo.el6
-rw-r--r--lisp/ox.el66
54 files changed, 379 insertions, 330 deletions
diff --git a/lisp/ob-C.el b/lisp/ob-C.el
index f02950a..64e9d20 100644
--- a/lisp/ob-C.el
+++ b/lisp/ob-C.el
@@ -331,9 +331,9 @@ FORMAT can be either a format string or a function which is called with VAL."
(defun org-babel-C-val-to-base-type (val)
"Determine the base type of VAL which may be
-'integerp if all base values are integers
-'floatp if all base values are either floating points or integers
-'stringp otherwise."
+`integerp' if all base values are integers
+`floatp' if all base values are either floating points or integers
+`stringp' otherwise."
(cond
((integerp val) 'integerp)
((floatp val) 'floatp)
diff --git a/lisp/ob-R.el b/lisp/ob-R.el
index ac84d7d..4bd6eea 100644
--- a/lisp/ob-R.el
+++ b/lisp/ob-R.el
@@ -381,8 +381,8 @@ Has four %s escapes to be filled in:
(defun org-babel-R-evaluate-external-process
(body result-type result-params column-names-p row-names-p)
"Evaluate BODY in external R process.
-If RESULT-TYPE equals 'output then return standard output as a
-string. If RESULT-TYPE equals 'value then return the value of the
+If RESULT-TYPE equals `output' then return standard output as a
+string. If RESULT-TYPE equals `value' then return the value of the
last statement in BODY, as elisp."
(case result-type
(value
@@ -409,8 +409,8 @@ last statement in BODY, as elisp."
(defun org-babel-R-evaluate-session
(session body result-type result-params column-names-p row-names-p)
"Evaluate BODY in SESSION.
-If RESULT-TYPE equals 'output then return standard output as a
-string. If RESULT-TYPE equals 'value then return the value of the
+If RESULT-TYPE equals `output' then return standard output as a
+string. If RESULT-TYPE equals `value' then return the value of the
last statement in BODY, as elisp."
(case result-type
(value
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index f642b18..9545871 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -110,6 +110,7 @@
(defcustom org-confirm-babel-evaluate t
"Confirm before evaluation.
+\\<org-mode-map>\
Require confirmation before interactively evaluating code
blocks in Org-mode buffers. The default value of this variable
is t, meaning confirmation is required for any code block
@@ -122,10 +123,11 @@ execution or nil if no prompt is required.
Warning: Disabling confirmation may result in accidental
evaluation of potentially harmful code. It may be advisable
-remove code block execution from C-c C-c as further protection
+remove code block execution from \\[org-ctrl-c-ctrl-c] \
+as further protection
against accidental code block evaluation. The
`org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to
-remove code block execution from the C-c C-c keybinding."
+remove code block execution from the \\[org-ctrl-c-ctrl-c] keybinding."
:group 'org-babel
:version "24.1"
:type '(choice boolean function))
@@ -133,7 +135,8 @@ remove code block execution from the C-c C-c keybinding."
(put 'org-confirm-babel-evaluate 'safe-local-variable (lambda (x) (eq x t)))
(defcustom org-babel-no-eval-on-ctrl-c-ctrl-c nil
- "Remove code block evaluation from the C-c C-c key binding."
+ "\\<org-mode-map>\
+Remove code block evaluation from the \\[org-ctrl-c-ctrl-c] key binding."
:group 'org-babel
:version "24.1"
:type 'boolean)
@@ -511,7 +514,7 @@ The list can have entries of the following forms:
"Return a function that determines whether a list of header args are safe.
Intended usage is:
-\(put 'org-babel-default-header-args 'safe-local-variable
+\(put \\='org-babel-default-header-args \\='safe-local-variable
(org-babel-header-args-safe-p org-babel-safe-header-args)
This allows org-babel languages to extend the list of safe values for
@@ -555,7 +558,7 @@ be saved in the second match data.")
(defvar org-babel-result-w-name-regexp
(concat org-babel-result-regexp
- "\\([^ ()\f\t\n\r\v]+\\)\\(\(\\(.*\\)\)\\|\\)"))
+ "\\([^ ()\f\t\n\r\v]+\\)\\((\\(.*\\))\\|\\)"))
(defvar org-babel-min-lines-for-block-output 10
"The minimum number of lines for block output.
@@ -1309,8 +1312,9 @@ the `org-mode-hook'."
(defun org-babel-hash-at-point (&optional point)
"Return the value of the hash at POINT.
+\\<org-mode-map>\
The hash is also added as the last element of the kill ring.
-This can be called with C-c C-c."
+This can be called with \\[org-ctrl-c-ctrl-c]."
(interactive)
(let ((hash (car (delq nil (mapcar
(lambda (ol) (overlay-get ol 'babel-hash))
@@ -1597,7 +1601,7 @@ shown below.
;; row and column names
(defun org-babel-del-hlines (table)
- "Remove all 'hlines from TABLE."
+ "Remove all `hlines' from TABLE."
(remq 'hline table))
(defun org-babel-get-colnames (table)
@@ -1750,7 +1754,7 @@ If the point is not on a source block then return nil."
(if point
;; taken from `org-open-at-point'
(progn (org-mark-ring-push) (goto-char point) (org-show-context))
- (message "source-code block '%s' not found in this buffer" name))))
+ (message "source-code block `%s' not found in this buffer" name))))
(defun org-babel-find-named-block (name)
"Find a named source-code block.
@@ -1784,7 +1788,7 @@ to `org-babel-named-src-block-regexp'."
(if point
;; taken from `org-open-at-point'
(progn (goto-char point) (org-show-context))
- (message "result '%s' not found in this buffer" name))))
+ (message "result `%s' not found in this buffer" name))))
(defun org-babel-find-named-result (name &optional point)
"Find a named result.
@@ -2405,7 +2409,7 @@ file's directory then expand relative links."
'org-babel-examplify-region "25.1")
(defun org-babel-examplify-region (beg end &optional results-switches)
- "Comment out region using the inline '==' or ': ' org example quote."
+ "Comment out region using the inline `==' or `: ' org example quote."
(interactive "*r")
(let ((chars-between (lambda (b e)
(not (string-match "^[\\s]*$"
@@ -2620,7 +2624,7 @@ CONTEXT may be one of :tangle, :export or :eval."
"Expand Noweb references in the body of the current source code block.
For example the following reference would be replaced with the
-body of the source-code block named 'example-block'.
+body of the source-code block named `example-block'.
<<example-block>>
@@ -2633,7 +2637,7 @@ This function must be called from inside of the buffer containing
the source-code block which holds BODY.
In addition the following syntax can be used to insert the
-results of evaluating the source-code block named 'example-block'.
+results of evaluating the source-code block named `example-block'.
<<example-block()>>
@@ -2670,7 +2674,7 @@ block but are passed literally to the \"example-block\"."
(setq index (point))
(while (and (re-search-forward (org-babel-noweb-wrap) nil t))
(save-match-data (setf source-name (match-string 1)))
- (save-match-data (setq evaluate (string-match "\(.*\)" source-name)))
+ (save-match-data (setq evaluate (string-match "(.*)" source-name)))
(save-match-data
(setq prefix
(buffer-substring (match-beginning 0)
@@ -2844,7 +2848,7 @@ block but are passed literally to the \"example-block\"."
(defun org-babel-read (cell &optional inhibit-lisp-eval)
"Convert the string value of CELL to a number if appropriate.
Otherwise if CELL looks like lisp (meaning it starts with a
-\"(\", \"'\", \"\\=`\" or a \"[\") then read and evaluate it as
+\"(\", \"\\='\", \"\\=`\" or a \"[\") then read and evaluate it as
lisp, otherwise return it unmodified as a string. Optional
argument INHIBIT-LISP-EVAL inhibits lisp evaluation for
situations in which is it not appropriate."
diff --git a/lisp/ob-dot.el b/lisp/ob-dot.el
index 2f56208..7488980 100644
--- a/lisp/ob-dot.el
+++ b/lisp/ob-dot.el
@@ -53,7 +53,7 @@
(value (cdr pair)))
(setq body
(replace-regexp-in-string
- (concat "\$" (regexp-quote name))
+ (concat "$" (regexp-quote name))
(if (stringp value) value (format "%S" value))
body
t
diff --git a/lisp/ob-exp.el b/lisp/ob-exp.el
index 1f01973..38086df 100644
--- a/lisp/ob-exp.el
+++ b/lisp/ob-exp.el
@@ -54,7 +54,7 @@
(defcustom org-export-babel-evaluate t
"Switch controlling code evaluation during export.
When set to nil no code will be evaluated as part of the export
-process. When set to 'inline-only, only inline code blocks will
+process. When set to `inline-only', only inline code blocks will
be executed."
:group 'org-babel
:version "24.1"
@@ -99,7 +99,7 @@ be executed."
(defun org-babel-exp-src-block (&rest headers)
"Process source block for export.
-Depending on the 'export' headers argument, replace the source
+Depending on the `export' headers argument, replace the source
code block like this:
both ---- display the code and the results
diff --git a/lisp/ob-fortran.el b/lisp/ob-fortran.el
index d32092a..6390536 100644
--- a/lisp/ob-fortran.el
+++ b/lisp/ob-fortran.el
@@ -110,7 +110,7 @@ it's header arguments."
"Wrap body in a \"program ... end program\" block if none exists."
(if (string-match "^[ \t]*program[ \t]*.*" (capitalize body))
(let ((vars (mapcar #'cdr (org-babel-get-header params :var))))
- (if vars (error "Cannot use :vars if 'program' statement is present"))
+ (if vars (error "Cannot use :vars if `program' statement is present"))
body)
(format "program main\n%s\nend program main\n" body)))
diff --git a/lisp/ob-groovy.el b/lisp/ob-groovy.el
index 91100d2..8c0498e 100644
--- a/lisp/ob-groovy.el
+++ b/lisp/ob-groovy.el
@@ -80,8 +80,8 @@ println(new Runner().run())
(defun org-babel-groovy-evaluate
(session body &optional result-type result-params)
"Evaluate BODY in external Groovy process.
-If RESULT-TYPE equals 'output then return standard output as a string.
-If RESULT-TYPE equals 'value then return the value of the last statement
+If RESULT-TYPE equals `output' then return standard output as a string.
+If RESULT-TYPE equals `value' then return the value of the last statement
in BODY as elisp."
(when session (error "Sessions are not (yet) supported for Groovy"))
(case result-type
diff --git a/lisp/ob-io.el b/lisp/ob-io.el
index a5e5cda..4f32383 100644
--- a/lisp/ob-io.el
+++ b/lisp/ob-io.el
@@ -71,8 +71,8 @@ called by `org-babel-execute-src-block'"
(defun org-babel-io-evaluate (session body &optional result-type result-params)
"Evaluate BODY in external Io process.
-If RESULT-TYPE equals 'output then return standard output as a string.
-If RESULT-TYPE equals 'value then return the value of the last statement
+If RESULT-TYPE equals `output' then return standard output as a string.
+If RESULT-TYPE equals `value' then return the value of the last statement
in BODY as elisp."
(when session (error "Sessions are not (yet) supported for Io"))
(case result-type
diff --git a/lisp/ob-lilypond.el b/lisp/ob-lilypond.el
index fe0416e..eba8423 100644
--- a/lisp/ob-lilypond.el
+++ b/lisp/ob-lilypond.el
@@ -130,7 +130,7 @@ blocks.")
(value (cdr pair)))
(setq body
(replace-regexp-in-string
- (concat "\$" (regexp-quote name))
+ (concat "$" (regexp-quote name))
(if (stringp value) value (format "%S" value))
body))))
vars)
diff --git a/lisp/ob-lob.el b/lisp/ob-lob.el
index 0267f44..c285b0c 100644
--- a/lisp/ob-lob.el
+++ b/lisp/ob-lob.el
@@ -64,14 +64,14 @@ To add files to this list use the `org-babel-lob-ingest' command."
(defconst org-babel-block-lob-one-liner-regexp
(concat
- "^\\([ \t]*?\\)#\\+call:[ \t]+\\([^\(\)\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)"
- "\(\\([^\n]*?\\)\)\\(\\[.+\\]\\|\\)[ \t]*\\(\\([^\n]*\\)\\)?")
+ "^\\([ \t]*?\\)#\\+call:[ \t]+\\([^()\n]+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)"
+ "(\\([^\n]*?\\))\\(\\[.+\\]\\|\\)[ \t]*\\(\\([^\n]*\\)\\)?")
"Regexp to match non-inline calls to predefined source block functions.")
(defconst org-babel-inline-lob-one-liner-regexp
(concat
- "\\([^\n]*?\\)call_\\([^\(\)[:space:]\n]+?\\)\\(\\[\\(.*?\\)\\]\\|\\(\\)\\)"
- "\(\\(.*?\\)\)\\(\\[\\(.*?\\)\\]\\)?")
+ "\\([^\n]*?\\)call_\\([^()[:space:]\n]+?\\)\\(\\[\\(.*?\\)\\]\\|\\(\\)\\)"
+ "(\\(.*?\\))\\(\\[\\(.*?\\)\\]\\)?")
"Regexp to match inline calls to predefined source block functions.")
(defconst org-babel-lob-one-liner-regexp
diff --git a/lisp/ob-octave.el b/lisp/ob-octave.el
index 094b32c..dbd9100 100644
--- a/lisp/ob-octave.el
+++ b/lisp/ob-octave.el
@@ -61,7 +61,7 @@ if ischar(ans), fid = fopen('%s', 'w'); fprintf(fid, '%%s\\n', ans); fclose(fid)
else, dlmwrite('%s', ans, '\\t')
end")
-(defvar org-babel-octave-eoe-indicator "\'org_babel_eoe\'")
+(defvar org-babel-octave-eoe-indicator "'org_babel_eoe'")
(defvar org-babel-octave-eoe-output "ans = org_babel_eoe")
@@ -128,7 +128,7 @@ specifying a variable of the same value."
(if (listp (car var)) "; " ",")) "]")
(cond
((stringp var)
- (format "\'%s\'" var))
+ (format "'%s'" var))
(t
(format "%s" var)))))
@@ -168,8 +168,8 @@ create. Return the initialized session."
(defun org-babel-octave-evaluate
(session body result-type &optional matlabp)
"Pass BODY to the octave process in SESSION.
-If RESULT-TYPE equals 'output then return the outputs of the
-statements in BODY, if RESULT-TYPE equals 'value then return the
+If RESULT-TYPE equals `output' then return the outputs of the
+statements in BODY, if RESULT-TYPE equals `value' then return the
value of the last statement in BODY, as elisp."
(if session
(org-babel-octave-evaluate-session session body result-type matlabp)
diff --git a/lisp/ob-perl.el b/lisp/ob-perl.el
index d27c18e..67d48d7 100644
--- a/lisp/ob-perl.el
+++ b/lisp/ob-perl.el
@@ -127,8 +127,8 @@ specifying a var of the same value."
(defun org-babel-perl-evaluate (session ibody &optional result-type result-params)
"Pass BODY to the Perl process in SESSION.
-If RESULT-TYPE equals 'output then return a list of the outputs
-of the statements in BODY, if RESULT-TYPE equals 'value then
+If RESULT-TYPE equals `output' then return a list of the outputs
+of the statements in BODY, if RESULT-TYPE equals `value' then
return the value of the last statement in BODY, as elisp."
(when session (error "Sessions are not supported for Perl"))
(let* ((body (concat org-babel-perl-preface ibody))
diff --git a/lisp/ob-python.el b/lisp/ob-python.el
index dd3cc66..3a9b8f6 100644
--- a/lisp/ob-python.el
+++ b/lisp/ob-python.el
@@ -50,7 +50,7 @@
(defcustom org-babel-python-mode
(if (or (featurep 'xemacs) (featurep 'python-mode)) 'python-mode 'python)
"Preferred python mode for use in running python interactively.
-This will typically be either 'python or 'python-mode."
+This will typically be either `python' or `python-mode'."
:group 'org-babel
:version "24.4"
:package-version '(Org . "8.0")
@@ -64,7 +64,7 @@ This will typically be either 'python or 'python-mode."
:type 'string)
(defcustom org-babel-python-None-to 'hline
- "Replace 'None' in python tables with this before returning."
+ "Replace `None' in python tables with this before returning."
:group 'org-babel
:version "24.4"
:package-version '(Org . "8.0")
@@ -250,8 +250,8 @@ open('%s', 'w').write( pprint.pformat(main()) )")
(defun org-babel-python-evaluate-external-process
(body &optional result-type result-params preamble)
"Evaluate BODY in external python process.
-If RESULT-TYPE equals 'output then return standard output as a
-string. If RESULT-TYPE equals 'value then return the value of the
+If RESULT-TYPE equals `output' then return standard output as a
+string. If RESULT-TYPE equals `value' then return the value of the
last statement in BODY, as elisp."
(let ((raw
(case result-type
@@ -282,8 +282,8 @@ last statement in BODY, as elisp."
(defun org-babel-python-evaluate-session
(session body &optional result-type result-params)
"Pass BODY to the Python process in SESSION.
-If RESULT-TYPE equals 'output then return standard output as a
-string. If RESULT-TYPE equals 'value then return the value of the
+If RESULT-TYPE equals `output' then return standard output as a
+string. If RESULT-TYPE equals `value' then return the value of the
last statement in BODY, as elisp."
(let* ((send-wait (lambda () (comint-send-input nil t) (sleep-for 0 5)))
(dump-last-value
@@ -334,7 +334,7 @@ last statement in BODY, as elisp."
(org-babel-python-table-or-string results)))))
(defun org-babel-python-read-string (string)
- "Strip 's from around Python string."
+ "Strip \\='s from around Python string."
(if (string-match "^'\\([^\000]+\\)'$" string)
(match-string 1 string)
string))
diff --git a/lisp/ob-ref.el b/lisp/ob-ref.el
index b8a921e..6e690ab 100644
--- a/lisp/ob-ref.el
+++ b/lisp/ob-ref.el
@@ -139,7 +139,7 @@ the variable."
(setq ref (substring ref 0 (match-beginning 0))))
;; assign any arguments to pass to source block
(when (string-match
- "^\\(.+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)\(\\(.*\\)\)$" ref)
+ "^\\(.+?\\)\\(\\[\\(.*\\)\\]\\|\\(\\)\\)(\\(.*\\))$" ref)
(setq new-refere (match-string 1 ref))
(setq new-header-args (match-string 3 ref))
(setq new-referent (match-string 5 ref))
@@ -177,7 +177,7 @@ the variable."
;; buffer (marker-buffer id-loc)
;; loc (marker-position id-loc))
;; (move-marker id-loc nil)
- (error "Reference '%s' not found in this buffer" ref))
+ (error "Reference `%s' not found in this buffer" ref))
(cond
(lob-info (setq type 'lob))
(id (setq type 'id))
@@ -234,7 +234,7 @@ returned, or an empty string or \"*\" both of which are
interpreted to mean the entire range and as such are equivalent
to \"0:-1\"."
(if (and (> (length index) 0) (string-match "^\\([^,]*\\),?" index))
- (let* ((ind-re "\\(\\([-[:digit:]]+\\):\\([-[:digit:]]+\\)\\|\*\\)")
+ (let* ((ind-re "\\(\\([-[:digit:]]+\\):\\([-[:digit:]]+\\)\\|\\*\\)")
(lgth (length lis))
(portion (match-string 1 index))
(remainder (substring index (match-end 0)))
diff --git a/lisp/ob-ruby.el b/lisp/ob-ruby.el
index 0ff460e..780b7bc 100644
--- a/lisp/ob-ruby.el
+++ b/lisp/ob-ruby.el
@@ -187,8 +187,8 @@ end
(defun org-babel-ruby-evaluate
(buffer body &optional result-type result-params)
"Pass BODY to the Ruby process in BUFFER.
-If RESULT-TYPE equals 'output then return a list of the outputs
-of the statements in BODY, if RESULT-TYPE equals 'value then
+If RESULT-TYPE equals `output' then return a list of the outputs
+of the statements in BODY, if RESULT-TYPE equals `value' then
return the value of the last statement in BODY, as elisp."
(if (not buffer)
;; external process evaluation
diff --git a/lisp/ob-scala.el b/lisp/ob-scala.el
index 656667a..dfb72dd 100644
--- a/lisp/ob-scala.el
+++ b/lisp/ob-scala.el
@@ -78,8 +78,8 @@ print(str_result)
(defun org-babel-scala-evaluate
(session body &optional result-type result-params)
"Evaluate BODY in external Scala process.
-If RESULT-TYPE equals 'output then return standard output as a string.
-If RESULT-TYPE equals 'value then return the value of the last statement
+If RESULT-TYPE equals `output' then return standard output as a string.
+If RESULT-TYPE equals `value' then return the value of the last statement
in BODY as elisp."
(when session (error "Sessions are not (yet) supported for Scala"))
(case result-type
diff --git a/lisp/ob-scheme.el b/lisp/ob-scheme.el
index b10dfc3..2d7f3e6 100644
--- a/lisp/ob-scheme.el
+++ b/lisp/ob-scheme.el
@@ -109,7 +109,7 @@ For a named session, the buffer name will be the session name.
If the session is unnamed (nil), generate a name.
-If the session is 'none', use nil for the session name, and
+If the session is `none', use nil for the session name, and
org-babel-scheme-execute-with-geiser will use a temporary session."
(let ((result
(cond ((not name)
diff --git a/lisp/ob-shell.el b/lisp/ob-shell.el
index efa992f..84f4fa8 100644
--- a/lisp/ob-shell.el
+++ b/lisp/ob-shell.el
@@ -184,8 +184,8 @@ var of the same value."
(defun org-babel-sh-evaluate (session body &optional params stdin cmdline)
"Pass BODY to the Shell process in BUFFER.
-If RESULT-TYPE equals 'output then return a list of the outputs
-of the statements in BODY, if RESULT-TYPE equals 'value then
+If RESULT-TYPE equals `output' then return a list of the outputs
+of the statements in BODY, if RESULT-TYPE equals `value' then
return the value of the last statement in BODY."
(let ((results
(cond
diff --git a/lisp/ob-sql.el b/lisp/ob-sql.el
index 2748b43..a039613 100644
--- a/lisp/ob-sql.el
+++ b/lisp/ob-sql.el
@@ -119,7 +119,7 @@ This function is called by `org-babel-execute-src-block'."
('dbi (format "dbish --batch %s < %s | sed '%s' > %s"
(or cmdline "")
(org-babel-process-file-name in-file)
- "/^+/d;s/^\|//;s/(NULL)/ /g;$d"
+ "/^+/d;s/^|//;s/(NULL)/ /g;$d"
(org-babel-process-file-name out-file)))
('monetdb (format "mclient -f tab %s < %s > %s"
(or cmdline "")
@@ -202,7 +202,7 @@ This function is called by `org-babel-execute-src-block'."
(lambda (pair)
(setq body
(replace-regexp-in-string
- (format "\$%s" (car pair)) ;FIXME: "\$" == "$"!
+ (format "$%s" (car pair))
(let ((val (cdr pair)))
(if (listp val)
(let ((data-file (org-babel-temp-file "sql-data-")))
diff --git a/lisp/ob-sqlite.el b/lisp/ob-sqlite.el
index 33c8d9b..18d7fc8 100644
--- a/lisp/ob-sqlite.el
+++ b/lisp/ob-sqlite.el
@@ -119,7 +119,7 @@ This function is called by `org-babel-execute-src-block'."
(lambda (pair)
(setq body
(replace-regexp-in-string
- (format "\$%s" (car pair)) ;FIXME: "\$" == "$"!
+ (format "$%s" (car pair))
(let ((val (cdr pair)))
(if (listp val)
(let ((data-file (org-babel-temp-file "sqlite-data-")))
diff --git a/lisp/ob-table.el b/lisp/ob-table.el
index 3dccc71..ec7450e 100644
--- a/lisp/ob-table.el
+++ b/lisp/ob-table.el
@@ -94,7 +94,7 @@ the header argument which can then be passed before all variables
as shown in the example below.
| 1 | 2 | :file nothing.png | nothing.png |
-#+TBLFM: @1$4='(org-sbe test-sbe $3 (x $1) (y $2))"
+#+TBLFM: @1$4=\\='(org-sbe test-sbe $3 (x $1) (y $2))"
(declare (debug (form form)))
(let* ((header-args (if (stringp (car variables)) (car variables) ""))
(variables (if (stringp (car variables)) (cdr variables) variables)))
diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el
index 3852185..f822e3f 100644
--- a/lisp/ob-tangle.el
+++ b/lisp/ob-tangle.el
@@ -332,7 +332,7 @@ Insert the source-code specified by SPEC into the current source
code file. This function uses `comment-region' which assumes
that the appropriate major-mode is set. SPEC has the form:
- \(start-line file link source-name params body comment)"
+ (start-line file link source-name params body comment)"
(let* ((start-line (nth 0 spec))
(file (if org-babel-tangle-use-relative-file-links
(file-relative-name (nth 1 spec))
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 95fb046..61f2922 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -153,7 +153,7 @@ before assigned to the variables. So make sure to quote values you do
*not* want evaluated, for example
(setq org-agenda-exporter-settings
- '((ps-print-color-p 'black-white)))"
+ \\='((ps-print-color-p \\='black-white)))"
:group 'org-agenda-export
:type '(repeat
(list
@@ -440,7 +440,7 @@ This will be spliced into the custom type of
(defcustom org-agenda-custom-commands
- '(("n" "Agenda and all TODO's" ((agenda "") (alltodo ""))))
+ '(("n" "Agenda and all TODOs" ((agenda "") (alltodo ""))))
"Custom commands for the agenda.
These commands will be offered on the splash screen displayed by the
agenda dispatcher \\[org-agenda]. Each entry is a list like this:
@@ -504,7 +504,7 @@ are prefix commands. For the dispatcher to display useful information, you
should provide a description for the prefix, like
(setq org-agenda-custom-commands
- '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
+ \\='((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
(\"hl\" tags \"+HOME+Lisa\")
(\"hp\" tags \"+HOME+Peter\")
(\"hk\" tags \"+HOME+Kim\")))"
@@ -1211,7 +1211,7 @@ For example, 9:30am would become 09:30 rather than 9:30."
:type 'boolean)
(defun org-agenda-time-of-day-to-ampm (time)
- "Convert TIME of a string like '13:45' to an AM/PM style time string."
+ "Convert TIME of a string like \"13:45\" to an AM/PM style time string."
(let* ((hour-number (string-to-number (substring time 0 -3)))
(minute (substring time -2))
(ampm "am"))
@@ -1292,12 +1292,14 @@ given here."
(defcustom org-agenda-log-mode-items '(closed clock)
"List of items that should be shown in agenda log mode.
+\\<org-agenda-mode-map>\
This list may contain the following symbols:
closed Show entries that have been closed on that day.
clock Show entries that have received clocked time on that day.
state Show all logged state changes.
-Note that instead of changing this variable, you can also press `C-u l' in
+Note that instead of changing this variable, you can also press \
+`\\[universal-argument] \\[org-agenda-log-mode]' in
the agenda to display all available LOG items temporarily."
:group 'org-agenda-daily/weekly
:type '(set :greedy t (const closed) (const clock) (const state)))
@@ -1792,7 +1794,7 @@ When non-nil, this must be the number of minutes, e.g. 60 for one hour."
(defcustom org-agenda-show-inherited-tags t
"Non-nil means show inherited tags in each agenda line.
-When this option is set to 'always, it take precedences over
+When this option is set to `always', it take precedences over
`org-agenda-use-tag-inheritance' and inherited tags are shown
in every agenda.
@@ -1801,8 +1803,8 @@ shown when they are available, i.e. when the value of
`org-agenda-use-tag-inheritance' has been taken into account.
This can be set to a list of agenda types in which the agenda
-must display the inherited tags. Available types are 'todo,
-'agenda, 'search and 'timeline.
+must display the inherited tags. Available types are `todo',
+`agenda', `search' and `timeline'.
When set to nil, never show inherited tags in agenda lines."
:group 'org-agenda-line-format
@@ -1823,10 +1825,10 @@ controlled by `org-use-tag-inheritance'. In other agenda types,
agenda entries. Still, you may want the agenda to be aware of
the inherited tags anyway, e.g. for later tag filtering.
-Allowed value are 'todo, 'search, 'timeline and 'agenda.
+Allowed value are `todo', `search', `timeline' and `agenda'.
This variable has no effect if `org-agenda-show-inherited-tags'
-is set to 'always. In that case, the agenda is aware of those
+is set to `always'. In that case, the agenda is aware of those
tags.
The default value sets tags in every agenda type. Setting this
@@ -1932,7 +1934,7 @@ list as second element:
For example, to display a 16px horizontal space for Emacs
category, you can use:
- (\"Emacs\" '(space . (:width (16))))"
+ (\"Emacs\" \\='(space . (:width (16))))"
:group 'org-agenda-line-format
:version "24.1"
:type '(alist :key-type (string :tag "Regexp matching category")
@@ -1975,7 +1977,8 @@ estimate."
:type 'boolean)
(defcustom org-agenda-auto-exclude-function nil
- "A function called with a tag to decide if it is filtered on '/ RET'.
+ "A function called with a tag to decide if it is filtered on \
+\\<org-agenda-mode-map>`\\[org-agenda-filter-by-tag] RET'.
The sole argument to the function, which is called once for each
possible tag, is a string giving the name of the tag. The
function should return either nil if the tag should be included
@@ -1990,7 +1993,7 @@ the lower-case version of all tags."
"Alist of characters and custom functions for bulk actions.
For example, this value makes those two functions available:
- '((?R set-category)
+ \\='((?R set-category)
(?C bulk-cut))
With selected entries in an agenda buffer, `B R' will call
@@ -2547,7 +2550,7 @@ For example, if you have a custom agenda command \"p\" and you
want this command to be accessible only from plain text files,
use this:
- '((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
+ \\='((\"p\" ((in-file . \"\\\\.txt\\\\'\"))))
Here are the available contexts definitions:
@@ -2565,7 +2568,7 @@ accessible if there is at least one valid check.
You can also bind a key to another agenda custom command
depending on contextual rules.
- '((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
+ \\='((\"p\" \"q\" ((in-file . \"\\\\.txt\\\\'\"))))
Here it means: in .txt files, use \"p\" as the key for the
agenda command otherwise associated with \"q\". (The command
@@ -3851,7 +3854,7 @@ FILTER-ALIST is an alist of filters we need to apply when
(defvar org-depend-tag-blocked)
(defun org-agenda-dim-blocked-tasks (&optional invisible)
- "Dim currently blocked TODO's in the agenda display.
+ "Dim currently blocked TODOs in the agenda display.
When INVISIBLE is non-nil, hide currently blocked TODO instead of
dimming them."
(interactive "P")
@@ -4639,7 +4642,8 @@ in `org-agenda-text-search-extra-files'."
(goto-char (1- end))
(throw :skip t)))
(if todo-only
- (cons (concat "^\*+[ \t]+" org-not-done-regexp)
+ (cons (concat "^\\*+[ \t]+"
+ org-not-done-regexp)
regexps+)
regexps+))
(goto-char beg)
@@ -4681,7 +4685,12 @@ in `org-agenda-text-search-extra-files'."
(add-text-properties pos (1- (point)) (list 'face 'org-warning))
(setq pos (point))
(unless org-agenda-multi
- (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
+ (insert (substitute-command-keys "\
+Press `\\[org-agenda-manipulate-query-add]', \
+`\\[org-agenda-manipulate-query-subtract]' to add/sub word, \
+`\\[org-agenda-manipulate-query-add-re]', \
+`\\[org-agenda-manipulate-query-subtract-re]' to add/sub regexp, \
+`\\[universal-argument] \\[org-agenda-redo]' to edit\n"))
(add-text-properties pos (1- (point))
(list 'face 'org-agenda-structure))))
(org-agenda-mark-header-line (point-min))
@@ -4775,7 +4784,8 @@ for a keyword. A numeric prefix directly selects the Nth keyword in
org-select-this-todo-keyword))
(setq pos (point))
(unless org-agenda-multi
- (insert "Available with `N r': (0)[ALL]")
+ (insert (substitute-command-keys "Available with \
+`N \\[org-agenda-redo]': (0)[ALL]"))
(let ((n 0) s)
(mapc (lambda (x)
(setq s (format "(%d)%s" (setq n (1+ n)) x))
@@ -4870,7 +4880,9 @@ The prefix arg TODO-ONLY limits the search to TODO entries."
(add-text-properties pos (1- (point)) (list 'face 'org-warning))
(setq pos (point))
(unless org-agenda-multi
- (insert "Press `C-u r' to search again with new search string\n"))
+ (insert (substitute-command-keys
+ "Press `\\[universal-argument] \\[org-agenda-redo]' \
+to search again with new search string\n")))
(add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
(org-agenda-mark-header-line (point-min))
(when rtnall
@@ -4969,13 +4981,13 @@ the `regexp' or `notregexp' element.
`todo' and `nottodo' accept as an argument a list of todo
keywords, which may include \"*\" to match any todo keyword.
- (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
+ (org-agenda-skip-entry-if \\='todo \\='(\"TODO\" \"WAITING\"))
would skip all entries with \"TODO\" or \"WAITING\" keywords.
Instead of a list, a keyword class may be given. For example:
- (org-agenda-skip-entry-if 'nottodo 'done)
+ (org-agenda-skip-entry-if \\='nottodo \\='done)
would skip entries that haven't been marked with any of \"DONE\"
keywords. Possible classes are: `todo', `done', `any'.
@@ -7116,7 +7128,7 @@ their type."
(defun org-agenda-set-restriction-lock (&optional type)
"Set restriction lock for agenda, to current subtree or file.
Restriction will be the file if TYPE is `file', or if type is the
-universal prefix '(4), or if the cursor is before the first headline
+universal prefix \\='(4), or if the cursor is before the first headline
in the file. Otherwise, restriction will be to the current subtree."
(interactive "P")
(org-agenda-remove-restriction-lock 'noupdate)
@@ -7187,7 +7199,7 @@ in the file. Otherwise, restriction will be to the current subtree."
(defun org-agenda-check-type (error &rest types)
"Check if agenda buffer is of allowed type.
If ERROR is non-nil, throw an error, otherwise just return nil.
-Allowed types are 'agenda 'timeline 'todo 'tags 'search."
+Allowed types are `agenda' `timeline' `todo' `tags' `search'."
(if (not org-agenda-type)
(error "No Org agenda currently displayed")
(if (memq org-agenda-type types)
@@ -7262,8 +7274,7 @@ touched. Also, exit the agenda even if it is in column view."
(defun org-agenda-kill-all-agenda-buffers ()
"Kill all buffers in `org-agenda-mode'.
-This is used when toggling sticky agendas.
-You can also explicitly invoke it with `C-c a C-k'."
+This is used when toggling sticky agendas."
(interactive)
(let (blist)
(dolist (buf (buffer-list))
@@ -8170,7 +8181,8 @@ so that the date SD will be in that range."
"Toggle log mode in an agenda buffer.
With argument SPECIAL, show all possible log items, not only the ones
configured in `org-agenda-log-mode-items'.
-With a double `C-u' prefix arg, show *only* log items, nothing else."
+With a double \\[universal-argument] prefix arg, show *only* \
+log items, nothing else."
(interactive "P")
(org-agenda-check-type t 'agenda 'timeline)
(setq org-agenda-show-log
@@ -8517,8 +8529,10 @@ If this information is not given, the function uses the tree at point."
(defun org-agenda-refile (&optional goto rfloc no-update)
"Refile the item at point.
-When GOTO is 0 or '(64) or \\[universal-argument] \\[universal-argument] \\[universal-argument], clear the refile cache.
-When GOTO is '(16) or \\[universal-argument] \\[universal-argument], go to the location of the last refiled item.
+When GOTO is 0 or \\='(64) or a triple \\[universal-argument] prefix argument,
+clear the refile cache.
+When GOTO is \\='(16) or a double \\[universal-argument] prefix argument,
+go to the location of the last refiled item.
RFLOC can be a refile location obtained in a different way.
When NO-UPDATE is non-nil, don't redo the agenda buffer."
(interactive "P")
@@ -9692,7 +9706,7 @@ This is a command that has to be installed in `calendar-mode-map'."
"Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
"Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
"French: " (calendar-french-date-string date) "\n"
- "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
+ "Bahá’í: " (calendar-bahai-date-string date) " (until sunset)\n"
"Mayan: " (calendar-mayan-date-string date) "\n"
"Coptic: " (calendar-coptic-date-string date) "\n"
"Ethiopic: " (calendar-ethiopic-date-string date) "\n"
@@ -10071,7 +10085,8 @@ tag and (if present) the flagging note."
(replace-match "\n" t t))
(goto-char (point-min))
(select-window win)
- (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
+ (message (substitute-command-keys "Flagging note pushed to kill ring. \
+Press \\[org-agenda-show-the-flagging-note] again to remove tag and note")))))
(defun org-agenda-remove-flag (marker)
"Remove the FLAGGED tag and any flagging note in the entry."
@@ -10108,9 +10123,9 @@ calling the function returns nil. This function takes one
argument: an entry from `org-agenda-get-day-entries'.
FILTER can also be an alist with the car of each cell being
-either 'headline or 'category. For example:
+either `headline' or `category'. For example:
- '((headline \"IMPORTANT\")
+ \\='((headline \"IMPORTANT\")
(category \"Work\"))
will only add headlines containing IMPORTANT or headlines
diff --git a/lisp/org-bibtex.el b/lisp/org-bibtex.el
index d795c53..4622702 100644
--- a/lisp/org-bibtex.el
+++ b/lisp/org-bibtex.el
@@ -195,7 +195,7 @@
(:howpublished . "How something strange has been published. The first word should be capitalized.")
(:institution . "The sponsoring institution of a technical report.")
(:journal . "A journal name.")
- (:key . "Used for alphabetizing, cross-referencing, and creating a label when the author information is missing. This field should not be confused with the key that appears in the \cite command and at the beginning of the database entry.")
+ (:key . "Used for alphabetizing, cross-referencing, and creating a label when the author information is missing. This field should not be confused with the key that appears in the \\cite command and at the beginning of the database entry.")
(:month . "The month in which the work was published or, for an unpublished work, in which it was written. You should use the standard three-letter abbreviation,")
(:note . "Any additional information that can help the reader. The first word should be capitalized.")
(:number . "Any additional information that can help the reader. The first word should be capitalized.")
@@ -221,7 +221,7 @@
(defcustom org-bibtex-prefix nil
"Optional prefix for all bibtex property names.
-For example setting to 'BIB_' would allow interoperability with fireforg."
+For example setting to `BIB_' would allow interoperability with fireforg."
:group 'org-bibtex
:version "24.1"
:type '(choice
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index 93a7f2a..67dc319 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -462,7 +462,7 @@ For example, if you have a capture template \"c\" and you want
this template to be accessible only from `message-mode' buffers,
use this:
- '((\"c\" ((in-mode . \"message-mode\"))))
+ \\='((\"c\" ((in-mode . \"message-mode\"))))
Here are the available contexts definitions:
@@ -480,7 +480,7 @@ accessible if there is at least one valid check.
You can also bind a key to another agenda custom command
depending on contextual rules.
- '((\"c\" \"d\" ((in-mode . \"message-mode\"))))
+ \\='((\"c\" \"d\" ((in-mode . \"message-mode\"))))
Here it means: in `message-mode buffers', use \"c\" as the
key for the capture template otherwise associated with \"d\".
@@ -1610,7 +1610,7 @@ The template may still contain \"%?\" for cursor positioning."
(delete-region start end)
(condition-case error
(insert-file-contents filename)
- (error (insert (format "%%![Couldn't insert %s: %s]"
+ (error (insert (format "%%![Couldn not insert %s: %s]"
filename error)))))))
;; The current time
diff --git a/lisp/org-clock.el b/lisp/org-clock.el
index 5533d4a..84d032c 100644
--- a/lisp/org-clock.el
+++ b/lisp/org-clock.el
@@ -94,9 +94,10 @@ Return value is either a string, an integer, or nil."
(defcustom org-clock-out-when-done t
"When non-nil, clock will be stopped when the clocked entry is marked DONE.
+\\<org-mode-map>\
DONE here means any DONE-like state.
A nil value means clock will keep running until stopped explicitly with
-`C-c C-x C-o', or until the clock is started in a different item.
+`\\[org-clock-out]', or until the clock is started in a different item.
Instead of t, this can also be a list of TODO states that should trigger
clocking out."
:group 'org-clock
@@ -400,8 +401,8 @@ nil current clock is not displayed"
(defcustom org-clock-frame-title-format '(t org-mode-line-string)
"The value for `frame-title-format' when clocking in.
-When `org-clock-clocked-in-display' is set to 'frame-title
-or 'both, clocking in will replace `frame-title-format' with
+When `org-clock-clocked-in-display' is set to `frame-title'
+or `both', clocking in will replace `frame-title-format' with
this value. Clocking out will restore `frame-title-format'.
`org-frame-title-string' is a format string using the same
@@ -778,8 +779,9 @@ Notification is shown only once."
(unless org-clock-notification-was-shown
(setq org-clock-notification-was-shown t)
(org-notify
- (format "Task '%s' should be finished by now. (%s)"
- org-clock-heading org-clock-effort) org-clock-sound))
+ (format-message "Task `%s' should be finished by now. (%s)"
+ org-clock-heading org-clock-effort)
+ org-clock-sound))
(setq org-clock-notification-was-shown nil)))))
(defun org-notify (notification &optional play-sound)
@@ -994,7 +996,7 @@ was started."
(org-clock-jump-to-current-clock clock))
(unless org-clock-resolve-expert
(with-output-to-temp-buffer "*Org Clock*"
- (princ "Select a Clock Resolution Command:
+ (princ (format-message "Select a Clock Resolution Command:
i/q Ignore this question; the same as keeping all the idle time.
@@ -1004,7 +1006,7 @@ k/K Keep X minutes of the idle time (default is all). If this
clocked back in at the present time.
g/G Indicate that you \"got back\" X minutes ago. This is quite
- different from 'k': it clocks you out from the beginning of
+ different from `k': it clocks you out from the beginning of
the idle period and clock you back in X minutes ago.
s/S Subtract the idle time from the current clock. This is the
@@ -1016,7 +1018,7 @@ C Cancel the open timer altogether. It will be as though you
j/J Jump to the current clock, to make manual adjustments.
For all these options, using uppercase makes your final state
-to be CLOCKED OUT.")))
+to be CLOCKED OUT."))))
(org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
(let (char-pressed)
(when (featurep 'xemacs)
@@ -1293,7 +1295,7 @@ make this the default behavior.)"
(looking-at
(concat "^[ \t]*" org-clock-string
" \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
- " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
+ " *\\sw+.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
(message "Matched %s" (match-string 1))
(setq ts (concat "[" (match-string 1) "]"))
(goto-char (match-end 1))
@@ -1678,7 +1680,7 @@ Optional argument N tells to change by that many units."
(defun org-clock-timestamps-change (updown &optional n)
"Change CLOCK timestamps synchronously at cursor.
-UPDOWN tells whether to change 'up or 'down.
+UPDOWN tells whether to change `up' or `down'.
Optional argument N tells to change by that many units."
(setq org-ts-what nil)
(when (org-at-timestamp-p t)
diff --git a/lisp/org-compat.el b/lisp/org-compat.el
index a762b8e..d4dcdff 100644
--- a/lisp/org-compat.el
+++ b/lisp/org-compat.el
@@ -404,6 +404,10 @@ Pass BUFFER to the XEmacs version of `move-to-column'."
(unless (fboundp 'user-error)
(defalias 'user-error 'error))
+;; ‘format-message’ is available only from 25 on
+(unless (fboundp 'format-message)
+ (defalias 'format-message 'format))
+
;; `font-lock-ensure' is only available from 24.4.50 on
(unless (fboundp 'font-lock-ensure)
(defalias 'font-lock-ensure 'font-lock-fontify-buffer))
diff --git a/lisp/org-crypt.el b/lisp/org-crypt.el
index f527673..85b392f 100644
--- a/lisp/org-crypt.el
+++ b/lisp/org-crypt.el
@@ -104,10 +104,10 @@ t : Disable auto-save-mode for the current buffer
nil : Leave auto-save-mode enabled.
This may cause data to be written to disk unencrypted!
-'ask : Ask user whether or not to disable auto-save-mode
+`ask' : Ask user whether or not to disable auto-save-mode
for the current buffer.
-'encrypt : Leave auto-save-mode enabled for the current buffer,
+`encrypt': Leave auto-save-mode enabled for the current buffer,
but automatically re-encrypt all decrypted entries
*before* auto-saving.
NOTE: This only works for entries which have a tag
diff --git a/lisp/org-ctags.el b/lisp/org-ctags.el
index a9baf04..e5435e3 100644
--- a/lisp/org-ctags.el
+++ b/lisp/org-ctags.el
@@ -394,7 +394,8 @@ the new file."
(org-open-file filename t))
((or (eql create t)
(and (eql create 'ask)
- (y-or-n-p (format "File `%s.org' not found; create?" name))))
+ (y-or-n-p (format-message
+ "File `%s.org' not found; create?" name))))
(org-ctags-open-file filename name))
(t ;; File does not exist, and we don't want to create it.
nil))))
@@ -433,8 +434,8 @@ the heading a destination for the tag `NAME'."
"This function is intended to be used in ORG-OPEN-LINK-FUNCTIONS.
Wrapper for org-ctags-append-topic, which first asks the user if they want
to append a new topic."
- (if (y-or-n-p (format "Topic `%s' not found; append to end of buffer?"
- name))
+ (if (y-or-n-p (format-message
+ "Topic `%s' not found; append to end of buffer?" name))
(org-ctags-append-topic name narrowp)
nil))
@@ -455,7 +456,7 @@ to rebuild (update) the TAGS file."
Wrapper for org-ctags-rebuild-tags-file-then-find-tag."
(if (and (buffer-file-name)
(y-or-n-p
- (format
+ (format-message
"Tag `%s' not found. Rebuild table `%s/TAGS' and look again?"
name
(file-name-directory (buffer-file-name)))))
diff --git a/lisp/org-docview.el b/lisp/org-docview.el
index 479f4ff..e3bf5fd 100644
--- a/lisp/org-docview.el
+++ b/lisp/org-docview.el
@@ -61,7 +61,7 @@
(setq path (org-link-escape (expand-file-name path)))
(cond
((eq format 'html) (format "<a href=\"%s\">%s</a>" path desc))
- ((eq format 'latex) (format "\href{%s}{%s}" path desc))
+ ((eq format 'latex) (format "\\href{%s}{%s}" path desc))
((eq format 'ascii) (format "%s (%s)" desc path))
(t path)))))
diff --git a/lisp/org-element.el b/lisp/org-element.el
index 3c882e5..329a439 100644
--- a/lisp/org-element.el
+++ b/lisp/org-element.el
@@ -4010,30 +4010,30 @@ Assuming TREE is a variable containing an Org buffer parse tree,
the following example will return a flat list of all `src-block'
and `example-block' elements in it:
- \(org-element-map tree '(example-block src-block) #'identity)
+ (org-element-map tree \\='(example-block src-block) #\\='identity)
The following snippet will find the first headline with a level
of 1 and a \"phone\" tag, and will return its beginning position:
- \(org-element-map tree 'headline
- \(lambda (hl)
- \(and (= (org-element-property :level hl) 1)
- \(member \"phone\" (org-element-property :tags hl))
- \(org-element-property :begin hl)))
+ (org-element-map tree \\='headline
+ (lambda (hl)
+ (and (= (org-element-property :level hl) 1)
+ (member \"phone\" (org-element-property :tags hl))
+ (org-element-property :begin hl)))
nil t)
The next example will return a flat list of all `plain-list' type
elements in TREE that are not a sub-list themselves:
- \(org-element-map tree 'plain-list #'identity nil nil 'plain-list)
+ (org-element-map tree \\='plain-list #\\='identity nil nil \\='plain-list)
Eventually, this example will return a flat list of all `bold'
type objects containing a `latex-snippet' type object, even
looking into captions:
- \(org-element-map tree 'bold
- \(lambda (b)
- \(and (org-element-map b 'latex-snippet #'identity nil t) b))
+ (org-element-map tree \\='bold
+ (lambda (b)
+ (and (org-element-map b \\='latex-snippet #\\='identity nil t) b))
nil nil nil t)"
;; Ensure TYPES and NO-RECURSION are a list, even of one element.
(let* ((types (if (listp types) types (list types)))
diff --git a/lisp/org-entities.el b/lisp/org-entities.el
index ccb9cd6..29eea4e 100644
--- a/lisp/org-entities.el
+++ b/lisp/org-entities.el
@@ -362,8 +362,8 @@ packages to be loaded, add these packages to `org-latex-packages-alist'."
("lessgtr" "\\lessgtr" t "&lessgtr;" "[less than or greater than]" "[less than or greater than]" "≶")
("lesseqgtr" "\\lesseqgtr" t "&lesseqgtr;" "[less than or equal or greater than or equal]" "[less than or equal or greater than or equal]" "â‹š")
("ll" "\\ll" t "&Lt;" "<<" "<<" "≪")
- ("Ll" "\lll" t "&Ll;" "<<<" "<<<" "⋘")
- ("lll" "\lll" t "&Ll;" "<<<" "<<<" "⋘")
+ ("Ll" "\\lll" t "&Ll;" "<<<" "<<<" "⋘")
+ ("lll" "\\lll" t "&Ll;" "<<<" "<<<" "⋘")
("gg" "\\gg" t "&Gt;" ">>" ">>" "≫")
("Gg" "\\ggg" t "&Gg;" ">>>" ">>>" "â‹™")
("ggg" "\\ggg" t "&Gg;" ">>>" ">>>" "â‹™")
diff --git a/lisp/org-faces.el b/lisp/org-faces.el
index 1eac660..0a1ce1d 100644
--- a/lisp/org-faces.el
+++ b/lisp/org-faces.el
@@ -669,7 +669,7 @@ which days belong to the weekend."
(0.0 . default))
"Faces for showing deadlines in the agenda.
This is a list of cons cells. The cdr of each cell is a face to be used,
-and it can also just be like '(:foreground \"yellow\").
+and it can also just be like \\='(:foreground \"yellow\").
Each car is a fraction of the head-warning time that must have passed for
this the face in the cdr to be used for display. The numbers must be
given in descending order. The head-warning time is normally taken
diff --git a/lisp/org-feed.el b/lisp/org-feed.el
index b63ac2a..e511be0 100644
--- a/lisp/org-feed.el
+++ b/lisp/org-feed.el
@@ -690,7 +690,8 @@ formatted as a string, not the original XML data."
(xml-node-children content)))))
(t
(setq entry (plist-put entry :description
- (format "Unknown '%s' content." type)))))))
+ (format-message
+ "Unknown `%s' content." type)))))))
entry))
(provide 'org-feed)
diff --git a/lisp/org-habit.el b/lisp/org-habit.el
index 338aabc..69d1912 100644
--- a/lisp/org-habit.el
+++ b/lisp/org-habit.el
@@ -181,7 +181,7 @@ This list represents a \"habit\" for the rest of this module."
(error "Habit %s has no scheduled date" habit-entry))
(unless scheduled-repeat
(error
- "Habit '%s' has no scheduled repeat period or has an incorrect one"
+ "Habit `%s' has no scheduled repeat period or has an incorrect one"
habit-entry))
(setq sr-days (org-habit-duration-to-days scheduled-repeat)
sr-type (progn (string-match "[\\.+]?\\+" scheduled-repeat)
diff --git a/lisp/org-id.el b/lisp/org-id.el
index 5c85d7a..f86ef22 100644
--- a/lisp/org-id.el
+++ b/lisp/org-id.el
@@ -87,6 +87,7 @@
'org-link-to-org-use-id 'org-id-link-to-org-use-id "24.3")
(defcustom org-id-link-to-org-use-id nil
"Non-nil means storing a link to an Org file will use entry IDs.
+\\<org-mode-map>\
The variable can have the following values:
@@ -101,7 +102,7 @@ create-if-interactive
call `org-capture' that automatically and preemptively creates a
link. If you do want to get an ID link in a capture template to
an entry not having an ID, create it first by explicitly creating
- a link to it, using `C-c C-l' first.
+ a link to it, using `\\[org-insert-link]' first.
create-if-interactive-and-no-custom-id
Like create-if-interactive, but do not create an ID if there is
diff --git a/lisp/org-irc.el b/lisp/org-irc.el
index 62f3d95..1ec69d8 100644
--- a/lisp/org-irc.el
+++ b/lisp/org-irc.el
@@ -108,7 +108,7 @@ attributes that are found."
(defun org-irc-ellipsify-description (string &optional after)
"Remove unnecessary white space from STRING and add ellipses if necessary.
Strip starting and ending white space from STRING and replace any
-chars that the value AFTER with '...'"
+chars that the value AFTER with `...'"
(let* ((after (number-to-string (or after 30)))
(replace-map (list (cons "^[ \t]*" "")
(cons "[ \t]*$" "")
@@ -172,7 +172,7 @@ the session itself."
(org-store-link-props
:type "irc"
:link (concat "irc:/" link-text)
- :description (concat "irc session '" link-text "'")
+ :description (concat "irc session `" link-text "'")
:server (car (car link))
:port (or (string-to-number (cadr (pop link))) erc-default-port)
:nick (pop link))
diff --git a/lisp/org-list.el b/lisp/org-list.el
index d865a78..568afd9 100644
--- a/lisp/org-list.el
+++ b/lisp/org-list.el
@@ -176,7 +176,7 @@ to the bullet that should be used when this item is demoted.
For example,
(setq org-list-demote-modify-bullet
- '((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\")))
+ \\='((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\")))
will make
@@ -612,11 +612,11 @@ point-at-bol:
will get the following structure:
-\(\(1 0 \"- \" nil \"[X]\" nil 97\)
- \(18 2 \"1. \" nil nil nil 34\)
- \(34 2 \"5. \" \"5\" nil nil 55\)
- \(97 0 \"- \" nil nil nil 131\)
- \(109 2 \"+ \" nil nil \"tag\" 131\)
+ ((1 0 \"- \" nil \"[X]\" nil 97)
+ (18 2 \"1. \" nil nil nil 34)
+ (34 2 \"5. \" \"5\" nil nil 55)
+ (97 0 \"- \" nil nil nil 131)
+ (109 2 \"+ \" nil nil \"tag\" 131))
Assume point is at an item."
(save-excursion
@@ -2026,7 +2026,7 @@ previous item, plus ARGS extra arguments.
FUNCTION is applied on items in reverse order.
-As an example, \(org-apply-on-list \(lambda \(result\) \(1+ result\)\) 0\)
+As an example, \(org-apply-on-list \(lambda \(result) \(1+ result)) 0)
will return the number of items in the current list.
Sublists of the list are skipped. Cursor is always at the
@@ -2942,13 +2942,13 @@ For example, the following list:
will be parsed as:
-\(ordered
- \(nil \"first item\"
- \(unordered
- \(nil \"sub-item one\"\)
- \(nil \"[CBON] sub-item two\"\)\)
- \"more text in first item\"\)
- \(3 \"last item\"\)\)
+ (ordered
+ (nil \"first item\"
+ (unordered
+ (nil \"sub-item one\")
+ (nil \"[CBON] sub-item two\"))
+ \"more text in first item\")
+ (3 \"last item\"))
Point is left at list end."
(defvar parse-item) ;FIXME: Or use `cl-labels' or `letrec'.
diff --git a/lisp/org-macs.el b/lisp/org-macs.el
index 821cfda..d6dcca8 100644
--- a/lisp/org-macs.el
+++ b/lisp/org-macs.el
@@ -138,7 +138,7 @@ Otherwise return nil."
;; FIXME: Slated for removal. Current Org mode does not support Emacs < 22
(defmacro org-maybe-intangible (props)
- "Add '(intangible t) to PROPS if Emacs version is earlier than Emacs 22.
+ "Add \\='(intangible t) to PROPS if Emacs version is earlier than Emacs 22.
In Emacs 21, invisible text is not avoided by the command loop, so the
intangible property is needed to make sure point skips this text.
In Emacs 22, this is not necessary. The intangible text property has
diff --git a/lisp/org-mouse.el b/lisp/org-mouse.el
index 3fe35bd..c2fa46a 100644
--- a/lisp/org-mouse.el
+++ b/lisp/org-mouse.el
@@ -377,7 +377,7 @@ nor a function, elements of KEYWORDS are used directly."
(defvar org-mouse-priority-regexp "\\[#\\([A-Z]\\)\\]"
"Regular expression matching the priority indicator.
Differs from `org-priority-regexp' in that it doesn't contain the
-leading '.*?'.")
+leading `.*?'.")
(defun org-mouse-get-priority (&optional default)
"Return the priority of the current headline.
@@ -538,7 +538,7 @@ SCHEDULED: or DEADLINE: or ANYTHINGLIKETHIS:"
((stringp (nth 2 entry))
(concat (org-mouse-agenda-type (nth 1 entry))
(nth 2 entry)))
- (t "Agenda Command '%s'"))
+ (t "Agenda Command `%s'"))
30))))
"--"
["Delete Blank Lines" delete-blank-lines
@@ -565,7 +565,7 @@ SCHEDULED: or DEADLINE: or ANYTHINGLIKETHIS:"
(save-excursion (org-apply-on-list wrap-fun nil)))))
(defun org-mouse-bolp ()
- "Return true if there only spaces, tabs, and '*' before point.
+ "Return true if there only spaces, tabs, and `*' before point.
This means, between the beginning of line and the point."
(save-excursion
(skip-chars-backward " \t*") (bolp)))
@@ -707,9 +707,9 @@ This means, between the beginning of line and the point."
((org-mouse-looking-at ":\\([A-Za-z0-9_]+\\):" "A-Za-z0-9_" -1) ;tags
(popup-menu
`(nil
- [,(format "Display '%s'" (match-string 1))
+ [,(format-message "Display `%s'" (match-string 1))
(org-tags-view nil ,(match-string 1))]
- [,(format "Sparse Tree '%s'" (match-string 1))
+ [,(format-message "Sparse Tree `%s'" (match-string 1))
(org-tags-sparse-tree nil ,(match-string 1))]
"--"
,@(org-mouse-tag-menu))))
diff --git a/lisp/org-plot.el b/lisp/org-plot.el
index a089f34..90a7f36 100644
--- a/lisp/org-plot.el
+++ b/lisp/org-plot.el
@@ -94,7 +94,7 @@ Return value is the point at the beginning of the table."
(goto-char (org-table-begin)))
(defun org-plot/collect-options (&optional params)
- "Collect options from an org-plot '#+Plot:' line.
+ "Collect options from an org-plot `#+Plot:' line.
Accepts an optional property list PARAMS, to which the options
will be added. Returns the resulting property list."
(interactive)
diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el
index d0750f7..339f2b7 100644
--- a/lisp/org-protocol.el
+++ b/lisp/org-protocol.el
@@ -197,7 +197,7 @@ Possible properties are:
Example:
(setq org-protocol-project-alist
- '((\"http://orgmode.org/worg/\"
+ \\='((\"http://orgmode.org/worg/\"
:online-suffix \".php\"
:working-suffix \".org\"
:base-url \"http://orgmode.org/worg/\"
@@ -251,7 +251,7 @@ kill-client - If t, kill the client immediately, once the sub-protocol is
Here is an example:
(setq org-protocol-protocol-alist
- '((\"my-protocol\"
+ \\='((\"my-protocol\"
:protocol \"my-protocol\"
:function my-protocol-handler-function)
(\"your-protocol\"
@@ -303,7 +303,7 @@ part."
(defun org-protocol-flatten-greedy (param-list &optional strip-path replacement)
"Greedy handlers might receive a list like this from emacsclient:
- '((\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\")
+ ((\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\"))
where \"/dir/\" is the absolute path to emacsclients working directory. This
function transforms it into a flat list using `org-protocol-flatten' and
transforms the elements of that list as follows:
@@ -347,7 +347,7 @@ returned list."
(defun org-protocol-flatten (l)
"Greedy handlers might receive a list like this from emacsclient:
- '( (\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\")
+ ((\"/dir/org-protocol:/greedy:/~/path1\" (23 . 12)) (\"/dir/param\"))
where \"/dir/\" is the absolute path to emacsclients working directory.
This function transforms it into a flat list."
(if (null l) ()
@@ -365,9 +365,9 @@ link's URL to the `kill-ring'.
The location for a browser's bookmark has to look like this:
- javascript:location.href='org-protocol://store-link://'+ \\
+ javascript:location.href=\\='org-protocol://store-link://\\='+ \\
encodeURIComponent(location.href)
- encodeURIComponent(document.title)+'/'+ \\
+ encodeURIComponent(document.title)+\\='/\\='+ \\
Don't use `escape()'! Use `encodeURIComponent()' instead. The title of the page
could contain slashes and the location definitely will.
@@ -394,18 +394,18 @@ The sub-protocol used to reach this function is set in
`org-protocol-protocol-alist'.
This function detects an URL, title and optional text, separated
-by '/'. The location for a browser's bookmark looks like this:
+by `/'. The location for a browser's bookmark looks like this:
- javascript:location.href='org-protocol://capture://'+ \\
- encodeURIComponent(location.href)+'/' \\
- encodeURIComponent(document.title)+'/'+ \\
+ javascript:location.href=\\='org-protocol://capture://\\='+ \\
+ encodeURIComponent(location.href)+\\='/\\=' \\
+ encodeURIComponent(document.title)+\\='/\\='+ \\
encodeURIComponent(window.getSelection())
By default, it uses the character `org-protocol-default-template-key',
which should be associated with a template in `org-capture-templates'.
But you may prepend the encoded URL with a character and a slash like so:
- javascript:location.href='org-protocol://capture://b/'+ ...
+ javascript:location.href=\\='org-protocol://capture://b/\\='+ ...
Now template ?b will be used."
(if (and (boundp 'org-stored-links)
@@ -455,7 +455,7 @@ in `org-protocol-project-alist'.
The location for a browser's bookmark should look like this:
- javascript:location.href='org-protocol://open-source://'+ \\
+ javascript:location.href=\\='org-protocol://open-source://\\='+ \\
encodeURIComponent(location.href)"
;; As we enter this function for a match on our protocol, the return value
;; defaults to nil.
diff --git a/lisp/org-src.el b/lisp/org-src.el
index 163d726..9c205e1 100644
--- a/lisp/org-src.el
+++ b/lisp/org-src.el
@@ -657,9 +657,9 @@ This command is not bound to a key by default, to avoid conflicts
with language major mode bindings. To bind it to C-c @ in all
language major modes, you could use
- (add-hook 'org-src-mode-hook
+ (add-hook \\='org-src-mode-hook
(lambda () (define-key org-src-mode-map \"\\C-c@\"
- 'org-src-do-key-sequence-at-code-block)))
+ \\='org-src-do-key-sequence-at-code-block)))
In that case, for example, C-c @ t issued in code edit buffers
would tangle the current Org code block, C-c @ e would execute
diff --git a/lisp/org-table.el b/lisp/org-table.el
index 74aebb4..0e42d27 100644
--- a/lisp/org-table.el
+++ b/lisp/org-table.el
@@ -284,9 +284,9 @@ relies on the variables to be present in the list."
(defcustom org-table-duration-custom-format 'hours
"Format for the output of calc computations like $1+$2;t.
-The default value is 'hours, and will output the results as a
-number of hours. Other allowed values are 'seconds, 'minutes and
-'days, and the output will be a fraction of seconds, minutes or
+The default value is `hours', and will output the results as a
+number of hours. Other allowed values are `seconds', `minutes' and
+`days', and the output will be a fraction of seconds, minutes or
days."
:group 'org-table-calculation
:version "24.1"
@@ -329,7 +329,7 @@ The car of each element is a name of a constant, without the `$' before it.
The cdr is the value as a string. For example, if you'd like to use the
speed of light in a formula, you would configure
- (setq org-table-formula-constants '((\"c\" . \"299792458.\")))
+ (setq org-table-formula-constants \\='((\"c\" . \"299792458.\")))
and then use it in an equation like `$1*$c'.
@@ -343,7 +343,9 @@ Constants can also be defined on a per-file basis using a line like
(defcustom org-table-allow-automatic-line-recalculation t
"Non-nil means lines marked with |#| or |*| will be recomputed automatically.
-Automatically means when TAB or RET or C-c C-c are pressed in the line."
+\\<org-mode-map>\
+Automatically means when TAB or RET or \\[org-ctrl-c-ctrl-c] \
+are pressed in the line."
:group 'org-table-calculation
:type 'boolean)
@@ -561,9 +563,9 @@ slightly, to make sure a beginning of line in the first line is included.
SEPARATOR specifies the field separator in the lines. It can have the
following values:
-'(4) Use the comma as a field separator
-'(16) Use a TAB as field separator
-'(64) Prompt for a regular expression as field separator
+(4) Use the comma as a field separator
+(16) Use a TAB as field separator
+(64) Prompt for a regular expression as field separator
integer When a number, use that many spaces as field separator
regexp When a regular expression, use it to match the separator
nil When nil, the command tries to be smart and figure out the
@@ -3035,7 +3037,7 @@ search, as a string."
KEEP-EMPTY indicated to keep empty fields, default is to skip them.
NUMBERS indicates that everything should be converted to numbers.
LISPP non-nil means to return something appropriate for a Lisp
-list, 'literal is for the format specifier L."
+list, `literal' is for the format specifier L."
;; Calc nan (not a number) is used for the conversion of the empty
;; field to a reference for several reasons: (i) It is accepted in a
;; Calc formula (e. g. "" or "()" would result in a Calc error).
@@ -3390,7 +3392,7 @@ formulas that use a range of rows or columns, it may often be better
to anchor the formula with \"I\" row markers, or to offset from the
borders of the table using the @< @> $< $> makers."
(let (n nmax len char (start 0))
- (while (string-match "\\([@$]\\)\\(<+\\|>+\\)\\|\\(remote([^\)]+)\\)"
+ (while (string-match "\\([@$]\\)\\(<+\\|>+\\)\\|\\(remote([^)]+)\\)"
s start)
(if (match-end 3)
(setq start (match-end 3))
@@ -3555,8 +3557,10 @@ Parameters get priority."
(when (eq org-table-use-standard-references t)
(org-table-fedit-toggle-ref-type))
(org-goto-line startline)
- (message "Edit formulas, finish with `C-c C-c' or `C-c ' '. \
-See menu for more commands.")))
+ (message
+ (substitute-command-keys "\\<org-mode-map>\
+Edit formulas, finish with `\\[org-ctrl-c-ctrl-c]' or `\\[org-edit-special]'. \
+See menu for more commands."))))
(defun org-table-fedit-post-command ()
(when (not (memq this-command '(lisp-complete-symbol)))
diff --git a/lisp/org.el b/lisp/org.el
index ce80129..e49a667 100755
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -681,7 +681,7 @@ core modules, nor modules from the CONTRIB directory). Just add symbols
to the end of the list. If the package is called org-xyz.el, then you need
to add the symbol `xyz', and the package must have a call to:
- \(provide 'org-xyz)
+ (provide \\='org-xyz)
For export specific modules, see also `org-export-backends'."
:group 'org
@@ -765,26 +765,26 @@ need to make a change while Emacs is running, use the customize
interface or run the following code, where VAL stands for the new
value of the variable, after updating it:
- \(progn
- \(setq org-export-registered-backends
- \(org-remove-if-not
- \(lambda (backend)
- \(let ((name (org-export-backend-name backend)))
- \(or (memq name val)
- \(catch 'parentp
- \(dolist (b val)
- \(and (org-export-derived-backend-p b name)
- \(throw 'parentp t)))))))
+ (progn
+ (setq org-export-registered-backends
+ (org-remove-if-not
+ (lambda (backend)
+ (let ((name (org-export-backend-name backend)))
+ (or (memq name val)
+ (catch \\='parentp
+ (dolist (b val)
+ (and (org-export-derived-backend-p b name)
+ (throw \\='parentp t)))))))
org-export-registered-backends))
- \(let ((new-list (mapcar #'org-export-backend-name
+ (let ((new-list (mapcar #\\='org-export-backend-name
org-export-registered-backends)))
- \(dolist (backend val)
- \(cond
- \((not (load (format \"ox-%s\" backend) t t))
- \(message \"Problems while trying to load export back-end `%s'\"
+ (dolist (backend val)
+ (cond
+ ((not (load (format \"ox-%s\" backend) t t))
+ (message \"Problems while trying to load export back-end \\=`%s\\='\"
backend))
- \((not (memq backend new-list)) (push backend new-list))))
- \(set-default 'org-export-backends new-list)))
+ ((not (memq backend new-list)) (push backend new-list))))
+ (set-default \\='org-export-backends new-list)))
Adding a back-end to this list will also pull the back-end it
depends on, if any."
@@ -850,6 +850,7 @@ depends on, if any."
(defcustom org-support-shift-select nil
"Non-nil means make shift-cursor commands select text when possible.
+\\<org-mode-map>\
In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
start selecting a region, or enlarge regions started in this way.
@@ -876,10 +877,13 @@ if the cursor is exactly on the bullet.
If you set this variable to the symbol `always', then the keys
will not be special in headlines, property lines, and item lines,
to make shift selection work there as well. If this is what you
-want, you can use the following alternative commands: `C-c C-t'
-and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
-can be used to switch TODO sets, `C-c -' to cycle item bullet
-types, and properties can be edited by hand or in column view.
+want, you can use the following alternative commands:
+`\\[org-todo]' and `\\[org-priority]' \
+to change TODO state and priority,
+`\\[universal-argument] \\[universal-argument] \\[org-todo]' \
+can be used to switch TODO sets,
+`\\[org-ctrl-c-minus]' to cycle item bullet types,
+and properties can be edited by hand or in column view.
However, when the cursor is on a timestamp, shift-cursor commands
will still edit the time stamp - this is just too good to give up.
@@ -1674,10 +1678,12 @@ changed by an edit command."
(defcustom org-remove-highlights-with-change t
"Non-nil means any change to the buffer will remove temporary highlights.
+\\<org-mode-map>\
Such highlights are created by `org-occur' and `org-clock-display'.
-When nil, `C-c C-c' needs to be used to get rid of the highlights.
+When nil, `\\[org-ctrl-c-ctrl-c]' needs to be used \
+to get rid of the highlights.
The highlights created by `org-toggle-latex-fragment' always need
-`C-c C-x C-l' to be removed."
+`\\[org-toggle-latex-fragment]' to be removed."
:group 'org-sparse-trees
:group 'org-time
:type 'boolean)
@@ -1771,8 +1777,8 @@ links in Org-mode buffers can have an optional tag after a double colon, e.g.
[[linkkey:tag][description]]
-The 'linkkey' must be a word word, starting with a letter, followed
-by letters, numbers, '-' or '_'.
+The `linkkey' must be a word word, starting with a letter, followed
+by letters, numbers, `-' or `_'.
If REPLACE is a string, the tag will simply be appended to create the link.
If the string contains \"%s\", the tag will be inserted there. If the string
@@ -2201,7 +2207,7 @@ file identifier are
filename matches the regexp. If you want to
use groups here, use shy groups.
- Example: (\"\\.x?html\\'\" . \"firefox %s\")
+ Example: (\"\\.x?html\\\\='\" . \"firefox %s\")
(\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
to open *.html and *.xhtml with firefox.
@@ -2217,7 +2223,7 @@ file identifier are
In a custom lisp form, you can access the group matches with
(match-string n link).
- Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
+ Example: (\"\\.pdf::\\(\\d+\\)\\\\='\" . \"evince -p %1 %s\")
to open [[file:document.pdf::5]] with evince at page 5.
`directory' Matches a directory
@@ -2432,12 +2438,15 @@ of the subtree."
(defcustom org-refile-use-cache nil
"Non-nil means cache refile targets to speed up the process.
+\\<org-mode-map>\
The cache for a particular file will be updated automatically when
the buffer has been killed, or when any of the marker used for flagging
refile targets no longer points at a live buffer.
If you have added new entries to a buffer that might themselves be targets,
-you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
-find that easier, `C-u C-u C-u C-c C-w'."
+you need to clear the cache manually by pressing `C-0 \\[org-refile]' or,
+if you find that easier, \
+`\\[universal-argument] \\[universal-argument] \\[universal-argument] \
+\\[org-refile]'."
:group 'org-refile
:version "24.1"
:type 'boolean)
@@ -2620,7 +2629,8 @@ more information."
(const type)))
(defcustom org-use-fast-todo-selection t
- "Non-nil means use the fast todo selection scheme with C-c C-t.
+ "\\<org-mode-map>\
+Non-nil means use the fast todo selection scheme with \\[org-todo].
This variable describes if and under what circumstances the cycling
mechanism for TODO keywords will be replaced by a single-key, direct
selection scheme.
@@ -2628,8 +2638,9 @@ selection scheme.
When nil, fast selection is never used.
When the symbol `prefix', it will be used when `org-todo' is called
-with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
-`C-u t' in an agenda buffer.
+with a prefix argument, i.e. `\\[universal-argument] \\[org-todo]' \
+in an Org-mode buffer, and
+`\\[universal-argument] t' in an agenda buffer.
When t, fast selection is used by default. In this case, the prefix
argument forces cycling instead.
@@ -2709,7 +2720,7 @@ TODO state changes
------------------
:type todo-state-change
:from previous state (keyword as a string), or nil, or a symbol
- 'todo' or 'done', to indicate the general type of state.
+ `todo' or `done', to indicate the general type of state.
:to new state, like in :from")
(defcustom org-enforce-todo-dependencies nil
@@ -3095,6 +3106,7 @@ as an argument and return the numeric priority."
(defcustom org-time-stamp-rounding-minutes '(0 5)
"Number of minutes to round time stamps to.
+\\<org-mode-map>\
These are two values, the first applies when first creating a time stamp.
The second applies when changing it with the commands `S-up' and `S-down'.
When changing the time stamp, this means that it will change in steps
@@ -3104,7 +3116,8 @@ When a setting is 0 or 1, insert the time unmodified. Useful rounding
numbers should be factors of 60, so for example 5, 10, 15.
When this is larger than 1, you can still force an exact time stamp by using
-a double prefix argument to a time stamp command like `C-c .' or `C-c !',
+a double prefix argument to a time stamp command like \
+`\\[org-time-stamp]' or `\\[org-time-stamp-inactive],
and by using a prefix arg to `S-up/down' to specify the exact number
of minutes to shift."
:group 'org-time
@@ -3175,7 +3188,7 @@ its value is 0.
For example,
- \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
+ (:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
:require-minutes t)
means durations longer than a day will be expressed in days,
@@ -3185,7 +3198,7 @@ hour).
The value
- \(:days \"%dd\" :minutes \"%dm\")
+ (:days \"%dd\" :minutes \"%dm\")
means durations longer than a day will be expressed in days and
minutes, and durations less than a day will be expressed entirely
@@ -3515,10 +3528,10 @@ Instead of customizing this variable directly, you might want to
set it locally for capture buffers, because there no list of
tags in that file can be created dynamically (there are none).
- (add-hook 'org-capture-mode-hook
+ (add-hook \\='org-capture-mode-hook
(lambda ()
(set (make-local-variable
- 'org-complete-tags-always-offer-all-agenda-tags)
+ \\='org-complete-tags-always-offer-all-agenda-tags)
t)))"
:group 'org-tags
:version "24.1"
@@ -3851,7 +3864,8 @@ regular expression will be included."
(defcustom org-agenda-text-search-extra-files nil
"List of extra files to be searched by text search commands.
These files will be searched in addition to the agenda files by the
-commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
+commands `org-search-view' (`\\[org-agenda] s') \
+and `org-occur-in-agenda-files'.
Note that these files will only be searched for text search commands,
not for the other agenda views like todo lists, tag searches or the weekly
agenda. This variable is intended to list notes and possibly archive files
@@ -4109,7 +4123,7 @@ a string.
A cell is of the format
- \(\"options\" \"package\" SNIPPET-FLAG)
+ (\"options\" \"package\" SNIPPET-FLAG)
If SNIPPET-FLAG is non-nil, the package also needs to be included
when compiling LaTeX snippets into images for inclusion into
@@ -4138,7 +4152,7 @@ Each element is either a cell or a string.
A cell is of the format:
- \(\"options\" \"package\" SNIPPET-FLAG)
+ (\"options\" \"package\" SNIPPET-FLAG)
SNIPPET-FLAG, when non-nil, indicates that this package is also
needed when turning LaTeX snippets into images for inclusion into
@@ -4195,7 +4209,7 @@ lines to the buffer:
(defcustom org-hidden-keywords nil
"List of symbols corresponding to keywords to be hidden the org buffer.
-For example, a value '(title) for this list will make the document's title
+For example, a value \\='(title) for this list will make the document's title
appear in the buffer without the initial #+TITLE: keyword."
:group 'org-appearance
:version "24.1"
@@ -6652,11 +6666,12 @@ in special contexts.
1. OVERVIEW: Show only top-level headlines.
2. CONTENTS: Show all headlines of all levels, but no body text.
3. SHOW ALL: Show everything.
- When called with two `C-u C-u' prefixes, switch to the startup visibility,
+ With a double \\[universal-argument] prefix argument, \
+switch to the startup visibility,
determined by the variable `org-startup-folded', and by any VISIBILITY
properties in the buffer.
- When called with three `C-u C-u C-u' prefixed, show the entire buffer,
- including any drawers.
+ With a triple \\[universal-argument] prefix argument, \
+show the entire buffer, including any drawers.
- When inside a table, re-align the table and move to the next field.
@@ -6685,7 +6700,7 @@ in special contexts.
- Special case: if point is at the beginning of the buffer and there is
no headline in line 1, this function will act as if called with prefix arg
- (C-u TAB, same as S-TAB) also when called without prefix arg.
+ (\\[universal-argument] TAB, same as S-TAB) also when called without prefix arg.
But only if also the variable `org-cycle-global-at-bob' is t."
(interactive "P")
(org-load-modules-maybe)
@@ -6736,7 +6751,8 @@ in special contexts.
;; Table: enter it or move to the next field.
((org-at-table-p 'any)
(if (org-at-table.el-p)
- (message "Use C-c ' to edit table.el tables")
+ (message "%s" (substitute-command-keys "\\<org-mode-map>\
+Use \\[org-edit-special] to edit table.el tables"))
(if arg (org-table-edit-field t)
(org-table-justify-field-maybe)
(call-interactively 'org-table-next-field))))
@@ -11452,7 +11468,7 @@ org-open-file.
It assumes that is the case when the entry uses a regular
expression which has at least one grouping construct and the
action is either a lisp form or a command string containing
-'%1', i.e. using at least one subexpression match as a
+`%1', i.e. using at least one subexpression match as a
parameter."
(let ((selector (car entry))
(action (cdr entry)))
@@ -11654,7 +11670,7 @@ on the system \"/user@host:\"."
(setq level (org-reduced-level
(- (match-end 1) (match-beginning 1)))
txt (org-link-display-format (match-string 4))
- txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
+ txt (replace-regexp-in-string "\\( *[[0-9]+/?[0-9]*%?]\\)+$" "" txt)
re (format org-complex-heading-regexp-format
(regexp-quote (match-string 4))))
(when org-refile-use-outline-path
@@ -12487,11 +12503,11 @@ With a numeric prefix arg of 0, inhibit note taking for the change.
With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
When called through ELisp, arg is also interpreted in the following way:
-'none -> empty state
+`none' -> empty state
\"\"(empty string) -> switch to empty state
-'done -> switch to DONE
-'nextset -> switch to the next set of keywords
-'previousset -> switch to the previous set of keywords
+`done' -> switch to DONE
+`nextset' -> switch to the next set of keywords
+`previousset' -> switch to the previous set of keywords
\"WAITING\" -> switch to the specified keyword, but only if it
really is a member of `org-todo-keywords'."
(interactive "P")
@@ -14439,7 +14455,7 @@ must be bound around the form's evaluation: todo, the TODO keyword
at the entry (or nil of none); and tags-list, the list of all tags
at the entry including inherited ones. Additionally, the category
of the entry (if any) must be specified as the text property
-'org-category on the headline.
+`org-category' on the headline.
See also `org-scan-tags'.
"
@@ -16855,7 +16871,7 @@ While prompting, a calendar is popped up - you can also select the
date with the mouse (button 1). The calendar shows a period of three
months. To scroll it to other months, use the keys `>' and `<'.
If you don't like the calendar, turn it off with
- \(setq org-read-date-popup-calendar nil)
+ (setq org-read-date-popup-calendar nil)
With optional argument TO-TIME, the date will immediately be converted
to an internal time.
@@ -17623,7 +17639,7 @@ days in order to avoid rounding problems."
(error (error "Bad timestamp `%s'%s\nError was: %s"
s (if (not (and buffer pos))
""
- (format " at %d in buffer `%s'" pos buffer))
+ (format-message " at %d in buffer `%s'" pos buffer))
(cdr errdata)))))
(defun org-time-string-to-seconds (s)
@@ -17652,7 +17668,7 @@ The variable `date' is bound by the calendar when this is called."
(error (error "Bad timestamp `%s'%s\nError was: %s"
s (if (not (and buffer pos))
""
- (format " at %d in buffer `%s'" pos buffer))
+ (format-message " at %d in buffer `%s'" pos buffer))
(cdr errdata))))))))
(defun org-days-to-iso-week (days)
@@ -18451,7 +18467,7 @@ If EXCLUDE-TMP is non-nil, ignore temporary buffers."
((eq predicate 'files)
(lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
((eq predicate 'export)
- (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
+ (lambda (b) (string-match "\\*Org .*Export" (buffer-name b))))
((eq predicate 'agenda)
(lambda (b)
(with-current-buffer b
@@ -18460,7 +18476,7 @@ If EXCLUDE-TMP is non-nil, ignore temporary buffers."
(member (file-truename bfn) agenda-files)))))
(t (lambda (b) (with-current-buffer b
(or (derived-mode-p 'org-mode)
- (string-match "\*Org .*Export"
+ (string-match "\\*Org .*Export"
(buffer-name b)))))))))
(delq nil
(mapcar
@@ -21196,7 +21212,8 @@ This command does many different things, depending on context:
;; a `table.el' type, just give up. At a table row or
;; cell, maybe recalculate line but always align table.
(if (eq (org-element-property :type context) 'table.el)
- (message "Use C-c ' to edit table.el tables")
+ (message "%s" (substitute-command-keys "\\<org-mode-map>\
+Use \\[org-edit-special] to edit table.el tables"))
(let ((org-enable-table-editor t))
(if (or (eq type 'table)
;; Check if point is at a TBLFM line.
@@ -22627,8 +22644,8 @@ for the search purpose."
For example, in this alist:
-\(org-uniquify-alist '((a 1) (b 2) (a 3)))
- => '((a 1 3) (b 2))
+\(org-uniquify-alist \\='((a 1) (b 2) (a 3)))
+ => \\='((a 1 3) (b 2))
merge (a 1) and (a 3) into (a 1 3).
diff --git a/lisp/ox-html.el b/lisp/ox-html.el
index 629c1cc..960bee8 100644
--- a/lisp/ox-html.el
+++ b/lisp/ox-html.el
@@ -873,7 +873,7 @@ you can reuse them:
For example:
\(setq org-html-table-row-tags
- (cons '(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
+ (cons \\='(cond (top-row-p \"<tr class=\\\"tr-top\\\">\")
(bottom-row-p \"<tr class=\\\"tr-bottom\\\">\")
(t (if (= (mod row-number 2) 1)
\"<tr class=\\\"tr-odd\\\">\"
@@ -997,7 +997,7 @@ org-info.js for your website."
(content "div" "content")
(postamble "div" "postamble"))
"Alist of the three section elements for HTML export.
-The car of each entry is one of 'preamble, 'content or 'postamble.
+The car of each entry is one of `preamble', `content' or `postamble'.
The cdrs of each entry are the ELEMENT_TYPE and ID for each
section of the exported document.
@@ -1176,7 +1176,7 @@ MathJax CDN Terms of Service.
(defcustom org-html-postamble 'auto
"Non-nil means insert a postamble in HTML export.
-When set to 'auto, check against the
+When set to `auto', check against the
`org-export-with-author/email/creator/date' variables to set the
content of the postamble. When set to a string, use this string
as the postamble. When t, insert a string as defined by the
@@ -1811,7 +1811,7 @@ used in the preamble or postamble."
(defun org-html--build-pre/postamble (type info)
"Return document preamble or postamble as a string, or nil.
-TYPE is either 'preamble or 'postamble, INFO is a plist used as a
+TYPE is either `preamble' or `postamble', INFO is a plist used as a
communication channel."
(let ((section (plist-get info (intern (format ":html-%s" type))))
(spec (org-html-format-spec info)))
@@ -2781,7 +2781,7 @@ Bind `org-html-standalone-image-predicate' to constrain paragraph
further. For example, to check for only captioned standalone
images, set it to:
- \(lambda (paragraph) (org-element-property :caption paragraph))"
+ (lambda (paragraph) (org-element-property :caption paragraph))"
(let ((paragraph (case (org-element-type element)
(paragraph element)
(link (org-export-get-parent element)))))
diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el
index ae16151..aefddf8 100644
--- a/lisp/ox-icalendar.el
+++ b/lisp/ox-icalendar.el
@@ -450,7 +450,7 @@ or subject for the event."
;; characters with literal \n.
(replace-regexp-in-string
"[ \t]*\n" "\\n"
- (replace-regexp-in-string "[\\,;]" "\\\&" s)
+ (replace-regexp-in-string "[\\,;]" "\\\\\\&" s)
nil t)))
(defun org-icalendar-fold-string (s)
diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el
index ddbbd33..1840a54 100644
--- a/lisp/ox-latex.el
+++ b/lisp/ox-latex.el
@@ -426,9 +426,9 @@ references."
If #+LATEX_CLASS is set in the buffer, use its value and the
associated information. Here is the structure of each cell:
- \(class-name
+ (class-name
header-string
- \(numbered-section . unnumbered-section)
+ (numbered-section . unnumbered-section)
...)
The header string
@@ -499,11 +499,11 @@ section string and will be replaced by the title of the section.
Instead of a cons cell (numbered . unnumbered), you can also
provide a list of 2 or 4 elements,
- \(numbered-open numbered-close)
+ (numbered-open numbered-close)
or
- \(numbered-open numbered-close unnumbered-open unnumbered-close)
+ (numbered-open numbered-close unnumbered-open unnumbered-close)
providing opening and closing strings for a LaTeX environment
that should represent the document section. The opening clause
@@ -879,21 +879,21 @@ listings package, and if you want to have color, the color
package. Just add these to `org-latex-packages-alist', for
example using customize, or with something like:
- \(require 'ox-latex)
- \(add-to-list 'org-latex-packages-alist '(\"\" \"listings\"))
- \(add-to-list 'org-latex-packages-alist '(\"\" \"color\"))
+ (require \\='ox-latex)
+ (add-to-list \\='org-latex-packages-alist \\='(\"\" \"listings\"))
+ (add-to-list \\='org-latex-packages-alist \\='(\"\" \"color\"))
Alternatively,
- \(setq org-latex-listings 'minted)
+ (setq org-latex-listings \\='minted)
causes source code to be exported using the minted package as
opposed to listings. If you want to use minted, you need to add
the minted package to `org-latex-packages-alist', for example
using customize, or with
- \(require 'ox-latex)
- \(add-to-list 'org-latex-packages-alist '(\"newfloat\" \"minted\"))
+ (require \\='ox-latex)
+ (add-to-list \\='org-latex-packages-alist \\='(\"newfloat\" \"minted\"))
In addition, it is necessary to install pygments
\(http://pygments.org), and to configure the variable
@@ -946,9 +946,9 @@ These options are supplied as a comma-separated list to the
a list containing two strings: the name of the option, and the
value. For example,
- \(setq org-latex-listings-options
- '((\"basicstyle\" \"\\\\small\")
- \(\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
+ (setq org-latex-listings-options
+ \\='((\"basicstyle\" \"\\\\small\")
+ (\"keywordstyle\" \"\\\\color{black}\\\\bfseries\\\\underbar\")))
will typeset the code in a small size font with underlined, bold
black keywords.
@@ -999,8 +999,8 @@ These options are supplied within square brackets in
be a list containing two strings: the name of the option, and the
value. For example,
- \(setq org-latex-minted-options
- '\((\"bgcolor\" \"bg\") \(\"frame\" \"lines\")))
+ (setq org-latex-minted-options
+ '((\"bgcolor\" \"bg\") (\"frame\" \"lines\")))
will result in src blocks being exported with
@@ -1026,8 +1026,8 @@ block-specific options, you may use the following syntax:
It is used during export of src blocks by the listings and minted
latex packages. For example,
- \(setq org-latex-custom-lang-environments
- '\(\(python \"pythoncode\"\)\)\)
+ (setq org-latex-custom-lang-environments
+ '((python \"pythoncode\")))
would have the effect that if org encounters begin_src python
during latex export it will output
diff --git a/lisp/ox-man.el b/lisp/ox-man.el
index f9d37ac..f979fd3 100644
--- a/lisp/ox-man.el
+++ b/lisp/ox-man.el
@@ -210,8 +210,8 @@ in this list - but it does not hurt if it is present."
It is used during export of src blocks by the listings and
man packages. For example,
- \(setq org-man-custom-lang-environments
- '\(\(python \"pythoncode\"\)\)\)
+ (setq org-man-custom-lang-environments
+ '((python \"pythoncode\")))
would have the effect that if org encounters begin_src python
during man export."
diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el
index 225b643..2d2db89 100644
--- a/lisp/ox-odt.el
+++ b/lisp/ox-odt.el
@@ -245,13 +245,13 @@ standard Emacs.")
(defvar org-odt-automatic-styles '()
"Registry of automatic styles for various OBJECT-TYPEs.
The variable has the following form:
-\(\(OBJECT-TYPE-A
- \(\(OBJECT-NAME-A.1 OBJECT-PROPS-A.1\)
- \(OBJECT-NAME-A.2 OBJECT-PROPS-A.2\) ...\)\)
- \(OBJECT-TYPE-B
- \(\(OBJECT-NAME-B.1 OBJECT-PROPS-B.1\)
- \(OBJECT-NAME-B.2 OBJECT-PROPS-B.2\) ...\)\)
- ...\).
+ ((OBJECT-TYPE-A
+ ((OBJECT-NAME-A.1 OBJECT-PROPS-A.1)
+ (OBJECT-NAME-A.2 OBJECT-PROPS-A.2) ...))
+ (OBJECT-TYPE-B
+ ((OBJECT-NAME-B.1 OBJECT-PROPS-B.1)
+ (OBJECT-NAME-B.2 OBJECT-PROPS-B.2) ...))
+ ...).
OBJECT-TYPEs could be \"Section\", \"Table\", \"Figure\" etc.
OBJECT-PROPS is (typically) a plist created by passing
@@ -306,7 +306,7 @@ according to the default face identified by the `htmlfontify'.")
This is an alist where each element is of the form:
- \(STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
+ (STYLE-NAME ATTACH-FMT REF-MODE REF-FMT)
ATTACH-FMT controls how labels and captions are attached to an
entity. It may contain following specifiers - %e and %c. %e is
@@ -333,7 +333,7 @@ See also `org-odt-format-label'.")
This is a list where each entry is of the form:
- \(CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
+ (CATEGORY-HANDLE OD-VARIABLE LABEL-STYLE CATEGORY-NAME ENUMERATOR-PREDICATE)
CATEGORY_HANDLE identifies the captionable entity in question.
@@ -685,11 +685,11 @@ The default value simply returns the value of CONTENTS."
"Function to format headline text.
This function will be called with 5 arguments:
-TODO the todo keyword \(string or nil\).
-TODO-TYPE the type of todo \(symbol: `todo', `done', nil\)
-PRIORITY the priority of the headline \(integer or nil\)
-TEXT the main headline text \(string\).
-TAGS the tags string, separated with colons \(string or nil\).
+TODO the todo keyword (string or nil).
+TODO-TYPE the type of todo (symbol: `todo', `done', nil)
+PRIORITY the priority of the headline (integer or nil)
+TEXT the main headline text (string).
+TAGS the tags string, separated with colons (string or nil).
The function result will be used as headline text."
:group 'org-export-odt
@@ -867,11 +867,11 @@ ON-OR-OFF := t | nil
For example, with the following configuration
\(setq org-odt-table-styles
- '\(\(\"TableWithHeaderRowsAndColumns\" \"Custom\"
- \(\(use-first-row-styles . t\)
- \(use-first-column-styles . t\)\)\)
- \(\"TableWithHeaderColumns\" \"Custom\"
- \(\(use-first-column-styles . t\)\)\)\)\)
+ '((\"TableWithHeaderRowsAndColumns\" \"Custom\"
+ ((use-first-row-styles . t)
+ (use-first-column-styles . t)))
+ (\"TableWithHeaderColumns\" \"Custom\"
+ ((use-first-column-styles . t)))))
1. A table associated with \"TableWithHeaderRowsAndColumns\"
style will use the following table-cell styles -
diff --git a/lisp/ox-org.el b/lisp/ox-org.el
index 82262e0..b395577 100644
--- a/lisp/ox-org.el
+++ b/lisp/ox-org.el
@@ -45,7 +45,7 @@ look bad if different people with different fontification setup
work on the same website. When this variable is non-nil,
creating an htmlized version of an Org buffer using
`org-org-export-as-org' will include a link to this URL if the
-setting of `org-html-htmlize-output-type' is 'css."
+setting of `org-html-htmlize-output-type' is `css'."
:group 'org-export-org
:type '(choice
(const :tag "Don't include external stylesheet link" nil)
diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el
index 9f49f24..20cacf9 100644
--- a/lisp/ox-publish.el
+++ b/lisp/ox-publish.el
@@ -67,7 +67,7 @@ produced.")
(defcustom org-publish-project-alist nil
"Association list to control publishing behavior.
-Each element of the alist is a publishing 'project.' The CAR of
+Each element of the alist is a publishing project. The CAR of
each element is a string, uniquely identifying the project. The
CDR of each element is in one of the following forms:
@@ -75,12 +75,12 @@ CDR of each element is in one of the following forms:
alternating keys and values, specifying parameters for the
publishing process.
- \(:property value :property value ... )
+ (:property value :property value ... )
2. A meta-project definition, specifying of a list of
sub-projects:
- \(:components (\"project-1\" \"project-2\" ...))
+ (:components (\"project-1\" \"project-2\" ...))
When the CDR of an element of org-publish-project-alist is in
this second form, the elements of the list after `:components'
@@ -717,7 +717,7 @@ If `:auto-sitemap' is set, publish the sitemap too. If
(defun org-publish-org-sitemap (project &optional sitemap-filename)
"Create a sitemap of pages in set defined by PROJECT.
Optionally set the filename of the sitemap with SITEMAP-FILENAME.
-Default for SITEMAP-FILENAME is 'sitemap.org'."
+Default for SITEMAP-FILENAME is `sitemap.org'."
(let* ((project-plist (cdr project))
(dir (file-name-as-directory
(plist-get project-plist :base-directory)))
diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el
index 85b3dee..6dfb92e 100644
--- a/lisp/ox-texinfo.el
+++ b/lisp/ox-texinfo.el
@@ -153,9 +153,9 @@ If nil it will default to `buffer-file-coding-system'."
If #+TEXINFO_CLASS is set in the buffer, use its value and the
associated information. Here is the structure of each cell:
- \(class-name
+ (class-name
header-string
- \(numbered-section . unnumbered-section)
+ (numbered-section . unnumbered-section)
...)
@@ -1655,7 +1655,7 @@ none."
(re-search-forward "requires a sectioning" nil t))
(setq errors (concat errors " [invalid section command]")))
(when (save-excursion
- (re-search-forward "\\[unexpected\]" nil t))
+ (re-search-forward "\\[unexpected\ ]" nil t))
(setq errors (concat errors " [unexpected error]")))
(when (save-excursion
(re-search-forward "misplaced " nil t))
diff --git a/lisp/ox.el b/lisp/ox.el
index 0d82913..dd2614e 100644
--- a/lisp/ox.el
+++ b/lisp/ox.el
@@ -802,7 +802,7 @@ is nil. You can also allow them through local buffer variables."
This variable allows to provide shortcuts for export snippets.
-For example, with a value of '\(\(\"h\" . \"html\"\)\), the
+For example, with a value of \\='((\"h\" . \"html\")), the
HTML back-end will recognize the contents of \"@@h:<b>@@\" as
HTML code while every other back-end will ignore it."
:group 'org-export-general
@@ -883,7 +883,7 @@ output is restricted to body only, \"s\" when it is restricted to
the current subtree, \"v\" when only visible elements are
considered for export, \"f\" when publishing functions should be
passed the FORCE argument and \"a\" when the export should be
-asynchronous). Also, \[?] allows to switch back to standard
+asynchronous). Also, [?] allows to switch back to standard
mode."
:group 'org-export-general
:version "24.4"
@@ -1094,7 +1094,7 @@ keywords are understood:
Menu entry for the export dispatcher. It should be a list
like:
- '(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
+ \\='(KEY DESCRIPTION-OR-ORDINAL ACTION-OR-MENU)
where :
@@ -1118,30 +1118,30 @@ keywords are understood:
If it is an alist, associations should follow the
pattern:
- '(KEY DESCRIPTION ACTION)
+ \\='(KEY DESCRIPTION ACTION)
where KEY, DESCRIPTION and ACTION are described above.
Valid values include:
- '(?m \"My Special Back-end\" my-special-export-function)
+ \\='(?m \"My Special Back-end\" my-special-export-function)
or
- '(?l \"Export to LaTeX\"
- \(?p \"As PDF file\" org-latex-export-to-pdf)
- \(?o \"As PDF file and open\"
- \(lambda (a s v b)
- \(if a (org-latex-export-to-pdf t s v b)
- \(org-open-file
- \(org-latex-export-to-pdf nil s v b)))))))
+ \\='(?l \"Export to LaTeX\"
+ (?p \"As PDF file\" org-latex-export-to-pdf)
+ (?o \"As PDF file and open\"
+ (lambda (a s v b)
+ (if a (org-latex-export-to-pdf t s v b)
+ (org-open-file
+ (org-latex-export-to-pdf nil s v b)))))))
or the following, which will be added to the previous
sub-menu,
- '(?l 1
- \((?B \"As TEX buffer (Beamer)\" org-beamer-export-as-latex)
- \(?P \"As PDF file (Beamer)\" org-beamer-export-to-pdf)))
+ \\='(?l 1
+ ((?B \"As TEX buffer (Beamer)\" org-beamer-export-as-latex)
+ (?P \"As PDF file (Beamer)\" org-beamer-export-to-pdf)))
:options-alist
@@ -1215,12 +1215,12 @@ keywords are understood:
As an example, here is how one could define \"my-latex\" back-end
as a variant of `latex' back-end with a custom template function:
- \(org-export-define-derived-backend 'my-latex 'latex
- :translate-alist '((template . my-latex-template-fun)))
+ (org-export-define-derived-backend \\='my-latex \\='latex
+ :translate-alist \\='((template . my-latex-template-fun)))
The back-end could then be called with, for example:
- \(org-export-to-buffer 'my-latex \"*Test my-latex*\")"
+ (org-export-to-buffer \\='my-latex \"*Test my-latex*\")"
(declare (indent 2))
(let (blocks filters menu-entry options transcoders)
(while (keywordp (car body))
@@ -1677,7 +1677,7 @@ DATA is the parse tree. OPTIONS is the plist holding export
options.
Return an alist whose key is a headline and value is its
-associated numbering \(in the shape of a list of numbers\) or nil
+associated numbering \(in the shape of a list of numbers) or nil
for a footnotes section."
(let ((numbering (make-vector org-export-max-depth 0)))
(org-element-map data 'headline
@@ -4035,7 +4035,7 @@ PATH is the link path. DESC is its description."
Optional argument is a set of RULES defining inline images. It
is an alist where associations have the following shape:
- \(TYPE . REGEXP)
+ (TYPE . REGEXP)
Applying a rule means apply REGEXP against LINK's path when its
type is TYPE. The function will return a non-nil value if any of
@@ -4091,7 +4091,7 @@ Return value can be an object or an element:
- If LINK path matches a target object (i.e. <<path>>) return it.
- If LINK path exactly matches the name affiliated keyword
- \(i.e. #+NAME: path) of an element, return that element.
+ (i.e. #+NAME: path) of an element, return that element.
- If LINK path exactly matches any headline name, return that
element.
@@ -5746,7 +5746,7 @@ and `org-export-to-file' for more specialized functions."
(kill-buffer proc-buffer))))
(org-export-add-to-stack proc-buffer nil p)
(ding)
- (message "Process '%s' exited abnormally" p))
+ (message "Process `%s' exited abnormally" p))
(unless org-export-async-debug
(delete-file ,,temp-file)))))))))))))
@@ -5779,10 +5779,10 @@ no argument. It is always called within the current process,
from BUFFER, with point at its beginning. Export back-ends can
use it to set a major mode there, e.g,
- \(defun org-latex-export-as-latex
- \(&optional async subtreep visible-only body-only ext-plist)
- \(interactive)
- \(org-export-to-buffer 'latex \"*Org LATEX Export*\"
+ (defun org-latex-export-as-latex
+ (&optional async subtreep visible-only body-only ext-plist)
+ (interactive)
+ (org-export-to-buffer \\='latex \"*Org LATEX Export*\"
async subtreep visible-only body-only ext-plist (lambda () (LaTeX-mode))))
This function returns BUFFER."
@@ -5839,13 +5839,13 @@ argument and happens asynchronously when ASYNC is non-nil. It
has to return a file name, or nil. Export back-ends can use this
to send the output file through additional processing, e.g,
- \(defun org-latex-export-to-latex
- \(&optional async subtreep visible-only body-only ext-plist)
- \(interactive)
- \(let ((outfile (org-export-output-file-name \".tex\" subtreep)))
- \(org-export-to-file 'latex outfile
+ (defun org-latex-export-to-latex
+ (&optional async subtreep visible-only body-only ext-plist)
+ (interactive)
+ (let ((outfile (org-export-output-file-name \".tex\" subtreep)))
+ (org-export-to-file \\='latex outfile
async subtreep visible-only body-only ext-plist
- \(lambda (file) (org-latex-compile file)))
+ (lambda (file) (org-latex-compile file)))
The function returns either a file name returned by POST-PROCESS,
or FILE."
@@ -6174,7 +6174,7 @@ is nil when this menu hasn't been selected yet.
EXPERTP, when non-nil, triggers expert UI. In that case, no help
buffer is provided, but indications about currently active
-options are given in the prompt. Moreover, \[?] allows to switch
+options are given in the prompt. Moreover, [?] allows to switch
back to standard interface."
(let* ((fontify-key
(lambda (key &optional access-key)