From 98b17ef4055d957ebf67d575515d69a53c077570 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20A=2E=20Gomes?= Date: Tue, 5 Oct 2021 22:21:11 +0300 Subject: [PATCH 01/76] Fix documentation (manuals and card). --- doc/Documentation_Standards.org | 2 +- doc/org-guide.org | 120 +++--- doc/org-manual.org | 666 ++++++++++++++++---------------- doc/orgcard.tex | 8 +- 4 files changed, 398 insertions(+), 398 deletions(-) diff --git a/doc/Documentation_Standards.org b/doc/Documentation_Standards.org index c4dd862db..2f18ab11f 100644 --- a/doc/Documentation_Standards.org +++ b/doc/Documentation_Standards.org @@ -112,7 +112,7 @@ version of the manual. - Use example blocks for Org syntax instead of "begin_src org". -- Internal links to headlines always start with a star. +- Internal links to headings always start with a star. - Tags, node properties, are not shown with the surrounding colons. diff --git a/doc/org-guide.org b/doc/org-guide.org index aa793f11a..bb110f812 100644 --- a/doc/org-guide.org +++ b/doc/org-guide.org @@ -107,31 +107,31 @@ worked on. Org greatly simplifies the use of outlines by compressing the entire show and hide functionalities into a single command, ~org-cycle~, which is bound to the {{{kbd(TAB)}}} key. -** Headlines +** Headings :PROPERTIES: :DESCRIPTION: How to typeset Org tree nodes. :END: -Headlines define the structure of an outline tree. The headlines in +Headings define the structure of an outline tree. The headings in Org start on the left margin[fn:1] with one or more stars followed by a space. For example: #+begin_example -,* Top level headline +,* Top level heading ,** Second level ,*** Third level some text ,*** Third level more text -,* Another top level headline +,* Another top level heading #+end_example -Note that a headline named after ~org-footnote-section~, which +Note that a heading named after ~org-footnote-section~, which defaults to =Footnotes=, is considered as special. A subtree with -this headline will be silently ignored by exporting functions. +this heading will be silently ignored by exporting functions. Some people find the many stars too noisy and would prefer an outline -that has whitespace followed by a single star as headline starters. +that has whitespace followed by a single star as heading starters. See [[*Miscellaneous]] for a setup to realize this. ** Visibility Cycling @@ -166,7 +166,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and Show all, including drawers. When Emacs first visits an Org file, the global state is set to -OVERVIEW, i.e., only the top level headlines are visible. This can be +OVERVIEW, i.e., only the top level headings are visible. This can be configured through the variable ~org-startup-folded~, or on a per-file basis by adding a =STARTUP= keyword to =overview=, =content=, =showall=, =showeverything= or =showlevels= (n = 2..5) like this: @@ -175,10 +175,10 @@ basis by adding a =STARTUP= keyword to =overview=, =content=, ** Motion :PROPERTIES: -:DESCRIPTION: Jumping to other headlines. +:DESCRIPTION: Jumping to other headings. :END: -The following commands jump to other headlines in the buffer. +The following commands jump to other headings in the buffer. - {{{kbd(C-c C-n)}}} :: Next heading. @@ -192,7 +192,7 @@ The following commands jump to other headlines in the buffer. ** Structure Editing :PROPERTIES: -:DESCRIPTION: Changing sequence and level of headlines. +:DESCRIPTION: Changing sequence and level of headings. :END: #+attr_texinfo: :sep , @@ -201,7 +201,7 @@ The following commands jump to other headlines in the buffer. Insert new heading with same level as current. If point is in a plain list item, a new item is created (see [[Plain Lists]]). When this command is used in the middle of a line, the line is split and - the rest of the line becomes the new headline[fn:2]. + the rest of the line becomes the new heading[fn:2]. - {{{kbd(M-S-RET)}}} :: @@ -231,7 +231,7 @@ The following commands jump to other headlines in the buffer. Narrow buffer to current subtree and widen it again. When there is an active region (Transient Mark mode), promotion and -demotion work on all headlines in the region. +demotion work on all headings in the region. ** Sparse Trees :PROPERTIES: @@ -241,7 +241,7 @@ demotion work on all headlines in the region. An important feature of Org mode is the ability to construct /sparse trees/ for selected information in an outline tree, so that the entire document is folded as much as possible, but the selected information -is made visible along with the headline structure above it[fn:3]. +is made visible along with the heading structure above it[fn:3]. Just try it out and you will see immediately how it works. Org mode contains several commands creating such trees, all these @@ -305,7 +305,7 @@ an item (the line with the bullet or number). #+attr_texinfo: :sep , - {{{kbd(TAB)}}} :: - Items can be folded just like headline levels. + Items can be folded just like heading levels. - {{{kbd(M-RET)}}} :: @@ -620,7 +620,7 @@ that you have to do, collected from many files. :ALT_TITLE: TODO Basics :END: -Any headline becomes a TODO item when it starts with the word =TODO=, +Any heading becomes a TODO item when it starts with the word =TODO=, for example: : *** TODO Write letter to Sam Fortune @@ -747,7 +747,7 @@ was marked as done. This can be achieved with[fn:4] #+texinfo: @noindent Then each time you turn an entry from a TODO (not-done) state into any of the DONE states, a line =CLOSED: [timestamp]= is inserted just -after the headline. +after the heading. If you want to record a note along with the timestamp, use[fn:5] @@ -766,7 +766,7 @@ entry with a =Closing Note= heading. You might want to keep track of TODO state changes. You can either record just a timestamp, or a time-stamped note for a change. These -records are inserted after the headline as an itemized list. When +records are inserted after the heading as an itemized list. When taking a lot of notes, you might want to get the notes out of the way into a drawer. Customize the variable ~org-log-into-drawer~ to get this behavior. @@ -791,7 +791,7 @@ works also when setting ~org-todo-keywords~. If you use Org mode extensively, you may end up with enough TODO items that it starts to make sense to prioritize them. Prioritizing can be -done by placing a /priority cookie/ into the headline of a TODO item, +done by placing a /priority cookie/ into the heading of a TODO item, like this : *** TODO [#A] Write letter to Sam Fortune @@ -803,13 +803,13 @@ a difference only in the agenda. #+attr_texinfo: :sep ; - {{{kbd(C-c \,)}}} :: - Set the priority of the current headline. Press {{{kbd(A)}}}, + Set the priority of the current heading. Press {{{kbd(A)}}}, {{{kbd(B)}}} or {{{kbd(C)}}} to select a priority, or {{{kbd(SPC)}}} to remove the cookie. - {{{kbd(S-UP)}}} (~org-priority-up~); {{{kbd(S-DOWN)}}} (~org-priority-down~) :: - Increase/decrease the priority of the current headline. + Increase/decrease the priority of the current heading. ** Breaking Tasks Down into Subtasks :PROPERTIES: @@ -821,7 +821,7 @@ It is often advisable to break down large tasks into smaller, manageable subtasks. You can do this by creating an outline tree below a TODO item, with detailed subtasks on the tree. To keep an overview of the fraction of subtasks that have already been marked -as done, insert either =[/]= or =[%]= anywhere in the headline. These +as done, insert either =[/]= or =[%]= anywhere in the heading. These cookies are updated each time the TODO status of a child changes, or when pressing {{{kbd(C-c C-c)}}} on the cookie. For example: @@ -873,18 +873,18 @@ The following commands work with checkboxes: * Tags :PROPERTIES: -:DESCRIPTION: Tagging headlines and matching sets of tags. +:DESCRIPTION: Tagging headings and matching sets of tags. :END: An excellent way to implement labels and contexts for -cross-correlating information is to assign /tags/ to headlines. Org +cross-correlating information is to assign /tags/ to headings. Org mode has extensive support for tags. -Every headline can contain a list of tags; they occur at the end of -the headline. Tags are normal words containing letters, numbers, =_=, +Every heading can contain a list of tags; they occur at the end of +the heading. Tags are normal words containing letters, numbers, =_=, and =@=. Tags must be preceded and followed by a single colon, e.g., =:work:=. Several tags can be specified, as in =:work:urgent:=. Tags -by default are in bold face with the same color as the headline. +by default are in bold face with the same color as the heading. ** Tag inheritance :PROPERTIES: @@ -917,19 +917,19 @@ surrounds the entire file. Use a line like this[fn:6]: :UNNUMBERED: notoc :END: -Tags can simply be typed into the buffer at the end of a headline. +Tags can simply be typed into the buffer at the end of a heading. After a colon, {{{kbd(M-TAB)}}} offers completion on tags. There is also a special command for inserting tags: - {{{kbd(C-c C-q)}}} :: - Enter new tags for the current headline. Org mode either offers + Enter new tags for the current heading. Org mode either offers completion or a special single-key interface for setting tags, see below. - {{{kbd(C-c C-c)}}} :: - When point is in a headline, this does the same as {{{kbd(C-c + When point is in a heading, this does the same as {{{kbd(C-c C-q)}}}. Org supports tag insertion based on a /list of tags/. By default this @@ -980,7 +980,7 @@ or, if tags in the group should be mutually exclusive: When you search for a group tag, it return matches for all members in the group and its subgroups. In an agenda view, filtering by a group -tag displays or hide headlines tagged with at least one of the members +tag displays or hide headings tagged with at least one of the members of the group or any of its subgroups. If you want to ignore group tags temporarily, toggle group tags @@ -993,8 +993,8 @@ support with ~org-toggle-tags-groups~, bound to {{{kbd(C-c C-x q)}}}. - {{{kbd(C-c / m)}}} or {{{kbd(C-c \)}}} :: - Create a sparse tree with all headlines matching a tags search. - With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not + Create a sparse tree with all headings matching a tags search. + With a {{{kbd(C-u)}}} prefix argument, ignore headings that are not a TODO line. - {{{kbd(M-x org-agenda m)}}} :: @@ -1091,7 +1091,7 @@ time information is called a /timestamp/ in Org mode. A timestamp is a specification of a date---possibly with a time or a range of times---in a special format, either =<2003-09-16 Tue>= or =<2003-09-16 Tue 09:39>= or =<2003-09-16 Tue 12:00-12:30>=. -A timestamp can appear anywhere in the headline or body of an Org tree +A timestamp can appear anywhere in the heading or body of an Org tree entry. Its presence causes entries to be shown on specific dates in the agenda (see [[*The Weekly/daily Agenda]]). We distinguish: @@ -1207,7 +1207,7 @@ planning: - {{{kbd(C-c C-d)}}} :: Insert =DEADLINE= keyword along with a time stamp, in the line - following the headline. + following the heading. Meaning: the task---most likely a TODO item, though not necessarily---is supposed to be finished on that date. @@ -1227,12 +1227,12 @@ planning: - {{{kbd(C-c C-s)}}} :: Insert =SCHEDULED= keyword along with a stamp, in the line following - the headline. + the heading. Meaning: you are planning to start working on that task on the given date[fn:7]. - The headline is listed under the given date[fn:8]. In addition, + The heading is listed under the given date[fn:8]. In addition, a reminder that the scheduled date has passed is present in the compilation for /today/, until the entry is marked as done, i.e., the task is automatically forwarded until completed. @@ -1290,7 +1290,7 @@ a project. - {{{kbd(C-c C-x C-j)}}} :: - Jump to the headline of the currently clocked in task. With + Jump to the heading of the currently clocked in task. With a {{{kbd(C-u)}}} prefix argument, select the target task from a list of recently clocked tasks. @@ -1374,7 +1374,7 @@ configuration would look like: #+begin_src emacs-lisp (setq org-capture-templates - '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") + '(("t" "Todo" entry (file+heading "~/org/gtd.org" "Tasks") "* TODO %?\n %i\n %a") ("j" "Journal" entry (file+datetree "~/org/journal.org") "* %?\nEntered on %U\n %i\n %a"))) @@ -1415,7 +1415,7 @@ special command: completion. The item (or all items in the region) is filed below the target heading as a subitem. - By default, all level 1 headlines in the current buffer are + By default, all level 1 headings in the current buffer are considered to be targets, but you can have more complex definitions across a number of files. See the variable ~org-refile-targets~ for details. @@ -1475,7 +1475,7 @@ example: :END: Due to the way Org works, TODO items, time-stamped items, and tagged -headlines can be scattered throughout a file or even a number of +headings can be scattered throughout a file or even a number of files. To get an overview of open action items, or of events that are important for a particular date, this information must be collected, sorted and displayed in an organized way. @@ -1535,7 +1535,7 @@ commands: - {{{kbd(m)}}}, {{{kbd(M)}}} :: - Create a list of headlines matching a given expression (see + Create a list of headings matching a given expression (see [[*Matching Tags and Properties]]). - {{{kbd(s)}}} :: @@ -1607,15 +1607,15 @@ Buffer]]. :DESCRIPTION: Structured information with fine-tuned search. :END: -If headlines in the agenda files are marked with /tags/ (see [[*Tags]]), -or have properties (see [[*Properties]]), you can select headlines based +If headings in the agenda files are marked with /tags/ (see [[*Tags]]), +or have properties (see [[*Properties]]), you can select headings based on this metadata and collect them into an agenda buffer. The match syntax described here also applies when creating sparse trees with {{{kbd(C-c / m)}}}. - {{{kbd(M-x org-agenda m)}}} :: - Produce a list of all headlines that match a given set of tags. The + Produce a list of all headings that match a given set of tags. The command prompts for a selection criterion, which is a boolean logic expression with tags, like =+work+urgent-withboss= or =work|home= (see [[*Tags]]). If you often need a specific search, define a custom @@ -1623,7 +1623,7 @@ syntax described here also applies when creating sparse trees with - {{{kbd(M-x org-agenda M)}}} :: - Like {{{kbd(m)}}}, but only select headlines that are also TODO + Like {{{kbd(m)}}}, but only select headings that are also TODO items. A search string can use Boolean operators =&= for AND and =|= for OR. @@ -1638,7 +1638,7 @@ only tags. - =+work-boss= :: - Select headlines tagged =work=, but discard those also tagged + Select headings tagged =work=, but discard those also tagged =boss=. - =work|laptop= :: @@ -1811,7 +1811,7 @@ the agenda menu and the manual for a complete list. - {{{kbd($)}}} :: - Archive the subtree corresponding to the current headline. + Archive the subtree corresponding to the current heading. - {{{kbd(C-c C-s)}}} :: @@ -1900,12 +1900,12 @@ matching. The example above will therefore define: - {{{kbd(u)}}} :: - as a global tags search for headlines tagged =boss= but not + as a global tags search for headings tagged =boss= but not =urgent=. - {{{kbd(v)}}} :: - The same search, but limiting it to headlines that are also TODO + The same search, but limiting it to headings that are also TODO items. * Markup for Rich Contents @@ -2137,8 +2137,8 @@ pressing {{{kbd(#)}}}. :DESCRIPTION: The if and where of the table of contents. :END: -The table of contents includes all headlines in the document. Its -depth is therefore the same as the headline levels in the file. If +The table of contents includes all headings in the document. Its +depth is therefore the same as the heading levels in the file. If you need to use a different depth, or turn it off entirely, set the ~org-export-with-toc~ variable accordingly. You can achieve the same on a per file basis, using the following =toc= item in =OPTIONS= @@ -2150,7 +2150,7 @@ keyword: #+end_example Org normally inserts the table of contents directly before the first -headline of the file. +heading of the file. ** Include Files :PROPERTIES: @@ -2185,7 +2185,7 @@ are not exported. Finally, a =COMMENT= keyword at the beginning of an entry, but after any other keyword or priority cookie, comments out the entire subtree. -The command below helps changing the comment status of a headline. +The command below helps changing the comment status of a heading. - {{{kbd(C-c ;)}}} :: @@ -2555,8 +2555,8 @@ involved. Type one or more letters and invoke the hot key to complete the text in-place. For example, this command will complete TeX symbols after =\=, TODO -keywords at the beginning of a headline, and tags after =:= in -a headline. +keywords at the beginning of a heading, and tags after =:= in +a heading. ** Structure Templates @@ -2584,13 +2584,13 @@ indentation scheme, as shown on the right in the following table. It uses only one star and indents text to line with the heading: #+begin_example -,* Top level headline | * Top level headline +,* Top level heading | * Top level heading ,** Second level | * Second level ,*** Third level | * Third level some text | some text ,*** Third level | * Third level more text | more text -,* Another top level headline | * Another top level headline +,* Another top level heading | * Another top level heading #+end_example This kind of view can be achieved dynamically at display time using @@ -2604,7 +2604,7 @@ can turn it on for individual files using If you want the indentation to be hard space characters so that the plain text file looks as similar as possible to the Emacs display, Org supports you by helping to indent (with {{{kbd(TAB)}}}) text below -each headline, by hiding leading stars, and by only using levels 1, 3, +each heading, by hiding leading stars, and by only using levels 1, 3, etc to get two characters indentation for each level. To get this support in a file, use @@ -2623,7 +2623,7 @@ support in a file, use * Footnotes [fn:1] See the variable ~org-special-ctrl-a/e~ to configure special -behavior of {{{kbd(C-a)}}} and {{{kbd(C-e)}}} in headlines. +behavior of {{{kbd(C-a)}}} and {{{kbd(C-e)}}} in headings. [fn:2] If you do not want the line to be split, customize the variable ~org-M-RET-may-split-line~. diff --git a/doc/org-manual.org b/doc/org-manual.org index 2cb538975..9843c7242 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -376,28 +376,28 @@ worked on. Org greatly simplifies the use of outlines by compressing the entire show and hide functionalities into a single command, ~org-cycle~, which is bound to the {{{kbd(TAB)}}} key. -** Headlines +** Headings :PROPERTIES: -:DESCRIPTION: How to typeset Org tree headlines. +:DESCRIPTION: How to typeset Org tree headings. :END: -#+cindex: headlines +#+cindex: headings #+cindex: outline tree #+vindex: org-special-ctrl-a/e #+vindex: org-special-ctrl-k #+vindex: org-ctrl-k-protect-subtree -Headlines define the structure of an outline tree. Org headlines +Headings define the structure of an outline tree. Org headings start on the left margin[fn:3] with one or more stars followed by a space. For example: #+begin_example -,* Top level headline +,* Top level heading ,** Second level ,*** Third level some text ,*** Third level more text -,* Another top level headline +,* Another top level heading #+end_example #+vindex: org-footnote-section @@ -405,12 +405,12 @@ The name defined in ~org-footnote-section~ is reserved. Do not use it as a title for your own headings. Some people find the many stars too noisy and would prefer an outline -that has whitespace followed by a single star as headline starters. +that has whitespace followed by a single star as heading starters. This can be achieved using a Org Indent minor mode. See [[*A Cleaner Outline View]] for more information. -Headlines are not numbered. However, you may want to dynamically -number some, or all, of them. See [[*Dynamic Headline Numbering]]. +Headings are not numbered. However, you may want to dynamically +number some, or all, of them. See [[*Dynamic Heading Numbering]]. #+vindex: org-cycle-separator-lines An empty line after the end of a subtree is considered part of it and @@ -456,7 +456,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and #+end_example #+vindex: org-cycle-emulate-tab - Point must be on a headline for this to work[fn:4]. + Point must be on a heading for this to work[fn:4]. - {{{kbd(S-TAB)}}} (~org-global-cycle~), {{{kbd(C-u TAB)}}} :: @@ -476,7 +476,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and #+end_example When {{{kbd(S-TAB)}}} is called with a numeric prefix argument - {{{var(N)}}}, view contents only up to headlines of level + {{{var(N)}}}, view contents only up to headings of level {{{var(N)}}}. Note that inside tables (see [[*Tables]]), {{{kbd(S-TAB)}}} jumps to the @@ -484,7 +484,7 @@ Org uses just two commands, bound to {{{kbd(TAB)}}} and #+vindex: org-cycle-global-at-bob You can run global cycling using {{{kbd(TAB)}}} only if point is at - the very beginning of the buffer, but not on a headline, and + the very beginning of the buffer, but not on a heading, and ~org-cycle-global-at-bob~ is set to a non-~nil~ value. - {{{kbd(C-u C-u TAB)}}} (~org-set-startup-visibility~) :: @@ -599,13 +599,13 @@ invisible edits and process them. ** Motion :PROPERTIES: -:DESCRIPTION: Jumping to other headlines. +:DESCRIPTION: Jumping to other headings. :END: -#+cindex: motion, between headlines -#+cindex: jumping, to headlines -#+cindex: headline navigation +#+cindex: motion, between headings +#+cindex: jumping, to headings +#+cindex: heading navigation -The following commands jump to other headlines in the buffer. +The following commands jump to other headings in the buffer. - {{{kbd(C-c C-n)}}} (~org-next-visible-heading~) :: @@ -648,7 +648,7 @@ The following commands jump to other headlines in the buffer. #+attr_texinfo: :columns 0.3 0.7 | {{{kbd(TAB)}}} | Cycle visibility. | - | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible headline. | + | {{{kbd(DOWN)}}} / {{{kbd(UP)}}} | Next/previous visible heading. | | {{{kbd(RET)}}} | Select this location. | | {{{kbd(/)}}} | Do a Sparse-tree search | @@ -656,8 +656,8 @@ The following commands jump to other headlines in the buffer. The following keys work if you turn off ~org-goto-auto-isearch~ #+attr_texinfo: :columns 0.3 0.7 - | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible headline. | - | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous headline same level. | + | {{{kbd(n)}}} / {{{kbd(p)}}} | Next/previous visible heading. | + | {{{kbd(f)}}} / {{{kbd(b)}}} | Next/previous heading same level. | | {{{kbd(u)}}} | One level up. | | {{{kbd(0)}}} ... {{{kbd(9)}}} | Digit argument. | | {{{kbd(q)}}} | Quit. | @@ -668,10 +668,10 @@ The following commands jump to other headlines in the buffer. ** Structure Editing :PROPERTIES: -:DESCRIPTION: Changing sequence and level of headlines. +:DESCRIPTION: Changing sequence and level of headings. :END: #+cindex: structure editing -#+cindex: headline, promotion and demotion +#+cindex: heading, promotion and demotion #+cindex: promotion, of subtrees #+cindex: demotion, of subtrees #+cindex: subtree, cut and paste @@ -695,7 +695,7 @@ The following commands jump to other headlines in the buffer. beginning of a regular line of text, turn that line into a heading. When this command is used in the middle of a line, the line is split - and the rest of the line becomes the new item or headline. If you + and the rest of the line becomes the new item or heading. If you do not want the line to be split, customize ~org-M-RET-may-split-line~. @@ -723,7 +723,7 @@ The following commands jump to other headlines in the buffer. #+kindex: C-S-RET #+findex: org-insert-todo-heading-respect-content Insert new TODO entry with same level as current heading. Like - {{{kbd(C-RET)}}}, the new headline is inserted after the current + {{{kbd(C-RET)}}}, the new heading is inserted after the current subtree. - {{{kbd(TAB)}}} (~org-cycle~) :: @@ -748,10 +748,10 @@ The following commands jump to other headlines in the buffer. #+cindex: active region #+cindex: transient mark mode When there is an active region---i.e., when Transient Mark mode is - active---promotion and demotion work on all headlines in the region. - To select a region of headlines, it is best to place both point and + active---promotion and demotion work on all headings in the region. + To select a region of headings, it is best to place both point and mark at the beginning of a line, mark at the beginning of the first - headline, and point at the line just after the last headline to + heading, and point at the line just after the last heading to change. - {{{kbd(M-S-LEFT)}}} (~org-promote-subtree~) :: @@ -806,7 +806,7 @@ The following commands jump to other headlines in the buffer. Yank subtree from kill ring. This does modify the level of the subtree to make sure the tree fits in nicely at the yank position. The yank level can also be specified with a numeric prefix argument, - or by yanking after a headline marker like =****=. + or by yanking after a heading marker like =****=. - {{{kbd(C-y)}}} (~org-yank~) :: @@ -849,7 +849,7 @@ The following commands jump to other headlines in the buffer. #+findex: org-sort Sort same-level entries. When there is an active region, all entries in the region are sorted. Otherwise the children of the - current headline are sorted. The command prompts for the sorting + current heading are sorted. The command prompts for the sorting method, which can be alphabetically, numerically, by time---first timestamp with active preferred, creation time, scheduled time, deadline time---by priority, by TODO keyword---in the sequence the @@ -880,13 +880,13 @@ The following commands jump to other headlines in the buffer. #+kindex: C-c * #+findex: org-toggle-heading - Turn a normal line or plain list item into a headline---so that it - becomes a subheading at its location. Also turn a headline into + Turn a normal line or plain list item into a heading---so that it + becomes a subheading at its location. Also turn a heading into a normal line by removing the stars. If there is an active region, - turn all lines in the region into headlines. If the first line in - the region was an item, turn only the item lines into headlines. - Finally, if the first line is a headline, remove the stars from all - headlines in the region. + turn all lines in the region into headings. If the first line in + the region was an item, turn only the item lines into headings. + Finally, if the first line is a heading, remove the stars from all + headings in the region. Note that when point is inside a table (see [[*Tables]]), the Meta-Cursor keys have different functionality. @@ -904,7 +904,7 @@ keys have different functionality. An important feature of Org mode is the ability to construct /sparse trees/ for selected information in an outline tree, so that the entire document is folded as much as possible, but the selected information -is made visible along with the headline structure above it[fn:7]. +is made visible along with the heading structure above it[fn:7]. Just try it out and you will see immediately how it works. Org mode contains several commands creating such trees, all these @@ -924,11 +924,11 @@ commands can be accessed through a dispatcher: #+findex: org-occur #+vindex: org-remove-highlights-with-change Prompts for a regexp (see [[*Regular Expressions]]) and shows a sparse - tree with all matches. If the match is in a headline, the headline - is made visible. If the match is in the body of an entry, headline + tree with all matches. If the match is in a heading, the heading + is made visible. If the match is in the body of an entry, heading and body are made visible. In order to provide minimal context, - also the full hierarchy of headlines above the match is shown, as - well as the headline following the match. Each match is also + also the full hierarchy of headings above the match is shown, as + well as the heading following the match. Each match is also highlighted; the highlights disappear when the buffer is changed by an editing command, or by pressing {{{kbd(C-c C-c)}}}[fn:8]. When called with a {{{kbd(C-u)}}} prefix argument, previous highlights @@ -1065,12 +1065,12 @@ to disable them individually. #+kindex: TAB #+findex: org-cycle #+vindex: org-cycle-include-plain-lists - Items can be folded just like headline levels. Normally this works + Items can be folded just like heading levels. Normally this works only if point is on a plain list item. For more details, see the variable ~org-cycle-include-plain-lists~. If this variable is set to ~integrate~, plain list items are treated like low-level - headlines. The level of an item is then given by the indentation of - the bullet/number. Items are always subordinate to real headlines, + headings. The level of an item is then given by the indentation of + the bullet/number. Items are always subordinate to real headings, however; the hierarchies remain completely separated. In a new item with no text yet, the first {{{kbd(TAB)}}} demotes the item to become a child of the previous one. Subsequent {{{kbd(TAB)}}}s move @@ -1162,7 +1162,7 @@ to disable them individually. - {{{kbd(C-c *)}}} :: #+kindex: C-c * - Turn a plain list item into a headline---so that it becomes + Turn a plain list item into a heading---so that it becomes a subheading at its location. See [[*Structure Editing]], for a detailed explanation. @@ -1198,11 +1198,11 @@ to disable them individually. Sometimes you want to keep information associated with an entry, but you normally do not want to see it. For this, Org mode has /drawers/. -They can contain anything but a headline and another drawer. Drawers +They can contain anything but a heading and another drawer. Drawers look like this: #+begin_example -,** This is a headline +,** This is a heading Still outside the drawer :DRAWERNAME: This is inside the drawer. @@ -1216,14 +1216,14 @@ You can interactively insert a drawer at point by calling ~org-insert-drawer~, which is bound to {{{kbd(C-c C-x d)}}}. With an active region, this command puts the region inside the drawer. With a prefix argument, this command calls ~org-insert-property-drawer~, -which creates a =PROPERTIES= drawer right below the current headline. +which creates a =PROPERTIES= drawer right below the current heading. Org mode uses this special drawer for storing properties (see [[*Properties and Columns]]). You cannot use it for anything else. Completion over drawer keywords is also possible using {{{kbd(M-TAB)}}}[fn:16]. -Visibility cycling (see [[*Visibility Cycling]]) on the headline hides and +Visibility cycling (see [[*Visibility Cycling]]) on the heading hides and shows the entry, but keep the drawer collapsed to a single line. In order to look inside the drawer, you need to move point to the drawer line and press {{{kbd(TAB)}}} there. @@ -3065,7 +3065,7 @@ Org provides several refinements to internal navigation within a document. Most notably, a construct like =[[#my-custom-id]]= specifically targets the entry with the =CUSTOM_ID= property set to =my-custom-id=. Also, an internal link looking like =[[*Some -section]]= points to a headline with the name =Some section=[fn:25]. +section]]= points to a heading with the name =Some section=[fn:25]. #+cindex: targets, for links When the link does not belong to any of the cases above, Org looks for @@ -3085,11 +3085,11 @@ it refers to, as in the following example | of | four cells | #+end_example -#+vindex: org-link-search-must-match-exact-headline -Ultimately, if none of the above succeeds, Org searches for a headline +#+vindex: org-link-search-must-match-exact-heading +Ultimately, if none of the above succeeds, Org searches for a heading that is exactly the link text but may also include a TODO keyword and tags, or initiates a plain text search, according to the value of -~org-link-search-must-match-exact-headline~. +~org-link-search-must-match-exact-heading~. Note that you must make sure custom IDs, dedicated targets, and names are unique throughout the document. Org provides a linter to assist @@ -3170,7 +3170,7 @@ Here is the full set of built-in link types: File links. File name may be remote, absolute, or relative. Additionally, you can specify a line number, or a text search. - In Org files, you may link to a headline name, a custom ID, or a + In Org files, you may link to a heading name, a custom ID, or a code reference instead. As a special case, "file" prefix may be omitted if the file name @@ -3214,7 +3214,7 @@ Here is the full set of built-in link types: - =id= :: - Link to a specific headline by its ID property, in an Org file. + Link to a specific heading by its ID property, in an Org file. - =info= :: @@ -3253,8 +3253,8 @@ options: | | =file:sometextfile::NNN= (jump to line number) | | | =file:projects.org= | | | =file:projects.org::some words= (text search)[fn:27] | -| | =file:projects.org::*task title= (headline search) | -| | =file:projects.org::#custom-id= (headline search) | +| | =file:projects.org::*task title= (heading search) | +| | =file:projects.org::#custom-id= (heading search) | | attachment | =attachment:projects.org= | | | =attachment:projects.org::some words= (text search) | | docview | =docview:papers/last.pdf::NNN= | @@ -3334,13 +3334,13 @@ current buffer: - /Org mode buffers/ :: For Org files, if there is a =<>= at point, the link points - to the target. Otherwise it points to the current headline, which + to the target. Otherwise it points to the current heading, which is also the description[fn:28]. #+vindex: org-id-link-to-org-use-id #+cindex: @samp{CUSTOM_ID}, property #+cindex: @samp{ID}, property - If the headline has a =CUSTOM_ID= property, store a link to this + If the heading has a =CUSTOM_ID= property, store a link to this custom ID. In addition or alternatively, depending on the value of ~org-id-link-to-org-use-id~, create and/or use a globally unique =ID= property for the link[fn:29]. So using this command in Org @@ -3460,7 +3460,7 @@ generally, act on links. ~browse-url-at-point~), run VM/MH-E/Wanderlust/Rmail/Gnus/BBDB for the corresponding links, and execute the command in a shell link. When point is on an internal link, this command runs the - corresponding search. When point is on the tags part of a headline, + corresponding search. When point is on the tags part of a heading, it creates the corresponding tags view (see [[*Matching tags and properties]]). If point is on a timestamp, it compiles the agenda for that date. Furthermore, it visits text and remote files in =file= @@ -3472,8 +3472,8 @@ generally, act on links. a {{{kbd(C-u C-u)}}} prefix. #+vindex: org-link-frame-setup - If point is on a headline, but not on a link, offer all links in the - headline and entry text. If you want to setup the frame + If point is on a heading, but not on a link, offer all links in the + heading and entry text. If you want to setup the frame configuration for following links, customize ~org-link-frame-setup~. - {{{kbd(RET)}}} :: @@ -3664,7 +3664,7 @@ link, together with explanations for each: - =*My Target= :: - In an Org file, restrict search to headlines. + In an Org file, restrict search to headings. - =#my-custom-id= :: @@ -3731,7 +3731,7 @@ have to do. :ALT_TITLE: TODO Basics :END: -Any headline becomes a TODO item when it starts with the word =TODO=, +Any heading becomes a TODO item when it starts with the word =TODO=, for example: : *** TODO Write letter to Sam Fortune @@ -3820,7 +3820,7 @@ with /TODO keywords/ (stored in ~org-todo-keywords~). With special setup, the TODO keyword system can work differently in different files. -Note that /tags/ are another way to classify headlines in general and +Note that /tags/ are another way to classify headings in general and TODO items in particular (see [[*Tags]]). *** TODO keywords as workflow states @@ -4142,7 +4142,7 @@ command ~org-todo~ with a prefix argument. #+kindex: C-u C-c C-t Prompt for a note and record a the time of the TODO state change. - The note is inserted as a list item below the headline, but can also + The note is inserted as a list item below the heading, but can also be placed into a drawer, see [[*Tracking TODO state changes]]. If you want to be more systematic, Org mode can automatically record a @@ -4168,7 +4168,7 @@ TODO item was marked as done. This can be achieved with[fn:41] #+texinfo: @noindent Then each time you turn an entry from a TODO (not-done) state into any of the DONE states, a line =CLOSED: [timestamp]= is inserted just -after the headline. If you turn the entry back into a TODO item +after the heading. If you turn the entry back into a TODO item through further state cycling, that line is removed again. If you turn the entry back to a non-TODO state (by pressing {{{kbd(C-c C-t SPC)}}} for example), that line is also removed, unless you set @@ -4195,7 +4195,7 @@ entry with a =Closing Note= heading. You might want to automatically keep track of when a state change occurred and maybe take a note about this change. You can either record just a timestamp, or a time-stamped note. These records are -inserted after the headline as an itemized list, newest first[fn:43]. +inserted after the heading as an itemized list, newest first[fn:43]. When taking a lot of notes, you might want to get the notes out of the way into a drawer (see [[*Drawers]]). Customize the variable ~org-log-into-drawer~ to get this behavior---the recommended drawer @@ -4379,7 +4379,7 @@ example. If you use Org mode extensively, you may end up with enough TODO items that it starts to make sense to prioritize them. Prioritizing can be -done by placing a /priority cookie/ into the headline of a TODO item +done by placing a /priority cookie/ into the heading of a TODO item right after the TODO keyword, like this: : *** TODO [#A] Write letter to Sam Fortune @@ -4409,10 +4409,10 @@ TODO items. #+kindex: C-c , #+findex: org-priority - Set the priority of the current headline. The command prompts for + Set the priority of the current heading. The command prompts for a priority character =A=, =B= or =C=. When you press {{{kbd(SPC)}}} instead, the priority cookie, if one is set, is removed from the - headline. The priorities can also be changed "remotely" from the + heading. The priorities can also be changed "remotely" from the agenda buffer with the {{{kbd(\,)}}} command (see [[*Commands in the Agenda Buffer]]). @@ -4423,7 +4423,7 @@ TODO items. #+findex: org-priority-up #+findex: org-priority-down #+vindex: org-priority-start-cycle-with-default - Increase/decrease the priority of the current headline[fn:46]. Note + Increase/decrease the priority of the current heading[fn:46]. Note that these keys are also used to modify timestamps (see [[*Creating Timestamps]]). See also [[*Packages that conflict with Org mode]], for a discussion of the interaction with shift-selection. @@ -4457,7 +4457,7 @@ It is often advisable to break down large tasks into smaller, manageable subtasks. You can do this by creating an outline tree below a TODO item, with detailed subtasks on the tree[fn:47]. To keep an overview of the fraction of subtasks that have already been marked -as done, insert either =[/]= or =[%]= anywhere in the headline. These +as done, insert either =[/]= or =[%]= anywhere in the heading. These cookies are updated each time the TODO status of a child changes, or when pressing {{{kbd(C-c C-c)}}} on the cookie. For example: @@ -4544,14 +4544,14 @@ The =[2/4]= and =[1/3]= in the first and second line are cookies indicating how many checkboxes present in this entry have been checked off, and the total number of checkboxes present. This can give you an idea on how many checkboxes remain, even without opening a folded -entry. The cookies can be placed into a headline or into (the first +entry. The cookies can be placed into a heading or into (the first line of) a plain list item. Each cookie covers checkboxes of direct -children structurally below the headline/item on which the cookie +children structurally below the heading/item on which the cookie appears[fn:49]. You have to insert the cookie yourself by typing either =[/]= or =[%]=. With =[/]= you get an =n out of m= result, as in the examples above. With =[%]= you get information about the percentage of checkboxes checked (in the above example, this would be -=[50%]= and =[33%]=, respectively). In a headline, a cookie can count +=[50%]= and =[33%]=, respectively). In a heading, a cookie can count either checkboxes below the heading or TODO states of children, and it displays whatever was changed last. Set the property =COOKIE_DATA= to either =checkbox= or =todo= to resolve this issue. @@ -4586,8 +4586,8 @@ The following commands work with checkboxes: first. With a prefix argument, add or remove the checkbox for all items in the region. - - If point is in a headline, toggle checkboxes in the region between - this headline and the next---so /not/ the entire subtree. + - If point is in a heading, toggle checkboxes in the region between + this heading and the next---so /not/ the entire subtree. - If there is no active region, just toggle the checkbox at point. @@ -4640,23 +4640,23 @@ The following commands work with checkboxes: * Tags :PROPERTIES: -:DESCRIPTION: Tagging headlines and matching sets of tags. +:DESCRIPTION: Tagging headings and matching sets of tags. :END: #+cindex: tags -#+cindex: headline tagging +#+cindex: heading tagging #+cindex: matching, tags #+cindex: sparse tree, tag based An excellent way to implement labels and contexts for -cross-correlating information is to assign /tags/ to headlines. Org +cross-correlating information is to assign /tags/ to headings. Org mode has extensive support for tags. #+vindex: org-tag-faces -Every headline can contain a list of tags; they occur at the end of -the headline. Tags are normal words containing letters, numbers, =_=, +Every heading can contain a list of tags; they occur at the end of +the heading. Tags are normal words containing letters, numbers, =_=, and =@=. Tags must be preceded and followed by a single colon, e.g., =:work:=. Several tags can be specified, as in =:work:urgent:=. Tags -by default are in bold face with the same color as the headline. You +by default are in bold face with the same color as the heading. You may specify special faces for specific tags using the variable ~org-tag-faces~, in much the same way as you can for TODO keywords (see [[*Faces for TODO keywords]]). @@ -4696,7 +4696,7 @@ use the variables ~org-use-tag-inheritance~ and ~org-tags-exclude-from-inheritance~. #+vindex: org-tags-match-list-sublevels -When a headline matches during a tags search while tag inheritance is +When a heading matches during a tags search while tag inheritance is turned on, all the sublevels in the same tree---for a simple match form---match as well[fn:52]. The list of matches may then become very long. If you only want to see the first tags match in a subtree, @@ -4715,13 +4715,13 @@ up agenda generation. ** Setting Tags :PROPERTIES: -:DESCRIPTION: How to assign tags to a headline. +:DESCRIPTION: How to assign tags to a heading. :END: #+cindex: setting tags #+cindex: tags, setting #+kindex: M-TAB -Tags can simply be typed into the buffer at the end of a headline. +Tags can simply be typed into the buffer at the end of a heading. After a colon, {{{kbd(M-TAB)}}} offers completion on tags. There is also a special command for inserting tags: @@ -4731,7 +4731,7 @@ also a special command for inserting tags: #+findex: org-set-tags-command #+cindex: completion, of tags #+vindex: org-tags-column - Enter new tags for the current headline. Org mode either offers + Enter new tags for the current heading. Org mode either offers completion or a special single-key interface for setting tags, see below. After pressing {{{kbd(RET)}}}, the tags are inserted and aligned to ~org-tags-column~. When called with a {{{kbd(C-u)}}} @@ -4743,7 +4743,7 @@ also a special command for inserting tags: - {{{kbd(C-c C-c)}}} (~org-set-tags-command~) :: #+kindex: C-c C-c - When point is in a headline, this does the same as {{{kbd(C-c + When point is in a heading, this does the same as {{{kbd(C-c C-q)}}}. #+vindex: org-complete-tags-always-offer-all-agenda-tags @@ -4836,7 +4836,7 @@ by the following configuration: If at least one tag has a selection key then pressing {{{kbd(C-c C-c)}}} automatically presents you with a special interface, listing -inherited tags, the tags of the current headline, and a list of all +inherited tags, the tags of the current heading, and a list of all valid tags with corresponding keys[fn:54]. Pressing keys assigned to tags adds or removes them from the list of @@ -4888,7 +4888,7 @@ In this interface, you can also use the following special keys: using expert mode, the first {{{kbd(C-c)}}} displays the selection window. -This method lets you assign tags to a headline with very few keys. +This method lets you assign tags to a heading with very few keys. With the above setup, you could clear the current tags and set =@home=, =laptop= and =pc= tags with just the following keys: {{{kbd(C-c C-c SPC h l p RET)}}}. Switching from =@home= to =@work= @@ -4926,7 +4926,7 @@ to classify nodes in a document or set of documents. When you search for a group tag, it return matches for all members in the group and its subgroups. In an agenda view, filtering by a group -tag displays or hide headlines tagged with at least one of the members +tag displays or hide headings tagged with at least one of the members of the group or any of its subgroups. This makes tag searches and filters even more flexible. @@ -5027,8 +5027,8 @@ related information into special lists. #+kindex: C-c / m #+kindex: C-c \ #+findex: org-match-sparse-tree - Create a sparse tree with all headlines matching a tags search. - With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not + Create a sparse tree with all headings matching a tags search. + With a {{{kbd(C-u)}}} prefix argument, ignore headings that are not a TODO line. - {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) :: @@ -5088,7 +5088,7 @@ Properties can be conveniently edited and viewed in column view (see Properties are key--value pairs. When they are associated with a single entry or with a tree they need to be inserted into a special drawer (see [[*Drawers]]) with the name =PROPERTIES=, which has to be -located right below a headline, and its planning line (see [[*Deadlines +located right below a heading, and its planning line (see [[*Deadlines and Scheduling]]) when applicable. Each property is specified on a single line, with the key---surrounded by colons---first, and the value after it. Keys are case-insensitive. Here is an example: @@ -5127,8 +5127,8 @@ disks in a box like this: #+end_example Properties can be inserted on buffer level. That means they apply -before the first headline and can be inherited by all entries in a -file. Property blocks defined before first headline needs to be +before the first heading and can be inherited by all entries in a +file. Property blocks defined before first heading needs to be located at the top of the buffer, allowing only comments above. Properties can also be defined using lines like: @@ -5196,7 +5196,7 @@ The following commands help to work with properties: #+findex: org-insert-drawer Insert a property drawer into the current entry. The drawer is inserted early in the entry, but after the lines with planning - information like deadlines. If before first headline the drawer is + information like deadlines. If before first heading the drawer is inserted at the top of the drawer after any potential comments. - {{{kbd(C-c C-c)}}} (~org-property-action~) :: @@ -5275,10 +5275,10 @@ not be used as keys in the properties drawer: | =CLOSED= | When was this entry closed? | | =DEADLINE= | The deadline timestamp. | | =FILE= | The filename the entry is located in. | -| =ITEM= | The headline of the entry. | +| =ITEM= | The heading of the entry. | | =PRIORITY= | The priority of the entry, a string with a single letter. | | =SCHEDULED= | The scheduling timestamp. | -| =TAGS= | The tags defined directly in the headline. | +| =TAGS= | The tags defined directly in the heading. | | =TIMESTAMP= | The first keyword-less timestamp in the entry. | | =TIMESTAMP_IA= | The first inactive timestamp in the entry. | | =TODO= | The TODO keyword of the entry. | @@ -5300,7 +5300,7 @@ Searches]]). #+kindex: C-c \ #+findex: org-match-sparse-tree Create a sparse tree with all matching entries. With - a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not + a {{{kbd(C-u)}}} prefix argument, ignore headings that are not a TODO line. - {{{kbd(M-x org-agenda m)}}} (~org-tags-view~) :: @@ -5394,12 +5394,12 @@ A great way to view and edit properties in an outline tree is /column view/. In column view, each outline node is turned into a table row. Columns in this table provide access to properties of the entries. Org mode implements columns by overlaying a tabular structure over the -headline of each item. While the headlines have been turned into +heading of each item. While the headings have been turned into a table row, you can still change the visibility of the outline tree. For example, you get a compact table by switching to "contents" view---{{{kbd(S-TAB)}}} {{{kbd(S-TAB)}}}, or simply {{{kbd(c)}}} while column view is active---but you can still open, read, and edit -the entry below each headline. Or, you can switch to column view +the entry below each heading. Or, you can switch to column view after executing a sparse tree command and in this way get a table only for the selected items. Column view also works in agenda buffers (see [[*Agenda Views]]) where queries have collected selected items, possibly @@ -5430,7 +5430,7 @@ a =COLUMNS= property to the top node of that tree, for example: :END: #+end_example -A =COLUMNS= property within a property drawer before first headline +A =COLUMNS= property within a property drawer before first heading will apply to the entire file. As an addition to property drawers, keywords can also be defined for an entire file using a line like: @@ -5534,7 +5534,7 @@ allowed values[fn:57]. #+texinfo: @noindent The first column, =%25ITEM=, means the first 25 characters of the item -itself, i.e., of the headline. You probably always should start the +itself, i.e., of the heading. You probably always should start the column definition with the =ITEM= specifier. The other specifiers create columns =Owner= with a list of names as allowed values, for =Status= with four different possible values, and for a checkbox field @@ -5563,7 +5563,7 @@ either for all clocks or just for today. #+kindex: C-c C-x C-c #+vindex: org-columns #+vindex: org-columns-default-format - Turn on column view. If point is before the first headline in the + Turn on column view. If point is before the first heading in the file, column view is turned on for the entire file, using the =#+COLUMNS= definition. If point is somewhere inside the outline, this command searches the hierarchy, up from point, for a =COLUMNS= @@ -5724,14 +5724,14 @@ This dynamic block has the following parameters: - =:match= :: When set to a string, use this as a tags/property match filter to - select only a subset of the headlines in the scope set by the ~:id~ + select only a subset of the headings in the scope set by the ~:id~ parameter. - =:hlines= :: When ~t~, insert an hline after every line. When a number N, insert - an hline before each headline with level ~<= N~. + an hline before each heading with level ~<= N~. - =:vlines= :: @@ -5829,7 +5829,7 @@ is used in a much wider sense. A timestamp is a specification of a date (possibly with a time or a range of times) in a special format, either =<2003-09-16 Tue>= or =<2003-09-16 Tue 09:39>= or =<2003-09-16 Tue 12:00-12:30>=[fn:59]. -A timestamp can appear anywhere in the headline or body of an Org tree +A timestamp can appear anywhere in the heading or body of an Org tree entry. Its presence causes entries to be shown on specific dates in the agenda (see [[*Weekly/daily agenda]]). We distinguish: @@ -5839,7 +5839,7 @@ the agenda (see [[*Weekly/daily agenda]]). We distinguish: #+cindex: appointment A simple timestamp just assigns a date/time to an item. This is just like writing down an appointment or event in a paper agenda. - In the agenda display, the headline of an entry associated with + In the agenda display, the heading of an entry associated with a plain timestamp is shown exactly on that date. #+begin_example @@ -5879,7 +5879,7 @@ the agenda (see [[*Weekly/daily agenda]]). We distinguish: #+cindex: timerange #+cindex: date range - Two timestamps connected by =--= denote a range. The headline is + Two timestamps connected by =--= denote a range. The heading is shown on the first and last day of the range, and on any dates that are displayed and fall in the range. Here is an example: @@ -5986,7 +5986,7 @@ format. contains a time range like =15:30-16:30=, modifying the first time also shifts the second, shifting the time block with constant length. To change the length, modify the second time. Note that if - point is in a headline and not at a timestamp, these same keys + point is in a heading and not at a timestamp, these same keys modify the priority of an item (see [[*Priorities]]). The key bindings also conflict with shift-selection and related modes (see [[*Packages that conflict with Org mode]]). @@ -6217,7 +6217,7 @@ immediately after the task they refer to. date. #+vindex: org-agenda-skip-scheduled-if-done - The headline is listed under the given date[fn:65]. In addition, + The heading is listed under the given date[fn:65]. In addition, a reminder that the scheduled date has passed is present in the compilation for /today/, until the entry is marked as done, i.e., the task is automatically forwarded until completed. @@ -6277,7 +6277,7 @@ schedule an item:[fn:66] #+findex: org-deadline #+vindex: org-log-redeadline Insert =DEADLINE= keyword along with a stamp. The insertion happens - in the line directly following the headline. Remove any =CLOSED= + in the line directly following the heading. Remove any =CLOSED= timestamp . When called with a prefix argument, also remove any existing deadline from the entry. Depending on the variable ~org-log-redeadline~, take a note when changing an existing @@ -6289,7 +6289,7 @@ schedule an item:[fn:66] #+findex: org-schedule #+vindex: org-log-reschedule Insert =SCHEDULED= keyword along with a stamp. The insertion - happens in the line directly following the headline. Remove any + happens in the line directly following the heading. Remove any =CLOSED= timestamp. When called with a prefix argument, also remove the scheduling date from the entry. Depending on the variable ~org-log-reschedule~, take a note when changing an existing @@ -6583,7 +6583,7 @@ prompted about what to do with it. #+kindex: C-c C-x C-j #+findex: or-clock-goto - Jump to the headline of the currently clocked in task. With + Jump to the heading of the currently clocked in task. With a {{{kbd(C-u)}}} prefix argument, select the target task from a list of recently clocked tasks. @@ -6593,7 +6593,7 @@ prompted about what to do with it. #+findex: org-clock-display #+vindex: org-remove-highlights-with-change Display time summaries for each subtree in the current buffer. This - puts overlays at the end of each headline, showing the total time + puts overlays at the end of each heading, showing the total time recorded under that heading, including the time of any subheadings. You can use visibility cycling to study the tree, but the overlays disappear when you change the buffer (see variable @@ -6771,17 +6771,17 @@ using the =:formatter= parameter. - =:link= :: - Link the item headlines in the table to their origins. + Link the item headings in the table to their origins. - =:narrow= :: - An integer to limit the width of the headline column in the Org - table. If you write it like =50!=, then the headline is also + An integer to limit the width of the heading column in the Org + table. If you write it like =50!=, then the heading is also shortened in export. - =:indent= :: - Indent each headline field according to its level. + Indent each heading field according to its level. - =:hidefiles= :: @@ -6815,7 +6815,7 @@ using the =:formatter= parameter. - =:tags= :: - When this flag is non-~nil~, show the headline's tags. + When this flag is non-~nil~, show the heading's tags. - =:properties= :: @@ -7202,7 +7202,7 @@ special command: the target heading as a subitem. Depending on ~org-reverse-note-order~, it is either the first or last subitem. - By default, all level 1 headlines in the current buffer are + By default, all level 1 headings in the current buffer are considered to be targets, but you can have more complex definitions across a number of files. See the variable ~org-refile-targets~ for details. If you would like to select a location via @@ -7306,10 +7306,10 @@ file, the archive file. - {{{kbd(C-u C-c C-x C-s)}}} :: #+kindex: C-u C-c C-x C-s - Check if any direct children of the current headline could be moved + Check if any direct children of the current heading could be moved to the archive. To do this, check each subtree for open TODO entries. If none is found, the command offers to move it to the - archive location. If point is /not/ on a headline when this command + archive location. If point is /not/ on a heading when this command is invoked, check level 1 trees. - {{{kbd(C-u C-u C-c C-x C-s)}}} :: @@ -7360,7 +7360,7 @@ If you want to just switch off---for agenda views---certain subtrees without moving them to a different file, you can use the =ARCHIVE= tag. -A headline that is marked with the =ARCHIVE= tag (see [[*Tags]]) stays at +A heading that is marked with the =ARCHIVE= tag (see [[*Tags]]) stays at its location in the outline tree, but behaves in the following way: - @@ -7387,7 +7387,7 @@ its location in the outline tree, but behaves in the following way: - #+vindex: org-export-with-archived-trees - Archived trees are not exported (see [[*Exporting]]), only the headline + Archived trees are not exported (see [[*Exporting]]), only the heading is. Configure the details using the variable ~org-export-with-archived-trees~. @@ -7402,17 +7402,17 @@ The following commands help manage the =ARCHIVE= tag: #+kindex: C-c C-x a #+findex: org-toggle-archive-tag - Toggle the archive tag for the current headline. When the tag is - set, the headline changes to a shadowed face, and the subtree below + Toggle the archive tag for the current heading. When the tag is + set, the heading changes to a shadowed face, and the subtree below it is hidden. - {{{kbd(C-u C-c C-x a)}}} :: #+kindex: C-u C-c C-x a - Check if any direct children of the current headline should be + Check if any direct children of the current heading should be archived. To do this, check each subtree for open TODO entries. If none is found, the command offers to set the =ARCHIVE= tag for the - child. If point is /not/ on a headline when this command is + child. If point is /not/ on a heading when this command is invoked, check the level 1 trees. - {{{kbd(C-c C-TAB)}}} (~org-force-cycle-archived~) :: @@ -7568,7 +7568,7 @@ configuration would look like: #+begin_src emacs-lisp (setq org-capture-templates - '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") + '(("t" "Todo" entry (file+heading "~/org/gtd.org" "Tasks") "* TODO %?\n %i\n %a") ("j" "Journal" entry (file+datetree "~/org/journal.org") "* %?\nEntered on %U\n %i\n %a"))) @@ -7632,7 +7632,7 @@ Now lets look at the elements of a template definition. Each entry in - ~entry~ :: - An Org mode node, with a headline. Will be filed as the child of + An Org mode node, with a heading. Will be filed as the child of the target entry or as a top-level entry. The target file should be an Org file. @@ -7679,7 +7679,7 @@ Now lets look at the elements of a template definition. Each entry in Filing as child of this entry, or in the body of the entry. - - =(file+headline "filename" "node headline")= :: + - =(file+heading "filename" "node heading")= :: Fast configuration if the target heading is unique in the file. @@ -8184,7 +8184,7 @@ mentioning. A=. Inheritance works the same way for both =ID= and =DIR= property. If - both properties are defined on the same headline then =DIR= takes + both properties are defined on the same heading then =DIR= takes precedence. This is also true if inheritance is enabled. If =DIR= is inherited from a parent node in the outline, that property still takes precedence over an =ID= property defined on the node itself. @@ -8355,7 +8355,7 @@ Entries=, whenever the following command is used: #+kindex: C-c C-x G Prompt for a feed name and go to the inbox configured for this feed. -Under the same headline, Org creates a drawer =FEEDSTATUS= in which it +Under the same heading, Org creates a drawer =FEEDSTATUS= in which it stores information about the status of items in the feed, to avoid adding the same item several times. @@ -8369,7 +8369,7 @@ For more information, including how to read atom feeds, see #+cindex: agenda views Due to the way Org works, TODO items, time-stamped items, and tagged -headlines can be scattered throughout a file or even a number of +headings can be scattered throughout a file or even a number of files. To get an overview of open action items, or of events that are important for a particular date, this information must be collected, sorted and displayed in an organized way. @@ -8382,7 +8382,7 @@ a separate buffer. Six different view types are provided: - a /TODO list/ that covers all unfinished action items, -- a /match view/, showings headlines based on the tags, properties, +- a /match view/, showings headings based on the tags, properties, and TODO state associated with them, - a /text search view/ that shows all entries from multiple files that @@ -8479,7 +8479,7 @@ scope for an extended period, use the following commands: #+findex: org-agenda-set-restriction-lock Restrict the agenda to the current subtree. If there already is a restriction at point, remove it. When called with a universal - prefix argument or with point before the first headline in a file, + prefix argument or with point before the first heading in a file, set the agenda scope to the entire file. This restriction remains in effect until removed with {{{kbd(C-c C-x >)}}}, or by typing either {{{kbd(<)}}} or {{{kbd(>)}}} in the agenda dispatcher. If @@ -8534,7 +8534,7 @@ commands: - {{{kbd(m)}}}, {{{kbd(M)}}} :: - Create a list of headlines matching a given expression (see + Create a list of headings matching a given expression (see [[*Matching tags and properties]]). - {{{kbd(s)}}} :: @@ -8829,7 +8829,7 @@ a TODO entry with a single key press. The commands available in the TODO list are described in [[*Commands in the Agenda Buffer]]. #+cindex: sublevels, inclusion into TODO list -Normally the global TODO list simply shows all headlines with TODO +Normally the global TODO list simply shows all headings with TODO keywords. This list can become very long. There are two ways to keep it more compact: @@ -8852,7 +8852,7 @@ it more compact: #+vindex: org-agenda-todo-list-sublevels TODO items may have sublevels to break up the task into subtasks. In such cases it may be enough to list only the highest level TODO - headline and omit the sublevels from the global list. Configure the + heading and omit the sublevels from the global list. Configure the variable ~org-agenda-todo-list-sublevels~ to get this behavior. *** Matching tags and properties @@ -8864,9 +8864,9 @@ it more compact: #+cindex: tags view #+cindex: match view -If headlines in the agenda files are marked with /tags/ (see [[*Tags]]), +If headings in the agenda files are marked with /tags/ (see [[*Tags]]), or have properties (see [[*Properties and Columns]]), you can select -headlines based on this metadata and collect them into an agenda +headings based on this metadata and collect them into an agenda buffer. The match syntax described here also applies when creating sparse trees with {{{kbd(C-c / m)}}}. @@ -8874,7 +8874,7 @@ sparse trees with {{{kbd(C-c / m)}}}. #+kindex: m @r{(Agenda dispatcher)} #+findex: org-tags-view - Produce a list of all headlines that match a given set of tags. The + Produce a list of all headings that match a given set of tags. The command prompts for a selection criterion, which is a boolean logic expression with tags, like =+work+urgent-withboss= or =work|home= (see [[*Tags]]). If you often need a specific search, define a custom @@ -8886,7 +8886,7 @@ sparse trees with {{{kbd(C-c / m)}}}. #+findex: org-tags-view #+vindex: org-tags-match-list-sublevels #+vindex: org-agenda-tags-todo-honor-ignore-options - Like {{{kbd(m)}}}, but only select headlines that are also TODO + Like {{{kbd(m)}}}, but only select headings that are also TODO items and force checking subitems (see the variable ~org-tags-match-list-sublevels~). To exclude scheduled/deadline items, see the variable ~org-agenda-tags-todo-honor-ignore-options~. @@ -8909,7 +8909,7 @@ only tags. - =+work-boss= :: - Select headlines tagged =work=, but discard those also tagged + Select headings tagged =work=, but discard those also tagged =boss=. - =work|laptop= :: @@ -8924,14 +8924,14 @@ only tags. #+cindex: regular expressions, with tags search Instead of a tag, you may also specify a regular expression enclosed in curly braces (see [[*Regular Expressions]]). For example, -=work+{^boss.*}= matches headlines that contain the tag =:work:= and +=work+{^boss.*}= matches headings that contain the tag =:work:= and any tag /starting/ with =boss=. #+cindex: group tags, as regular expressions Group tags (see [[*Tag Hierarchy]]) are expanded as regular expressions. E.g., if =work= is a group tag for the group =:work:lab:conf:=, then searching for =work= also searches for ={\(?:work\|lab\|conf\)}= and -searching for =-work= searches for all headlines but those with one of +searching for =-work= searches for all headings but those with one of the tags in the group (i.e., =-{\(?:work\|lab\|conf\)}=). #+cindex: TODO keyword matching, with tags search @@ -8944,7 +8944,7 @@ special properties that represent other metadata (see [[*Special Properties]]). For example, the property =TODO= represents the TODO keyword of the entry. Or, the property =LEVEL= represents the level of an entry. So searching =+LEVEL=3+boss-TODO​="DONE"= lists all level -three headlines that have the tag =boss= and are /not/ marked with the +three headings that have the tag =boss= and are /not/ marked with the TODO keyword =DONE=. In buffers with ~org-odd-levels-only~ set, =LEVEL= does not count the number of stars, but =LEVEL=2= corresponds to 3 stars etc. @@ -9102,7 +9102,7 @@ and define next actions for them. You almost certainly need to configure this view before it works for you. The built-in default assumes that all your projects are level-2 -headlines, and that a project is not stuck if it has at least one +headings, and that a project is not stuck if it has at least one entry marked with a TODO keyword =TODO= or =NEXT= or =NEXTACTION=. Let's assume that you, in your own way of using Org mode, identify @@ -9142,7 +9142,7 @@ of the item and other important information. You can customize in which column tags are displayed through ~org-agenda-tags-column~. You can also customize the prefix using the option ~org-agenda-prefix-format~. This prefix is followed by a cleaned-up -version of the outline headline associated with the item. +version of the outline heading associated with the item. *** Categories :PROPERTIES: @@ -9185,8 +9185,8 @@ Time ranges can be specified with two timestamps: : <2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15> -#+vindex: org-agenda-search-headline-for-time -In the headline of the entry itself, a time(range)---like =12:45= or +#+vindex: org-agenda-search-heading-for-time +In the heading of the entry itself, a time(range)---like =12:45= or a =8:30-1pm=---may also appear as plain text[fn:97]. If the agenda integrates the Emacs diary (see [[*Weekly/daily agenda]]), @@ -9291,7 +9291,7 @@ agenda commands. #+cindex: filtering entries, in agenda #+cindex: tag filtering, in agenda #+cindex: category filtering, in agenda -#+cindex: top headline filtering, in agenda +#+cindex: top heading filtering, in agenda #+cindex: effort filtering, in agenda #+cindex: query editing, in agenda @@ -9355,11 +9355,11 @@ filter elements are accumulated. filter, press {{{kbd(_)}}} twice (once to call the command again, and once at the first prompt). -- {{{kbd(^)}}} (~org-agenda-filter-by-top-headline~) :: +- {{{kbd(^)}}} (~org-agenda-filter-by-top-heading~) :: - #+findex: org-agenda-filter-by-top-headline + #+findex: org-agenda-filter-by-top-heading Filter the current agenda view and only display items that fall - under the same top-level headline as the current entry. To clear + under the same top-level heading as the current entry. To clear the filter, call this command again by pressing {{{kbd(^)}}}. - {{{kbd(/)}}} (~org-agenda-filter~) :: @@ -9905,7 +9905,7 @@ the other commands, point needs to be in the desired line. #+kindex: C-c C-x a #+findex: org-agenda-toggle-archive-tag Toggle the archive tag (see [[*Internal archiving]]) for the current - headline. + heading. - {{{kbd(C-c C-x A)}}} (~org-agenda-archive-to-archive-sibling~) :: @@ -9919,7 +9919,7 @@ the other commands, point needs to be in the desired line. #+kindex: C-c C-x C-s #+kindex: $ #+findex: org-agenda-archive - Archive the subtree corresponding to the current headline. This + Archive the subtree corresponding to the current heading. This means the entry is moved to the configured archive location, most likely a different file. @@ -9930,13 +9930,13 @@ the other commands, point needs to be in the desired line. #+vindex: org-agenda-show-inherited-tags Show all tags associated with the current item. This is useful if you have turned off ~org-agenda-show-inherited-tags~, but still want - to see all tags of a headline occasionally. + to see all tags of a heading occasionally. - {{{kbd(:)}}} (~org-agenda-set-tags~) :: #+kindex: : #+findex: org-agenda-set-tags - Set tags for the current headline. If there is an active region in + Set tags for the current heading. If there is an active region in the agenda, change a tag for all headings in the region. - {{{kbd(\,)}}} (~org-agenda-priority~) :: @@ -10373,12 +10373,12 @@ above will therefore define: - {{{kbd(u)}}} :: - as a global tags search for headlines tagged =boss= but not + as a global tags search for headings tagged =boss= but not =urgent=. - {{{kbd(v)}}} :: - The same search, but limiting it to headlines that are also TODO + The same search, but limiting it to headings that are also TODO items. - {{{kbd(U)}}} :: @@ -10467,8 +10467,8 @@ at the right spot in ~org-agenda-custom-commands~. For example: Now the {{{kbd(w)}}} command sorts the collected entries only by priority, and the prefix format is modified to just say =Mixed:= instead of giving the category of the entry. The sparse tags tree of -{{{kbd(U)}}} now turns out ultra-compact, because neither the headline -hierarchy above the match, nor the headline following the match are +{{{kbd(U)}}} now turns out ultra-compact, because neither the heading +hierarchy above the match, nor the heading following the match are shown. The command {{{kbd(N)}}} does a text search limited to only a single file. @@ -11009,7 +11009,7 @@ images. Produce a preview image of the LaTeX fragment at point and overlay it over the source code. If there is no fragment at point, process - all fragments in the current entry---between two headlines. + all fragments in the current entry---between two headings. When called with a single prefix argument, clear all images in the current entry. Two prefix arguments produce a preview image for all @@ -11127,7 +11127,7 @@ the contents of the block. #+begin_example ,#+BEGIN_EXAMPLE -,,* I am no real headline +,,* I am no real heading ,#+END_EXAMPLE #+end_example @@ -11323,7 +11323,7 @@ as a horizontal line. A footnote is started by a footnote marker in square brackets in column 0, no indentation allowed. It ends at the next footnote -definition, headline, or after two consecutive empty lines. The +definition, heading, or after two consecutive empty lines. The footnote reference is simply the marker in square brackets, inside text. Markers always start with =fn:=. For example: @@ -11601,7 +11601,7 @@ global variables, include: =export= (~org-export-select-tags~), Org selects that tree and its sub-trees for export. Org excludes trees with =noexport= tags, see below. When selectively exporting files with =export= tags set, Org - does not export any text that appears before the first headline. + does not export any text that appears before the first heading. - =EXCLUDE_TAGS= :: @@ -11678,9 +11678,9 @@ following arguments. - ~arch~ :: #+vindex: org-export-with-archived-trees - Configure how archived trees are exported. When set to ~headline~, + Configure how archived trees are exported. When set to ~heading~, the export process skips the contents and processes only the - headlines (~org-export-with-archived-trees~). + headings (~org-export-with-archived-trees~). - ~author~ :: @@ -11736,9 +11736,9 @@ following arguments. - ~H~ :: - #+vindex: org-export-headline-levels - Set the number of headline levels for export - (~org-export-headline-levels~). Below that level, headlines are + #+vindex: org-export-heading-levels + Set the number of heading levels for export + (~org-export-heading-levels~). Below that level, headings are treated differently. In most back-ends, they become list items. - ~inline~ :: @@ -11751,10 +11751,10 @@ following arguments. #+vindex: org-export-with-section-numbers #+cindex: @samp{UNNUMBERED}, property Toggle section-numbers (~org-export-with-section-numbers~). When - set to number N, Org numbers only those headlines at level N or + set to number N, Org numbers only those headings at level N or above. Set =UNNUMBERED= property to non-~nil~ to disable numbering of heading and subheadings entirely. Moreover, when the value is - =notoc= the headline, and all its children, do not appear in the + =notoc= the heading, and all its children, do not appear in the table of contents either (see [[*Table of Contents]]). - ~p~ :: @@ -11762,7 +11762,7 @@ following arguments. #+vindex: org-export-with-planning Toggle export of planning information (~org-export-with-planning~). "Planning information" comes from lines located right after the - headline and contain any combination of these cookies: =SCHEDULED=, + heading and contain any combination of these cookies: =SCHEDULED=, =DEADLINE=, or =CLOSED=. - ~pri~ :: @@ -11853,8 +11853,8 @@ in-buffer settings that cannot be changed using keywords. #+cindex: @samp{toc}, in @samp{OPTIONS} keyword #+vindex: org-export-with-toc -The table of contents includes all headlines in the document. Its -depth is therefore the same as the headline levels in the file. If +The table of contents includes all headings in the document. Its +depth is therefore the same as the heading levels in the file. If you need to use a different depth, or turn it off entirely, set the ~org-export-with-toc~ variable accordingly. You can achieve the same on a per file basis, using the following =toc= item in =OPTIONS= @@ -11867,8 +11867,8 @@ keyword: #+cindex: excluding entries from table of contents #+cindex: table of contents, exclude entries -Org includes both numbered and unnumbered headlines in the table of -contents[fn:124]. If you need to exclude an unnumbered headline, +Org includes both numbered and unnumbered headings in the table of +contents[fn:124]. If you need to exclude an unnumbered heading, along with all its children, set the =UNNUMBERED= property to =notoc= value. @@ -11881,15 +11881,15 @@ value. #+cindex: @samp{TOC}, keyword Org normally inserts the table of contents directly before the first -headline of the file. To move the table of contents to a different +heading of the file. To move the table of contents to a different location, first turn off the default with ~org-export-with-toc~ -variable or with =#+OPTIONS: toc:nil=. Then insert =#+TOC: headlines +variable or with =#+OPTIONS: toc:nil=. Then insert =#+TOC: headings N= at the desired location(s). #+begin_example ,#+OPTIONS: toc:nil ... -,#+TOC: headlines 2 +,#+TOC: headings 2 #+end_example To adjust the table of contents depth for a specific section of the @@ -11899,7 +11899,7 @@ inserts a local table of contents, with direct children only. #+begin_example ,* Section -,#+TOC: headlines 1 local +,#+TOC: headings 1 local #+end_example Note that for this feature to work properly in LaTeX export, the Org @@ -11918,7 +11918,7 @@ children of the specified target. ,** Heading A ,** Heading B ,* Another section -,#+TOC: headlines 1 :target #TargetSection +,#+TOC: headings 1 :target #TargetSection #+end_example The =:target= attribute is supported in HTML, Markdown, ODT, and ASCII export. @@ -11932,7 +11932,7 @@ listings---with captions. #+end_example #+cindex: @samp{ALT_TITLE}, property -Normally Org uses the headline for its entry in the table of contents. +Normally Org uses the heading for its entry in the table of contents. But with =ALT_TITLE= property, a different entry can be specified for the table of contents. @@ -11966,13 +11966,13 @@ If an included file is not specified as having any markup language, Org assumes it be in Org format and proceeds as usual with a few exceptions. Org makes the footnote labels (see [[*Creating Footnotes]]) in the included file local to that file. The contents of the included -file belong to the same structure---headline, item---containing the -=INCLUDE= keyword. In particular, headlines within the file become +file belong to the same structure---heading, item---containing the +=INCLUDE= keyword. In particular, headings within the file become children of the current section. That behavior can be changed by providing an additional keyword parameter, =:minlevel=. It shifts the -headlines in the included file to become the lowest level. For +headings in the included file to become the lowest level. For example, this syntax makes the included file a sibling of the current -top-level headline: +top-level heading: : #+INCLUDE: "~/my-book/chapter2.org" :minlevel 1 @@ -11994,7 +11994,7 @@ Therefore, : #+INCLUDE: "./paper.org::*conclusion" :lines 1-20 #+texinfo: @noindent -includes the first 20 lines of the headline named =conclusion=. +includes the first 20 lines of the heading named =conclusion=. #+cindex: @samp{only-contents}, include To extract only the contents of the matched object, set @@ -12051,7 +12051,7 @@ macro turns ={{{gnustamp(linux)}}}= into =GNU/Linux= during export. Org recognizes macro references in following Org markup areas: -paragraphs, headlines, verse blocks, tables cells and lists. Org also +paragraphs, headings, verse blocks, tables cells and lists. Org also recognizes macro references in keywords, such as =CAPTION=, =TITLE=, =AUTHOR=, =DATE=, and for some back-end specific export options. @@ -12147,7 +12147,7 @@ Finally, a =COMMENT= keyword at the beginning of an entry, but after any other keyword or priority cookie, comments out the entire subtree. In this case, the subtree is not exported and no code block within it is executed either[fn:127]. The command below helps changing the -comment status of a headline. +comment status of a heading. - {{{kbd(C-c ;)}}} (~org-toggle-comment~) :: #+kindex: C-c ; @@ -12225,7 +12225,7 @@ output. Setting this keyword works similar to the general options :UNNUMBERED: notoc :END: -Org converts the first three outline levels into headlines for ASCII +Org converts the first three outline levels into headings for ASCII export. The remaining levels are turned into lists. To change this cut-off point where levels become lists, see [[*Export Settings]]. @@ -12404,15 +12404,15 @@ should in principle be exportable as a Beamer presentation. - #+vindex: org-beamer-frame-level - Org headlines become Beamer frames when the heading level in Org is + Org headings become Beamer frames when the heading level in Org is equal to ~org-beamer-frame-level~ or =H= value in a =OPTIONS= line (see [[*Export Settings]]). #+cindex: @samp{BEAMER_ENV}, property - Org overrides headlines to frames conversion for the current tree of + Org overrides headings to frames conversion for the current tree of an Org file if it encounters the =BEAMER_ENV= property set to =frame= or =fullframe=. Org ignores whatever - ~org-beamer-frame-level~ happens to be for that headline level in + ~org-beamer-frame-level~ happens to be for that heading level in the Org tree. In Beamer terminology, a full frame is a frame without its title. @@ -12434,15 +12434,15 @@ should in principle be exportable as a Beamer presentation. with =\againframe= command, which makes setting the =BEAMER_REF= property mandatory because =\againframe= needs frame to resume. - When =ignoreheading= is set, Org export ignores the entry's headline + When =ignoreheading= is set, Org export ignores the entry's heading but not its content. This is useful for inserting content between frames. It is also useful for properly closing a =column= environment. @end itemize #+cindex: @samp{BEAMER_ACT}, property #+cindex: @samp{BEAMER_OPT}, property - When =BEAMER_ACT= is set for a headline, Org export translates that - headline as an overlay or action specification. When enclosed in + When =BEAMER_ACT= is set for a heading, Org export translates that + heading as an overlay or action specification. When enclosed in square brackets, Org export makes the overlay specification a default. Use =BEAMER_OPT= to set any options applicable to the current Beamer frame or block. The Beamer export back-end wraps @@ -12451,7 +12451,7 @@ should in principle be exportable as a Beamer presentation. #+cindex: @samp{BEAMER_COL}, property To create a column on the Beamer slide, use the =BEAMER_COL= - property for its headline in the Org file. Set the value of + property for its heading in the Org file. Set the value of =BEAMER_COL= to a decimal number representing the fraction of the total text width. Beamer export uses this value to set the column's width and fills the column with the contents of the Org entry. If @@ -12459,7 +12459,7 @@ should in principle be exportable as a Beamer presentation. ignores the heading. If the Org entry has a defined environment, Beamer export uses the heading as title. Behind the scenes, Beamer export automatically handles LaTeX column separations for contiguous - headlines. To manually adjust them for any unique configurations + headings. To manually adjust them for any unique configurations needs, use the =BEAMER_ENV= property. *** Beamer specific syntax @@ -12476,7 +12476,7 @@ Beamer export wraps the table of contents generated with =toc:t= wrap the table of contents generated with =TOC= keyword (see [[*Table of Contents]]). Use square brackets for specifying options. -: #+TOC: headlines [currentsection] +: #+TOC: headings [currentsection] Insert Beamer-specific code using the following constructs: @@ -12784,9 +12784,9 @@ HTML exporter reverts to standard translation (see ~org-html-html5-elements~). For example, =#+BEGIN_lederhosen= exports to ~
~. -Special blocks cannot have headlines. For the HTML exporter to wrap -the headline and its contents in ~
~ or ~
~ tags, set -the =HTML_CONTAINER= property for the headline. +Special blocks cannot have headings. For the HTML exporter to wrap +the heading and its contents in ~
~ or ~
~ tags, set +the =HTML_CONTAINER= property for the heading. *** HTML preamble and postamble :PROPERTIES: @@ -12842,20 +12842,20 @@ For larger raw HTML code blocks, use these HTML export code blocks: ,#+END_EXPORT #+end_example -*** Headlines in HTML export +*** Headings in HTML export :PROPERTIES: -:DESCRIPTION: Formatting headlines. +:DESCRIPTION: Formatting headings. :END: -#+cindex: headlines, in HTML export +#+cindex: headings, in HTML export -Headlines are exported to =

=, =

=, etc. Each headline gets the +Headings are exported to =

=, =

=, etc. Each heading gets the =id= attribute from =CUSTOM_ID= property, or a unique generated value, see [[*Internal Links]]. -#+vindex: org-html-self-link-headlines -When ~org-html-self-link-headlines~ is set to a non-~nil~ value, the -text of the headlines is also wrapped in == tags. These tags have -a =href= attribute making the headlines link to themselves. +#+vindex: org-html-self-link-headings +When ~org-html-self-link-headings~ is set to a non-~nil~ value, the +text of the headings is also wrapped in == tags. These tags have +a =href= attribute making the headings link to themselves. *** Links in HTML export :PROPERTIES: @@ -13084,7 +13084,7 @@ You can modify the CSS style definitions for the exported file. The HTML exporter assigns the following special CSS classes[fn:132] to appropriate parts of the document---your style specifications may change these, in addition to any of the standard classes like for -headlines, tables, etc. +headings, tables, etc. | ~p.author~ | author information, including email | | ~p.date~ | publishing date | @@ -13097,14 +13097,14 @@ headlines, tables, etc. | ~.timestamp~ | timestamp | | ~.timestamp-kwd~ | keyword associated with a timestamp, like =SCHEDULED= | | ~.timestamp-wrapper~ | span around keyword plus timestamp | -| ~.tag~ | tag in a headline | +| ~.tag~ | tag in a heading | | ~._HOME~ | each tag uses itself as a class, "@" replaced by "_" | | ~.target~ | target for links | | ~.linenr~ | the line number in a code example | | ~.code-highlighted~ | for highlighting referenced code lines | -| ~div.outline-N~ | div for outline level N (headline plus text) | +| ~div.outline-N~ | div for outline level N (heading plus text) | | ~div.outline-text-N~ | extra div for text at outline level N | -| ~.section-number-N~ | section number in headlines, different for each level | +| ~.section-number-N~ | section number in headings, different for each level | | ~.figure-number~ | label like "Figure 1:" | | ~.table-number~ | label like "Table 1:" | | ~.listing-number~ | label like "Listing 1:" | @@ -13112,7 +13112,7 @@ headlines, tables, etc. | ~pre.src~ | formatted source code | | ~pre.example~ | normal example | | ~p.verse~ | verse paragraph | -| ~div.footnotes~ | footnote section headline | +| ~div.footnotes~ | footnote section heading | | ~p.footnote~ | footnote definition paragraph, containing a footnote | | ~.footref~ | a footnote reference number (always a ) | | ~.footnum~ | footnote number in footnote definition (always ) | @@ -13148,12 +13148,12 @@ around them. Both of these approaches can avoid referring to an external file. #+cindex: @samp{HTML_CONTAINER_CLASS}, property -#+cindex: @samp{HTML_HEADLINE_CLASS}, property +#+cindex: @samp{HTML_HEADING_CLASS}, property In order to add styles to a sub-tree, use the =HTML_CONTAINER_CLASS= property to assign a class to the tree. In order to specify CSS -styles for a particular headline, you can use the ID specified in +styles for a particular heading, you can use the ID specified in a =CUSTOM_ID= property. You can also assign a specific class to -a headline with the =HTML_HEADLINE_CLASS= property. +a heading with the =HTML_HEADING_CLASS= property. Never change the ~org-html-style-default~ constant. Instead use other simpler ways of customizing as described above. @@ -13197,16 +13197,16 @@ options described below: | =info= | Info-like interface with one section per page | | =overview= | Folding interface, initially showing only top-level | - | =content= | Folding interface, starting with all headlines visible | - | =showall= | Folding interface, all headlines and text visible | + | =content= | Folding interface, starting with all headings visible | + | =showall= | Folding interface, all headings and text visible | - =sdepth:= :: - Maximum headline level still considered as an independent section + Maximum heading level still considered as an independent section for info and folding modes. The default is taken from - ~org-export-headline-levels~, i.e., the =H= switch in =OPTIONS=. If - this is smaller than in ~org-export-headline-levels~, each - info/folding section can still contain child headlines. + ~org-export-heading-levels~, i.e., the =H= switch in =OPTIONS=. If + this is smaller than in ~org-export-heading-levels~, each + info/folding section can still contain child headings. - =toc:= :: @@ -13216,7 +13216,7 @@ options described below: - =tdepth:= :: The depth of the table of contents. The defaults are taken from the - variables ~org-export-headline-levels~ and ~org-export-with-toc~. + variables ~org-export-heading-levels~ and ~org-export-with-toc~. - =ftoc:= :: @@ -13363,7 +13363,7 @@ general options (see [[*Export Settings]]). #+vindex: org-latex-default-class #+vindex: org-latex-classes This is LaTeX document class, such as /article/, /report/, /book/, - and so on, which contain predefined preamble and headline level + and so on, which contain predefined preamble and heading level mapping that the LaTeX export back-end needs. The back-end reads the default class name from the ~org-latex-default-class~ variable. Org has /article/ as the default class. A valid default class must @@ -13429,7 +13429,7 @@ The following sections have further details. #+cindex: sectioning structure, for @LaTeX{} export The LaTeX export back-end converts the first three of Org's outline -levels into LaTeX headlines. The remaining Org levels are exported as +levels into LaTeX headings. The remaining Org levels are exported as lists. To change this globally for the cut-off point between levels and lists, (see [[*Export Settings]]). @@ -13476,9 +13476,9 @@ A sample Org file with the above headers: ,#+LATEX_CLASS_OPTIONS: [a4paper] ,#+LATEX_HEADER: \usepackage{xyz} -,* Headline 1 +,* Heading 1 some text -,* Headline 2 +,* Heading 2 some more text #+end_example @@ -14011,11 +14011,11 @@ tables, to HTML. :UNNUMBERED: notoc :END: -#+vindex: org-md-headline-style -Based on ~org-md-headline-style~, Markdown export can generate -headlines of both /atx/ and /setext/ types. /atx/ limits headline -levels to two whereas /setext/ limits headline levels to six. Beyond -these limits, the export back-end converts headlines to lists. To set +#+vindex: org-md-heading-style +Based on ~org-md-heading-style~, Markdown export can generate +headings of both /atx/ and /setext/ types. /atx/ limits heading +levels to two whereas /setext/ limits heading levels to six. Beyond +these limits, the export back-end converts headings to lists. To set a limit to a level before the absolute limit (see [[*Export Settings]]). ** OpenDocument Text Export @@ -15054,7 +15054,7 @@ keywords. They have to be set in raw Texinfo code. #+end_example #+cindex: @samp{COPYING}, property -Copying material is defined in a dedicated headline with a non-~nil~ +Copying material is defined in a dedicated heading with a non-~nil~ =COPYING= property. The back-end inserts the contents within a =@copying= command at the beginning of the document. The heading itself does not appear in the structure of the document. @@ -15107,9 +15107,9 @@ Here is an example that writes to the Info directory file: #+vindex: org-texinfo-default-class #+cindex: @samp{TEXINFO_CLASS}, keyword The Texinfo export back-end uses a pre-defined scheme to convert Org -headlines to equivalent Texinfo structuring commands. A scheme like -this maps top-level headlines to numbered chapters tagged as -~@chapter~ and lower-level headlines to unnumbered chapters tagged as +headings to equivalent Texinfo structuring commands. A scheme like +this maps top-level headings to numbered chapters tagged as +~@chapter~ and lower-level headings to unnumbered chapters tagged as ~@unnumbered~. To override such mappings to introduce ~@part~ or other Texinfo structuring commands, define a new class in ~org-texinfo-classes~. Activate the new class with the @@ -15117,19 +15117,19 @@ other Texinfo structuring commands, define a new class in the Texinfo export back-end defaults to the ~org-texinfo-default-class~. -If an Org headline's level has no associated Texinfo structuring +If an Org heading's level has no associated Texinfo structuring command, or is below a certain threshold (see [[*Export Settings]]), then the Texinfo export back-end makes it into a list item. #+cindex: @samp{APPENDIX}, property -The Texinfo export back-end makes any headline with a non-~nil~ +The Texinfo export back-end makes any heading with a non-~nil~ =APPENDIX= property into an appendix. This happens independent of the -Org headline level or the =TEXINFO_CLASS= keyword. +Org heading level or the =TEXINFO_CLASS= keyword. #+cindex: @samp{ALT_TITLE}, property #+cindex: @samp{DESCRIPTION}, property The Texinfo export back-end creates a menu entry after the Org -headline for each regular sectioning structure. To override this with +heading for each regular sectioning structure. To override this with a shorter menu entry, use the =ALT_TITLE= property (see [[*Table of Contents]]). Texinfo menu entries also have an option for a longer =DESCRIPTION= property. Here's an example that uses both to override @@ -15144,7 +15144,7 @@ the default menu entry: #+end_example #+cindex: Top node, in Texinfo export -The text before the first headline belongs to the /Top/ node, i.e., +The text before the first heading belongs to the /Top/ node, i.e., the node in which a reader enters an Info manual. As such, it is expected not to appear in printed output generated from the =.texi= file. See [[info:texinfo::The Top Node]], for more information. @@ -15175,11 +15175,11 @@ belong to a Texinfo command. : #+CINDEX: Defining indexing entries #+cindex: @samp{INDEX}, property -For the back-end to generate an index entry for a headline, set the +For the back-end to generate an index entry for a heading, set the =INDEX= property to =cp= or =vr=. These abbreviations come from Texinfo that stand for concept index and variable index. The Texinfo manual has abbreviations for all other kinds of indexes. The back-end -exports the headline as an unnumbered chapter or section command, and +exports the heading as an unnumbered chapter or section command, and then inserts the index after its contents. #+begin_example @@ -15459,7 +15459,7 @@ entry. Consult the ~org-icalendar-use-deadline~ and #+vindex: org-icalendar-categories #+vindex: org-icalendar-alarm-time -For tags on the headline, the iCalendar export back-end makes them +For tags on the heading, the iCalendar export back-end makes them into iCalendar categories. To tweak the inheritance of tags and TODO states, configure the variable ~org-icalendar-categories~. To assign clock alarms based on time, configure the ~org-icalendar-alarm-time~ @@ -15518,7 +15518,7 @@ when exporting. To force the back-end to inherit the =LOCATION=, #+vindex: org-icalendar-include-body When Org entries do not have =SUMMARY=, =DESCRIPTION=, =LOCATION= and =CLASS= properties, the iCalendar export back-end derives the summary -from the headline, and derives the description from the body of the +from the heading, and derives the description from the body of the Org item. The ~org-icalendar-include-body~ variable limits the maximum number of characters of the content are turned into its description. @@ -15582,16 +15582,16 @@ before the buffer is parsed. Functions added to these hooks are called with a single argument: the export back-end actually used, as a symbol. You may use them for heavy duty structural modifications of the document. For example, you -can remove every headline in the buffer during export like this: +can remove every heading in the buffer during export like this: #+begin_src emacs-lisp -(defun my-headline-removal (backend) - "Remove all headlines in the current buffer. +(defun my-heading-removal (backend) + "Remove all headings in the current buffer. BACKEND is the export back-end being used, as a symbol." (org-map-entries (lambda () (delete-region (point) (line-beginning-position 2))))) -(add-hook 'org-export-before-parsing-hook #'my-headline-removal) +(add-hook 'org-export-before-parsing-hook #'my-heading-removal) #+end_src *** Filters @@ -15617,7 +15617,7 @@ is the type targeted by the filter. Valid types are: | diary-sexp | drawer | dynamic-block | | entity | example-block | export-block | | export-snippet | final-output | fixed-width | -| footnote-definition | footnote-reference | headline | +| footnote-definition | footnote-reference | heading | | horizontal-rule | inline-babel-call | inline-src-block | | inlinetask | italic | item | | keyword | latex-environment | latex-fragment | @@ -15996,7 +15996,7 @@ Settings]]), however, override everything. | ~:archived-trees~ | ~org-export-with-archived-trees~ | | ~:exclude-tags~ | ~org-export-exclude-tags~ | -| ~:headline-levels~ | ~org-export-headline-levels~ | +| ~:heading-levels~ | ~org-export-heading-levels~ | | ~:language~ | ~org-export-default-language~ | | ~:preserve-breaks~ | ~org-export-preserve-breaks~ | | ~:section-numbers~ | ~org-export-with-section-numbers~ | @@ -16036,7 +16036,7 @@ Settings]]), however, override everything. | ~:ascii-global-margin~ | ~org-ascii-global-margin~ | | ~:ascii-format-drawer-function~ | ~org-ascii-format-drawer-function~ | | ~:ascii-format-inlinetask-function~ | ~org-ascii-format-inlinetask-function~ | -| ~:ascii-headline-spacing~ | ~org-ascii-headline-spacing~ | +| ~:ascii-heading-spacing~ | ~org-ascii-heading-spacing~ | | ~:ascii-indented-line-width~ | ~org-ascii-indented-line-width~ | | ~:ascii-inlinetask-width~ | ~org-ascii-inlinetask-width~ | | ~:ascii-inner-margin~ | ~org-ascii-inner-margin~ | @@ -16079,7 +16079,7 @@ Settings]]), however, override everything. | ~:html-footnote-separator~ | ~org-html-footnote-separator~ | | ~:html-footnotes-section~ | ~org-html-footnotes-section~ | | ~:html-format-drawer-function~ | ~org-html-format-drawer-function~ | -| ~:html-format-headline-function~ | ~org-html-format-headline-function~ | +| ~:html-format-heading-function~ | ~org-html-format-heading-function~ | | ~:html-format-inlinetask-function~ | ~org-html-format-inlinetask-function~ | | ~:html-head-extra~ | ~org-html-head-extra~ | | ~:html-head-include-default-style~ | ~org-html-head-include-default-style~ | @@ -16104,7 +16104,7 @@ Settings]]), however, override everything. | ~:html-postamble~ | ~org-html-postamble~ | | ~:html-preamble-format~ | ~org-html-preamble-format~ | | ~:html-preamble~ | ~org-html-preamble~ | -| ~:html-self-link-headlines~ | ~org-html-self-link-headlines~ | +| ~:html-self-link-headings~ | ~org-html-self-link-headings~ | | ~:html-table-align-individual-field~ | ~de{org-html-table-align-individual-fields~ | | ~:html-table-attributes~ | ~org-html-table-default-attributes~ | | ~:html-table-caption-above~ | ~org-html-table-caption-above~ | @@ -16139,7 +16139,7 @@ Settings]]), however, override everything. | ~:latex-footnote-defined-format~ | ~org-latex-footnote-defined-format~ | | ~:latex-footnote-separator~ | ~org-latex-footnote-separator~ | | ~:latex-format-drawer-function~ | ~org-latex-format-drawer-function~ | -| ~:latex-format-headline-function~ | ~org-latex-format-headline-function~ | +| ~:latex-format-heading-function~ | ~org-latex-format-heading-function~ | | ~:latex-format-inlinetask-function~ | ~org-latex-format-inlinetask-function~ | | ~:latex-hyperref-template~ | ~org-latex-hyperref-template~ | | ~:latex-image-default-height~ | ~org-latex-image-default-height~ | @@ -16171,7 +16171,7 @@ Settings]]), however, override everything. | ~:md-footnote-format~ | ~org-md-footnote-format~ | | ~:md-footnotes-section~ | ~org-md-footnotes-section~ | -| ~:md-headline-style~ | ~org-md-headline-style~ | +| ~:md-heading-style~ | ~org-md-heading-style~ | **** ODT specific properties :PROPERTIES: @@ -16182,7 +16182,7 @@ Settings]]), however, override everything. | ~:odt-display-outline-level~ | ~org-odt-display-outline-level~ | | ~:odt-fontify-srcblocks~ | ~org-odt-fontify-srcblocks~ | | ~:odt-format-drawer-function~ | ~org-odt-format-drawer-function~ | -| ~:odt-format-headline-function~ | ~org-odt-format-headline-function~ | +| ~:odt-format-heading-function~ | ~org-odt-format-heading-function~ | | ~:odt-format-inlinetask-function~ | ~org-odt-format-inlinetask-function~ | | ~:odt-inline-formula-rules~ | ~org-odt-inline-formula-rules~ | | ~:odt-inline-image-rules~ | ~org-odt-inline-image-rules~ | @@ -16203,7 +16203,7 @@ Settings]]), however, override everything. | ~:texinfo-diary-timestamp-format~ | ~org-texinfo-diary-timestamp-format~ | | ~:texinfo-filename~ | ~org-texinfo-filename~ | | ~:texinfo-format-drawer-function~ | ~org-texinfo-format-drawer-function~ | -| ~:texinfo-format-headline-function~ | ~org-texinfo-format-headline-function~ | +| ~:texinfo-format-heading-function~ | ~org-texinfo-format-heading-function~ | | ~:texinfo-format-inlinetask-function~ | ~org-texinfo-format-inlinetask-function~ | | ~:texinfo-inactive-timestamp-format~ | ~org-texinfo-inactive-timestamp-format~ | | ~:texinfo-link-with-unknown-path-format~ | ~org-texinfo-link-with-unknown-path-format~ | @@ -16455,7 +16455,7 @@ place on the web server, and publishing images to it. :publishing-directory "/ssh:user@host:~/html/notebook/" :publishing-function org-html-publish-to-html :exclude "PrivatePage.org" ;; regexp - :headline-levels 3 + :heading-levels 3 :section-numbers nil :with-toc nil :html-head "