From 89e646799b0c7cd2b9c23a84fedfe32885b9f1a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20A=2E=20Gomes?= Date: Tue, 5 Oct 2021 22:57:02 +0300 Subject: [PATCH 02/76] Fix comments. --- lisp/ob-core.el | 2 +- lisp/ob-ref.el | 2 +- lisp/oc.el | 2 +- lisp/ol-bibtex.el | 8 +- lisp/ol.el | 14 +-- lisp/org-agenda.el | 4 +- lisp/org-archive.el | 2 +- lisp/org-capture.el | 12 +- lisp/org-clock.el | 8 +- lisp/org-colview.el | 6 +- lisp/org-compat.el | 2 +- lisp/org-crypt.el | 2 +- lisp/org-element.el | 36 +++--- lisp/org-footnote.el | 4 +- lisp/org-indent.el | 14 +-- lisp/org-inlinetask.el | 4 +- lisp/org-list.el | 2 +- lisp/org-mouse.el | 2 +- lisp/org-num.el | 30 ++--- lisp/org-pcomplete.el | 4 +- lisp/org-refile.el | 2 +- lisp/org.el | 100 ++++++++-------- lisp/ox-ascii.el | 20 ++-- lisp/ox-beamer.el | 38 +++--- lisp/ox-html.el | 20 ++-- lisp/ox-icalendar.el | 14 +-- lisp/ox-koma-letter.el | 12 +- lisp/ox-latex.el | 28 ++--- lisp/ox-man.el | 12 +- lisp/ox-md.el | 12 +- lisp/ox-odt.el | 36 +++--- lisp/ox-org.el | 2 +- lisp/ox-publish.el | 2 +- lisp/ox-texinfo.el | 14 +-- lisp/ox.el | 66 +++++------ testing/lisp/test-ob-exp.el | 4 +- testing/lisp/test-ob.el | 4 +- testing/lisp/test-ol.el | 8 +- testing/lisp/test-org-capture.el | 8 +- testing/lisp/test-org-clock.el | 16 +-- testing/lisp/test-org-colview.el | 4 +- testing/lisp/test-org-element.el | 18 +-- testing/lisp/test-org-footnote.el | 2 +- testing/lisp/test-org-list.el | 14 +-- testing/lisp/test-org-macro.el | 4 +- testing/lisp/test-org-num.el | 16 +-- testing/lisp/test-org.el | 190 +++++++++++++++--------------- testing/lisp/test-ox.el | 70 +++++------ 48 files changed, 448 insertions(+), 448 deletions(-) diff --git a/lisp/ob-core.el b/lisp/ob-core.el index 06a2a88cd..58bc5b25f 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -2880,7 +2880,7 @@ block but are passed literally to the \"example-block\"." (setq cache nil) (let ((raw (org-babel-ref-resolve id))) (if (stringp raw) raw (format "%S" raw)))) - ;; Return the contents of headlines literally. + ;; Return the contents of headings literally. ((org-babel-ref-goto-headline-id id) (org-babel-ref-headline-body)) ;; Look for a source block named SOURCE-NAME. If diff --git a/lisp/ob-ref.el b/lisp/ob-ref.el index a7ab299b2..04b797f0f 100644 --- a/lisp/ob-ref.el +++ b/lisp/ob-ref.el @@ -182,7 +182,7 @@ Emacs Lisp representation of the value of the variable." (guard v)) (throw :found v)) (_ (error "Reference not found"))))))) - ;; Check for local or global headlines by ID. + ;; Check for local or global headings by ID. (when (org-babel-ref-goto-headline-id ref) (throw :found (org-babel-ref-headline-body))) ;; Check the Library of Babel. diff --git a/lisp/oc.el b/lisp/oc.el index 2f741768f..501c7a5c3 100644 --- a/lisp/oc.el +++ b/lisp/oc.el @@ -1425,7 +1425,7 @@ CONTEXT is the element or object at point, as returned by `org-element-context'. ((eq type 'verse-block) (and (>= (point) (org-element-property :contents-begin context)) (< (point) (org-element-property :contents-end context)))) - ;; In an headline or inlinetask, point must be either on the + ;; In an heading or inlinetask, point must be either on the ;; heading itself or on the blank lines below. ((memq type '(headline inlinetask)) (or (not (org-at-heading-p)) diff --git a/lisp/ol-bibtex.el b/lisp/ol-bibtex.el index 476095d3e..23b00d5d8 100644 --- a/lisp/ol-bibtex.el +++ b/lisp/ol-bibtex.el @@ -78,7 +78,7 @@ ;; - Run `org-bibtex' to export the current file to a .bib. ;; ;; - Run `org-bibtex-check' or `org-bibtex-check-all' to check and -;; fill in missing field of either the current, or all headlines +;; fill in missing field of either the current, or all headings ;; ;; - Run `org-bibtex-create' to add a bibtex entry ;; @@ -99,8 +99,8 @@ ;; and then implemented by Bastien Guerry. ;; ;; Eric Schulte eventually added the functions for translating between -;; Org headlines and Bibtex entries, and for fleshing out the Bibtex -;; fields of existing Org headlines. +;; Org headings and Bibtex entries, and for fleshing out the Bibtex +;; fields of existing Org headings. ;; ;; Org mode loads this module by default - if this is not what you want, ;; configure the variable `org-modules'. @@ -578,7 +578,7 @@ ARG, when non-nil, is a universal prefix argument. See (add-hook 'org-execute-file-search-functions 'org-execute-file-search-in-bibtex) -;;; Bibtex <-> Org headline translation functions +;;; Bibtex <-> Org heading translation functions (defun org-bibtex (filename) "Export each headline in the current file to a bibtex entry. Headlines are exported using `org-bibtex-headline'." diff --git a/lisp/ol.el b/lisp/ol.el index aa1849715..3b93ad721 100644 --- a/lisp/ol.el +++ b/lisp/ol.el @@ -1168,7 +1168,7 @@ of matched result, which is either `dedicated' or `fuzzy'." (match-string 1 s))) ;; From here, we handle fuzzy links. ;; - ;; Look for targets, only if not in a headline search. + ;; Look for targets, only if not in a heading search. ((and (not starred) (let ((target (format "<<%s>>" s-multi-re))) (catch :target-match @@ -1181,7 +1181,7 @@ of matched result, which is either `dedicated' or `fuzzy'." (goto-char (org-element-property :begin context)) (throw :target-match t)))) nil)))) - ;; Look for elements named after S, only if not in a headline + ;; Look for elements named after S, only if not in a heading ;; search. ((and (not starred) (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re))) @@ -1195,7 +1195,7 @@ of matched result, which is either `dedicated' or `fuzzy'." (beginning-of-line) (throw :name-match t)))) nil)))) - ;; Regular text search. Prefer headlines in Org mode buffers. + ;; Regular text search. Prefer headings in Org mode buffers. ;; Ignore COMMENT keyword, TODO keywords, priority cookies, ;; statistics cookies and tags. ((and (derived-mode-p 'org-mode) @@ -1215,7 +1215,7 @@ of matched result, which is either `dedicated' or `fuzzy'." nil))) (beginning-of-line) (setq type 'dedicated)) - ;; Offer to create non-existent headline depending on + ;; Offer to create non-existent heading depending on ;; `org-link-search-must-match-exact-headline'. ((and (derived-mode-p 'org-mode) (eq org-link-search-must-match-exact-headline 'query-to-create) @@ -1225,7 +1225,7 @@ of matched result, which is either `dedicated' or `fuzzy'." (org-insert-heading nil t t) (insert s "\n") (beginning-of-line 0)) - ;; Only headlines are looked after. No need to process + ;; Only headings are looked after. No need to process ;; further: throw an error. ((and (derived-mode-p 'org-mode) (or starred org-link-search-must-match-exact-headline)) @@ -1645,12 +1645,12 @@ non-nil." :description) ""))) (error - ;; Probably before first headline, link only to file. + ;; Probably before first heading, link only to file. (concat "file:" (abbreviate-file-name (buffer-file-name (buffer-base-buffer)))))))) (t - ;; Just link to current headline. + ;; Just link to current heading. (setq cpltxt (concat "file:" (abbreviate-file-name (buffer-file-name (buffer-base-buffer))))) diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index 5eb896b9a..5fb136fb5 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -5455,7 +5455,7 @@ the documentation of `org-diary'." (delq :deadline (delq :deadline* args))))) ((memq :deadline* args) (setf args (cons :deadline* (delq :deadline* args))))) - ;; Collect list of headlines. Return them flattened. + ;; Collect list of headings. Return them flattened. (let ((case-fold-search nil) results deadlines) (org-dlet ((date date)) @@ -5720,7 +5720,7 @@ displayed in agenda view." (goto-char (point-min)) (while (re-search-forward regexp nil t) ;; Skip date ranges, scheduled and deadlines, which are handled - ;; specially. Also skip time-stamps before first headline as + ;; specially. Also skip time-stamps before first heading as ;; there would be no entry to add to the agenda. Eventually, ;; ignore clock entries. (catch :skip diff --git a/lisp/org-archive.el b/lisp/org-archive.el index 0943869a8..fc73f5926 100644 --- a/lisp/org-archive.el +++ b/lisp/org-archive.el @@ -352,7 +352,7 @@ direct children of this heading." (unless (org-at-heading-p) (outline-next-heading))) (goto-char (point-max)) ;; Subtree narrowing can let the buffer end on - ;; a headline. `org-paste-subtree' then deletes it. + ;; a heading. `org-paste-subtree' then deletes it. ;; To prevent this, make sure visible part of buffer ;; always terminates on a new line, while limiting ;; number of blank lines in a date tree. diff --git a/lisp/org-capture.el b/lisp/org-capture.el index a9350c58d..837ef3a80 100644 --- a/lisp/org-capture.el +++ b/lisp/org-capture.el @@ -895,7 +895,7 @@ for `entry'-type templates")) (refile-targets (org-capture-get :refile-targets 'local))) ;; Since `org-capture-finalize' may alter buffer contents (e.g., ;; empty lines) around entry, use a marker to refer to the - ;; headline to be refiled. Place the marker in the base buffer, + ;; heading to be refiled. Place the marker in the base buffer, ;; as the current indirect one is going to be killed. (set-marker pos (save-excursion (org-back-to-heading t) (point)) base) ;; `org-capture-finalize' calls `org-capture-goto-last-stored' too @@ -1294,7 +1294,7 @@ may have been stored before." (org-capture-mark-kill-region origin (point)) ;; ITEM always end with a newline character. Make sure we do ;; not narrow at the beginning of the next line, possibly - ;; altering its structure (e.g., when it is a headline). + ;; altering its structure (e.g., when it is a heading). (org-capture-narrow beg (1- end)) (org-capture--position-cursor beg end))))) @@ -1394,7 +1394,7 @@ Of course, if exact position has been required, just put it there." (if (org-capture-get :prepend) ;; Skip meta data and drawers. (org-end-of-meta-data t) - ;; Go to end of the entry text, before the next headline. + ;; Go to end of the entry text, before the next heading. (outline-next-heading))) (t ;; Beginning or end of file. @@ -1782,10 +1782,10 @@ by their respective `org-store-link-plist' properties if present." (org-capture-get :buffer))) ;; Find location from where to get allowed ;; values. If `:target-entry-p' is - ;; non-nil, the current headline in the + ;; non-nil, the current heading in the ;; target buffer is going to be a parent - ;; headline, so location is fine. - ;; Otherwise, find the parent headline in + ;; heading, so location is fine. + ;; Otherwise, find the parent heading in ;; the target buffer. (pom (if (org-capture-get :target-entry-p) origin (let ((level (progn diff --git a/lisp/org-clock.el b/lisp/org-clock.el index 2e9a1c9b2..c590680a6 100644 --- a/lisp/org-clock.el +++ b/lisp/org-clock.el @@ -982,7 +982,7 @@ CLOCK is a cons cell of the form (MARKER START-TIME)." ;; If the clocked entry contained only a clock and possibly ;; the associated drawer, and we either cancel it or clock it ;; out, `org-clock-out-remove-zero-time-clocks' may clear all - ;; contents, and leave point on the /next/ headline. We store + ;; contents, and leave point on the /next/ heading. We store ;; the current entry location to be able to get back here when ;; we need to clock in again the previously clocked task. (heading (org-with-point-at (car clock) @@ -1918,7 +1918,7 @@ PROPNAME lets you set a custom text property instead of :org-clock-minutes." ;; A naked time. (setq t1 (+ t1 (string-to-number (match-string 5)) (* 60 (string-to-number (match-string 4)))))) - (t ;A headline + (t ;A heading ;; Add the currently clocking item time to the total. (when (and org-clock-report-include-clocking-task (eq (org-clocking-buffer) (current-buffer)) @@ -2583,7 +2583,7 @@ from the dynamic block definition." (properties (plist-get params :properties)) (time-columns (if (or compact? (< maxlevel 2)) 1 - ;; Deepest headline level is a hard limit for the number + ;; Deepest heading level is a hard limit for the number ;; of time columns. (let ((levels (cl-mapcan @@ -2644,7 +2644,7 @@ from the dynamic block definition." (if properties ;properties columns, maybe (make-string (length properties) ?|) "") - (format "<%d>| |\n" narrow))) ;headline and time columns + (format "<%d>| |\n" narrow))) ;heading and time columns ;; Insert the table header line (insert-before-markers diff --git a/lisp/org-colview.el b/lisp/org-colview.el index 9794382d8..ca3de4cb8 100644 --- a/lisp/org-colview.el +++ b/lisp/org-colview.el @@ -663,7 +663,7 @@ Where possible, use the standard interface for changing this line." (with-silent-modifications (remove-text-properties (max (point-min) (1- bol)) eol '(read-only t))) (org-columns--call action)) - ;; Some properties can modify headline (e.g., "TODO"), and + ;; Some properties can modify heading (e.g., "TODO"), and ;; possible shuffle overlays. Make sure they are still all at ;; the right place on the current line. (let ((org-columns-inhibit-recalculation)) (org-columns-redo)) @@ -757,7 +757,7 @@ an integer, select that value." (remove-text-properties (line-end-position 0) (line-end-position) '(read-only t)) (org-columns--call action)) - ;; Some properties can modify headline (e.g., "TODO"), and + ;; Some properties can modify heading (e.g., "TODO"), and ;; possible shuffle overlays. Make sure they are still all at ;; the right place on the current line. (let ((org-columns-inhibit-recalculation)) (org-columns-redo)) @@ -1615,7 +1615,7 @@ PARAMS is a property list of parameters: (when org-agenda-columns-compute-summary-properties (org-agenda-colview-compute org-columns-current-fmt-compiled)) (save-excursion - ;; Collect properties for each headline in current view. + ;; Collect properties for each heading in current view. (goto-char (point-min)) (let (cache) (while (not (eobp)) diff --git a/lisp/org-compat.el b/lisp/org-compat.el index 6ac0b6252..24c4b35f2 100644 --- a/lisp/org-compat.el +++ b/lisp/org-compat.el @@ -1009,7 +1009,7 @@ ELEMENT is the element at point." (defun org-mode-flyspell-verify () "Function used for `flyspell-generic-check-word-predicate'." (if (org-at-heading-p) - ;; At a headline or an inlinetask, check title only. + ;; At a heading or an inlinetask, check title only. (and (save-excursion (beginning-of-line) (and (let ((case-fold-search t)) (not (looking-at-p "\\*+ END[ \t]*$"))) diff --git a/lisp/org-crypt.el b/lisp/org-crypt.el index 48f76b79f..3ccc526bc 100644 --- a/lisp/org-crypt.el +++ b/lisp/org-crypt.el @@ -31,7 +31,7 @@ ;; 2. Set the encryption key to use in the `org-crypt-key' variable, ;; or use `M-x org-set-property' to set the property CRYPTKEY to ;; any address in your public keyring. The text of the entry (but -;; not its properties or headline) will be encrypted for this user. +;; not its properties or heading) will be encrypted for this user. ;; For them to read it, the corresponding secret key must be ;; located in the secret key ring of the account where you try to ;; decrypt it. This makes it possible to leave secure notes that diff --git a/lisp/org-element.el b/lisp/org-element.el index cc3976d21..9127105ca 100644 --- a/lisp/org-element.el +++ b/lisp/org-element.el @@ -147,7 +147,7 @@ specially in `org-element--object-lex'.") "Build variable syntax regexps." (setq org-element-paragraph-separate (concat "^\\(?:" - ;; Headlines, inlinetasks. + ;; Headings, inlinetasks. "\\*+ " "\\|" ;; Footnote definitions. "\\[fn:[-_[:word:]]+\\]" "\\|" @@ -945,7 +945,7 @@ CONTENTS is the contents of the footnote-definition." (concat (make-string pre-blank ?\n) contents))))) -;;;; Headline +;;;; Heading (defun org-element--get-node-properties () "Return node properties associated to headline at point. @@ -1023,7 +1023,7 @@ Assume point is at beginning of the headline." (goto-char (match-end 0)))) (title-start (prog1 (point) (unless (or todo priority commentedp) - ;; Headline like "* :tag:" + ;; Heading like "* :tag:" (skip-chars-backward " \t")))) (tags (when (re-search-forward "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$" @@ -1624,7 +1624,7 @@ containing `:begin', `:end', `:contents-begin', `contents-end', `:post-blank' and `:post-affiliated' keywords." (save-excursion ;; Beginning of section is the beginning of the first non-blank - ;; line after previous headline. + ;; line after previous heading. (let ((begin (point)) (end (progn (org-with-limited-levels (outline-next-heading)) (point))) @@ -3322,8 +3322,8 @@ Assume point is at the beginning of the link." (setq type "custom-id") (setq path (substring raw-link 1))) ;; Fuzzy type: Internal link either matches a target, an - ;; headline name or nothing. PATH is the target or - ;; headline's name. + ;; heading name or nothing. PATH is the target or + ;; heading's name. (t (setq type "fuzzy") (setq path raw-link)))) @@ -4002,10 +4002,10 @@ element it has to parse." ((eq mode 'table-row) (org-element-table-row-parser limit)) ;; Node Property. ((eq mode 'node-property) (org-element-node-property-parser limit)) - ;; Headline. + ;; Heading. ((org-with-limited-levels (org-at-heading-p)) (org-element-headline-parser limit raw-secondary-p)) - ;; Sections (must be checked after headline). + ;; Sections (must be checked after heading). ((eq mode 'section) (org-element-section-parser limit)) ((eq mode 'first-section) (org-element-section-parser @@ -4281,7 +4281,7 @@ This function assumes that current major mode is `org-mode'." (org-element--parse-elements (point-at-bol) (point-max) ;; Start in `first-section' mode so text before the first - ;; headline belongs to a section. + ;; heading belongs to a section. 'first-section nil granularity visible-only (list 'org-data nil)))) (defun org-element-parse-secondary-string (string restriction &optional parent) @@ -4529,7 +4529,7 @@ elements. Elements are accumulated into ACC." (save-excursion (goto-char beg) - ;; When parsing only headlines, skip any text before first one. + ;; When parsing only headings, skip any text before first one. (when (and (eq granularity 'headline) (not (org-at-heading-p))) (org-with-limited-levels (outline-next-heading))) (let (elements) @@ -4552,7 +4552,7 @@ Elements are accumulated into ACC." ((not cbeg)) ;; Greater element: parse it between `contents-begin' and ;; `contents-end'. Ensure GRANULARITY allows recursion, - ;; or ELEMENT is a headline, in which case going inside + ;; or ELEMENT is a heading, in which case going inside ;; is mandatory, in order to get sub-level headings. ((and (memq type org-element-greater-elements) (or (memq granularity '(element object nil)) @@ -5626,7 +5626,7 @@ the process stopped before finding the expected result." element next mode) (cond ;; Nothing in cache before point: start parsing from first - ;; element following headline above, or first element in + ;; element following heading above, or first element in ;; buffer. ((not cached) (if (org-with-limited-levels (outline-previous-heading)) @@ -5639,9 +5639,9 @@ the process stopped before finding the expected result." ;; Cache returned exact match: return it. ((= pos begin) (throw 'exit (if syncp (org-element-property :parent cached) cached))) - ;; There's a headline between cached value and POS: cached + ;; There's a heading between cached value and POS: cached ;; value is invalid. Start parsing from first element - ;; following the headline. + ;; following the heading. ((re-search-backward (org-with-limited-levels org-outline-regexp-bol) begin t) (forward-line) @@ -5792,7 +5792,7 @@ that range. See `after-change-functions' for more information." (bottom (save-excursion (goto-char end) (line-end-position)))) ;; Determine if modified area needs to be extended, according ;; to both previous and current state. We make a special - ;; case for headline editing: if a headline is modified but + ;; case for heading editing: if a heading is modified but ;; not removed, do not extend. (when (pcase org-element--cache-change-warning (`t t) @@ -6011,8 +6011,8 @@ element ending there." (cond ;; Within blank lines at the beginning of buffer, return nil. ((bobp) nil) - ;; Within blank lines right after a headline, return that - ;; headline. + ;; Within blank lines right after a heading, return that + ;; heading. ((org-with-limited-levels (org-at-heading-p)) (beginning-of-line) (org-element-headline-parser (point-max) t)) @@ -6081,7 +6081,7 @@ Providing it allows for quicker computation." (if (and (>= pos (point)) (< pos (match-end 0))) (narrow-to-region (point) (match-end 0)) (throw 'objects-forbidden element))))) - ;; At an headline or inlinetask, objects are in title. + ;; At an heading or inlinetask, objects are in title. ((memq type '(headline inlinetask)) (let ((case-fold-search nil)) (goto-char (org-element-property :begin element)) diff --git a/lisp/org-footnote.el b/lisp/org-footnote.el index fcc7579ba..1371e1d59 100644 --- a/lisp/org-footnote.el +++ b/lisp/org-footnote.el @@ -261,7 +261,7 @@ otherwise." ((eq type 'verse-block) (and (>= (point) (org-element-property :contents-begin context)) (< (point) (org-element-property :contents-end context)))) - ;; In an headline or inlinetask, point must be either on the + ;; In an heading or inlinetask, point must be either on the ;; heading itself or on the blank lines below. ((memq type '(headline inlinetask)) (or (not (org-at-heading-p)) @@ -518,7 +518,7 @@ This function is meant to be used for fontification only." (save-excursion (end-of-line) ;; Footnotes definitions are separated by new - ;; headlines, another footnote definition or 2 blank + ;; headings, another footnote definition or 2 blank ;; lines. (let ((end (match-end 0)) (lim (save-excursion diff --git a/lisp/org-indent.el b/lisp/org-indent.el index 5b5465dd8..66e3b941a 100644 --- a/lisp/org-indent.el +++ b/lisp/org-indent.el @@ -131,7 +131,7 @@ useful to make it ever so slightly different." (let ((indentation (if (<= n 1) 0 (* (1- org-indent-indentation-per-level) (1- n))))) - ;; Headlines line prefixes. + ;; Headings line prefixes. (let ((heading-prefix (make-string indentation ?*))) (aset org-indent--heading-line-prefixes n @@ -332,7 +332,7 @@ stopped." (level (or (org-current-level) 0)) (time-limit (and delay (time-add nil delay)))) ;; For each line, set `line-prefix' and `wrap-prefix' - ;; properties depending on the type of line (headline, inline + ;; properties depending on the type of line (heading, inline ;; task, item or other). (with-silent-modifications (while (and (<= (point) end) (not (eobp))) @@ -349,12 +349,12 @@ stopped." (time-add (current-idle-time) org-indent-agent-resume-delay) nil #'org-indent-initialize-agent)) (throw 'interrupt (point))) - ;; Headline or inline task. + ;; Heading or inline task. ((looking-at org-outline-regexp) (let* ((nstars (- (match-end 0) (match-beginning 0) 1)) (type (or (looking-at-p limited-re) 'inlinetask))) (org-indent-set-line-properties nstars 0 type) - ;; At an headline, define new value for LEVEL. + ;; At an heading, define new value for LEVEL. (unless (eq type 'inlinetask) (setq level nstars)))) ;; List item: `wrap-prefix' is set where body starts. ((org-at-item-p) @@ -367,7 +367,7 @@ stopped." (current-indentation) ;; When adapt indentation is 'headline-data, use ;; `org-indent--heading-line-prefixes' for setting - ;; headline data indentation. + ;; heading data indentation. (and (eq org-adapt-indentation 'headline-data) (or (org-at-planning-p) (org-at-clock-log-p) @@ -401,8 +401,8 @@ range of inserted text. DUMMY is an unused argument. This function is meant to be called by `after-change-functions'." (when org-indent-mode (save-match-data - ;; If a headline was modified or inserted, set properties until - ;; next headline. + ;; If a heading was modified or inserted, set properties until + ;; next heading. (org-with-wide-buffer (if (or org-indent-modified-headline-flag (save-excursion diff --git a/lisp/org-inlinetask.el b/lisp/org-inlinetask.el index 3379a2e46..e8f373286 100644 --- a/lisp/org-inlinetask.el +++ b/lisp/org-inlinetask.el @@ -40,7 +40,7 @@ ;; parent into children. ;; ;; Special fontification of inline tasks, so that they can be -;; immediately recognized. From the stars of the headline, only last +;; immediately recognized. From the stars of the heading, only last ;; two will be visible, the others will be hidden using the `org-hide' ;; face. ;; @@ -49,7 +49,7 @@ ;; ;; If you need to have a time planning line (DEADLINE etc), drawers, ;; for example LOGBOOK of PROPERTIES, or even normal text as part of -;; the inline task, you must add an "END" headline with the same +;; the inline task, you must add an "END" heading with the same ;; number of stars. ;; ;; As an example, here are two valid inline tasks: diff --git a/lisp/org-list.el b/lisp/org-list.el index 6d3ef7cc9..93aa00a73 100644 --- a/lisp/org-list.el +++ b/lisp/org-list.el @@ -3070,7 +3070,7 @@ With a prefix argument ARG, change the region in a single item." (let* ((level (org-reduced-level (org-outline-level))) (delta (max 0 (- level ref-level))) (todo-state (org-get-todo-state))) - ;; If current headline is less indented than the first + ;; If current heading is less indented than the first ;; one, set it as reference, in order to preserve ;; subtrees. (when (< level ref-level) (setq ref-level level)) diff --git a/lisp/org-mouse.el b/lisp/org-mouse.el index a35a19bca..66a153c9c 100644 --- a/lisp/org-mouse.el +++ b/lisp/org-mouse.el @@ -31,7 +31,7 @@ ;; * subtree expansion/collapse (org-cycle) with the left mouse button ;; * several context menus on the right mouse button: ;; + general text -;; + headlines +;; + headings ;; + timestamps ;; + priorities ;; + links diff --git a/lisp/org-num.el b/lisp/org-num.el index f00e6c463..849368481 100644 --- a/lisp/org-num.el +++ b/lisp/org-num.el @@ -1,4 +1,4 @@ -;;; org-num.el --- Dynamic Headlines Numbering -*- lexical-binding: t; -*- +;;; org-num.el --- Dynamic Headings Numbering -*- lexical-binding: t; -*- ;; Copyright (C) 2018-2021 Free Software Foundation, Inc. @@ -22,7 +22,7 @@ ;;; Commentary: -;; This library provides dynamic numbering for Org headlines. Use +;; This library provides dynamic numbering for Org headings. Use ;; ;; ;; @@ -41,10 +41,10 @@ ;; position, of overlays in `org-num--overlays'. These overlays are ;; marked with the `org-num' property set to a non-nil value. ;; -;; Overlays store the level of the headline in the `level' property, +;; Overlays store the level of the heading in the `level' property, ;; and the face used for the numbering in `numbering-face'. ;; -;; The `skip' property is set to t when the corresponding headline has +;; The `skip' property is set to t when the corresponding heading has ;; some characteristic -- e.g., a node property, or a tag -- that ;; prevents it from being numbered. ;; @@ -219,7 +219,7 @@ Assume point is at a headline." (overlay-put o 'numbering-face (or org-num-face ;; Compute face that would be used at the - ;; headline. We cannot extract it from the + ;; heading. We cannot extract it from the ;; buffer: at the time the overlay is created, ;; Font Lock has not proceeded yet. (nth (if org-cycle-level-faces @@ -282,7 +282,7 @@ if headline should be skipped." (let ((last-level (length org-num--numbering))) (setq org-num--numbering (cond - ;; First headline : nil => (1), or (1 0)... + ;; First heading : nil => (1), or (1 0)... ((null org-num--numbering) (cons 1 (make-list (1- level) 0))) ;; Sibling: (1 1) => (2 1). ((= level last-level) @@ -302,7 +302,7 @@ When START or END are nil, use buffer boundaries. Narrowing, if any, is ignored. Return the list of created overlays, newest first." (org-with-point-at (or start 1) - ;; Do not match headline starting at START. + ;; Do not match heading starting at START. (when start (end-of-line)) (let ((regexp (org-num--headline-regexp)) (new nil)) @@ -311,7 +311,7 @@ first." (- (match-end 0) (match-beginning 0) 1))) (skip (org-num--skip-value)) (numbering (org-num--current-numbering level skip))) - ;; Apply numbering to current headline. Store overlay for + ;; Apply numbering to current heading. Store overlay for ;; the return value. (push (org-num--make-overlay numbering level skip) new))) @@ -399,16 +399,16 @@ See this variable for the meaning of BEG and END." ;; to an indirect change. That happens when the skip value -- ;; see `org-num--skip-value' -- of the heading BEG belongs to ;; is altered, or when deleting the newline character right - ;; before the next headline. + ;; before the next heading. (save-excursion - ;; Bail out if we're before first headline or within - ;; a headline too deep to be numbered. + ;; Bail out if we're before first heading or within + ;; a heading too deep to be numbered. (when (and (org-with-limited-levels (ignore-errors (org-back-to-heading t))) (looking-at regexp)) (pcase (get-char-property-and-overlay (point) 'org-num) (`(nil) - ;; At a headline, without a numbering overlay: change + ;; At a heading, without a numbering overlay: change ;; just created one. Mark it for parsing. (setq org-num--missing-overlay (point))) (`(t . ,o) @@ -426,7 +426,7 @@ See this variable for the meaning of BEG and END." (_ nil))) ;; Second, if nothing is marked as invalid, and therefore if ;; no full update is due so far, changes may still have - ;; created new headlines, at BEG -- which is actually handled + ;; created new headings, at BEG -- which is actually handled ;; by the previous phase --, or, in case of a multi-line ;; insertion, at END, or in-between. (unless (or org-num--invalid-flag @@ -434,10 +434,10 @@ See this variable for the meaning of BEG and END." (<= end (line-end-position))) ;single line change (forward-line) (when (or (re-search-forward regexp end 'move) - ;; Check if change created a headline after END. + ;; Check if change created a heading after END. (progn (skip-chars-backward "*") (looking-at regexp))) (setq org-num--missing-overlay (line-beginning-position)))))) - ;; Update numbering only if a headline was altered or created. + ;; Update numbering only if a heading was altered or created. (when (or org-num--missing-overlay org-num--invalid-flag) (org-num--update)))) diff --git a/lisp/org-pcomplete.el b/lisp/org-pcomplete.el index b31dc333f..c92144560 100644 --- a/lisp/org-pcomplete.el +++ b/lisp/org-pcomplete.el @@ -106,14 +106,14 @@ The return value is a string naming the thing at point." (skip-chars-backward "a-zA-Z") (char-before))) (cons "tex" nil)) - ;; Tags on a headline. + ;; Tags on a heading. ((and (org-match-line (format "\\*+ \\(?:.+? \\)?\\(:\\)\\(\\(?::\\|%s\\)+\\)?[ \t]*$" org-tag-re)) (or (org-point-in-group (point) 2) (= (point) (match-end 1)))) (cons "tag" nil)) - ;; TODO keywords on an empty headline. + ;; TODO keywords on an empty heading. ((and (string-match "^\\*+ +\\S-*$" line-to-here) (looking-at-p "[ \t]*$")) (cons "todo" nil)) diff --git a/lisp/org-refile.el b/lisp/org-refile.el index 678759e10..e5908e9d8 100644 --- a/lisp/org-refile.el +++ b/lisp/org-refile.el @@ -550,7 +550,7 @@ prefix argument (`C-u C-u C-u C-c C-w')." (org-paste-subtree level nil nil t) ;; Record information, according to `org-log-refile'. ;; Do not prompt for a note when refiling multiple - ;; headlines, however. Simply add a time stamp. + ;; headings, however. Simply add a time stamp. (cond ((not org-log-refile)) (regionp diff --git a/lisp/org.el b/lisp/org.el index 18cb53af6..01d15aa91 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -574,7 +574,7 @@ Group 1 contains drawer's name or \"END\".") org-clock-drawer-end-re "\\)\n?") "Matches an entire clock drawer.") -;;;; Headline +;;;; Heading (defconst org-heading-keyword-regexp-format "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$" @@ -1199,7 +1199,7 @@ or context. Valid contexts are Allowed visibility spans are - minimal show current headline; if point is not on headline, + minimal show current headline; if point is not on heading, also show entry local show current headline, entry and next headline @@ -1210,11 +1210,11 @@ Allowed visibility spans are ancestors-full show current subtree and its direct ancestors lineage show current headline, its direct ancestors and all - their children; if point is not on headline, also show + their children; if point is not on heading, also show entry and first child tree show current headline, its direct ancestors and all - their children; if point is not on headline, also show + their children; if point is not on heading, also show entry and all children canonical show current headline, its direct ancestors along with @@ -4046,7 +4046,7 @@ STATE should be one of the symbols listed in the docstring of (let ((case-fold-search nil) (re (concat org-outline-regexp-bol ".*:" org-archive-tag ":"))) (goto-char beg) - ;; Include headline point is currently on. + ;; Include heading point is currently on. (beginning-of-line) (while (and (< (point) end) (re-search-forward re end t)) (when (member org-archive-tag (org-get-tags nil t)) @@ -5084,8 +5084,8 @@ stacked delimiters is N. Escaping delimiters is not possible." (not (and (equal marker "+") (org-match-line "[ \t]*\\(|[-+]+|?\\|\\+[-+]+\\+\\)[ \t]*$"))) - ;; Do not match headline stars. Do not consider - ;; stars of a headline as closing marker for bold + ;; Do not match heading stars. Do not consider + ;; stars of a heading as closing marker for bold ;; markup either. (not (and (equal marker "*") (save-excursion @@ -5669,7 +5669,7 @@ needs to be inserted at a specific position in the font-lock sequence.") (list ;; Call the hook '(org-font-lock-hook) - ;; Headlines + ;; Headings `(,(if org-fontify-whole-heading-line "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)" "^\\(\\**\\)\\(\\* \\)\\(.*\\)") @@ -6050,9 +6050,9 @@ open and agenda-wise Org files." (set-window-start window (line-beginning-position)))))) -;;; Visibility (headlines, blocks, drawers) +;;; Visibility (headings, blocks, drawers) -;;;; Headlines visibility +;;;; Headings visibility (defun org-show-entry () "Show the body directly following its heading. @@ -6425,7 +6425,7 @@ Use `\\[org-edit-special]' to edit table.el tables")) (call-interactively #'org-table-next-field))) ((run-hook-with-args-until-success 'org-tab-after-check-for-table-hook)) - ;; At an item/headline: delegate to `org-cycle-internal-local'. + ;; At an item/heading: delegate to `org-cycle-internal-local'. ((and (or (and org-cycle-include-plain-lists (let ((item (org-element-lineage element '(item plain-list) @@ -6499,7 +6499,7 @@ Use `\\[org-edit-special]' to edit table.el tables")) (defun org-cycle-internal-local () "Do the local cycling action." (let ((goal-column 0) eoh eol eos has-children children-skipped struct) - ;; First, determine end of headline (EOH), end of subtree or item + ;; First, determine end of heading (EOH), end of subtree or item ;; (EOS), and if item or heading has children (HAS-CHILDREN). (save-excursion (if (org-at-item-p) @@ -6815,7 +6815,7 @@ be shown." DETAIL is either nil, `minimal', `local', `ancestors', `ancestors-full', `lineage', `tree', `canonical' or t. See `org-show-context-detail' for more information." - ;; Show current heading and possibly its entry, following headline + ;; Show current heading and possibly its entry, following heading ;; or all children. (if (and (org-at-heading-p) (not (eq detail 'local))) (org-flag-heading nil) @@ -6963,7 +6963,7 @@ frame is not changed." ;;;; Structure editing -;;; Inserting headlines +;;; Inserting headings (defun org--blank-before-heading-p (&optional parent) "Non-nil when an empty line should precede a new heading here. @@ -7029,9 +7029,9 @@ unconditionally." (and (not invisible-ok) (invisible-p (max (1- (point)) (point-min))))) ;; Position point at the location of insertion. Make sure we - ;; end up on a visible headline if INVISIBLE-OK is nil. + ;; end up on a visible heading if INVISIBLE-OK is nil. (org-with-limited-levels - (if (not level) (outline-next-heading) ;before first headline + (if (not level) (outline-next-heading) ;before first heading (org-back-to-heading invisible-ok) (when (equal arg '(16)) (org-up-heading-safe)) (org-end-of-subtree))) @@ -7047,14 +7047,14 @@ unconditionally." (unless (and blank? (org-previous-line-empty-p)) (org-N-empty-lines-before-current (if blank? 1 0))) (insert stars " ") - ;; When INVISIBLE-OK is non-nil, ensure newly created headline + ;; When INVISIBLE-OK is non-nil, ensure newly created heading ;; is visible. (unless invisible-ok (pcase (get-char-property-and-overlay (point) 'invisible) (`(outline . ,o) (move-overlay o (overlay-start o) (line-end-position 0))) (_ nil)))) - ;; At a headline... + ;; At a heading... ((org-at-heading-p) (cond ((bolp) (when blank? (save-excursion (insert "\n"))) @@ -7065,7 +7065,7 @@ unconditionally." ((and (org-get-alist-option org-M-RET-may-split-line 'headline) (org-match-line org-complex-heading-regexp) (org-pos-in-match-range (point) 4)) - ;; Grab the text that should moved to the new headline. + ;; Grab the text that should moved to the new heading. ;; Preserve tags. (let ((split (delete-and-extract-region (point) (match-end 4)))) (if (looking-at "[ \t]*$") (replace-match "") @@ -7078,7 +7078,7 @@ unconditionally." (end-of-line) (when blank? (insert "\n")) (insert "\n" stars " ")))) - ;; On regular text, turn line into a headline or split, if + ;; On regular text, turn line into a heading or split, if ;; appropriate. ((bolp) (insert stars " ") @@ -7397,7 +7397,7 @@ After top level, it switches back to sibling level." (let ((cur-level (org-current-level)) (prev-level (org-get-previous-line-level))) (cond - ;; If first headline in file, promote to top-level. + ;; If first heading in file, promote to top-level. ((= prev-level 0) (cl-loop repeat (/ (- cur-level 1) (org-level-increment)) do (org-do-promote))) @@ -7516,7 +7516,7 @@ Assume point is at a heading or an inlinetask beginning." (goto-char (org-element-property :end e)))))) ((looking-at-p org-outline-regexp) (forward-line)) ;; Give up if shifting would move before column 0 or - ;; if it would introduce a headline or a footnote + ;; if it would introduce a heading or a footnote ;; definition. (t (skip-chars-forward " \t") @@ -7773,7 +7773,7 @@ When REMOVE is non-nil, remove the subtree from the clipboard." (cond (level (prefix-numeric-value level)) ;; When point is after the stars in an otherwise empty - ;; headline, use the number of stars as the forced level. + ;; heading, use the number of stars as the forced level. ((and (org-match-line "^\\*+[ \t]*$") (not (eq ?* (char-after)))) (org-outline-level)) @@ -7801,7 +7801,7 @@ When REMOVE is non-nil, remove the subtree from the clipboard." (when (and force-level (not level)) (delete-region (line-beginning-position) (point))) ;; Paste before the next visible heading or at end of buffer, - ;; unless point is at the beginning of a headline. + ;; unless point is at the beginning of a heading. (unless (and (bolp) (org-at-heading-p)) (org-next-visible-heading 1) (unless (bolp) (insert "\n"))) @@ -8276,7 +8276,7 @@ function is being called interactively." (setq start (point))) ((or (org-at-heading-p) (ignore-errors (progn (org-back-to-heading) t))) - ;; we will sort the children of the current headline + ;; we will sort the children of the current heading (org-back-to-heading) (setq start (point) end (progn (org-end-of-subtree t t) @@ -8980,7 +8980,7 @@ a link." ;; looks like a link under point in some specific places. ((memq type '(comment comment-block node-property keyword)) (call-interactively #'org-open-at-point-global)) - ;; On a headline or an inlinetask, but not on a timestamp, + ;; On a heading or an inlinetask, but not on a timestamp, ;; a link, a footnote reference or a citation. ((memq type '(headline inlinetask)) (org-match-line org-complex-heading-regexp) @@ -9919,7 +9919,7 @@ When called through ELisp, arg is also interpreted in the following way: ;; Do we need to trigger a repeat? (when now-done-p (when (boundp 'org-agenda-headline-snapshot-before-repeat) - ;; This is for the agenda, take a snapshot of the headline. + ;; This is for the agenda, take a snapshot of the heading. (save-match-data (setq org-agenda-headline-snapshot-before-repeat (org-get-heading)))) @@ -10158,10 +10158,10 @@ statistics everywhere." ;; Three situations are to consider: ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up - ;; to the top-level ancestor on the headline; + ;; to the top-level ancestor on the heading; ;; 2. If parent has "recursive" property, repeat up to the - ;; headline setting that property, taking inheritance into + ;; heading setting that property, taking inheritance into ;; account; ;; 3. Else, move up to direct parent and proceed only once. @@ -11530,7 +11530,7 @@ headlines matching this string." (setq tags (org-split-string tags ":") tags-alist (cons (cons level tags) tags-alist))) - ;; compile tags for current headline + ;; compile tags for current heading (setq tags-list (if org-use-tag-inheritance (apply 'append (mapcar 'cdr (reverse tags-alist))) @@ -11569,7 +11569,7 @@ headlines matching this string." (or (not org-agenda-tags-todo-honor-ignore-options) (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item)))))) - ;; select this headline + ;; select this heading (cond ((eq action 'sparse-tree) (and org-highlight-sparse-tree-matches @@ -12131,7 +12131,7 @@ This function assumes point is on a headline." (line-end-position))) (skip-chars-backward " \t") (delete-region (point) (line-end-position)) - ;; Deleting white spaces may break an otherwise empty headline. + ;; Deleting white spaces may break an otherwise empty heading. ;; Re-introduce one space in this case. (unless (org-at-heading-p) (insert " ")) (when tags @@ -12951,7 +12951,7 @@ strings." (when (= (length ts) 2) (throw 'next ts))))) ts))))) (goto-char beg) - ;; First look for timestamps within headline. + ;; First look for timestamps within heading. (let ((ts (funcall find-ts (line-end-position) nil))) (if (= (length ts) 2) (setq props (nconc ts props)) ;; Then find timestamps in the section, skipping @@ -13305,7 +13305,7 @@ COLUMN formats in the current buffer." ;; It can happen, for example, in the following ;; situation: ;; - ;; * Headline + ;; * Heading ;; :PROPERTIES: ;; ... ;; :END: @@ -15790,7 +15790,7 @@ It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is ;; Before any word on the line: No expansion possible. ((save-excursion (skip-chars-backward " \t") (bolp)) nil) ;; Just after first word on the line: Expand it. Make sure it - ;; cannot happen on headlines, though. + ;; cannot happen on headings, though. ((save-excursion (skip-chars-backward "a-zA-Z0-9*") (skip-chars-backward " \t") @@ -17948,7 +17948,7 @@ region." (beginning-of-line (if arg 1 0)) (let ((case-fold-search nil)) (looking-at org-complex-heading-regexp))) - ;; At headline. + ;; At heading. (let ((tags-column (when (match-beginning 5) (save-excursion (goto-char (match-beginning 5)) (current-column)))) @@ -18040,9 +18040,9 @@ object (e.g., within a comment). In these case, you need to use ((and (not (bolp)) (let ((case-fold-search nil)) (org-match-line org-complex-heading-regexp))) - ;; At headline. Split line. However, if point is on keyword, + ;; At heading. Split line. However, if point is on keyword, ;; priority cookie or tags, do not break any of them: add - ;; a newline after the headline instead. + ;; a newline after the heading instead. (let ((tags-column (and (match-beginning 5) (save-excursion (goto-char (match-beginning 5)) (current-column)))) @@ -18188,7 +18188,7 @@ number of stars to add." (looking-at org-outline-regexp) (replace-match "") (setq toggled t)) (forward-line))) - ;; Case 2. Started at an item: change items into headlines. + ;; Case 2. Started at an item: change items into headings. ;; One star will be added by `org-list-to-subtree'. ((org-at-item-p) (while (< (point) end) @@ -18208,7 +18208,7 @@ number of stars to add." (setq toggled t)) (forward-line))) ;; Case 3. Started at normal text: make every line an heading, - ;; skipping headlines and items. + ;; skipping headings and items. (t (let* ((stars (make-string (if (numberp nstars) nstars (or (org-current-level) 0)) ?*)) @@ -19726,7 +19726,7 @@ region only contains such lines." ;; Remove fixed width marker only in a fixed-with element. ;; ;; Add fixed width maker in paragraphs, in blank lines after - ;; elements or at the beginning of a headline or an inlinetask, + ;; elements or at the beginning of a heading or an inlinetask, ;; and before any one-line elements (e.g., a clock). (progn (beginning-of-line) @@ -20211,7 +20211,7 @@ With argument N not nil or 1, move forward N - 1 lines first." ;; out. ((and (bound-and-true-p visual-line-mode) (not (bolp)))) ((let ((case-fold-search nil)) (looking-at org-complex-heading-regexp)) - ;; At a headline, special position is before the title, but + ;; At a heading, special position is before the title, but ;; after any TODO keyword or priority cookie. (let ((refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1))) (line-end-position))) @@ -20261,7 +20261,7 @@ With argument N not nil or 1, move forward N - 1 lines first." (beginning-of-visual-line n) (move-beginning-of-line n)) (cond - ;; At a headline, with tags. + ;; At a heading, with tags. ((and special (save-excursion (beginning-of-line) @@ -20277,7 +20277,7 @@ With argument N not nil or 1, move forward N - 1 lines first." (end-of-visual-line) (point))))) ;; If `end-of-visual-line' brings us before end of line or - ;; even tags, i.e., the headline spans over multiple visual + ;; even tags, i.e., the heading spans over multiple visual ;; lines, move there. (cond ((and visual-end (< visual-end tags) @@ -20732,7 +20732,7 @@ If there is no such heading, return nil." "Goto to the end of a subtree." ;; This contains an exact copy of the original function, but it uses ;; `org-back-to-heading-or-point-min', to make it work also in invisible - ;; trees and before first headline. And is uses an invisible-ok argument. + ;; trees and before first heading. And is uses an invisible-ok argument. ;; Under Emacs this is not needed, but the old outline.el needs this fix. ;; Furthermore, when used inside Org, finding the end of a large subtree ;; with many children and grandchildren etc, this can be much faster @@ -20821,7 +20821,7 @@ non-nil it will also look at invisible ones." (if (org-before-first-heading-p) (if backward? (goto-char (point-min)) (outline-next-heading)) (org-back-to-heading invisible-ok) - (unless backward? (end-of-line)) ;do not match current headline + (unless backward? (end-of-line)) ;do not match current heading (let ((level (- (match-end 0) (match-beginning 0) 1)) (f (if backward? #'re-search-backward #'re-search-forward)) (count (if arg (abs arg) 1)) @@ -21127,7 +21127,7 @@ See `org-backward-paragraph'." ;; There is a blank line above. Move there. ((and (org-previous-line-empty-p) (let ((lep (line-end-position 0))) - ;; When the first headline start at point 2, don't choke while + ;; When the first heading start at point 2, don't choke while ;; checking with `org-invisible-p'. (or (= lep 1) (not (org-invisible-p (1- (line-end-position 0))))))) @@ -21209,11 +21209,11 @@ Move to the previous element at the same level, when possible." (interactive) (cond ((bobp) (user-error "Cannot move further up")) ((org-with-limited-levels (org-at-heading-p)) - ;; At a headline, move to the previous one, if any, or stay + ;; At a heading, move to the previous one, if any, or stay ;; here. (let ((origin (point))) (org-with-limited-levels (org-backward-heading-same-level 1)) - ;; When current headline has no sibling above, move to its + ;; When current heading has no sibling above, move to its ;; parent. (when (= (point) origin) (or (org-with-limited-levels (org-up-heading-safe)) @@ -21270,7 +21270,7 @@ Move to the previous element at the same level, when possible." (user-error "No element at point")))) (if (eq (org-element-type elem) 'headline) ;; Preserve point when moving a whole tree, even if point was - ;; on blank lines below the headline. + ;; on blank lines below the heading. (let ((offset (skip-chars-backward " \t\n"))) (unwind-protect (org-move-subtree-up) (forward-char (- offset)))) diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el index 2e91c7fea..a18cf5e31 100644 --- a/lisp/ox-ascii.el +++ b/lisp/ox-ascii.el @@ -44,7 +44,7 @@ ;; overriding `org-ascii-charset' variable on the fly by the ext-plist ;; mechanism. ;; -;; We also install a filter for headlines and sections, in order to +;; We also install a filter for headings and sections, in order to ;; control blank lines separating them in output string. (org-export-define-backend 'ascii @@ -435,7 +435,7 @@ nil to ignore the inline task." ;; `org-ascii--list-tables' does the same for table elements. ;; The third category includes general helper functions. -;; `org-ascii--build-title' creates the title for a given headline +;; `org-ascii--build-title' creates the title for a given heading ;; or inlinetask element. `org-ascii--build-caption' returns the ;; caption string associated to a table or a src-block. ;; `org-ascii--describe-links' creates notes about links for @@ -577,12 +577,12 @@ INFO is a plist used as a communication channel." (plist-get info :ascii-global-margin) (let ((parent (org-export-get-parent-headline element))) ;; Inner margin doesn't apply to text before first - ;; headline. + ;; heading. (if (not parent) 0 (let ((low-level-rank (org-export-low-level-p parent info))) ;; Inner margin doesn't apply to contents of - ;; low level headlines, since they've got their + ;; low level headings, since they've got their ;; own indentation mechanism. (if low-level-rank (* low-level-rank 2) (plist-get info :ascii-inner-margin))))))))) @@ -656,7 +656,7 @@ When optional argument TOC is non-nil, use optional title if possible. It doesn't apply to `inlinetask' elements." (let* ((headlinep (eq (org-element-type element) 'headline)) (numbers - ;; Numbering is specific to headlines. + ;; Numbering is specific to headings. (and headlinep (org-export-numbered-headline-p element info) (let ((numbering (org-export-get-headline-number element info))) @@ -882,7 +882,7 @@ is a plist used as a communication channel." (push footprint seen) link))))) (org-element-map (if (eq (org-element-type element) 'section) element - ;; In a headline, only retrieve links in title + ;; In a heading, only retrieve links in title ;; and relative section, not in children. (list (org-element-property :title element) (car (org-element-contents element)))) @@ -1295,7 +1295,7 @@ CONTENTS is nil. INFO is a plist holding contextual information." (format "[%s]" (org-export-get-footnote-number footnote-reference info))) -;;;; Headline +;;;; Heading (defun org-ascii-headline (headline contents info) "Transcode a HEADLINE element from Org to ASCII. @@ -1309,7 +1309,7 @@ holding contextual information." ;; Export title early so that any link in it can be ;; exported and seen in `org-ascii--unique-links'. (title (org-ascii--build-title headline info width (not low-level))) - ;; Blank lines between headline and its contents. + ;; Blank lines between heading and its contents. ;; `org-ascii-headline-spacing', when set, overwrites ;; original buffer's spacing. (pre-blanks @@ -1346,7 +1346,7 @@ holding contextual information." (concat bullet title "\n" pre-blanks ;; Contents, indented by length of bullet. (org-ascii--indent-string body (length bullet)))) - ;; Else: Standard headline. + ;; Else: Standard heading. (concat title "\n" pre-blanks body))))) @@ -1753,7 +1753,7 @@ contextual information." (org-ascii--indent-string (if (not (org-string-nw-p links)) contents (concat (org-element-normalize-string contents) "\n\n" links)) - ;; Do not apply inner margin if parent headline is low level. + ;; Do not apply inner margin if parent heading is low level. (let ((headline (org-export-get-parent-headline section))) (if (or (not headline) (org-export-low-level-p headline info)) 0 (plist-get info :ascii-inner-margin)))))) diff --git a/lisp/ox-beamer.el b/lisp/ox-beamer.el index c9a67f891..dd7c3555c 100644 --- a/lisp/ox-beamer.el +++ b/lisp/ox-beamer.el @@ -305,13 +305,13 @@ channel." value)))) -;;;; Headline +;;;; Heading ;; -;; The main function to translate a headline is +;; The main function to translate a heading is ;; `org-beamer-headline'. ;; -;; Depending on the level at which a headline is considered as -;; a frame (given by `org-beamer--frame-level'), the headline is +;; Depending on the level at which a heading is considered as +;; a frame (given by `org-beamer--frame-level'), the heading is ;; either a section (`org-beamer--format-section'), a frame ;; (`org-beamer--format-frame') or a block ;; (`org-beamer--format-block'). @@ -353,7 +353,7 @@ INFO is a plist used as a communication channel." (let ((env (org-element-property :BEAMER_ENV parent))) (when (and env (member-ignore-case env '("frame" "fullframe"))) (throw 'exit (org-export-get-relative-level parent info)))))) - ;; 2. Look for "frame" environment in HEADLINE. + ;; 2. Look for "frame" environment in HEADING. (let ((env (org-element-property :BEAMER_ENV headline))) (and env (member-ignore-case env '("frame" "fullframe")) (org-export-get-relative-level headline info))) @@ -406,7 +406,7 @@ used as a communication channel." CONTENTS holds the contents of the headline. INFO is a plist used as a communication channel." (let ((fragilep - ;; FRAGILEP is non-nil when HEADLINE contains an element + ;; FRAGILEP is non-nil when HEADING contains an element ;; among `org-beamer-verbatim-elements'. (org-element-map headline org-beamer-verbatim-elements 'identity info 'first-match))) @@ -424,7 +424,7 @@ used as a communication channel." (let* ((beamer-opt (org-element-property :BEAMER_OPT headline)) (options ;; Collect nonempty options from default value and - ;; headline's properties. + ;; heading's properties. (cl-remove-if-not #'org-string-nw-p (append (org-split-string @@ -510,8 +510,8 @@ used as a communication channel." (org-beamer--normalize-argument raw-options 'option) "")) ;; Start a "columns" environment when explicitly requested or - ;; when there is no previous headline or the previous - ;; headline do not have a BEAMER_column property. + ;; when there is no previous heading or the previous + ;; heading do not have a BEAMER_column property. (parent-env (org-element-property :BEAMER_ENV (org-export-get-parent-headline headline))) (start-columns-p @@ -525,7 +525,7 @@ used as a communication channel." (org-export-get-previous-element headline info))))))) ;; End the "columns" environment when explicitly requested or - ;; when there is no next headline or the next headline do not + ;; when there is no next heading or the next heading do not ;; have a BEAMER_column property. (end-columns-p (or (equal environment "columns") @@ -545,7 +545,7 @@ used as a communication channel." (when column-width (format "\\begin{column}%s{%s}\n" ;; One can specify placement for column only when - ;; HEADLINE stands for a column on its own. + ;; HEADING stands for a column on its own. (if (equal environment "column") options "") (format "%s\\columnwidth" column-width))) ;; Block's opening string. @@ -600,7 +600,7 @@ as a communication channel." ((equal environment "againframe") (let ((ref (org-element-property :BEAMER_REF headline))) ;; Reference to frame being resumed is mandatory. Ignore - ;; the whole headline if it isn't provided. + ;; the whole heading if it isn't provided. (when (org-string-nw-p ref) (concat "\\againframe" ;; Overlay specification. @@ -625,12 +625,12 @@ as a communication channel." info) (org-export-resolve-fuzzy-link `(link (:path - ;; Look for headlines only. + ;; Look for headings only. ,(if (eq (string-to-char ref) ?*) ref (concat "*" ref)))) info)))) ;; Now use user-defined label provided in TARGET - ;; headline, or fallback to standard one. + ;; heading, or fallback to standard one. (format "{%s}" (org-beamer--get-label target info))))))) ;; Case 2: Creation of an appendix is requested. ((equal environment "appendix") @@ -643,7 +643,7 @@ as a communication channel." ((equal environment "ignoreheading") (concat (make-string (org-element-property :pre-blank headline) ?\n) contents)) - ;; Case 4: HEADLINE is a note. + ;; Case 4: HEADING is a note. ((member environment '("note" "noteNH")) (concat "\\note" ;; Overlay specification. @@ -661,14 +661,14 @@ as a communication channel." info) "\n")) (org-trim contents))))) - ;; Case 5: HEADLINE is a frame. + ;; Case 5: HEADING is a frame. ((= level frame-level) (org-beamer--format-frame headline contents info)) ;; Case 6: Regular section, extracted from ;; `org-latex-classes'. ((< level frame-level) (org-beamer--format-section headline contents info)) - ;; Case 7: Otherwise, HEADLINE is a block. + ;; Case 7: Otherwise, HEADING is a block. (t (org-beamer--format-block headline contents info)))))) @@ -709,7 +709,7 @@ CONTENTS is nil. INFO is a plist used as a communication channel." (let ((key (org-element-property :key keyword)) (value (org-element-property :value keyword))) - ;; Handle specifically BEAMER and TOC (headlines only) keywords. + ;; Handle specifically BEAMER and TOC (headings only) keywords. ;; Otherwise, fallback to `latex' back-end. (cond ((equal key "BEAMER") value) @@ -829,7 +829,7 @@ holding export options." (:beamer-inner-theme "\\useinnertheme") (:beamer-outer-theme "\\useoutertheme")) "")) - ;; Possibly limit depth for headline numbering. + ;; Possibly limit depth for heading numbering. (let ((sec-num (plist-get info :section-numbers))) (when (integerp sec-num) (format "\\setcounter{secnumdepth}{%d}\n" sec-num))) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index a150b1fdb..163d96ade 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -689,7 +689,7 @@ by the footnotes themselves." :group 'org-export-html :type 'string) -;;;; Headline +;;;; Heading (defcustom org-html-toplevel-hlevel 2 "The level for level 1 headings in HTML export. @@ -2599,7 +2599,7 @@ CONTENTS is nil. INFO is a plist holding contextual information." (org-html--anchor id n (format " class=\"footref\" href=\"#fn.%d\" role=\"doc-backlink\"" n) info))))) -;;;; Headline +;;;; Heading (defun org-html-headline (headline contents info) "Transcode a HEADLINE element from Org to HTML. @@ -2640,7 +2640,7 @@ holding contextual information." (concat (org-html--anchor id nil nil info) formatted-text)) "\n" (and (org-export-last-sibling-p headline info) (format "\n" html-type)))) - ;; Standard headline. Export it as a section. + ;; Standard heading. Export it as a section. (let ((extra-class (org-element-property :HTML_CONTAINER_CLASS headline)) (headline-class @@ -3092,7 +3092,7 @@ INFO is a plist holding contextual information. See ;; Maybe turn ".org" into ".html". (setq raw-path (funcall link-org-files-as-html-maybe raw-path info)) ;; Add search option, if any. A search option can be - ;; relative to a custom-id, a headline title, a name or + ;; relative to a custom-id, a heading title, a name or ;; a target. (let ((option (org-element-property :search-option link))) (if (not option) raw-path @@ -3140,7 +3140,7 @@ INFO is a plist holding contextual information. See (org-export-get-reference destination info) attributes desc)))) - ;; Links pointing to a headline: Find destination and build + ;; Links pointing to a heading: Find destination and build ;; appropriate referencing command. ((member type '("custom-id" "fuzzy" "id")) (let ((destination (if (string= type "fuzzy") @@ -3161,21 +3161,21 @@ INFO is a plist holding contextual information. See (or desc (org-export-data (org-element-property :raw-link link) info)))) - ;; Link points to a headline. + ;; Link points to a heading. (`headline (let ((href (org-html--reference destination info)) ;; What description to use? (desc - ;; Case 1: Headline is numbered and LINK has no + ;; Case 1: Heading is numbered and LINK has no ;; description. Display section number. (if (and (org-export-numbered-headline-p destination info) (not desc)) (mapconcat #'number-to-string (org-export-get-headline-number destination info) ".") - ;; Case 2: Either the headline is un-numbered or + ;; Case 2: Either the heading is un-numbered or ;; LINK has a custom description. Display LINK's - ;; description or headline's title. + ;; description or heading's title. (or desc (org-export-data (org-element-property :title destination) info))))) @@ -3415,7 +3415,7 @@ holding contextual information." CONTENTS holds the contents of the section. INFO is a plist holding contextual information." (let ((parent (org-export-get-parent-headline section))) - ;; Before first headline: no container, just return CONTENTS. + ;; Before first heading: no container, just return CONTENTS. (if (not parent) contents ;; Get div's class and id references. (let* ((class-num (+ (org-export-get-relative-level parent info) diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el index 80ce0a8ce..e82a55645 100644 --- a/lisp/ox-icalendar.el +++ b/lisp/ox-icalendar.el @@ -525,10 +525,10 @@ BACK-END and INFO are ignored." ;;; Transcode Functions -;;;; Headline and Inlinetasks +;;;; Heading and Inlinetasks ;; The main function is `org-icalendar-entry', which extracts -;; information from a headline or an inlinetask (summary, +;; information from a heading or an inlinetask (summary, ;; description...) and then delegates code generation to ;; `org-icalendar--vtodo' and `org-icalendar--vevent', depending ;; on the component needed. @@ -550,7 +550,7 @@ inlinetask within the section." (unless (org-element-property :footnote-section-p entry) (let* ((type (org-element-type entry)) ;; Determine contents really associated to the entry. For - ;; a headline, limit them to section, if any. For an + ;; a heading, limit them to section, if any. For an ;; inlinetask, this is every element within the task. (inside (if (eq type 'inlinetask) @@ -575,7 +575,7 @@ inlinetask within the section." :CLASS entry (org-property-inherit-p "CLASS")))) ;; Build description of the entry from associated section - ;; (headline) or contents (inlinetask). + ;; (heading) or contents (inlinetask). (desc (org-icalendar-cleanup-string (or (org-element-property :DESCRIPTION entry) @@ -618,7 +618,7 @@ inlinetask within the section." (org-icalendar--vevent entry scheduled (concat "SC-" uid) (concat "S: " summary) loc desc cat tz class))) - ;; When collecting plain timestamps from a headline and its + ;; When collecting plain timestamps from a heading and its ;; title, skip inlinetasks since collection will happen once ;; ENTRY is one of them. (let ((counter 0)) @@ -652,7 +652,7 @@ inlinetask within the section." (org-icalendar--vtodo entry uid summary loc desc cat tz class)) ;; Diary-sexp: Collect every diary-sexp element within ENTRY ;; and its title, and transcode them. If ENTRY is - ;; a headline, skip inlinetasks: they will be handled + ;; a heading, skip inlinetasks: they will be handled ;; separately. (when org-icalendar-include-sexps (let ((counter 0)) @@ -668,7 +668,7 @@ inlinetask within the section." summary)) info nil (and (eq type 'headline) 'inlinetask)) ""))))) - ;; If ENTRY is a headline, call current function on every + ;; If ENTRY is a heading, call current function on every ;; inlinetask within it. In agenda export, this is independent ;; from the mark (or lack thereof) on the entry. (when (eq type 'headline) diff --git a/lisp/ox-koma-letter.el b/lisp/ox-koma-letter.el index 6a895a6a2..6cb8e0cda 100644 --- a/lisp/ox-koma-letter.el +++ b/lisp/ox-koma-letter.el @@ -53,7 +53,7 @@ ;; be specified using "special headings" with the special tags ;; specified in `org-koma-letter-special-tags-in-letter'. LaTeX line ;; breaks are not necessary for TO_ADDRESS, FROM_ADDRESS and LOCATION. -;; If both a headline and a keyword specify a to or from address the +;; If both a heading and a keyword specify a to or from address the ;; value is determined in accordance with ;; `org-koma-letter-prefer-special-headings'. ;; @@ -117,17 +117,17 @@ ;; \includegraphics{logo.pdf} ;; \includegraphics{logo.png} ;; -;; Headlines are in general ignored. However, headlines with special +;; Headings are in general ignored. However, headings with special ;; tags can be used for specified contents like postscript (ps), ;; carbon copy (cc), enclosures (encl) and code to be inserted after ;; \end{letter} (after_letter). Specials tags are defined in ;; `org-koma-letter-special-tags-after-closing' and ;; `org-koma-letter-special-tags-after-letter'. Currently members of ;; `org-koma-letter-special-tags-after-closing' used as macros and the -;; content of the headline is the argument. +;; content of the heading is the argument. ;; -;; Headlines with to and from may also be used rather than the keyword -;; approach described above. If both a keyword and a headline with +;; Headings with to and from may also be used rather than the keyword +;; approach described above. If both a keyword and a heading with ;; information is present precedence is determined by ;; `org-koma-letter-prefer-special-headings'. ;; @@ -624,7 +624,7 @@ channel." (if (equal key "KOMA-LETTER") value (org-export-with-backend 'latex keyword contents info)))) -;; Headline +;; Heading (defun org-koma-letter-headline (headline contents info) "Transcode a HEADLINE element from Org to LaTeX. diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el index 3e3967033..17698601d 100644 --- a/lisp/ox-latex.el +++ b/lisp/ox-latex.el @@ -643,7 +643,7 @@ precedence over this variable." :type '(choice (const :tag "No template" nil) (string :tag "Format string"))) -;;;; Headline +;;;; Heading (defcustom org-latex-format-headline-function 'org-latex-format-headline-default-function @@ -1710,7 +1710,7 @@ holding export options." (org-latex--insert-compiler info) ;; Document class and packages. (org-latex-make-preamble info) - ;; Possibly limit depth for headline numbering. + ;; Possibly limit depth for heading numbering. (let ((sec-num (plist-get info :section-numbers))) (when (integerp sec-num) (format "\\setcounter{secnumdepth}{%d}\n" sec-num))) @@ -1947,7 +1947,7 @@ CONTENTS is nil. INFO is a plist holding contextual information." (org-latex--delayed-footnotes-definitions def info)))))))) -;;;; Headline +;;;; Heading (defun org-latex-headline (headline contents info) "Transcode a HEADLINE element from Org to LaTeX. @@ -2005,24 +2005,24 @@ holding contextual information." (org-export-get-tags headline info))) (priority (and (plist-get info :with-priority) (org-element-property :priority headline))) - ;; Create the headline text along with a no-tag version. + ;; Create the heading text along with a no-tag version. ;; The latter is required to remove tags from toc. (full-text (funcall (plist-get info :latex-format-headline-function) todo todo-type priority text tags info)) - ;; Associate \label to the headline for internal links. + ;; Associate \label to the heading for internal links. (headline-label (org-latex--label headline info t t)) (pre-blanks (make-string (org-element-property :pre-blank headline) ?\n))) (if (or (not section-fmt) (org-export-low-level-p headline info)) ;; This is a deep sub-tree: export it as a list item. Also - ;; export as items headlines for which no section format has + ;; export as items headings for which no section format has ;; been found. (let ((low-level-body (concat - ;; If headline is the first sibling, start a list. + ;; If heading is the first sibling, start a list. (when (org-export-first-sibling-p headline info) (format "\\begin{%s}\n" (if numberedp 'enumerate 'itemize))) - ;; Itemize headline + ;; Itemize heading "\\item" (and full-text (string-match-p "\\`[ \t]*\\[" full-text) @@ -2031,7 +2031,7 @@ holding contextual information." headline-label pre-blanks contents))) - ;; If headline is not the last sibling simply return + ;; If heading is not the last sibling simply return ;; LOW-LEVEL-BODY. Otherwise, also close the list, before ;; any blank line. (if (not (org-export-last-sibling-p headline info)) low-level-body @@ -2039,7 +2039,7 @@ holding contextual information." "[ \t\n]*\\'" (format "\n\\\\end{%s}" (if numberedp 'enumerate 'itemize)) low-level-body))) - ;; This is a standard headline. Export it as a section. Add + ;; This is a standard heading. Export it as a section. Add ;; an alternative heading when possible, and when this is not ;; identical to the usual heading. (let ((opt-title @@ -2597,7 +2597,7 @@ INFO is a plist holding contextual information. See (format "\\hyperref[%s]{%s}" (org-export-get-reference destination info) desc)))) - ;; Links pointing to a headline: Find destination and build + ;; Links pointing to a heading: Find destination and build ;; appropriate referencing command. ((member type '("custom-id" "fuzzy" "id")) (let ((destination @@ -2615,9 +2615,9 @@ INFO is a plist holding contextual information. See (or desc (org-export-data (org-element-property :raw-link link) info)))) - ;; LINK points to a headline. If headlines are numbered - ;; and the link has no description, display headline's - ;; number. Otherwise, display description or headline's + ;; LINK points to a heading. If headings are numbered + ;; and the link has no description, display heading's + ;; number. Otherwise, display description or heading's ;; title. (headline (let ((label (org-latex--label destination info t))) diff --git a/lisp/ox-man.el b/lisp/ox-man.el index 6d3476cda..b825dc67b 100644 --- a/lisp/ox-man.el +++ b/lisp/ox-man.el @@ -440,7 +440,7 @@ CONTENTS is nil. INFO is a plist holding contextual information." ;; Footnote References are Ignored -;;; Headline +;;; Heading (defun org-man-headline (headline contents info) "Transcode a HEADLINE element from Org to Man. @@ -462,19 +462,19 @@ holding contextual information." ((org-element-property :footnote-section-p headline) nil) ;; Case 2. This is a deep sub-tree: export it as a list item. - ;; Also export as items headlines for which no section + ;; Also export as items headings for which no section ;; format has been found. ((or (not section-fmt) (org-export-low-level-p headline info)) ;; Build the real contents of the sub-tree. (let ((low-level-body (concat - ;; If the headline is the first sibling, start a list. + ;; If the heading is the first sibling, start a list. (when (org-export-first-sibling-p headline info) (format "%s\n" ".RS")) - ;; Itemize headline + ;; Itemize heading ".TP\n.ft I\n" text "\n.ft\n" contents ".RE"))) - ;; If headline is not the last sibling simply return + ;; If heading is not the last sibling simply return ;; LOW-LEVEL-BODY. Otherwise, also close the list, before any ;; blank line. (if (not (org-export-last-sibling-p headline info)) low-level-body @@ -482,7 +482,7 @@ holding contextual information." "[ \t\n]*\\'" "" low-level-body)))) - ;; Case 3. Standard headline. Export it as a section. + ;; Case 3. Standard heading. Export it as a section. (t (format section-fmt text contents ))))) ;;; Horizontal Rule diff --git a/lisp/ox-md.el b/lisp/ox-md.el index 678edbbfd..5a407048a 100644 --- a/lisp/ox-md.el +++ b/lisp/ox-md.el @@ -165,11 +165,11 @@ INFO is a plist used as a communication channel. Links and table of contents can refer to headlines." (unless (org-element-property :footnote-section-p headline) (or - ;; Global table of contents includes HEADLINE. + ;; Global table of contents includes HEADING. (and (plist-get info :with-toc) (memq headline (org-export-collect-headlines info (plist-get info :with-toc)))) - ;; A local table of contents includes HEADLINE. + ;; A local table of contents includes HEADING. (cl-some (lambda (h) (let ((section (car (org-element-contents h)))) @@ -190,7 +190,7 @@ of contents can refer to headlines." info n (and local? keyword)))))))) info t)))) (org-element-lineage headline)) - ;; A link refers internally to HEADLINE. + ;; A link refers internally to HEADING. (org-element-map (plist-get info :parse-tree) 'link (lambda (link) (eq headline @@ -343,7 +343,7 @@ CONTENTS is nil. INFO is a plist holding contextual information." (org-export-with-backend 'html export-block contents info))) -;;;; Headline +;;;; Heading (defun org-md-headline (headline contents info) "Transcode HEADLINE element into Markdown format. @@ -364,11 +364,11 @@ a communication channel." (and (plist-get info :with-priority) (let ((char (org-element-property :priority headline))) (and char (format "[#%c] " char))))) - ;; Headline text without tags. + ;; Heading text without tags. (heading (concat todo priority title)) (style (plist-get info :md-headline-style))) (cond - ;; Cannot create a headline. Fall-back to a list. + ;; Cannot create a heading. Fall-back to a list. ((or (org-export-low-level-p headline info) (not (memq style '(atx setext))) (and (eq style 'atx) (> level 6)) diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el index f186ebb16..60660e9ab 100644 --- a/lisp/ox-odt.el +++ b/lisp/ox-odt.el @@ -650,7 +650,7 @@ The default value simply returns the value of CONTENTS." :type 'function) -;;;; Headline +;;;; Heading (defcustom org-odt-format-headline-function 'org-odt-format-headline-default-function @@ -1136,7 +1136,7 @@ a plist containing current export properties. Optional argument SCOPE, when non-nil, defines the scope of the table. Return the table of contents as a string, or nil." (cl-assert (wholenump depth)) - ;; When a headline is marked as a radio target, as in the example below: + ;; When a heading is marked as a radio target, as in the example below: ;; ;; ** <<>> ;; Some text. @@ -1748,7 +1748,7 @@ CONTENTS is nil. INFO is a plist holding contextual information." (funcall --format-footnote-definition n def)))))))) -;;;; Headline +;;;; Heading (defun org-odt-format-headline--wrap (headline backend info &optional format-function @@ -1797,7 +1797,7 @@ holding contextual information." ;; Get level relative to current parsed data. (level (org-export-get-relative-level headline info)) (numbered (org-export-numbered-headline-p headline info)) - ;; Get canonical label for the headline. + ;; Get canonical label for the heading. (id (org-export-get-reference headline info)) ;; Extra targets. (extra-targets @@ -1807,7 +1807,7 @@ holding contextual information." (anchored-title (org-odt--target full-text id))) (cond ;; Case 2. This is a deep sub-tree: export it as a list item. - ;; Also export as items headlines for which no section + ;; Also export as items headings for which no section ;; format has been found. ((org-export-low-level-p headline info) ;; Build the real contents of the sub-tree. @@ -1838,7 +1838,7 @@ holding contextual information." ""))) (and (org-export-last-sibling-p headline info) ""))) - ;; Case 3. Standard headline. Export it as a section. + ;; Case 3. Standard heading. Export it as a section. (t (concat (format @@ -2593,7 +2593,7 @@ Return nil, otherwise." (t nil)))))))) (defun org-odt-link--infer-description (destination info) - ;; DESTINATION is a headline or an element (like paragraph, + ;; DESTINATION is a heading or an element (like paragraph, ;; verse-block etc) to which a "#+NAME: label" can be attached. ;; Note that labels that are attached to captioned entities - inline @@ -2627,20 +2627,20 @@ Return nil, otherwise." 'ordered) (1+ (length (org-export-get-previous-element item info t)))))) - ;; Locate top-most listified headline. + ;; Locate top-most listified heading. (listified-headlines (cl-loop for x on data when (and (eq (org-element-type (car x)) 'headline) (org-export-low-level-p (car x) info)) return x)) - ;; Get listified headline numbers. + ;; Get listified heading numbers. (listified-headline-nos (cl-loop for el in listified-headlines when (eq (org-element-type el) 'headline) collect (when (org-export-numbered-headline-p el info) (1+ (length (org-export-get-previous-element el info t))))))) - ;; Combine item numbers from both the listified headlines and + ;; Combine item numbers from both the listified headings and ;; regular list items. ;; Case 1: Check if all the parents of list item are numbered. @@ -2652,11 +2652,11 @@ Return nil, otherwise." (mapconcat (lambda (n) (if (not n) " " (concat (number-to-string n) "."))) item-numbers ""))))) - ;; Case 2: Locate a regular and numbered headline in the + ;; Case 2: Locate a regular and numbered heading in the ;; hierarchy. Display its section number. (let ((headline (and - ;; Test if destination is a numbered headline. + ;; Test if destination is a numbered heading. (org-export-numbered-headline-p destination info) (cl-loop for el in (cons destination genealogy) when (and (eq (org-element-type el) 'headline) @@ -2669,7 +2669,7 @@ Return nil, otherwise." label (mapconcat 'number-to-string (org-export-get-headline-number headline info) ".")))) - ;; Case 4: Locate a regular headline in the hierarchy. Display + ;; Case 4: Locate a regular heading in the hierarchy. Display ;; its title. (let ((headline (cl-loop for el in (cons destination genealogy) when (and (eq (org-element-type el) 'headline) @@ -2722,14 +2722,14 @@ INFO is a plist holding contextual information. See "%s" (org-export-get-reference destination info) desc)))) - ;; Links pointing to a headline: Find destination and build + ;; Links pointing to a heading: Find destination and build ;; appropriate referencing command. ((member type '("custom-id" "fuzzy" "id")) (let ((destination (if (string= type "fuzzy") (org-export-resolve-fuzzy-link link info) (org-export-resolve-id-link link info)))) (cl-case (org-element-type destination) - ;; Fuzzy link points to a headline. If there's + ;; Fuzzy link points to a heading. If there's ;; a description, create a hyperlink. Otherwise, try to ;; provide a meaningful description. (headline @@ -3495,7 +3495,7 @@ pertaining to indentation here." parent-list info) '("" . "")) (t '("" . "")))))) - ;; Handle low-level headlines. + ;; Handle low-level headings. (cl-loop for el in llh-genealogy with step = 'item collect (cl-case step @@ -3568,10 +3568,10 @@ pertaining to indentation here." ;; account the following facts: ;; ;; - Description lists are simulated as plain lists. - ;; - Low-level headlines can be listified. + ;; - Low-level headings can be listified. ;; - In Org mode, a table can occur not only as a regular list ;; item, but also within description lists and low-level - ;; headlines. + ;; headings. ;; See `org-odt-translate-description-lists' and ;; `org-odt-translate-low-level-headlines' for how this is diff --git a/lisp/ox-org.el b/lisp/ox-org.el index 1b4654e36..3fe836e7e 100644 --- a/lisp/ox-org.el +++ b/lisp/ox-org.el @@ -218,7 +218,7 @@ a communication channel." (concat (org-element-normalize-string contents) ;; Insert footnote definitions appearing for the first time in this - ;; section, or in the relative headline title. Indeed, some of + ;; section, or in the relative heading title. Indeed, some of ;; them may not be available to narrowing so we make sure all of ;; them are included in the result. (let ((footnotes diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el index b6c804a83..774ad27e4 100644 --- a/lisp/ox-publish.el +++ b/lisp/ox-publish.el @@ -1125,7 +1125,7 @@ publishing directory." ;;; External Fuzzy Links Resolution ;; -;; This part implements tools to resolve [[file.org::*Some headline]] +;; This part implements tools to resolve [[file.org::*Some heading]] ;; links, where "file.org" belongs to the current project. (defun org-publish--store-crossrefs (output _backend info) diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index b0125894a..b0dad2541 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -209,7 +209,7 @@ section string and will be replaced by the title of the section." (string :tag "unnumbered-no-toc") (string :tag " appendix"))))))) -;;;; Headline +;;;; Heading (defcustom org-texinfo-format-headline-function 'org-texinfo-format-headline-default-function @@ -491,7 +491,7 @@ node or anchor name is unique." ;; node names collide -- e.g., they have the same title -- ;; within the same hierarchy, the second one would get the ;; smaller node name. This is counter-intuitive. - ;; Consequently, we ensure that every parent headline gets + ;; Consequently, we ensure that every parent heading gets ;; its node beforehand. As a recursive operation, this ;; achieves the desired effect. (let ((parent (org-element-lineage datum '(headline)))) @@ -577,7 +577,7 @@ INFO is a plist holding export options." CONTENTS is the transcoded contents string. INFO is a plist holding export options." (let ((title (org-export-data (plist-get info :title) info)) - ;; Copying data is the contents of the first headline in + ;; Copying data is the contents of the first heading in ;; parse tree with a non-nil copying property. (copying (org-element-map (plist-get info :parse-tree) 'headline (lambda (hl) @@ -861,7 +861,7 @@ plist holding contextual information." (org-trim data) data)))) -;;;; Headline +;;;; Heading (defun org-texinfo-headline (headline contents info) "Transcode a HEADLINE element from Org to Texinfo. @@ -921,7 +921,7 @@ holding contextual information." (format "@end %s" (if numbered? 'enumerate 'itemize)) "\n")) (concat - ;; Even if HEADLINE is using @subheading and al., leave an + ;; Even if HEADING is using @subheading and al., leave an ;; anchor so cross-references in the Org document still work. (format (if notoc? "@anchor{%s}\n" "@node %s\n") node) (format command full-text) @@ -1094,8 +1094,8 @@ INFO is a plist holding contextual information. See (if desc (format "@uref{file://%s,%s}" destination desc) (format "@uref{file://%s}" destination))) ((or `headline - ;; Targets within headlines cannot be turned into - ;; @anchor{}, so we refer to the headline parent + ;; Targets within headings cannot be turned into + ;; @anchor{}, so we refer to the heading parent ;; directly. (and `target (guard (eq 'headline diff --git a/lisp/ox.el b/lisp/ox.el index d89706c20..b367def86 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -1415,7 +1415,7 @@ specific items to read, if any." Optional argument BACKEND is an export back-end, as returned by, e.g., `org-export-create-backend'. It specifies back-end used for export. Return options as a plist." - ;; For each buffer keyword, create a headline property setting the + ;; For each buffer keyword, create a heading property setting the ;; same property in communication channel. The name for the ;; property is the keyword with "EXPORT_" appended to it. (org-with-wide-buffer @@ -1427,7 +1427,7 @@ for export. Return options as a plist." (let ((o (org-entry-get (point) "EXPORT_OPTIONS" 'selective))) (and o (org-export--parse-option-keyword o backend)))) ;; Take care of EXPORT_TITLE. If it isn't defined, use - ;; headline's title (with no todo keyword, priority cookie or + ;; heading's title (with no todo keyword, priority cookie or ;; tag) as its fallback value. (cache (list (cons "TITLE" @@ -1611,9 +1611,9 @@ BLOB is the element or object considered." ;; `org-export--populate-ignore-list' lists elements and objects that ;; should be skipped during export, `org-export--get-min-level' gets ;; the minimal exportable level, used as a basis to compute relative -;; level for headlines. Eventually +;; level for headings. Eventually ;; `org-export--collect-headline-numbering' builds an alist between -;; headlines and their numbering. +;; headings and their numbering. (defun org-export--collect-tree-properties (data info) "Extract tree properties from parse tree. @@ -1668,7 +1668,7 @@ OPTIONS is a plist holding export options." (not (memq datum (plist-get options :ignore-list)))) (setq min-level (min (org-element-property :level datum) min-level)) (when (= min-level 1) (throw 'exit 1)))) - ;; If no headline was found, for the sake of consistency, set + ;; If no heading was found, for the sake of consistency, set ;; minimum level to 1 nonetheless. (if (= min-level 10000) 1 min-level)))) @@ -1705,7 +1705,7 @@ INFO is a plist holding export options." (let ((select (cl-mapcan (lambda (tag) (org-tags-expand tag t)) (plist-get info :select-tags)))) (if (cl-some (lambda (tag) (member tag select)) (plist-get info :filetags)) - ;; If FILETAGS contains a select tag, every headline or + ;; If FILETAGS contains a select tag, every heading or ;; inlinetask is returned. (org-element-map data '(headline inlinetask) #'identity) (letrec ((selected-trees nil) @@ -1717,7 +1717,7 @@ INFO is a plist holding export options." (let ((tags (org-element-property :tags data))) (if (cl-some (lambda (tag) (member tag select)) tags) ;; When a select tag is found, mark full - ;; genealogy and every headline within the + ;; genealogy and every heading within the ;; tree as acceptable. (setq selected-trees (append @@ -1725,7 +1725,7 @@ INFO is a plist holding export options." (org-element-map data '(headline inlinetask) #'identity) selected-trees)) - ;; If at a headline, continue searching in + ;; If at a heading, continue searching in ;; tree, recursively. (when (eq type 'headline) (dolist (el (org-element-contents data)) @@ -1898,7 +1898,7 @@ Return a string." ((not type) (mapconcat (lambda (obj) (org-export-data obj info)) data "")) ;; Element/Object without contents or, as a special - ;; case, headline with archive tag and archived trees + ;; case, heading with archive tag and archived trees ;; restricted to title only. ((or (not (org-element-contents data)) (and (eq type 'headline) @@ -2518,8 +2518,8 @@ Return the updated communication channel." ;; `org-export-expand-include-keyword' and ;; `org-export--prepare-file-contents'. Structure wise, including ;; a whole Org file in a buffer often makes little sense. For -;; example, if the file contains a headline and the include keyword -;; was within an item, the item should contain the headline. That's +;; example, if the file contains a heading and the include keyword +;; was within an item, the item should contain the heading. That's ;; why file inclusion should be done before any structure can be ;; associated to the file, that is before parsing. ;; @@ -2644,7 +2644,7 @@ from tree." (letrec ((ignore nil) ;; First find trees containing a select tag, if any. (selected (org-export--selected-trees data info)) - ;; List tags that prevent export of headlines. + ;; List tags that prevent export of headings. (excluded (cl-mapcan (lambda (tag) (org-tags-expand tag t)) (plist-get info :exclude-tags))) (walk-data @@ -2662,7 +2662,7 @@ from tree." (eq (plist-get info :with-archived-trees) 'headline) (org-element-property :archivedp data)) - ;; If headline is archived but tree below has + ;; If heading is archived but tree below has ;; to be skipped, remove contents. (org-element-set-contents data) ;; Move into recursive objects/elements. @@ -2683,7 +2683,7 @@ from tree." f) (t nil)))))) ;; If a select tag is active, also ignore the section before the - ;; first headline, if any. + ;; first heading, if any. (when selected (let ((first-element (car (org-element-contents data)))) (when (eq (org-element-type first-element) 'section) @@ -2934,7 +2934,7 @@ Return code as a string." (save-restriction ;; Narrow buffer to an appropriate region or subtree for ;; parsing. If parsing subtree, be sure to remove main - ;; headline, planning data and property drawer. + ;; heading, planning data and property drawer. (cond ((org-region-active-p) (narrow-to-region (region-beginning) (region-end))) (subtreep @@ -3248,7 +3248,7 @@ storing and resolving footnotes. It is created automatically." ((string-match "\\ ind 0)) (unless (eq major-mode 'org-mode) (let ((org-inhibit-startup t)) (org-mode))) @@ -3515,9 +3515,9 @@ is to happen." 'footnote-definition)) (insert ind-str)) (forward-line)))) - ;; When MINLEVEL is specified, compute minimal level for headlines - ;; in the file (CUR-MIN), and remove stars to each headline so - ;; that headlines with minimal level have a level of MINLEVEL. + ;; When MINLEVEL is specified, compute minimal level for headings + ;; in the file (CUR-MIN), and remove stars to each heading so + ;; that headings with minimal level have a level of MINLEVEL. (when minlevel (unless (eq major-mode 'org-mode) (let ((org-inhibit-startup t)) (org-mode))) @@ -3727,7 +3727,7 @@ applied." ;; ;; `org-export-collect-footnote-definitions' is a tool to list ;; actually used footnotes definitions in the whole parse tree, or in -;; a headline, in order to add footnote listings throughout the +;; a heading, in order to add footnote listings throughout the ;; transcoded data. ;; ;; `org-export-footnote-first-reference-p' is a predicate used by some @@ -3902,16 +3902,16 @@ process, leading to a different order when footnotes are nested." (or data (plist-get info :parse-tree)) info body-first)))) -;;;; For Headlines +;;;; For Headings ;; -;; `org-export-get-relative-level' is a shortcut to get headline -;; level, relatively to the lower headline level in the parsed tree. +;; `org-export-get-relative-level' is a shortcut to get heading +;; level, relatively to the lower heading level in the parsed tree. ;; ;; `org-export-get-headline-number' returns the section number of an -;; headline, while `org-export-number-to-roman' allows it to be +;; heading, while `org-export-number-to-roman' allows it to be ;; converted to roman numbers. With an optional argument, ;; `org-export-get-headline-number' returns a number to unnumbered -;; headlines (used for internal id). +;; headings (used for internal id). ;; ;; `org-export-low-level-p', `org-export-first-sibling-p' and ;; `org-export-last-sibling-p' are three useful predicates when it @@ -3919,7 +3919,7 @@ process, leading to a different order when footnotes are nested." ;; ;; `org-export-get-tags', `org-export-get-category' and ;; `org-export-get-node-property' extract useful information from an -;; headline or a parent headline. They all handle inheritance. +;; heading or a parent heading. They all handle inheritance. ;; ;; `org-export-get-alt-title' tries to retrieve an alternative title, ;; as a secondary string, suitable for table of contents. It falls @@ -4106,7 +4106,7 @@ meant to be translated with `org-export-data' or alike." ;; (i.e. links with "fuzzy" as type) within the parsed tree, and ;; returns an appropriate unique identifier. ;; -;; `org-export-resolve-id-link' returns the first headline with +;; `org-export-resolve-id-link' returns the first heading with ;; specified id or custom-id in parse tree, the path to the external ;; file with the id. ;; @@ -4356,7 +4356,7 @@ significant." search-cells ;; There can be multiple matches for un-typed searches, i.e., ;; for searches not starting with # or *. In this case, - ;; prioritize targets and names over headline titles. + ;; prioritize targets and names over heading titles. ;; Matching both a name and a target is not valid, and ;; therefore undefined. (or (cl-some (lambda (datum) @@ -4551,14 +4551,14 @@ table, item or headline containing the target. In any other case, return the sequence number of ELEMENT among elements or objects of the same type." ;; Ordinal of a target object refer to the ordinal of the closest - ;; table, item, or headline containing the object. + ;; table, item, or heading containing the object. (when (eq (org-element-type element) 'target) (setq element (org-element-lineage element '(footnote-definition footnote-reference headline item table)))) (cl-case (org-element-type element) - ;; Special case 1: A headline returns its number as a list. + ;; Special case 1: A heading returns its number as a list. (headline (org-export-get-headline-number element info)) ;; Special case 2: An item returns its number as a list. (item (let ((struct (org-element-property :structure element))) @@ -5254,7 +5254,7 @@ return nil." ;;;; For Tables of Contents ;; ;; `org-export-collect-headlines' builds a list of all exportable -;; headline elements, maybe limited to a certain depth. One can then +;; heading elements, maybe limited to a certain depth. One can then ;; easily parse it and transcode it. ;; ;; Building lists of tables, figures or listings is quite similar. @@ -5690,7 +5690,7 @@ Return the new string." ;; ;; Here are various functions to retrieve information about the ;; neighborhood of a given element or object. Neighbors of interest -;; are direct parent (`org-export-get-parent'), parent headline +;; are direct parent (`org-export-get-parent'), parent heading ;; (`org-export-get-parent-headline'), first element containing an ;; object, (`org-export-get-parent-element'), parent table ;; (`org-export-get-parent-table'), previous element or object diff --git a/testing/lisp/test-ob-exp.el b/testing/lisp/test-ob-exp.el index 6cd7514a5..6f0c65d9d 100644 --- a/testing/lisp/test-ob-exp.el +++ b/testing/lisp/test-ob-exp.el @@ -468,7 +468,7 @@ be evaluated." "Test evaluation of code blocks under COMMENT headings." (let ((org-export-use-babel t) (org-babel-inline-result-wrap "=%s=")) - ;; Do not eval block in a commented headline. + ;; Do not eval block in a commented heading. (should (string-match ": 2" @@ -502,7 +502,7 @@ src_emacs-lisp{(+ 1 1)}" src_emacs-lisp{(+ 1 1)}" (org-babel-exp-process-buffer) (buffer-string)))) - ;; Also check parent headlines. + ;; Also check parent headings. (should-not (string-match ": 2" diff --git a/testing/lisp/test-ob.el b/testing/lisp/test-ob.el index a5ae8e389..47702eab6 100644 --- a/testing/lisp/test-ob.el +++ b/testing/lisp/test-ob.el @@ -828,7 +828,7 @@ x baz #+end_src" (org-babel-expand-noweb-references)))) - ;; Respect COMMENT headlines + ;; Respect COMMENT headings (should (equal "C" (org-test-with-temp-text " @@ -959,7 +959,7 @@ x #+END_SRC " (org-babel-execute-maybe) t)) - ;; Escape headlines when producing an example block. + ;; Escape headings when producing an example block. (should (string-match-p ",\\* Not an headline" diff --git a/testing/lisp/test-ol.el b/testing/lisp/test-ol.el index ddcc570b3..cd1ba0510 100644 --- a/testing/lisp/test-ol.el +++ b/testing/lisp/test-ol.el @@ -125,7 +125,7 @@ (ert-deftest test-ol/store-link () "Test `org-store-link' specifications." - ;; On a headline, link to that headline. Use heading as the + ;; On a heading, link to that heading. Use heading as the ;; description of the link. (should (let (org-store-link-props org-stored-links) @@ -133,7 +133,7 @@ (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) - ;; On a headline, remove TODO and COMMENT keywords, priority cookie, + ;; On a heading, remove TODO and COMMENT keywords, priority cookie, ;; and tags. (should (let (org-store-link-props org-stored-links) @@ -159,7 +159,7 @@ (let ((file (buffer-file-name))) (equal (format "[[file:%s::*H1][H1]]" file) (org-store-link nil)))))) - ;; On a headline, remove any link from description. + ;; On a heading, remove any link from description. (should (let (org-store-link-props org-stored-links) (org-test-with-temp-text-in-file "* [[#l][d]]" @@ -329,7 +329,7 @@ (let ((file (buffer-file-name))) (equal (format "[[file:%s::two]]" file file) (org-store-link nil)))))) - ;; Context also ignore statistics cookies and special headlines + ;; Context also ignore statistics cookies and special headings ;; data. (should (let ((org-stored-links nil) diff --git a/testing/lisp/test-org-capture.el b/testing/lisp/test-org-capture.el index ea42fa374..f2489abc2 100644 --- a/testing/lisp/test-org-capture.el +++ b/testing/lisp/test-org-capture.el @@ -113,7 +113,7 @@ (ert-deftest test-org-capture/refile () "Test `org-capture-refile' specifications." - ;; When refiling, make sure the headline being refiled is the one + ;; When refiling, make sure the heading being refiled is the one ;; being captured. In particular, empty lines after the entry may ;; be removed, and we don't want to shift onto the next heading. (should @@ -199,7 +199,7 @@ (ert-deftest test-org-capture/entry () "Test `entry' type in capture template." - ;; Do not break next headline. + ;; Do not break next heading. (should (equal "* A\n** H1 Capture text\n* B\n" @@ -459,7 +459,7 @@ (org-capture nil "t") (org-capture-finalize)) (buffer-string)))) - ;; Do not break next headline. + ;; Do not break next heading. (should-not (equal "- A\n- X\nFoo* H" @@ -699,7 +699,7 @@ :immediate-finish t :prepend t)))) (org-capture nil "t") (buffer-string))))) - ;; When a headline is specified, add it at the beginning of the + ;; When a heading is specified, add it at the beginning of the ;; entry, past any meta-data, or at its end, depending on ;; `:prepend'. (should diff --git a/testing/lisp/test-org-clock.el b/testing/lisp/test-org-clock.el index d2179e1ec..b72dd24d3 100644 --- a/testing/lisp/test-org-clock.el +++ b/testing/lisp/test-org-clock.el @@ -575,14 +575,14 @@ CLOCK: [2016-12-28 Wed 13:09]--[2016-12-28 Wed 15:09] => 2:00" (ert-deftest test-org-clock/clocktable/link () "Test \":link\" parameter in Clock table." ;; If there is no file attached to the document, link directly to - ;; the headline. + ;; the heading. (should (string-match-p "| +\\[\\[\\*Foo]\\[Foo]] +| 26:00 +|" (org-test-with-temp-text "* Foo CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (test-org-clock-clocktable-contents ":link t")))) - ;; Otherwise, link to the headline in the current file. + ;; Otherwise, link to the heading in the current file. (should (string-match-p "| \\[\\[file:filename::\\*Foo]\\[Foo]] +| 26:00 +|" @@ -597,7 +597,7 @@ CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (org-table-align) (buffer-substring-no-properties (point-min) (point-max))))) ;; Ignore TODO keyword, priority cookie, COMMENT and tags in - ;; headline. + ;; heading. (should (string-match-p "| \\[\\[\\*Foo]\\[Foo]] +| 26:00 +|" @@ -626,7 +626,7 @@ CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" "* Foo :tag: CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (test-org-clock-clocktable-contents ":link t :lang en")))) - ;; Remove statistics cookie from headline description. + ;; Remove statistics cookie from heading description. (should (string-match-p "| \\[\\[\\*Foo]\\[Foo]] +| 26:00 +|" @@ -660,7 +660,7 @@ CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (ert-deftest test-org-clock/clocktable/compact () "Test \":compact\" parameter in Clock table." - ;; With :compact, all headlines are in the same column. + ;; With :compact, all headings are in the same column. (should (equal "| Headline | Time | @@ -784,7 +784,7 @@ CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (ert-deftest test-org-clock/clocktable/tcolumns () "Test \":tcolumns\" parameter in Clock table." - ;; When :tcolumns is smaller than the deepest headline level, lump + ;; When :tcolumns is smaller than the deepest heading level, lump ;; lower levels in the last column. (should (equal @@ -800,7 +800,7 @@ CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00 ** Bar CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (test-org-clock-clocktable-contents ":tcolumns 1")))) - ;; :tcolumns cannot create more columns than the deepest headline + ;; :tcolumns cannot create more columns than the deepest heading ;; level. (should (equal @@ -816,7 +816,7 @@ CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00 ** Bar CLOCK: [2016-12-27 Wed 13:09]--[2016-12-28 Wed 15:09] => 26:00" (test-org-clock-clocktable-contents ":tcolumns 3")))) - ;; Pathological case: when no headline contributes to the total + ;; Pathological case: when no heading contributes to the total ;; time, there is only one time column. (should (equal "| Headline | Time | diff --git a/testing/lisp/test-org-colview.el b/testing/lisp/test-org-colview.el index 64da5611d..f813aa8e1 100644 --- a/testing/lisp/test-org-colview.el +++ b/testing/lisp/test-org-colview.el @@ -67,7 +67,7 @@ (ert-deftest test-org-colview/columns-scope () "Test `org-columns' scope." - ;; Before the first headline, view all document. + ;; Before the first heading, view all document. (should (equal '("H1" "H2" "H3") @@ -85,7 +85,7 @@ (let ((org-columns-default-format "%ITEM")) (org-columns)) (org-map-entries (lambda () (get-char-property (point) 'org-columns-value)))))) - ;; Otherwise, view tree starting at the current headline. + ;; Otherwise, view tree starting at the current heading. (should (equal '(nil "H2" "H3" nil) diff --git a/testing/lisp/test-org-element.el b/testing/lisp/test-org-element.el index ea9f97a64..53896175d 100644 --- a/testing/lisp/test-org-element.el +++ b/testing/lisp/test-org-element.el @@ -1182,7 +1182,7 @@ Some other text (org-element-parse-buffer) 'footnote-reference 'identity)))) -;;;; Headline +;;;; Heading (ert-deftest test-org-element/headline-todo-keyword () "Test todo keyword recognition." @@ -1190,7 +1190,7 @@ Some other text (org-test-with-temp-text "* TODO Headline" (let ((org-todo-keywords '((sequence "TODO" "DONE")))) (should (org-element-property :todo-keyword (org-element-at-point))))) - ;; Todo keyword is prefix of headlines first word. + ;; Todo keyword is prefix of headings first word. (org-test-with-temp-text "* TODOHeadline" (let ((org-todo-keywords '((sequence "TODO" "DONE")))) (should-not (org-element-property :todo-keyword (org-element-at-point)))))) @@ -2064,7 +2064,7 @@ e^{i\\pi}+1=0 (list (org-element-property :key element) (org-element-property :value element)))))) ;; The insides of property blocks on document level are parsed the - ;; same way as headline property blocks. I.e. the concept of + ;; same way as heading property blocks. I.e. the concept of ;; `node-property' apply also for properties in those blocks. (should (equal '("abc" "value") @@ -2227,7 +2227,7 @@ Outside list" :scheduled (org-test-with-temp-text "* H\nSCHEDULED: <2012-03-29 thu.>" (org-element-at-point)))) - ;; Planning line only exists right after a headline. + ;; Planning line only exists right after a heading. (should-not (eq 'planning (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>" @@ -2364,7 +2364,7 @@ Outside list" (should (org-test-with-temp-text "* Headline\nText" (org-element-map (org-element-parse-buffer) 'section 'identity))) - ;; There's a section before the first headline. + ;; There's a section before the first heading. (should (org-test-with-temp-text "Text" (org-element-map (org-element-parse-buffer) 'section 'identity))) @@ -3473,7 +3473,7 @@ Paragraph \\alpha." (should (= 2 (length (org-element-map tree 'headline 'identity)))) (should-not (org-element-map tree 'paragraph 'identity))) ;; 1.2. Granularity set to `greater-element' should not enter - ;; greater elements excepted headlines and sections. + ;; greater elements excepted headings and sections. (let ((tree (org-element-parse-buffer 'greater-element))) (should (= 1 (length (org-element-map tree 'center-block 'identity)))) (should (= 1 (length (org-element-map tree 'paragraph 'identity)))) @@ -3693,8 +3693,8 @@ Text (progn (search-forward "A") (org-element-type (org-element-property :parent (org-element-at-point))))))) - ;; Special case: at a blank line just below a headline, return that - ;; headline. + ;; Special case: at a blank line just below a heading, return that + ;; heading. (should (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n" (forward-line) @@ -3823,7 +3823,7 @@ Text (eq 'underline (org-test-with-temp-text "Some *text with _underline_ text*" (org-element-type (org-element-context (org-element-at-point)))))) - ;; Special case: bold object at the beginning of a headline. + ;; Special case: bold object at the beginning of a heading. (should (eq 'bold (org-test-with-temp-text "* *bold*" diff --git a/testing/lisp/test-org-footnote.el b/testing/lisp/test-org-footnote.el index 8751dc842..78baafab9 100644 --- a/testing/lisp/test-org-footnote.el +++ b/testing/lisp/test-org-footnote.el @@ -58,7 +58,7 @@ (org-test-with-temp-text " " (let ((org-footnote-auto-label t)) (org-footnote-new)) (buffer-string)))) - ;; In an headline or inlinetask, point must be either on the + ;; In an heading or inlinetask, point must be either on the ;; heading itself or on the blank lines below. (should (org-test-with-temp-text "* H" (org-footnote-new) t)) (should diff --git a/testing/lisp/test-org-list.el b/testing/lisp/test-org-list.el index 3689a172f..964752be6 100644 --- a/testing/lisp/test-org-list.el +++ b/testing/lisp/test-org-list.el @@ -946,7 +946,7 @@ b. Item 2" (ert-deftest test-org-list/update-checkbox-count () "Test `org-update-checkbox-count' specifications." - ;; From a headline. + ;; From a heading. (should (string-match "\\[0/1\\]" (org-test-with-temp-text "* [/]\n- [ ] item" @@ -1079,13 +1079,13 @@ b. Item 2" (org-test-with-temp-text "- line" (org-toggle-item nil) (buffer-string)))) - ;; Convert headlines to items. + ;; Convert headings to items. (should (equal "- line" (org-test-with-temp-text "* line" (org-toggle-item nil) (buffer-string)))) - ;; When converting a headline to a list item, TODO keywords become + ;; When converting a heading to a list item, TODO keywords become ;; checkboxes. (should (equal "- [X] line" @@ -1097,7 +1097,7 @@ b. Item 2" (org-test-with-temp-text "* TODO line" (org-toggle-item nil) (buffer-string)))) - ;; When turning headlines into items, make sure planning info line + ;; When turning headings into items, make sure planning info line ;; and properties drawers are removed. This also includes empty ;; lines following them. (should @@ -1122,8 +1122,8 @@ b. Item 2" (org-test-with-temp-text " \n* H :tag:" (org-toggle-item nil) (buffer-string)))) - ;; When a region is marked and first line is a headline, all - ;; headlines are turned into items. + ;; When a region is marked and first line is a heading, all + ;; headings are turned into items. (should (equal "- H1\n - H2" (org-test-with-temp-text "* H1\n** H2" @@ -1140,7 +1140,7 @@ b. Item 2" (goto-char (point-max)) (org-toggle-item nil) (buffer-string)))) - ;; When turning headlines into items, make sure headings contents + ;; When turning headings into items, make sure headings contents ;; are kept within items. (should (equal "- H1\n Text" diff --git a/testing/lisp/test-org-macro.el b/testing/lisp/test-org-macro.el index 1b4b791ca..9d52df485 100644 --- a/testing/lisp/test-org-macro.el +++ b/testing/lisp/test-org-macro.el @@ -107,9 +107,9 @@ (ert-deftest test-org-macro/property () "Test {{{property}}} macro." - ;; With only one argument, retrieve property from current headline. + ;; With only one argument, retrieve property from current heading. ;; Otherwise, the second argument is a search option to get the - ;; property from another headline. + ;; property from another heading. (should (equal "1" (org-test-with-temp-text diff --git a/testing/lisp/test-org-num.el b/testing/lisp/test-org-num.el index 7a247b04a..d52e84b19 100644 --- a/testing/lisp/test-org-num.el +++ b/testing/lisp/test-org-num.el @@ -76,7 +76,7 @@ (ert-deftest test-org-num/skip-numbering () "Test various skip numbering parameters." - ;; Skip commented headlines. + ;; Skip commented headings. (should (equal '(nil "1 ") (org-test-with-temp-text "* H1\n* COMMENT H2" @@ -156,7 +156,7 @@ (let ((org-num-skip-unnumbered t)) (org-num-mode 1)) (mapcar (lambda (o) (overlay-get o 'after-string)) (overlays-in (point-min) (point-max)))))) - ;; Do not choke on empty headlines. + ;; Do not choke on empty headings. (should (equal '("1 ") (org-test-with-temp-text "* " @@ -178,7 +178,7 @@ (ert-deftest test-org-num/update () "Test numbering update after a buffer modification." - ;; Headlines created at BEG. + ;; Headings created at BEG. (should (equal "1 " (org-test-with-temp-text "X* H" @@ -200,7 +200,7 @@ (insert " ") (overlay-get (car (overlays-at (line-beginning-position))) 'after-string)))) - ;; Headlines created at END. + ;; Headings created at END. (should (equal '("1 ") (org-test-with-temp-text "X H" @@ -215,7 +215,7 @@ (insert "\n") (mapcar (lambda (o) (overlay-get o 'after-string)) (overlays-in (point-min) (point-max)))))) - ;; Headlines created between BEG and END. + ;; Headings created between BEG and END. (should (equal '("1.1 " "1 ") (org-test-with-temp-text "" @@ -223,7 +223,7 @@ (insert "\n* H\n** H2") (mapcar (lambda (o) (overlay-get o 'after-string)) (overlays-in (point-min) (point-max)))))) - ;; Change level of a headline. + ;; Change level of a heading. (should (equal '("0.1 ") (org-test-with-temp-text "* H" @@ -255,7 +255,7 @@ (insert "o")) (mapcar (lambda (o) (overlay-get o 'after-string)) (overlays-in (point-min) (point-max)))))) - ;; Invalidate an overlay and insert new headlines. + ;; Invalidate an overlay and insert new headings. (should (equal '("1.2 " "1.1 " "1 ") (org-test-with-temp-text @@ -265,7 +265,7 @@ (insert "\n** H2\n** H3\n") (mapcar (lambda (o) (overlay-get o 'after-string)) (overlays-in (point-min) (point-max))))))) - ;; Invalidate two overlays: current headline and next one. + ;; Invalidate two overlays: current heading and next one. (should (equal '("1 ") (org-test-with-temp-text diff --git a/testing/lisp/test-org.el b/testing/lisp/test-org.el index 18d41a0d2..e056bea2f 100644 --- a/testing/lisp/test-org.el +++ b/testing/lisp/test-org.el @@ -29,7 +29,7 @@ (ert-deftest test-org/toggle-comment () "Test `org-toggle-comment' specifications." - ;; Simple headline. + ;; Simple heading. (should (equal "* Test" (org-test-with-temp-text "* COMMENT Test" @@ -40,7 +40,7 @@ (org-test-with-temp-text "* Test" (org-toggle-comment) (buffer-string)))) - ;; Headline with a regular keyword. + ;; Heading with a regular keyword. (should (equal "* TODO Test" (org-test-with-temp-text "* TODO COMMENT Test" @@ -51,7 +51,7 @@ (org-test-with-temp-text "* TODO Test" (org-toggle-comment) (buffer-string)))) - ;; Empty headline. + ;; Empty heading. (should (equal "* " (org-test-with-temp-text "* COMMENT" @@ -62,7 +62,7 @@ (org-test-with-temp-text "* " (org-toggle-comment) (buffer-string)))) - ;; Headline with a single keyword. + ;; Heading with a single keyword. (should (equal "* TODO " (org-test-with-temp-text "* TODO COMMENT" @@ -73,7 +73,7 @@ (org-test-with-temp-text "* TODO" (org-toggle-comment) (buffer-string)))) - ;; Headline with a keyword, a priority cookie and contents. + ;; Heading with a keyword, a priority cookie and contents. (should (equal "* TODO [#A] Headline" (org-test-with-temp-text "* TODO [#A] COMMENT Headline" @@ -499,7 +499,7 @@ (org-test-with-temp-text "\n* T\n" (let ((org-adapt-indentation nil)) (org-insert-property-drawer)) (buffer-string)))) - ;; Insert drawer right after headline if there is no planning line, + ;; Insert drawer right after heading if there is no planning line, ;; or after it otherwise. (should (equal "* H\n:PROPERTIES:\n:END:\nParagraph" @@ -879,7 +879,7 @@ (ert-deftest test-org/indent-line () "Test `org-indent-line' specifications." - ;; Do not indent diary sexps, footnote definitions or headlines. + ;; Do not indent diary sexps, footnote definitions or headings. (should (zerop (org-test-with-temp-text "%%(org-calendar-holiday)" @@ -895,13 +895,13 @@ (org-test-with-temp-text "* H" (org-indent-line) (org-get-indentation)))) - ;; Do not indent before first headline. + ;; Do not indent before first heading. (should (zerop (org-test-with-temp-text "" (org-indent-line) (org-get-indentation)))) - ;; Indent according to headline level otherwise, unless + ;; Indent according to heading level otherwise, unless ;; `org-adapt-indentation' is nil. (should (= 2 @@ -1207,7 +1207,7 @@ "foo \n bar" (org-delete-indentation t) (buffer-string)))) - ;; At headline text should be appended to the headline text. + ;; At heading text should be appended to the heading text. (should (equal"* foo bar :tag:" (let (org-auto-align-tags) @@ -1328,14 +1328,14 @@ (org-test-with-temp-text "- A\n- B" (org-return t) (buffer-string)))) - ;; On tags part of a headline, add a newline below it instead of + ;; On tags part of a heading, add a newline below it instead of ;; breaking it. (should (equal "* H :tag:\n" (org-test-with-temp-text "* H :tag:" (org-return) (buffer-string)))) - ;; Before headline text, add a newline below it instead of breaking + ;; Before heading text, add a newline below it instead of breaking ;; it. (should (equal "* TODO H :tag:\n" @@ -1352,20 +1352,20 @@ (org-test-with-temp-text "* Todo" (org-return) (buffer-string)))) - ;; At headline text, break headline text but preserve tags. + ;; At heading text, break heading text but preserve tags. (should (equal "* TODO [#B] foo :tag:\nbar" (let (org-auto-align-tags) (org-test-with-temp-text "* TODO [#B] foobar :tag:" (org-return) (buffer-string))))) - ;; At bol of headline insert newline. + ;; At bol of heading insert newline. (should (equal "\n* h" (org-test-with-temp-text "* h" (org-return) (buffer-string)))) - ;; Refuse to leave invalid headline in buffer. + ;; Refuse to leave invalid heading in buffer. (should (equal "* h\n" (org-test-with-temp-text "* h" @@ -1517,20 +1517,20 @@ (ert-deftest test-org/insert-heading () "Test `org-insert-heading' specifications." - ;; In an empty buffer, insert a new headline. + ;; In an empty buffer, insert a new heading. (should (equal "* " (org-test-with-temp-text "" (org-insert-heading) (buffer-string)))) - ;; At the beginning of a line, turn it into a headline. + ;; At the beginning of a line, turn it into a heading. (should (equal "* P" (org-test-with-temp-text "P" (org-insert-heading) (buffer-string)))) ;; In the middle of a line, split the line if allowed, otherwise, - ;; insert the headline at its end. + ;; insert the heading at its end. (should (equal "Para\n* graph" (org-test-with-temp-text "Paragraph" @@ -1543,13 +1543,13 @@ (let ((org-M-RET-may-split-line '((default . nil)))) (org-insert-heading)) (buffer-string)))) - ;; At the beginning of a headline, create one above. + ;; At the beginning of a heading, create one above. (should (equal "* \n* H" (org-test-with-temp-text "* H" (org-insert-heading) (buffer-string)))) - ;; In the middle of a headline, split it if allowed. + ;; In the middle of a heading, split it if allowed. (should (equal "* H\n* 1" (org-test-with-temp-text "* H1" @@ -1582,7 +1582,7 @@ (let ((org-M-RET-may-split-line '((headline . t)))) (org-insert-heading)) (buffer-string)))) - ;; New headline level depends on the level of the headline above. + ;; New heading level depends on the level of the heading above. (should (equal "** H\n** P" (org-test-with-temp-text "** H\nP" @@ -1599,7 +1599,7 @@ (org-test-with-temp-text "** H" (org-insert-heading) (buffer-string)))) - ;; When called with one universal argument, insert a new headline at + ;; When called with one universal argument, insert a new heading at ;; the end of the current subtree, independently on the position of ;; point. (should @@ -1631,7 +1631,7 @@ (let ((org-insert-heading-respect-content nil)) (org-insert-heading '(4))) (buffer-string)))) - ;; When called with two universal arguments, insert a new headline + ;; When called with two universal arguments, insert a new heading ;; at the end of the grandparent subtree. (should (equal "* H1\n** H3\n- item\n** H2\n** " @@ -1676,7 +1676,7 @@ (let ((org-blank-before-new-entry '((heading . auto)))) (org-insert-heading)) (buffer-string)))) - ;; Corner case: correctly insert a headline after an empty one. + ;; Corner case: correctly insert a heading after an empty one. (should (equal "* \n* " (org-test-with-temp-text "* " @@ -1686,7 +1686,7 @@ (org-test-with-temp-text "* \n" (org-insert-heading) (looking-at-p "\n\\'"))) - ;; Do not insert spurious headlines when inserting a new headline. + ;; Do not insert spurious headings when inserting a new heading. (should (equal "* H1\n* H2\n* \n" (org-test-with-temp-text "* H1\n* H2\n" @@ -1701,7 +1701,7 @@ (let ((org-blank-before-new-entry '((heading . nil)))) (org-insert-heading '(4))) (invisible-p (line-end-position 0)))) - ;; Properly handle empty lines when forcing a headline below current + ;; Properly handle empty lines when forcing a heading below current ;; one. (should (equal "* H1\n\n* H\n\n* " @@ -1717,7 +1717,7 @@ (org-test-with-temp-text "* H1\n Body" (org-insert-todo-heading-respect-content) (nth 2 (org-heading-components)))) - ;; Add headline at the end of the first subtree + ;; Add heading at the end of the first subtree (should (equal "* TODO " @@ -1875,7 +1875,7 @@ (org-toggle-fixed-width) (buffer-string)))) ;; No region: Toggle on marker in blank lines after elements or just - ;; after a headline. + ;; after a heading. (should (equal "* H\n: " (org-test-with-temp-text "* H\n" @@ -1889,7 +1889,7 @@ (org-toggle-fixed-width) (buffer-string)))) ;; No region: Toggle on marker in front of one line elements (e.g., - ;; headlines, clocks) + ;; headings, clocks) (should (equal ": * Headline" (org-test-with-temp-text "* Headline" @@ -1977,7 +1977,7 @@ (org-test-with-temp-text "abc\n123" (org-kill-line) (buffer-string)))) - ;; When `org-special-ctrl-k' is non-nil and point is at a headline, + ;; When `org-special-ctrl-k' is non-nil and point is at a heading, ;; kill until tags. (should (equal "* A :tag:" @@ -1995,7 +1995,7 @@ (org-kill-line)) (buffer-string)))) ;; However, if point is at the beginning of the line, kill whole - ;; headline. + ;; heading. (should (equal "" (org-test-with-temp-text "* AB :tag:" @@ -2022,7 +2022,7 @@ -;;; Headline +;;; Heading (ert-deftest test-org/get-heading () "Test `org-get-heading' specifications." @@ -2102,7 +2102,7 @@ (equal "TODO [#A] H" (org-test-with-temp-text "* TODO [#A] COMMENT H" (org-get-heading nil nil nil t)))) - ;; On an empty headline, return value is consistent. + ;; On an empty heading, return value is consistent. (should (equal "" (org-test-with-temp-text "* " (org-get-heading)))) (should (equal "" (org-test-with-temp-text "* " (org-get-heading t)))) (should (equal "" (org-test-with-temp-text "* " (org-get-heading nil t)))) @@ -2112,7 +2112,7 @@ (ert-deftest test-org/in-commented-heading-p () "Test `org-in-commented-heading-p' specifications." - ;; Commented headline. + ;; Commented heading. (should (org-test-with-temp-text "* COMMENT Headline\nBody" (goto-char (point-max)) @@ -2140,7 +2140,7 @@ (ert-deftest test-org/in-archived-heading-p () "Test `org-in-archived-heading-p' specifications." - ;; Archived headline. + ;; Archived heading. (should (org-test-with-temp-text "* Headline :ARCHIVE:\nBody" (goto-char (point-max)) @@ -2207,16 +2207,16 @@ (ert-deftest test-org/get-outline-path () "Test `org-get-outline-path' specifications." - ;; Top-level headlines have no outline path. + ;; Top-level headings have no outline path. (should-not (org-test-with-temp-text "* H" (org-get-outline-path))) - ;; Otherwise, outline path is the path leading to the headline. + ;; Otherwise, outline path is the path leading to the heading. (should (equal '("H") (org-test-with-temp-text "* H\n** S" (org-get-outline-path)))) - ;; Find path even when point is not on a headline. + ;; Find path even when point is not on a heading. (should (equal '("H") (org-test-with-temp-text "* H\n** S\nText" @@ -2261,7 +2261,7 @@ (org-get-outline-path nil t) (search-forward "S2") (org-get-outline-path nil t)))) - ;; Do not choke on empty headlines. + ;; Do not choke on empty headings. (should (org-test-with-temp-text "* H\n** " (org-get-outline-path))) @@ -2695,7 +2695,7 @@ SCHEDULED: <2014-03-04 tue.>" ;;;; Fuzzy Links ;; Fuzzy links [[text]] encompass links to a target (<>), to -;; a named element (#+name: text) and to headlines (* Text). +;; a named element (#+name: text) and to headings (* Text). (ert-deftest test-org/fuzzy-links () "Test fuzzy links specifications." @@ -2710,7 +2710,7 @@ SCHEDULED: <2014-03-04 tue.>" (org-test-with-temp-text "Test\n#+NAME: Test\n|a|b|\n* Test\n[[Test]]" (let ((org-link-search-must-match-exact-headline nil)) (org-open-at-point)) (looking-at "#\\+NAME: Test"))) - ;; A target still lead to a matching headline otherwise. + ;; A target still lead to a matching heading otherwise. (should (org-test-with-temp-text "* Head1\n* Head2\n*Head3\n[[Head2]]" (let ((org-link-search-must-match-exact-headline nil)) (org-open-at-point)) @@ -2955,7 +2955,7 @@ Foo Bar (ert-deftest test-org/mark-subtree () "Test `org-mark-subtree' specifications." - ;; Error when point is before first headline. + ;; Error when point is before first heading. (should-error (org-test-with-temp-text "Paragraph\n* Headline\nBody" (progn (transient-mark-mode 1) @@ -3282,7 +3282,7 @@ SCHEDULED: <2017-05-06 Sat> (ert-deftest test-org/next-visible-heading () "Test `org-next-visible-heading' specifications." - ;; Move to the beginning of the next headline, taking into + ;; Move to the beginning of the next heading, taking into ;; consideration ARG. (should (org-test-with-temp-text "* H1\n* H2" @@ -3292,20 +3292,20 @@ SCHEDULED: <2017-05-06 Sat> (org-test-with-temp-text "* H1\n* H2\n* H3" (org-next-visible-heading 2) (looking-at "\\* H3"))) - ;; Ignore invisible headlines. + ;; Ignore invisible headings. (should (org-test-with-temp-text "* H1\n** H2\n* H3" (org-cycle) (org-next-visible-heading 1) (looking-at "\\* H3"))) - ;; Move point between headlines, not on blank lines between. + ;; Move point between headings, not on blank lines between. (should (org-test-with-temp-text "* H1\n** H2\n\n\n\n* H3" (let ((org-cycle-separator-lines 1)) (org-cycle) (org-next-visible-heading 1)) (looking-at "\\* H3"))) - ;; Move at end of buffer when there is no more headline. + ;; Move at end of buffer when there is no more heading. (should (org-test-with-temp-text "* H1" (org-next-visible-heading 1) @@ -3326,7 +3326,7 @@ SCHEDULED: <2017-05-06 Sat> (ert-deftest test-org/previous-visible-heading () "Test `org-previous-visible-heading' specifications." - ;; Move to the beginning of the next headline, taking into + ;; Move to the beginning of the next heading, taking into ;; consideration ARG. (should (org-test-with-temp-text "* H1\n* H2" @@ -3336,20 +3336,20 @@ SCHEDULED: <2017-05-06 Sat> (org-test-with-temp-text "* H1\n* H2\n* H3" (org-previous-visible-heading 2) (looking-at "\\* H1"))) - ;; Ignore invisible headlines. + ;; Ignore invisible headings. (should (org-test-with-temp-text "* H1\n** H2\n* H3" (org-overview) (org-previous-visible-heading 1) (looking-at "\\* H1"))) - ;; Move point between headlines, not on blank lines between. + ;; Move point between headings, not on blank lines between. (should (org-test-with-temp-text "* H1\n\n\n\n** H2\n* H3" (let ((org-cycle-separator-lines 1)) (org-overview) (org-previous-visible-heading 1)) (looking-at "\\* H1"))) - ;; Move at end of buffer when there is no more headline. + ;; Move at end of buffer when there is no more heading. (should (org-test-with-temp-text "* H1" (org-previous-visible-heading 1) @@ -3358,7 +3358,7 @@ SCHEDULED: <2017-05-06 Sat> (org-test-with-temp-text "* H1\n* H2" (org-previous-visible-heading 2) (bobp))) - ;; Invisible parts may not start at a headline, i.e., when revealing + ;; Invisible parts may not start at a heading, i.e., when revealing ;; parts of the buffer. Handle this. (should (org-test-with-temp-text "* Main\n** H1\nFoo\n** H2\nBar\n** H3\nBaz" @@ -3477,7 +3477,7 @@ SCHEDULED: <2017-05-06 Sat> (org-test-with-temp-text "* Headline\n:LOGBOOK:\nlogging\nContents" (org-end-of-meta-data t) (looking-at ":LOGBOOK:"))) - ;; Special case: Be careful about consecutive headlines. + ;; Special case: Be careful about consecutive headings. (should-not (org-test-with-temp-text "* H1\n*H2\nContents" (org-end-of-meta-data t) @@ -3530,7 +3530,7 @@ SCHEDULED: <2017-05-06 Sat> (dotimes (i 1000) (insert "very ")) (org-beginning-of-line) (bolp))) - ;; In a wide headline, with `visual-line-mode', prefer going to the + ;; In a wide heading, with `visual-line-mode', prefer going to the ;; beginning of a visual line than to the logical beginning of line, ;; even if special movement is active. (should-not @@ -3547,7 +3547,7 @@ SCHEDULED: <2017-05-06 Sat> (goto-char (point-max)) (let ((org-special-ctrl-a/e t)) (org-beginning-of-line)) (bobp))) - ;; At an headline with special movement, first move at beginning of + ;; At an heading with special movement, first move at beginning of ;; title, then at the beginning of line, rinse, repeat. (should (org-test-with-temp-text "* TODO Headline" @@ -3570,7 +3570,7 @@ SCHEDULED: <2017-05-06 Sat> (let ((org-special-ctrl-a/e '(nil . nil))) (org-beginning-of-line) (looking-at "Headline")))) - ;; At an headline with reversed movement, first move to beginning of + ;; At an heading with reversed movement, first move to beginning of ;; line, then to the beginning of title. (should (org-test-with-temp-text "* TODO Headline" @@ -3653,7 +3653,7 @@ SCHEDULED: <2017-05-06 Sat> (org-overview) (org-end-of-line) (eobp))) - ;; In a wide headline, with `visual-line-mode', prefer going to end + ;; In a wide heading, with `visual-line-mode', prefer going to end ;; of visible line if tags, or end of line, are farther. (should-not (org-test-with-temp-text "* A long headline" @@ -3669,7 +3669,7 @@ SCHEDULED: <2017-05-06 Sat> (goto-char (point-min)) (org-end-of-line) (eolp))) - ;; At an headline without special movement, go to end of line. + ;; At an heading without special movement, go to end of line. ;; However, never go past ellipsis. (should (org-test-with-temp-text "* Headline2b :tag:\n" @@ -3687,7 +3687,7 @@ SCHEDULED: <2017-05-06 Sat> (let ((org-special-ctrl-a/e nil)) (org-end-of-line) (= 1 (line-beginning-position))))) - ;; At an headline with special movement, first move before tags, + ;; At an heading with special movement, first move before tags, ;; then at the end of line, rinse, repeat. However, never go past ;; ellipsis. (should @@ -3715,7 +3715,7 @@ SCHEDULED: <2017-05-06 Sat> (org-end-of-line) (org-end-of-line) (= 1 (line-beginning-position))))) - ;; At an headline, with reversed movement, first go to end of line, + ;; At an heading, with reversed movement, first go to end of line, ;; then before tags. However, never go past ellipsis. (should (org-test-with-temp-text "* Headline3 :tag:\n" @@ -3815,7 +3815,7 @@ SCHEDULED: <2017-05-06 Sat> (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2." (org-forward-sentence) (eobp))) - ;; Headlines are considered to be sentences by themselves, even if + ;; Headings are considered to be sentences by themselves, even if ;; they do not end with a full stop. (should (equal @@ -4132,19 +4132,19 @@ SCHEDULED: <2017-05-06 Sat> (org-test-with-temp-text "First paragraph.\n\n\nSecond paragraph." (org-forward-element) (should (looking-at (regexp-quote "Second paragraph.")))) - ;; 3. Headline tests. + ;; 3. Heading tests. (org-test-with-temp-text " * Head 1 ** Head 1.1 *** Head 1.1.1 ** Head 1.2" - ;; 3.1. At an headline beginning: move to next headline at the + ;; 3.1. At an heading beginning: move to next heading at the ;; same level. (goto-line 3) (org-forward-element) (should (looking-at (regexp-quote "** Head 1.2"))) - ;; 3.2. At an headline beginning: move to parent headline if no - ;; headline at the same level. + ;; 3.2. At an heading beginning: move to parent heading if no + ;; heading at the same level. (goto-line 3) (org-forward-element) (should (looking-at (regexp-quote "** Head 1.2")))) @@ -4219,23 +4219,23 @@ Outside." (end-of-line) (org-backward-element) (should (looking-at (regexp-quote "Paragraph2.")))) - ;; 4. Headline tests. + ;; 4. Heading tests. (org-test-with-temp-text " * Head 1 ** Head 1.1 *** Head 1.1.1 ** Head 1.2" - ;; 4.1. At an headline beginning: move to previous headline at the + ;; 4.1. At an heading beginning: move to previous heading at the ;; same level. (goto-line 5) (org-backward-element) (should (looking-at (regexp-quote "** Head 1.1"))) - ;; 4.2. At an headline beginning: move to parent headline if no - ;; headline at the same level. + ;; 4.2. At an heading beginning: move to parent heading if no + ;; heading at the same level. (goto-line 3) (org-backward-element) (should (looking-at (regexp-quote "* Head 1"))) - ;; 4.3. At the first top-level headline: should error. + ;; 4.3. At the first top-level heading: should error. (goto-line 2) (should-error (org-backward-element))) ;; 5. At beginning of first element inside a greater element: @@ -4245,7 +4245,7 @@ Outside." (org-backward-element) (should (looking-at "#\\+BEGIN_CENTER"))) ;; 6. At the beginning of the first element in a section: should - ;; move back to headline, if any. + ;; move back to heading, if any. (should (org-test-with-temp-text "#+TITLE: test\n* Headline\n\nParagraph" (progn (goto-char (point-max)) @@ -4305,7 +4305,7 @@ Outside." (org-test-with-temp-text "Paragraph1.\n\nParagraph2." (goto-line 3) (should-error (org-up-element))) - ;; 2. At an headline: move to parent headline. + ;; 2. At an heading: move to parent heading. (org-test-with-temp-text "* Head1\n** Sub-Head1\n** Sub-Head2" (goto-line 3) (org-up-element) @@ -4407,7 +4407,7 @@ Outside." (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER" (org-drag-element-backward)) :type 'user-error) - ;; Error when trying to swap an headline element and a non-headline + ;; Error when trying to swap an heading element and a non-heading ;; element. (should-error (org-test-with-temp-text "Test.\n* Head 1" @@ -4435,7 +4435,7 @@ Text. (mapcar (lambda (ov) (cons (overlay-start ov) (overlay-end ov))) (overlays-in (point-min) (point-max)))))) ;; Pathological case: handle call with point in blank lines right - ;; after a headline. + ;; after a heading. (should (equal "* H2\n\n* H1\nText\n" (org-test-with-temp-text "* H1\nText\n* H2\n\n" @@ -4452,8 +4452,8 @@ Text. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER" (forward-line) (should-error (org-drag-element-forward))) - ;; 3. Error when trying to swap a non-headline element and an - ;; headline. + ;; 3. Error when trying to swap a non-heading element and an + ;; heading. (org-test-with-temp-text "Test.\n* Head 1" (should-error (org-drag-element-forward))) ;; 4. Error when called before first element. @@ -4831,9 +4831,9 @@ Text. (ert-deftest test-org/promote () "Test `org-promote' specifications." - ;; Return an error if headline is to be promoted to level 0, unless + ;; Return an error if heading is to be promoted to level 0, unless ;; `org-allow-promoting-top-level-subtree' is non-nil, in which case - ;; headline becomes a comment. + ;; heading becomes a comment. (should-error (org-test-with-temp-text "* H" (let ((org-allow-promoting-top-level-subtree nil)) (org-promote)))) @@ -5368,7 +5368,7 @@ Paragraph" (buffer-string)))) ;; When a region is active and ;; `org-loop-over-headlines-in-active-region' is non-nil, insert the - ;; same value in all headlines in region. + ;; same value in all headings in region. (should (equal "* H1\nDEADLINE: <2012-03-29>\n* H2\nDEADLINE: <2012-03-29>" (org-test-with-temp-text "* H1\n* H2" @@ -5482,7 +5482,7 @@ Paragraph" (buffer-string)))) ;; When a region is active and ;; `org-loop-over-headlines-in-active-region' is non-nil, insert the - ;; same value in all headlines in region. + ;; same value in all headings in region. (should (equal "* H1\nSCHEDULED: <2012-03-29>\n* H2\nSCHEDULED: <2012-03-29>" (org-test-with-temp-text "* H1\n* H2" @@ -6163,7 +6163,7 @@ Paragraph" (org-test-with-temp-text "* H" (org-entry-put (point) "A" "1") (buffer-string)))) - ;; Special case: two consecutive headlines. + ;; Special case: two consecutive headings. (should (string-match "\\* A\n *:PROPERTIES:" (org-test-with-temp-text "* A\n** B" @@ -6198,8 +6198,8 @@ Paragraph" (org-refresh-properties "A" 'org-test)) (get-text-property (point) 'org-test)))) ;; When a document level property-drawer is used, those properties - ;; should work exactly like headline-properties as if at a - ;; headline-level 0. + ;; should work exactly like heading-properties as if at a + ;; heading-level 0. (should (equal "1" (org-test-with-temp-text @@ -6328,21 +6328,21 @@ Paragraph" (let ((org-refile-use-outline-path nil) (org-refile-targets `((nil :maxlevel . 2)))) (mapcar #'car (org-refile-get-targets)))))) - ;; :level limits targets to headlines with the specified level. + ;; :level limits targets to headings with the specified level. (should (equal '("H2") (org-test-with-temp-text "* H1\n** H2\n*** H3" (let ((org-refile-use-outline-path nil) (org-refile-targets `((nil :level . 2)))) (mapcar #'car (org-refile-get-targets)))))) - ;; :tag limits targets to headlines with specified tag. + ;; :tag limits targets to headings with specified tag. (should (equal '("H1") (org-test-with-temp-text "* H1 :foo:\n** H2\n*** H3 :bar:" (let ((org-refile-use-outline-path nil) (org-refile-targets `((nil :tag . "foo")))) (mapcar #'car (org-refile-get-targets)))))) - ;; :todo limits targets to headlines with specified TODO keyword. + ;; :todo limits targets to headings with specified TODO keyword. (should (equal '("H2") (org-test-with-temp-text "* H1\n** TODO H2\n*** DONE H3" @@ -6356,7 +6356,7 @@ Paragraph" (let ((org-refile-use-outline-path nil) (org-refile-targets `((nil :regexp . "F")))) (mapcar #'car (org-refile-get-targets)))))) - ;; A nil `org-refile-targets' includes only top level headlines in + ;; A nil `org-refile-targets' includes only top level headings in ;; current buffer. (should (equal '("H1" "H2") @@ -6775,7 +6775,7 @@ Paragraph" ;; Return nil when there is no tag. (should-not (org-test-with-temp-text "* Test" (org-get-tags))) - ;; Tags are inherited from parent headlines. + ;; Tags are inherited from parent headings. (should (equal '("tag") (let ((org-use-tag-inheritance t)) @@ -6854,7 +6854,7 @@ Paragraph" (let ((org-use-tag-inheritance t)) (org-mode-restart) ;So that `org-file-tags' get populated from #+filetags (org-get-tags))))) - ;; Pathological case: tagged headline with an empty body. + ;; Pathological case: tagged heading with an empty body. (should (org-test-with-temp-text "* :tag:" (org-get-tags)))) (ert-deftest test-org/set-tags () @@ -6942,7 +6942,7 @@ Paragraph" (let ((org-after-tags-change-hook (lambda () (throw :return t)))) (org-set-tags '("foo")) nil)))) - ;; Special case: handle empty headlines. + ;; Special case: handle empty headings. (should (equal "* :tag0:" (org-test-with-temp-text "* " @@ -6965,11 +6965,11 @@ Paragraph" (set-buffer-modified-p nil) (let ((org-tags-column 10)) (org-set-tags '("bar"))) (buffer-modified-p))) - ;; Pathological case: when setting tags of a folded headline, do not + ;; Pathological case: when setting tags of a folded heading, do not ;; let new tags being sucked into invisibility. (should-not (org-test-with-temp-text "* H1\nContent\n* H2\n\n Other Content" - ;; Show only headlines + ;; Show only headings (org-content) ;; Set NEXT tag on current entry (org-set-tags ":NEXT:") @@ -6980,7 +6980,7 @@ Paragraph" (ert-deftest test-org/set-tags-command () "Test `org-set-tags-command' specifications" - ;; Set tags at current headline. + ;; Set tags at current heading. (should (equal "* H1 :foo:" (org-test-with-temp-text "* H1" @@ -7011,7 +7011,7 @@ Paragraph" (org-at-heading-p)))) ;; When a region is active and ;; `org-loop-over-headlines-in-active-region' is non-nil, insert the - ;; same value in all headlines in region. + ;; same value in all headings in region. (should (equal "* H1 :foo:\nContents\n* H2 :foo:" (org-test-with-temp-text "* H1\nContents\n* H2" @@ -7044,7 +7044,7 @@ Paragraph" (org-test-with-temp-text "* H1 :foo:\n* H2 :bar:" (let ((org-tags-column 1)) (org-set-tags-command '(4))) (buffer-string)))) - ;; Point does not move with empty headline. + ;; Point does not move with empty heading. (should (equal ":foo:" (org-test-with-temp-text "* " @@ -8105,7 +8105,7 @@ CLOSED: %s (org-test-with-temp-text "Preamble\n* Headline" (org-show-set-visibility 'tree) t)) - ;; Test all visibility spans, both on headline and in entry. + ;; Test all visibility spans, both on heading and in entry. (let ((list-visible-lines (lambda (state headerp) (org-test-with-temp-text "* Grandmother (0) diff --git a/testing/lisp/test-ox.el b/testing/lisp/test-ox.el index 54558041b..20c85da12 100644 --- a/testing/lisp/test-ox.el +++ b/testing/lisp/test-ox.el @@ -410,7 +410,7 @@ Paragraph" '((template . (lambda (text info) (org-element-interpret-data (plist-get info :title)))))))))) - ;; When exporting a subtree, its heading becomes the headline of the + ;; When exporting a subtree, its heading becomes the heading of the ;; document... (should (equal @@ -440,7 +440,7 @@ Paragraph" (ert-deftest test-org-export/handle-options () "Test if export options have an impact on output." - ;; Test exclude tags for headlines and inlinetasks. + ;; Test exclude tags for headings and inlinetasks. (should (equal "" (let (org-export-filter-body-functions @@ -466,7 +466,7 @@ Paragraph" (:endgrouptag)))) (org-export-as (org-test-default-backend) nil nil nil '(:exclude-tags ("foo")))))))) - ;; Test include tags for headlines and inlinetasks. + ;; Test include tags for headings and inlinetasks. (should (equal (org-test-with-temp-text "* H1\n* H2\n** Sub :exp:\n*** Sub Sub\n* H3" (let ((org-tags-column 0)) @@ -486,7 +486,7 @@ Paragraph" (org-export-as (org-test-default-backend) nil nil nil '(:select-tags ("foo")))))))) ;; If there is an include tag, ignore the section before the first - ;; headline, if any. + ;; heading, if any. (should (equal (org-test-with-temp-text "First section\n* H1 :exp:\nBody" (let ((org-tags-column 0)) @@ -1154,7 +1154,7 @@ Text" (org-export-expand-include-keyword) (should (equal (buffer-string) "Small Org file with an include keyword.\n"))) - ;; Insertion with constraints on headlines level. + ;; Insertion with constraints on headings level. (should (equal "* Top heading\n** Heading\nbody\n" @@ -1317,7 +1317,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] org-test-dir) (org-export-expand-include-keyword) (buffer-string)))) - ;; Properties should be dropped from headlines. + ;; Properties should be dropped from headings. (should (equal (org-test-with-temp-text @@ -1516,7 +1516,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (kill-buffer buffer)) (when (file-exists-p subdir) (delete-directory subdir t)) (when (file-exists-p includer) (delete-file includer))))))) - ;; Pathological case: Do not error when fixing a path in a headline. + ;; Pathological case: Do not error when fixing a path in a heading. (should (let* ((subdir (make-temp-file "org-includee-" t)) (includee (expand-file-name "includee.org" subdir)) @@ -2589,7 +2589,7 @@ Para2" (org-test-with-parsed-data "Text[fn:1]" (org-export-get-footnote-definition (org-element-map tree 'footnote-reference #'identity info t) info))) - ;; Footnote section should be ignored in TOC and in headlines + ;; Footnote section should be ignored in TOC and in headings ;; numbering. (should (= 1 (let ((org-footnote-section "Footnotes")) @@ -2607,7 +2607,7 @@ Para2" -;;; Headlines and Inlinetasks +;;; Headings and Inlinetasks (ert-deftest test-org-export/get-relative-level () "Test `org-export-get-relative-level' specifications." @@ -2662,13 +2662,13 @@ Para2" (ert-deftest test-org-export/numbered-headline-p () "Test `org-export-numbered-headline-p' specifications." - ;; If `:section-numbers' is nil, never number headlines. + ;; If `:section-numbers' is nil, never number headings. (should-not (org-test-with-parsed-data "* Headline" (org-element-map tree 'headline (lambda (h) (org-export-numbered-headline-p h info)) (plist-put info :section-numbers nil)))) - ;; If `:section-numbers' is a number, only number headlines with + ;; If `:section-numbers' is a number, only number headings with ;; a level greater that it. (should (equal @@ -2677,19 +2677,19 @@ Para2" (org-element-map tree 'headline (lambda (h) (if (org-export-numbered-headline-p h info) 'yes 'no)) (plist-put info :section-numbers 1))))) - ;; Otherwise, headlines are always numbered. + ;; Otherwise, headings are always numbered. (should (org-test-with-parsed-data "* Headline" (org-element-map tree 'headline (lambda (h) (org-export-numbered-headline-p h info)) (plist-put info :section-numbers t)))) - ;; With #+OPTIONS: num:nil all headlines are unnumbered. + ;; With #+OPTIONS: num:nil all headings are unnumbered. (should-not (org-test-with-parsed-data "* H\n#+OPTIONS: num:nil" (org-export-numbered-headline-p (org-element-map tree 'headline 'identity info t) info))) - ;; Headlines with a non-nil UNNUMBERED property are not numbered. + ;; Headings with a non-nil UNNUMBERED property are not numbered. (should-not (org-test-with-parsed-data "* H\n:PROPERTIES:\n:UNNUMBERED: t\n:END:" (org-export-numbered-headline-p @@ -2789,7 +2789,7 @@ Para2" Paragraph" (org-export-get-node-property :PROP (org-element-map tree 'paragraph 'identity nil t) t)))) - ;; Cannot return a value before the first headline. + ;; Cannot return a value before the first heading. (should-not (org-test-with-parsed-data "Paragraph * Headline @@ -2810,7 +2810,7 @@ Para2" :END:" (org-export-get-category (org-element-map tree 'headline 'identity nil t) info)))) - ;; Test inheritance from a parent headline. + ;; Test inheritance from a parent heading. (should (equal '("value" "value") (org-test-with-parsed-data "* Headline1 @@ -2857,14 +2857,14 @@ Para2" (org-element-map tree 'paragraph (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no)) info)))) - ;; Ignore sections for headlines. + ;; Ignore sections for headings. (should (equal '(yes yes) (org-test-with-parsed-data "* H\nSection\n** H 2" (org-element-map tree 'headline (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no)) info)))) - ;; Ignore headlines not exported. + ;; Ignore headings not exported. (should (equal '(yes) @@ -2890,7 +2890,7 @@ Para2" (org-element-map tree 'paragraph (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no)) info)))) - ;; Ignore headlines not exported. + ;; Ignore headings not exported. (should (equal '(yes) @@ -3168,9 +3168,9 @@ Para2" (ert-deftest test-org-export/fuzzy-link () "Test fuzzy links specifications." - ;; Link to an headline should return headline's number. + ;; Link to an heading should return heading's number. (should - ;; Note: Headline's number is in fact a list of numbers. + ;; Note: Heading's number is in fact a list of numbers. (equal '(2) (org-test-with-parsed-data "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]" @@ -3226,7 +3226,7 @@ Paragraph[fn:1][fn:2][fn:lbl3:C<>][[test]][[target]] (org-element-map tree 'link (lambda (link) (org-export-resolve-fuzzy-link link info)) info t))) - ;; Statistics cookies are ignored for headline match. + ;; Statistics cookies are ignored for heading match. (should (org-test-with-parsed-data "* Head [0/0]\n[[Head]]" (org-element-map tree 'link @@ -3542,19 +3542,19 @@ Another text. (ref:text) (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]" (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))) - ;; Match exact headline's name. + ;; Match exact heading's name. (should (org-test-with-parsed-data "* My headline\n[[My headline]]" (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))) - ;; Targets objects have priority over headline titles. + ;; Targets objects have priority over heading titles. (should (eq 'target (org-test-with-parsed-data "* target\n<>[[target]]" (org-element-type (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))))) - ;; Named elements have priority over headline titles. + ;; Named elements have priority over heading titles. (should (eq 'paragraph (org-test-with-parsed-data @@ -3562,7 +3562,7 @@ Another text. (ref:text) (org-element-type (org-export-resolve-fuzzy-link (org-element-map tree 'link 'identity info t) info))))) - ;; If link's path starts with a "*", only match headline titles, + ;; If link's path starts with a "*", only match heading titles, ;; though. (should (eq 'headline @@ -3578,7 +3578,7 @@ Another text. (ref:text) (org-export-resolve-fuzzy-link (org-element-map tree 'link #'identity info t) info) (org-link-broken t)))) - ;; Match fuzzy link even when before first headline. + ;; Match fuzzy link even when before first heading. (should (eq 'headline (org-test-with-parsed-data "[[hl]]\n* hl" @@ -4752,13 +4752,13 @@ This test does not cover listings and custom environments." (org-test-with-parsed-data "* H1\n** H2" (mapcar (lambda (h) (org-element-property :raw-value h)) (org-export-collect-headlines info))))) - ;; Do not collect headlines below optional argument. + ;; Do not collect headings below optional argument. (should (equal '("H1") (org-test-with-parsed-data "* H1\n** H2" (mapcar (lambda (h) (org-element-property :raw-value h)) (org-export-collect-headlines info 1))))) - ;; Never collect headlines below maximum headline level. + ;; Never collect headings below maximum heading level. (should (equal '("H1") (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2" @@ -4776,8 +4776,8 @@ This test does not cover listings and custom environments." (org-test-with-parsed-data "* H1\n** Footnotes" (mapcar (lambda (h) (org-element-property :raw-value h)) (org-export-collect-headlines info)))))) - ;; Do not collect headlines with UNNUMBERED property set to "notoc". - ;; Headlines with another value for the property are still + ;; Do not collect headings with UNNUMBERED property set to "notoc". + ;; Headings with another value for the property are still ;; collected. UNNUMBERED property is inherited. (should (equal '("H1") @@ -4796,14 +4796,14 @@ This test does not cover listings and custom environments." "* H1\n* H2\n:PROPERTIES:\n:UNNUMBERED: t\n:END:" (mapcar (lambda (h) (org-element-property :raw-value h)) (org-export-collect-headlines info))))) - ;; Collect headlines locally. + ;; Collect headings locally. (should (equal '("H2" "H3") (org-test-with-parsed-data "* H1\n** H2\n** H3" (let ((scope (org-element-map tree 'headline #'identity info t))) (mapcar (lambda (h) (org-element-property :raw-value h)) (org-export-collect-headlines info nil scope)))))) - ;; Collect headlines from a scope specified by a fuzzy match + ;; Collect headings from a scope specified by a fuzzy match (should (equal '("H3" "H4") (org-test-with-parsed-data "* HA @@ -4828,7 +4828,7 @@ This test does not cover listings and custom environments." (save-excursion (insert "[[Target]]")) (org-element-link-parser)) info)))))) - ;; Collect headlines from a scope specified by CUSTOM_ID + ;; Collect headings from a scope specified by CUSTOM_ID (should (equal '("H3" "H4") (org-test-with-parsed-data "* Not this section @@ -4863,7 +4863,7 @@ This test does not cover listings and custom environments." (ert-deftest test-org-export/excluded-from-toc-p () "Test `org-export-excluded-from-toc-p' specifications." - ;; By default, headlines are not excluded. + ;; By default, headings are not excluded. (should-not (org-test-with-parsed-data "* H1" (org-element-map tree 'headline -- 2.33.0