diff --git a/doc/docstyle.texi b/doc/docstyle.texi new file mode 100644 index 000000000..dfd14306b --- /dev/null +++ b/doc/docstyle.texi @@ -0,0 +1,10 @@ +@c Emacs documentation style settings +@documentencoding UTF-8 +@c These two require Texinfo 5.0 or later, so we use the older +@c equivalent @set variables supported in 4.11 and hence +@ignore +@codequotebacktick on +@codequoteundirected on +@end ignore +@set txicodequoteundirected +@set txicodequotebacktick diff --git a/doc/org.texi b/doc/org.texi index d42025954..c11dc1c3e 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -2,6 +2,7 @@ @c %**start of header @setfilename ../../info/org.info @settitle The Org Manual +@include docstyle.texi @include org-version.inc @@ -11,7 +12,6 @@ @set MAINTAINER Carsten Dominik @set MAINTAINEREMAIL @email{carsten at orgmode dot org} @set MAINTAINERCONTACT @uref{mailto:carsten at orgmode dot org,contact the maintainer} -@documentencoding UTF-8 @c %**end of header @finalout @@ -875,7 +875,7 @@ Recent Emacs distributions include a packaging system which lets you install Elisp libraries. You can install Org with @kbd{M-x package-install RET org}. @noindent @b{Important}: you need to do this in a session where no @code{.org} file has -been visited, i.e. where no Org built-in function have been loaded. +been visited, i.e., where no Org built-in function have been loaded. Otherwise autoload Org functions will mess up the installation. Then, to make sure your Org configuration is taken into account, initialize @@ -1038,7 +1038,7 @@ is not necessary. In that case it is sufficient to start Emacs as shown below. @lisp -;;; Minimal setup to load latest `org-mode' +;;; Minimal setup to load latest 'org-mode' ;; activate debugging (setq debug-on-error t @@ -2349,7 +2349,7 @@ Fields that are wider become clipped and end in the string @samp{=>}. Note that the full text is still in the buffer but is hidden. To see the full text, hold the mouse over the field---a tool-tip window will show the full content. To edit such a field, use the command -@kbd{C-c `} (that is @kbd{C-c} followed by the backquote). This will +@kbd{C-c `} (that is @kbd{C-c} followed by the grave accent). This will open a new window with the full field. Edit it and finish with @kbd{C-c C-c}. @@ -2776,7 +2776,7 @@ It is also possible to write a formula in Emacs Lisp. This can be useful for string manipulation and control structures, if Calc's functionality is not enough. -If a formula starts with a single-quote followed by an opening parenthesis, +If a formula starts with an apostrophe followed by an opening parenthesis, then it is evaluated as a Lisp form. The evaluation should return either a string or a number. Just as with @file{calc} formulas, you can specify modes and a printf format after a semicolon. @@ -6074,7 +6074,7 @@ sep 15 @result{} @b{2006}-09-15 feb 15 @result{} @b{2007}-02-15 sep 12 9 @result{} 2009-09-12 12:45 @result{} @b{2006}-@b{06}-@b{13} 12:45 -22 sept 0:34 @result{} @b{2006}-09-22 0:34 +22 sept 0:34 @result{} @b{2006}-09-22 00:34 w4 @result{} ISO week for of the current year @b{2006} 2012 w4 fri @result{} Friday of ISO week 4 in 2012 2012-w04-5 @result{} Same as above @@ -6456,9 +6456,9 @@ you stop working on that task, or when you mark the task done, the clock is stopped and the corresponding time interval is recorded. It also computes the total time spent on each subtree@footnote{Clocking only works if all headings are indented with less than 30 stars. This is a hardcoded -limitation of `lmax' in `org-clock-sum'.} of a project. And it remembers a -history or tasks recently clocked, so that you can jump quickly between a -number of tasks absorbing your time. +limitation of @code{lmax} in @code{org-clock-sum}.} of a project. +And it remembers a history or tasks recently clocked, so that you can jump +quickly between a number of tasks absorbing your time. To save the clock history across Emacs sessions, use @lisp @@ -8244,7 +8244,7 @@ brackets (like @samp{DEADLINE<="<2008-12-24 18:30>"}), both values are assumed to be date/time specifications in the standard Org way, and the comparison will be done accordingly. Special values that will be recognized are @code{""} for now (including time), and @code{""}, and -@code{""} for these days at 0:00 hours, i.e., without a time +@code{""} for these days at 00:00 hours, i.e., without a time specification. Also strings like @code{"<+5d>"} or @code{"<-2m>"} with units @code{d}, @code{w}, @code{m}, and @code{y} for day, week, month, and year, respectively, can be used. @@ -10508,14 +10508,14 @@ macro, they are removed again (depending on the variable @code{cdlatex-simplify-sub-super-scripts}). @item @kindex ` -Pressing the backquote @kbd{`} followed by a character inserts math +Pressing the grave accent @kbd{`} followed by a character inserts math macros, also outside @LaTeX{} fragments. If you wait more than 1.5 seconds -after the backquote, a help window will pop up. +after the grave accent, a help window will pop up. @item @kindex ' -Pressing the single-quote @kbd{'} followed by another character modifies +Pressing the apostrophe @kbd{'} followed by another character modifies the symbol before point with an accent or a font. If you wait more than -1.5 seconds after the single-quote, a help window will pop up. Character +1.5 seconds after the apostrophe, a help window will pop up. Character modification will work only inside @LaTeX{} fragments; outside the quote is normal. @end itemize @@ -10638,7 +10638,7 @@ You can change the default state of this option by setting @item C-v Toggle visible-only export. Only export the text that is currently -visible, i.e. not hidden by outline visibility in the buffer. +visible, i.e., not hidden by outline visibility in the buffer. @end table @node Export back-ends @@ -12622,7 +12622,7 @@ Internet-style links for all other links. A link with no description and destined to a regular (un-itemized) outline heading is replaced with a cross-reference and section number of the heading. -A @samp{\ref@{label@}}-style reference to an image, table etc. is replaced +A @samp{\ref@{label@}}-style reference to an image, table etc.@: is replaced with a cross-reference and sequence number of the labeled entity. @xref{Labels and captions in ODT export}. @@ -12711,7 +12711,7 @@ You can control the size and scale of the embedded images using the The exporter specifies the desired size of the image in the final document in units of centimeters. In order to scale the embedded images, the exporter queries for pixel dimensions of the images using one of a) ImageMagick's -@file{identify} program or b) Emacs `create-image' and `image-size' +@file{identify} program or b) Emacs @code{create-image} and @code{image-size} APIs@footnote{Use of @file{ImageMagick} is only desirable. However, if you routinely produce documents that have large images or you export your Org files that has images using a Emacs batch script, then the use of @@ -13527,7 +13527,7 @@ Copyright information is printed on the back of the title page. This is a short example of a complete Texinfo file, version 1.0. - Copyright \copy 2014 Free Software Foundation, Inc. + Copyright \copy 2015 Free Software Foundation, Inc. @end example @subsubheading The Top node @@ -13712,7 +13712,7 @@ equivalent Texinfo code. #+TEXINFO_PRINTED_TITLE: GNU Sample #+SUBTITLE: for version @{@{@{version@}@}@}, @{@{@{updated@}@}@} -* Copying +* Copying :PROPERTIES: :COPYING: t :END: @@ -13973,9 +13973,9 @@ the Org buffer and get them translated into @LaTeX{} without using the @lisp @group (defun my-latex-filter-nobreaks (text backend info) - "Ensure \" \" are properly handled in LaTeX export." + "Ensure \"_\" are properly handled in LaTeX export." (when (org-export-derived-backend-p backend 'latex) - (replace-regexp-in-string " " "~" text))) + (replace-regexp-in-string "_" "~" text))) (add-to-list 'org-export-filter-plain-text-functions 'my-latex-filter-nobreaks) @@ -14012,7 +14012,7 @@ in the file itself and ensures that the functions will be there when needed. This is obviously the most powerful customization, since the changes happen at the parser level. Indeed, some export back-ends are built as extensions -of other ones (e.g. Markdown back-end an extension of HTML back-end). +of other ones (e.g., Markdown back-end an extension of HTML back-end). Extending a back-end means that if an element type is not transcoded by the new back-end, it will be handled by the original one. Hence you can extend @@ -16538,7 +16538,7 @@ process. For example, compare the following two blocks: : bye @end example -In non-session mode, the `2' is not printed and does not appear. +In non-session mode, the ``2'' is not printed and does not appear. @example #+BEGIN_SRC python :results output :session @@ -16553,8 +16553,8 @@ In non-session mode, the `2' is not printed and does not appear. : bye @end example -But in @code{:session} mode, the interactive interpreter receives input `2' -and prints out its value, `2'. (Indeed, the other print statements are +But in @code{:session} mode, the interactive interpreter receives input ``2'' +and prints out its value, ``2''. (Indeed, the other print statements are unnecessary here). @node Noweb reference syntax @@ -18317,7 +18317,7 @@ The corresponding block writer function could look like this: (defun org-dblock-write:block-update-time (params) (let ((fmt (or (plist-get params :format) "%d. %m. %Y"))) (insert "Last block update at: " - (format-time-string fmt (current-time))))) + (format-time-string fmt)))) @end lisp If you want to make sure that all dynamic blocks are always up-to-date, @@ -18593,8 +18593,8 @@ scheduled, and clocking, and any additional properties defined in the entry. The return value is an alist. Keys may occur multiple times if the property key was used several times.@* POM may also be @code{nil}, in which case the current entry is used. -If WHICH is @code{nil} or `all', get all properties. If WHICH is -`special' or `standard', only get that subclass. +If WHICH is @code{nil} or @code{all}, get all properties. If WHICH is +@code{special} or @code{standard}, only get that subclass. @end defun @vindex org-use-property-inheritance @findex org-insert-property-drawer @@ -19267,7 +19267,7 @@ enabled source code highlighting in Gnus. Max-Planck-Institute for Neurology. He also inspired the creation of a concept index for HTML export. @item -@i{J@"urgen Vollmer} contributed code generating the table of contents +@i{Jürgen Vollmer} contributed code generating the table of contents in HTML output. @item @i{Samuel Wales} has provided important feedback and bug reports. diff --git a/doc/orgcard.tex b/doc/orgcard.tex index cf1e309be..2a0fbb2d9 100644 --- a/doc/orgcard.tex +++ b/doc/orgcard.tex @@ -17,7 +17,7 @@ \pdflayout=(0l) % Nothing else needs to be changed below this line. -% Copyright (C) 1987, 1993, 1996-1997, 2001-2014 Free Software +% Copyright (C) 1987, 1993, 1996-1997, 2001-2015 Free Software % Foundation, Inc. % This file is part of GNU Emacs. diff --git a/lisp/ob-core.el b/lisp/ob-core.el index ae79fe66d..30020f7ee 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -2160,8 +2160,8 @@ INFO may provide the values of these header arguments (in the (and (member "list" result-params) "`:results list'")))) (results-switches (cdr (assoc :results_switches (nth 2 info)))) - (visible-beg (copy-marker (point-min))) - (visible-end (copy-marker (point-max))) + (visible-beg (point-min-marker)) + (visible-end (point-max-marker)) ;; When results exist outside of the current visible ;; region of the buffer, be sure to widen buffer to ;; update them. @@ -2845,7 +2845,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-ruby.el b/lisp/ob-ruby.el index 26285ebde..2134fad68 100644 --- a/lisp/ob-ruby.el +++ b/lisp/ob-ruby.el @@ -58,7 +58,7 @@ :type 'string) (defcustom org-babel-ruby-nil-to 'hline - "Replace 'nil' in ruby tables with this before returning." + "Replace nil in ruby tables with this before returning." :group 'org-babel :version "24.4" :package-version '(Org . "8.0") diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index 2fb5403f4..c5cd21da3 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -5748,7 +5748,7 @@ This function is invoked if `org-agenda-todo-ignore-deadlines', (let ((calendar-date-style 'european) (european-calendar-style t)) (diary-date day month year mark)))) -;; Define the` org-class' function +;; Define the `org-class' function (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks) "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS. DAYNAME is a number between 0 (Sunday) and 6 (Saturday). @@ -6653,7 +6653,7 @@ The modified list may contain inherited tags, and tags matched by LIST is the list of agenda items formatted by `org-agenda-list'. NDAYS is the span of the current agenda view. -TODAYP is `t' when the current agenda view is on today." +TODAYP is t when the current agenda view is on today." (catch 'exit (cond ((not org-agenda-use-time-grid) (throw 'exit list)) ((and todayp (member 'today (car org-agenda-time-grid)))) diff --git a/lisp/org-archive.el b/lisp/org-archive.el index 3e142911f..bbe95ed5d 100644 --- a/lisp/org-archive.el +++ b/lisp/org-archive.el @@ -241,8 +241,7 @@ this heading." (error "No file associated to buffer")))) (olpath (mapconcat 'identity (org-get-outline-path) "/")) (time (format-time-string - (substring (cdr org-time-stamp-formats) 1 -1) - (current-time))) + (substring (cdr org-time-stamp-formats) 1 -1))) category todo priority ltags itags atags ;; end of variables that will be used for saving context location afile heading buffer level newfile-p infile-p visiting @@ -453,8 +452,7 @@ sibling does not exist, it will be created at the end of the subtree." (org-set-property "ARCHIVE_TIME" (format-time-string - (substring (cdr org-time-stamp-formats) 1 -1) - (current-time))) + (substring (cdr org-time-stamp-formats) 1 -1))) (outline-up-heading 1 t) (hide-subtree) (org-cycle-show-empty-lines 'folded) diff --git a/lisp/org-bbdb.el b/lisp/org-bbdb.el index cfd5b3b6a..78f9b7118 100644 --- a/lisp/org-bbdb.el +++ b/lisp/org-bbdb.el @@ -37,7 +37,7 @@ ;; the diary using bbdb-anniv.el. ;; ;; Put the following in /somewhere/at/home/diary.org and make sure -;; that this file is in `org-agenda-files` +;; that this file is in `org-agenda-files'. ;; ;; %%(org-bbdb-anniversaries) ;; diff --git a/lisp/org-capture.el b/lisp/org-capture.el index ac0ed6f1a..8715f9e43 100644 --- a/lisp/org-capture.el +++ b/lisp/org-capture.el @@ -201,7 +201,7 @@ properties are: :clock-resume Start the interrupted clock when finishing the capture. Note that :clock-keep has precedence over :clock-resume. - When setting both to `t', the current clock will run and + When setting both to t, the current clock will run and the previous one will not be resumed. :unnarrowed Do not narrow the target buffer, simply show the diff --git a/lisp/org-clock.el b/lisp/org-clock.el index fb290094c..6e344830e 100644 --- a/lisp/org-clock.el +++ b/lisp/org-clock.el @@ -1096,9 +1096,9 @@ If `only-dangling-p' is non-nil, only ask to resolve dangling (lambda (clock) (format "Dangling clock started %d mins ago" - (floor - (/ (- (org-float-time (current-time)) - (org-float-time (cdr clock))) 60)))))) + (floor (- (org-float-time) + (org-float-time (cdr clock))) + 60))))) (or last-valid (cdr clock))))))))))) @@ -1421,7 +1421,7 @@ decides which time to use." (current-time)) ((equal cmt "today") (setq org--msg-extra "showing today's task time.") - (let* ((dt (decode-time (current-time))) + (let* ((dt (decode-time)) (hour (nth 2 dt)) (day (nth 3 dt))) (if (< hour org-extend-today-until) (setf (nth 3 dt) (1- day))) @@ -1723,7 +1723,8 @@ Optional argument N tells to change by that many units." (save-excursion ; Do not replace this with `with-current-buffer'. (org-no-warnings (set-buffer (org-clocking-buffer))) (goto-char org-clock-marker) - (if (org-looking-back (concat "^[ \t]*" org-clock-string ".*")) + (if (org-looking-back (concat "^[ \t]*" org-clock-string ".*") + (line-beginning-position)) (progn (delete-region (1- (point-at-bol)) (point-at-eol)) (org-remove-empty-drawer-at (point))) (message "Clock gone, cancel the timer anyway") @@ -2135,7 +2136,7 @@ of a week (monday is 1). If MSTART is non-nil, use this number to specify the starting day of a month (1 is the first day of the month). If you can combine both, the month starting day will have priority." - (let* ((tm (decode-time (or time (current-time)))) + (let* ((tm (decode-time time)) (m (nth 1 tm)) (h (nth 2 tm)) (d (nth 3 tm)) @@ -2805,10 +2806,8 @@ TIME: The sum of all time spend in this tree, in minutes. This time (when (and te (listp te)) (setq te (format "%4d-%02d-%02d" (nth 2 te) (car te) (nth 1 te)))) ;; Now the times are strings we can parse. - (if ts (setq ts (org-float-time - (seconds-to-time (org-matcher-time ts))))) - (if te (setq te (org-float-time - (seconds-to-time (org-matcher-time te))))) + (if ts (setq ts (org-matcher-time ts))) + (if te (setq te (org-matcher-time te))) (save-excursion (org-clock-sum ts te (unless (null matcher) @@ -2948,8 +2947,8 @@ The details of what will be saved are regulated by the variable (delete-region (point-min) (point-max)) ;;Store clock (insert (format ";; org-persist.el - %s at %s\n" - system-name (format-time-string - (cdr org-time-stamp-formats)))) + (system-name) (format-time-string + (cdr org-time-stamp-formats)))) (if (and (memq org-clock-persist '(t clock)) (setq b (org-clocking-buffer)) (setq b (or (buffer-base-buffer b) b)) diff --git a/lisp/org-compat.el b/lisp/org-compat.el index 6bd3bfdc2..a762b8e19 100644 --- a/lisp/org-compat.el +++ b/lisp/org-compat.el @@ -236,7 +236,7 @@ ignored in this case." (or window (selected-window))) (defun org-number-sequence (from &optional to inc) - "Call `number-sequence or emulate it." + "Call `number-sequence' or emulate it." (if (fboundp 'number-sequence) (number-sequence from to inc) (if (or (not to) (= from to)) @@ -397,12 +397,8 @@ Pass BUFFER to the XEmacs version of `move-to-column'." (when focus-follows-mouse (set-mouse-position frame (1- (frame-width frame)) 0))))) -(defun org-float-time (&optional time) - "Convert time value TIME to a floating point number. -TIME defaults to the current time." - (if (featurep 'xemacs) - (time-to-seconds (or time (current-time))) - (float-time time))) +(defalias 'org-float-time + (if (featurep 'xemacs) 'time-to-seconds 'float-time)) ;; `user-error' is only available from 24.2.50 on (unless (fboundp 'user-error) diff --git a/lisp/org-ctags.el b/lisp/org-ctags.el index 41775bdab..faf543be1 100644 --- a/lisp/org-ctags.el +++ b/lisp/org-ctags.el @@ -63,19 +63,19 @@ ;; with the same name as the link; then, if unsuccessful, ask the user if ;; he/she wants to rebuild the 'TAGS' database and try again; then ask if ;; the user wishes to append 'tag' as a new toplevel heading at the end of -;; the buffer; and finally, defer to org's default behaviour which is to +;; the buffer; and finally, defer to org's default behavior which is to ;; search the entire text of the current buffer for 'tag'. ;; -;; This behaviour can be modified by changing the value of +;; This behavior can be modified by changing the value of ;; ORG-CTAGS-OPEN-LINK-FUNCTIONS. For example I have the following in my -;; .emacs, which describes the same behaviour as the above paragraph with +;; .emacs, which describes the same behavior as the above paragraph with ;; one difference: ;; ;; (setq org-ctags-open-link-functions ;; '(org-ctags-find-tag ;; org-ctags-ask-rebuild-tags-file-then-find-tag ;; org-ctags-ask-append-topic -;; org-ctags-fail-silently)) ; <-- prevents org default behaviour +;; org-ctags-fail-silently)) ; <-- prevents org default behavior ;; ;; ;; Usage diff --git a/lisp/org-gnus.el b/lisp/org-gnus.el index 5592dd893..c0087a1f0 100644 --- a/lisp/org-gnus.el +++ b/lisp/org-gnus.el @@ -62,7 +62,7 @@ Normally, this translation is done by querying the IMAP server, which is usually very fast. Unfortunately, some (maybe badly configured) IMAP servers don't support this operation quickly. So if following a link to a Gnus article takes ages, try setting -this variable to `t'." +this variable to t." :group 'org-link-store :version "24.1" :type 'boolean) diff --git a/lisp/org-macs.el b/lisp/org-macs.el index ad8b1b338..a4af38614 100644 --- a/lisp/org-macs.el +++ b/lisp/org-macs.el @@ -55,7 +55,7 @@ ,@body)) (defmacro org-called-interactively-p (&optional kind) - (declare (debug (&optional ("quote" symbolp)))) ;Why not just `t'? + (declare (debug (&optional ("quote" symbolp)))) ;Why not just t? (if (featurep 'xemacs) `(interactive-p) (if (or (> emacs-major-version 23) diff --git a/lisp/org-mouse.el b/lisp/org-mouse.el index e6ccb6ebe..42b666df7 100644 --- a/lisp/org-mouse.el +++ b/lisp/org-mouse.el @@ -191,7 +191,7 @@ Changing this variable requires a restart of Emacs to get activated." (interactive) (end-of-line) (skip-chars-backward "\t ") - (when (org-looking-back ":[A-Za-z]+:") + (when (org-looking-back ":[A-Za-z]+:" (line-beginning-position)) (skip-chars-backward ":A-Za-z") (skip-chars-backward "\t "))) @@ -644,7 +644,7 @@ This means, between the beginning of line and the point." 'org-mode-restart)))) ((or (eolp) (and (looking-at "\\( \\|\t\\)\\(+:[0-9a-zA-Z_:]+\\)?\\( \\|\t\\)+$") - (org-looking-back " \\|\t"))) + (org-looking-back " \\|\t" (- (point) 2)))) (org-mouse-popup-global-menu)) ((funcall get-context :checkbox) (popup-menu @@ -1007,7 +1007,7 @@ This means, between the beginning of line and the point." (let ((endmarker (with-current-buffer buffer (org-end-of-subtree nil t) (unless (eobp) (forward-char 1)) - (copy-marker (point))))) + (point-marker)))) (org-with-remote-undo buffer (with-current-buffer buffer (widen) @@ -1017,7 +1017,7 @@ This means, between the beginning of line and the point." (and (outline-next-heading) (org-flag-heading nil))) ; show the next heading (org-back-to-heading) - (setq marker (copy-marker (point))) + (setq marker (point-marker)) (goto-char (max (point-at-bol) (- (point-at-eol) anticol))) (funcall command) (message "_cmd: %S" org-mouse-cmd) diff --git a/lisp/org-protocol.el b/lisp/org-protocol.el index 0c6f2de34..4dfdb6cf6 100644 --- a/lisp/org-protocol.el +++ b/lisp/org-protocol.el @@ -561,7 +561,7 @@ as filename." (let ((fname (expand-file-name (car var)))) (setq fname (org-protocol-check-filename-for-protocol fname (member var flist) client)) - (if (eq fname t) ;; greedy? We need the `t' return value. + (if (eq fname t) ;; greedy? We need the t return value. (progn (ad-set-arg 0 nil) (throw 'greedy t)) diff --git a/lisp/org-src.el b/lisp/org-src.el index 2cceea5e4..96d21d09d 100644 --- a/lisp/org-src.el +++ b/lisp/org-src.el @@ -497,7 +497,7 @@ as `org-src-fontify-natively' is non-nil." (delete-region (point-min) (point-max)) (insert string " ") ;; so there's a final property change (unless (eq major-mode lang-mode) (funcall lang-mode)) - (font-lock-fontify-buffer) + (font-lock-ensure) (setq pos (point-min)) (while (setq next (next-single-property-change pos 'face)) (put-text-property diff --git a/lisp/org-table.el b/lisp/org-table.el index de9946b84..bb9572a45 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -2433,7 +2433,7 @@ For all numbers larger than LIMIT, shift them by DELTA." (string-match "^[a-zA-Z][_a-zA-Z0-9]*$" field)) (push (cons field v) org-table-local-parameters) (push (list field line col) org-table-named-field-locations)))) - ;; Analyse the line types + ;; Analyze the line types. (goto-char beg) (setq org-table-current-begin-line (org-current-line) org-table-current-begin-pos (point) diff --git a/lisp/org-timer.el b/lisp/org-timer.el index ffaeffc77..d645364de 100644 --- a/lisp/org-timer.el +++ b/lisp/org-timer.el @@ -231,6 +231,9 @@ it in the buffer." (abs (floor (org-timer-seconds)))))) (defun org-timer-seconds () + ;; Pass `current-time' result to `org-float-time' (instead of + ;; calling without arguments) so that only `current-time' has to be + ;; overriden in tests. (if org-timer-countdown-timer (- (org-float-time org-timer-start-time) (org-float-time (or org-timer-pause-time (current-time)))) diff --git a/lisp/org.el b/lisp/org.el index 9807e933e..7e89c7d35 100755 --- a/lisp/org.el +++ b/lisp/org.el @@ -895,7 +895,7 @@ XEmacs user should have this variable set to nil, because (defcustom org-loop-over-headlines-in-active-region nil "Shall some commands act upon headlines in the active region? -When set to `t', some commands will be performed in all headlines +When set to t, some commands will be performed in all headlines within the active region. When set to `start-level', some commands will be performed in all @@ -1802,7 +1802,7 @@ See the manual for examples." "Non-nil means Org will display descriptive links. E.g. [[http://orgmode.org][Org website]] will be displayed as \"Org Website\", hiding the link itself and just displaying its -description. When set to `nil', Org will display the full links +description. When set to nil, Org will display the full links literally. You can interactively set the value of this variable by calling @@ -7824,7 +7824,7 @@ heading, unconditionally." (re-search-forward org-outline-regexp-bol) (beginning-of-line 0)) (skip-chars-backward " \r\t\n") - (and (not (looking-back "^\\*+")) + (and (not (looking-back "^\\*+" (line-beginning-position))) (looking-at "[ \t]+") (replace-match "")) (unless (eobp) (forward-char 1)) (when (looking-at "^\\*") @@ -8900,7 +8900,8 @@ When sorting is done, call `org-after-sorting-entries-or-items-hook'." (when (equal (marker-buffer org-clock-marker) (current-buffer)) (save-excursion (goto-char org-clock-marker) - (looking-back "^.*") (match-string-no-properties 0)))) + (buffer-substring-no-properties (line-beginning-position) + (point))))) start beg end stars re re2 txt what tmp) ;; Find beginning and end of region to sort @@ -11790,7 +11791,7 @@ refiling operation has put the subtree. With a numeric prefix argument of `2', refile to the running clock. With a numeric prefix argument of `3', emulate `org-refile-keep' -being set to `t' and copy to the target location, don't move it. +being set to t and copy to the target location, don't move it. Beware that keeping refiled entries may result in duplicated ID properties. @@ -12293,7 +12294,7 @@ This is a list of abbreviation keys and values. The value gets inserted if you type `<' followed by the key and then press the completion key, usually `TAB'. %file will be replaced by a file name after prompting for the file using completion. The cursor will be placed at the position -of the `?` in the template. +of the `?' in the template. There are two templates for each key, the first uses the original Org syntax, the second uses Emacs Muse-like syntax tags. These Muse-like tags become the default when the /org-mtags.el/ module has been loaded. See also the @@ -15996,7 +15997,7 @@ and the new value.") (defun org-entry-put (pom property value) "Set PROPERTY to VALUE for entry at point-or-marker POM. -If the value is `nil', it is converted to the empty string. If +If the value is nil, it is converted to the empty string. If it is not a string, an error is raised. PROPERTY can be any regular property (see @@ -16939,6 +16940,9 @@ user." (defun org-read-date-analyze (ans org-def org-defdecode) "Analyze the combined answer of the date prompt." ;; FIXME: cleanup and comment + ;; Pass `current-time' result to `decode-time' (instead of calling + ;; without arguments) so that only `current-time' has to be + ;; overriden in tests. (let ((nowdecode (decode-time (current-time))) delta deltan deltaw deltadef year month day hour minute second wday pm h2 m2 tl wday1 @@ -17116,6 +17120,9 @@ user." (deltan (setq futurep nil) (unless deltadef + ;; Pass `current-time' result to `decode-time' (instead of + ;; calling without arguments) so that only `current-time' has + ;; to be overriden in tests. (let ((now (decode-time (current-time)))) (setq day (nth 3 now) month (nth 4 now) year (nth 5 now)))) (cond ((member deltaw '("d" "")) (setq day (+ day deltan))) @@ -18208,7 +18215,7 @@ If no number is found, the return value is 0." (defcustom org-image-actual-width t "Should we use the actual width of images when inlining them? -When set to `t', always use the image width. +When set to t, always use the image width. When set to a number, use imagemagick (when available) to set the image's width to this value. @@ -18235,7 +18242,7 @@ This requires Emacs >= 24.1, build with imagemagick support." (defcustom org-agenda-inhibit-startup nil "Inhibit startup when preparing agenda buffers. -When this variable is `t', the initialization of the Org agenda +When this variable is t, the initialization of the Org agenda buffers is inhibited: e.g. the visibility state is not set, the tables are not re-aligned, etc." :type 'boolean @@ -19777,7 +19784,7 @@ boundaries." (org-defkey org-mode-map "\C-c\M-f" 'org-next-block) (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block) (org-defkey org-mode-map "\C-c$" 'org-archive-subtree) -(org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree) +(org-defkey org-mode-map "\C-c\C-x\C-s" 'org-archive-subtree) (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default) (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer) (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag) @@ -21030,7 +21037,7 @@ This command does many different things, depending on context: (item ;; At an item: a double C-u set checkbox to "[-]" ;; unconditionally, whereas a single one will toggle its - ;; presence. Without an universal argument, if the item + ;; presence. Without a universal argument, if the item ;; has a checkbox, toggle it. Otherwise repair the list. (let* ((box (org-element-property :checkbox context)) (struct (org-element-property :structure context)) @@ -21684,7 +21691,7 @@ on context. See the individual commands for more information." ("Archive" ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)] "--" - ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)] + ["Move Subtree to Archive file" org-archive-subtree (org-in-subtree-not-table-p)] ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)] ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)] ) @@ -22763,8 +22770,9 @@ the agenda) or the current time of the day." (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp)) (setq hod (string-to-number (match-string 1 tp)) mod (string-to-number (match-string 2 tp)))) - (or tp (setq hod (nth 2 (decode-time (current-time))) - mod (nth 1 (decode-time (current-time)))))) + (or tp (let ((now (decode-time))) + (setq hod (nth 2 now) + mod (nth 1 now))))) (cond ((eq major-mode 'calendar-mode) (setq date (calendar-cursor-to-date) diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el index daf398890..5cc70bdaf 100644 --- a/lisp/ox-ascii.el +++ b/lisp/ox-ascii.el @@ -216,7 +216,7 @@ original Org buffer at the same place." :package-version '(Org . "8.0") :type '(choice (const :tag "Replicate original spacing" nil) - (cons :tag "Set an uniform spacing" + (cons :tag "Set a uniform spacing" (integer :tag "Number of blank lines before contents") (integer :tag "Number of blank lines after contents")))) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index d454fabae..eee76076e 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -627,7 +627,7 @@ The function must accept two parameters: The function should return the string to be exported. For example, the variable could be set to the following function -in order to mimic default behaviour: +in order to mimic default behavior: The default value simply returns the value of CONTENTS." :group 'org-export-html @@ -761,7 +761,7 @@ t Synonym for `mathjax'." When `org-mode' is exporting an `org-mode' file to HTML, links to non-html files are directly put into a href tag in HTML. However, links to other Org-mode files (recognized by the -extension `.org.) should become links to the corresponding html +extension `.org') should become links to the corresponding html file, assuming that the linked `org-mode' file will also be converted to HTML. When nil, the links still point to the plain `.org' file." @@ -1809,7 +1809,7 @@ used in the preamble or postamble." (?C . ,(let ((file (plist-get info :input-file))) (format-time-string (plist-get info :html-metadata-timestamp-format) - (if file (nth 5 (file-attributes file)) (current-time))))) + (when file (nth 5 (file-attributes file)))))) (?v . ,(or (plist-get info :html-validation-link) "")))) (defun org-html--build-pre/postamble (type info) diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el index b473f1109..6778eae1e 100644 --- a/lisp/ox-icalendar.el +++ b/lisp/ox-icalendar.el @@ -679,7 +679,7 @@ Return VTODO component as a string." (org-element-property :scheduled entry)) ;; If we can't use a scheduled time for some ;; reason, start task now. - (let ((now (decode-time (current-time)))) + (let ((now (decode-time))) (list 'timestamp (list :type 'active :minute-start (nth 1 now) diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el index 163f5804c..e578a1776 100644 --- a/lisp/ox-odt.el +++ b/lisp/ox-odt.el @@ -276,7 +276,8 @@ This style is much the same as that of \"OrgFixedWidthBlock\" except that the foreground and background colors are set according to the default face identified by the `htmlfontify'.") -(defvar hfy-optimisations) +(defvar hfy-optimizations) +(define-obsolete-variable-alias 'hfy-optimisations 'hfy-optimizations "25.1") (defvar org-odt-embedded-formulas-count 0) (defvar org-odt-embedded-images-count 0) (defvar org-odt-image-size-probe-method @@ -861,7 +862,7 @@ TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' | `use-banding-rows-styles' | `use-banding-columns-styles' | `use-first-row-styles' -ON-OR-OFF := `t' | `nil' +ON-OR-OFF := t | nil For example, with the following configuration @@ -3146,8 +3147,8 @@ and prefix with \"OrgSrc\". For example, (" " "") (" " ""))) (hfy-face-to-css 'org-odt-hfy-face-to-css) - (hfy-optimisations-1 (copy-sequence hfy-optimisations)) - (hfy-optimisations (add-to-list 'hfy-optimisations-1 + (hfy-optimizations-1 (copy-sequence hfy-optimizations)) + (hfy-optimizations (add-to-list 'hfy-optimizations-1 'body-text-only)) (hfy-begin-span-handler (lambda (style text-block text-id text-begins-block-p) diff --git a/lisp/ox-org.el b/lisp/ox-org.el index c52cbf24a..82262e072 100644 --- a/lisp/ox-org.el +++ b/lisp/ox-org.el @@ -294,12 +294,13 @@ Return output file name." (html-ext (concat "." (or (plist-get plist :html-extension) org-html-extension "html"))) (visitingp (find-buffer-visiting filename)) - (work-buffer (or visitingp (find-file filename))) + (work-buffer (or visitingp (find-file-noselect filename))) newbuf) - (font-lock-ensure) - (show-all) - (org-show-block-all) - (setq newbuf (htmlize-buffer)) + (with-current-buffer work-buffer + (font-lock-ensure) + (show-all) + (org-show-block-all) + (setq newbuf (htmlize-buffer))) (with-current-buffer newbuf (when org-org-htmlized-css-url (goto-char (point-min)) @@ -308,10 +309,12 @@ Return output file name." (replace-match (format "" - org-org-htmlized-css-url) t t))) + org-org-htmlized-css-url) + t t))) (write-file (concat pub-dir (file-name-nondirectory filename) html-ext))) (kill-buffer newbuf) (unless visitingp (kill-buffer work-buffer))) + ;; FIXME: Why? Which buffer is this supposed to apply to? (set-buffer-modified-p nil))) diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el index 951f0fe19..9f49f2490 100644 --- a/lisp/ox-publish.el +++ b/lisp/ox-publish.el @@ -236,7 +236,7 @@ If you create a site-map file, adjust the sorting like this: `:sitemap-sort-files' The site map is normally sorted alphabetically. You can - change this behaviour setting this to `anti-chronologically', + change this behavior setting this to `anti-chronologically', `chronologically', or nil. `:sitemap-ignore-case' diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index d7a48b756..df56b6708 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -133,7 +133,7 @@ (defcustom org-texinfo-coding-system nil "Default document encoding for Texinfo output. -If `nil' it will default to `buffer-file-coding-system'." +If nil it will default to `buffer-file-coding-system'." :group 'org-export-texinfo :type 'coding-system) diff --git a/lisp/ox.el b/lisp/ox.el index b06211b87..7f5360af4 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -496,7 +496,7 @@ t Allow export of math snippets." "The last level which is still exported as a headline. Inferior levels will usually produce itemize or enumerate lists -when exported, but back-end behaviour may differ. +when exported, but back-end behavior may differ. This option can also be set with the OPTIONS keyword, e.g. \"H:2\"." @@ -1514,7 +1514,7 @@ Assume buffer is in Org mode. Narrowing, if any, is ignored." (and buffer-file-name (list buffer-file-name)) nil))) ;; Parse properties in TO-PARSE. Remove newline characters not - ;; involved in line breaks to simulate `space' behaviour. + ;; involved in line breaks to simulate `space' behavior. ;; Finally return options. (dolist (p to-parse options) (let ((value (org-element-parse-secondary-string