diff --git a/contrib/orgmanual.org b/contrib/orgmanual.org index 24ba42747..e5935ca01 100644 --- a/contrib/orgmanual.org +++ b/contrib/orgmanual.org @@ -83,21 +83,21 @@ Org is a mode for keeping notes, maintaining TODO lists, and doing project planning with a fast and effective plain-text system. Org develops organizational tasks around NOTES files that contain -lists or information about projects as plain text. Org is implemented +lists or information about projects as plain text. Org is implemented on top of Outline mode, which makes it possible to keep the content of -large files well structured. Visibility cycling and structure editing -help to work with the tree. Tables are easily created with a built-in -table editor. Org supports TODO items, deadlines, timestamps, and -scheduling. It dynamically compiles entries into an agenda that +large files well structured. Visibility cycling and structure editing +help to work with the tree. Tables are easily created with a built-in +table editor. Org supports TODO items, deadlines, timestamps, and +scheduling. It dynamically compiles entries into an agenda that utilizes and smoothly integrates much of the Emacs calendar and diary. Plain text URL-like links connect to websites, emails, Usenet -messages, BBDB entries, and any files related to the projects. For +messages, BBDB entries, and any files related to the projects. For printing and sharing of notes, an Org file can be exported as a structured ASCII file, as HTML, or as an iCalendar file.[fn:1] It can also serve as a publishing tool for a set of linked web pages. As a project planning environment, Org works by adding metadata to -outline nodes. Based on this data, specific entries can be extracted +outline nodes. Based on this data, specific entries can be extracted in queries and create dynamic /agenda views/. Org mode contains the Org Babel environment which allows you to work @@ -106,15 +106,15 @@ evaluation, documentation, and literate programming techniques. Org's automatic, context-sensitive table editor with spreadsheet capabilities can be integrated into any major mode by activating the -minor Orgtbl mode. Using a translation step, it can be used to -maintain tables in arbitrary file types, for example in LaTeX. The +minor Orgtbl mode. Using a translation step, it can be used to +maintain tables in arbitrary file types, for example in LaTeX. The structure editing and list creation capabilities can be used outside Org with the minor Orgstruct mode. -Org keeps simple things simple. When first fired up, it should feel -like a straightforward, easy to use outliner. Complexity is not +Org keeps simple things simple. When first fired up, it should feel +like a straightforward, easy to use outliner. Complexity is not imposed, but a large amount of functionality is available when you -need it. Org is a toolbox and can be used in different ways and for +need it. Org is a toolbox and can be used in different ways and for different ends, for example: - an outline extension with visibility cycling and structure editing @@ -150,8 +150,8 @@ Network Theory Ltd.]] *Important:* If you have the version of Org that comes with Emacs or as a XEmacs package, please skip this section and go directly to -[[Activation]]. If you downloaded Org as an ELPA package, please read the -instructions on the [[http://orgmode.org/elpa.html][Org ELPA page]]. To see what version of Org (if any) +[[Activation]]. If you downloaded Org as an ELPA package, please read the +instructions on the [[http://orgmode.org/elpa.html][Org ELPA page]]. To see what version of Org (if any) is part of your Emacs distribution, type {{{kbd(M-x org-version)}}}.[fn:2] Installation of Org mode uses a build system, which is described in more @@ -178,7 +178,7 @@ If you have downloaded Org from the Web as a distribution {{{file(.zip)}}} or mode on your system If you use a cloned Git repository, then the procedure is slightly -different. The following description assumes that you are using the +different. The following description assumes that you are using the ~master~ branch.[fn:3] You could also use the ~maint~ branch instead, where the release versions are published, just replace ~master~ with ~maint~ in the description below. @@ -200,7 +200,7 @@ where the release versions are published, just replace ~master~ with - Optionally run ~make test~ to build Org mode and then run the full test suite - Run ~make update2~ or ~make up2~ to update the Git repository and - build and install Org mode. The latter invocation runs the + build and install Org mode. The latter invocation runs the complete test suite before installation and installs only if the build passes all tests @@ -238,12 +238,12 @@ compiling them, do a similar step for this directory: If you want to include those files with the build and install, please customize the variable ~ORG_ADD_CONTRIB~ instead in your -~local.mk~ file. For more details please see this +~local.mk~ file. For more details please see this [[http://orgmode.org/worg/dev/org-build-system.html#sec-4-1-2][description on Worg]]. Installing Info files is system dependent, because of differences in -the {{{file(install-info)}}} program. The Info documentation is -installed together with the rest of Org mode. If you don't install Org +the {{{file(install-info)}}} program. The Info documentation is +installed together with the rest of Org mode. If you don't install Org mode, it is possible to install the Info documentation separately if you have install-info on your system.[fn:4] @@ -314,12 +314,12 @@ like this: #+vindex: org-insert-mode-line-in-empty-file {{{noindent}}} which will select Org mode for this buffer no matter what the file's -name is. See also the variable +name is. See also the variable ~org-insert-mode-line-in-empty-file~. -Many commands in Org work on the region if the region is /active/. To +Many commands in Org work on the region if the region is /active/. To make use of this, you need to have ~transient-mark-mode~ -(~zmacs-regions~ in XEmacs) turned on. In Emacs 23 this is the +(~zmacs-regions~ in XEmacs) turned on. In Emacs 23 this is the default, in Emacs 22 you need to do this yourself with #+header: :exports code @@ -343,20 +343,20 @@ pressing {{{kbdkey(C-,SPC)}}} twice before moving the cursor. If you find problems with Org, or if you have questions, remarks, or ideas about it, please mail to the Org mailing list -[[mailto:emacs-orgmode@gnu.org]]. If you are not a member of +[[mailto:emacs-orgmode@gnu.org]]. If you are not a member of the mailing list, your mail will be passed to the list after a moderator has approved it.[fn:6] For bug reports, please first try to reproduce the bug with the latest version of Org available---if you are running an outdated version, it -is quite possible that the bug has been fixed already. If the bug +is quite possible that the bug has been fixed already. If the bug persists, prepare a report and provide as much information as possible, including the version information of Emacs ({{{kbdspckey(M-x emacs-version,RET)}}}) and Org ({{{kbdspckey(M-x org-version,RET)}}}), -as well as the Org related setup in {{{file(.emacs)}}}. The easiest +as well as the Org related setup in {{{file(.emacs)}}}. The easiest way to do this is to use the command {{{kbd(M-x org-submit-bug-report)}}}, which will put all this information into an -Emacs mail buffer so that you only need to add your description. If +Emacs mail buffer so that you only need to add your description. If you are not sending the Email from within Emacs, please copy and paste the content into your Email program. @@ -372,8 +372,8 @@ $ emacs -Q -l /path/to/minimal-org.el #+end_src However if you are using Org mode distributed with Emacs, a minimal -setup is not necessary. In that case it is sufficient to start Emacs -as ~emacs -Q~. The ~minimal-org.el~ setup +setup is not necessary. In that case it is sufficient to start Emacs +as ~emacs -Q~. The ~minimal-org.el~ setup file can have contents as shown below. #+header: :exports code @@ -392,7 +392,7 @@ file can have contents as shown below. #+end_src If an error occurs, a backtrace can be very useful (see [[How to -create a useful backtrace]]). Often a small example file helps, along +create a useful backtrace]]). Often a small example file helps, along with clear information about: 1. What exactly did you do? @@ -414,16 +414,16 @@ providing, in addition to what was mentioned above, a /backtrace/. This is information from the built-in debugger about where and how the error occurred. Here is how to produce a useful backtrace: - 1. Reload uncompiled versions of all Org mode Lisp files. The + 1. Reload uncompiled versions of all Org mode Lisp files. The backtrace contains much more information if it is produced with - uncompiled code. To do this, use + uncompiled code. To do this, use {{{kbdspckey(C-u M-x org-reload,RET)}}} or select ~Org -> Refresh/Reload -> Reload Org uncompiled~ from the menu. 2. Go to the ~Options~ menu and select ~Enter Debugger on Error~ (XEmacs has this option in the ~Troubleshooting~ sub-menu). - 3. Do whatever you have to do to hit the error. Don't forget to + 3. Do whatever you have to do to hit the error. Don't forget to document the steps you take. 4. When you hit the error, a {{{file(*Backtrace*)}}} buffer will @@ -455,7 +455,7 @@ names. In this manual we use the following conventions: Moreover, Org uses /option keywords/ (like ~#+TITLE~ to set the title) and /environment keywords/ (like ~#+BEGIN_HTML~ to start a ~HTML~ -environment). They are written in uppercase in the manual to enhance +environment). They are written in uppercase in the manual to enhance its readability, but you can use lowercase in your Org files.[fn:7] *** Keybindings and commands @@ -469,16 +469,16 @@ its readability, but you can use lowercase in your Org files.[fn:7] #+findex: org-capture The manual suggests two global keybindings: {{{kbd(C-c a)}}} for -~org-agenda~ and {{{kbd(C-c c)}}} for ~org-capture~. These are only +~org-agenda~ and {{{kbd(C-c c)}}} for ~org-capture~. These are only suggestions, but the rest of the manual assumes that you are using these keybindings. Also, the manual lists both the keys and the corresponding commands -for accessing a functionality. Org mode often uses the same key for -different functions, depending on context. The command that is bound +for accessing a functionality. Org mode often uses the same key for +different functions, depending on context. The command that is bound to such keys has a generic name, like ~org-metaright~. In the manual we will, wherever possible, give the function that is internally -called by the generic command. For example, in the chapter on document +called by the generic command. For example, in the chapter on document structure, {{{kbdkey(M-,right)}}} will be listed to call ~org-do-demote~, while in the chapter on tables, it will be listed to call ~org-table-move-column-right~. @@ -503,12 +503,12 @@ edit the structure of the document. #+cindex: outlines #+cindex: Outline mode -Org is implemented on top of Outline mode. Outlines allow a document +Org is implemented on top of Outline mode. Outlines allow a document to be organized in a hierarchical structure, which (at least for me) -is the best representation of notes and thoughts. An overview of this +is the best representation of notes and thoughts. An overview of this structure is achieved by folding (hiding) large parts of the document to show only the general document structure and the parts currently -being worked on. Org greatly simplifies the use of outlines by +being worked on. Org greatly simplifies the use of outlines by compressing the entire show/hide functionality into a single command, {{{command(org-cycle)}}}, which is bound to the {{{key(TAB)}}} key. @@ -537,7 +537,7 @@ start with one or more stars, on the left margin.[fn:8] For example: {{{noindent}}} Some people find the many stars too noisy and would prefer an outline that has whitespace followed by a single star as -headline starters. A setup to realize this is described in the +headline starters. A setup to realize this is described in the section, [[Clean view]]. #+vindex: org-cycle-separator-lines @@ -584,7 +584,7 @@ Org uses just two commands, bound to {{{key(TAB)}}} and By default, the cursor must be on a headline for this to work, but this behavior can be modified with the - ~org-cycle-emulate-tab~ option. When the cursor is at the + ~org-cycle-emulate-tab~ option. When the cursor is at the beginning of the buffer and the first line is not a headline, then {{{key(TAB)}}} actually runs global cycling (see below).[fn:9] Also, when called with a prefix argument @@ -609,7 +609,7 @@ Org uses just two commands, bound to {{{key(TAB)}}} and When {{{kbdkey(S-,TAB)}}} is called with a numeric prefix argument, ~N~, the CONTENTS view up to headlines of level N will - be shown. Note that inside tables, {{{kbdkey(S-,TAB)}}} jumps + be shown. Note that inside tables, {{{kbdkey(S-,TAB)}}} jumps to the previous field. - {{{kbdspckey(C-u C-u C-u,TAB)}}}, ~show-all~ :: Show all, including @@ -751,15 +751,15 @@ The following commands jump to other headlines in the buffer. #+attr_texinfo: :table-type table :indic @asis - {{{kbdkey(M-,RET)}}}, ~org-insert-heading~ :: Insert new heading - with same level as current. If the cursor is in a plain list - item, a new item is created (see [[Plain lists]]). To force - creation of a new headline, use a prefix argument. When this + with same level as current. If the cursor is in a plain list + item, a new item is created (see [[Plain lists]]). To force + creation of a new headline, use a prefix argument. 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:11] If the command is used at the beginning of a headline, the new - headline is created before the current line. If at the + headline is created before the current line. If at the beginning of any other line, the content of that line is made - the new heading. If the command is used at the end of a folded + the new heading. If the command is used at the end of a folded subtree (i.e., behind the ellipses at the end of a headline), then a headline like the current one will be inserted after the end of the subtree. @@ -770,7 +770,7 @@ The following commands jump to other headlines in the buffer. - {{{kbdkey(C-,RET)}}}, ~org-insert-heading-respect-content~ :: Just like {{{kbdkey(M-,RET)}}}, except when adding a new heading below the current heading, the new heading is placed after the - body instead of before it. This command works from anywhere in + body instead of before it. This command works from anywhere in the entry. #+kindex: C-RET @@ -783,7 +783,7 @@ The following commands jump to other headlines in the buffer. #+findex: org-insert-todo-heading #+vindex: org-treat-insert-todo-heading-as-state-change - {{{kbdkey(C-S-,RET)}}}, ~org-insert-todo-heading-respect-content~ :: Insert - new TODO entry with same level as current heading. Like + new TODO entry with same level as current heading. Like {{{kbdkey(C-,RET)}}}, the new headline will be inserted after the current subtree. @@ -791,8 +791,8 @@ The following commands jump to other headlines in the buffer. #+findex: org-insert-todo-heading-respect-content - {{{key(TAB)}}}, ~org-cycle~ :: In a new entry with no text yet, the first {{{key(TAB)}}} demotes the entry to become a - child of the previous one. The next {{{key(TAB)}}} makes it a - parent, and so on, all the way to top level. Yet another + child of the previous one. The next {{{key(TAB)}}} makes it a + parent, and so on, all the way to top level. Yet another {{{key(TAB)}}}, and you are back to the initial level. #+kindex: @key{TAB} @@ -828,7 +828,7 @@ The following commands jump to other headlines in the buffer. #+kindex: M-S-,down #+findex: org-move-subtree-down - {{{kbd(C-c C-x C-w)}}}, ~org-cut-subtree~ :: Kill subtree, i.e., - remove it from buffer but save in kill ring. With a numeric + remove it from buffer but save in kill ring. With a numeric prefix argument N, kill N sequential subtrees. #+kindex: C-c C-x C-w @@ -840,8 +840,8 @@ The following commands jump to other headlines in the buffer. #+kindex: C-c C-x M-w #+findex: org-copy-subtree - {{{kbd(C-c C-x C-y)}}}, ~org-paste-subtree~ :: 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 + 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 {{{samp(****)}}}. @@ -865,17 +865,17 @@ The following commands jump to other headlines in the buffer. #+vindex: org-yank-adjusted-subtrees #+vindex: org-yank-folded-subtrees - {{{kbd(C-c C-x c)}}}, ~org-clone-subtree-with-time-shift~ :: Clone - a subtree by making a number of sibling copies of it. You will + a subtree by making a number of sibling copies of it. You will be prompted for the number of copies to make, and you can also specify if any timestamps in the entry should be shifted. This can be useful, for example, to create a number of tasks related - to a series of lectures to prepare. For more details, see the + to a series of lectures to prepare. For more details, see the docstring of the command ~org-clone-subtree-with-time-shift~. #+kindex: C-c C-x c #+findex: org-clone-subtree-with-time-shift - {{{kbd(C-c C-w)}}}, ~org-refile~ :: Refile entry or region to a - different location. See [[Refile and copy]]. + different location. See [[Refile and copy]]. #+kindex: C-c C-w #+findex: org-refile @@ -909,11 +909,11 @@ The following commands jump to other headlines in the buffer. #+findex: widen - {{{kbd(C-c *)}}}, ~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 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 + subheading at its location). Also turn a headline 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 + headlines. Finally, if the first line is a headline, remove the stars from all headlines in the region. #+kindex: C-c * @@ -961,12 +961,12 @@ commands can be accessed through a dispatcher: #+kindex: C-c / #+findex: org-sparse-tree - {{{kbd(C-c / r)}}}, ~org-occur~ :: Prompts for a regexp 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 and body are made visible. In order to provide + 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 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 highlighted; the highlights disappear + 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:13] When called with a {{{kbd(C-u)}}} prefix argument, previous highlights are kept, so several calls @@ -995,9 +995,9 @@ commands can be accessed through a dispatcher: {{{noindent}}} For frequently used sparse trees of specific search strings, you can use the variable ~org-agenda-custom-commands~ to -define fast keyboard access to specific sparse trees. These commands +define fast keyboard access to specific sparse trees. These commands will then be accessible through the agenda dispatcher -(see [[Agenda dispatcher]]). For example: +(see [[Agenda dispatcher]]). For example: #+header: :exports code #+header: :eval no @@ -1034,8 +1034,8 @@ document and print the resulting file. #+cindex: ordered lists Within an entry of the outline tree, hand-formatted lists can provide -additional structure. They also provide a way to create lists of -checkboxes (see [[Checkboxes]]). Org supports editing +additional structure. They also provide a way to create lists of +checkboxes (see [[Checkboxes]]). Org supports editing such lists, and every exporter (see [[Exporting]]) can parse and format them. @@ -1060,9 +1060,9 @@ Org knows ordered lists, unordered lists, and description lists. Items belonging to the same list must have the same indentation on the -first line. In particular, if an ordered list reaches number +first line. In particular, if an ordered list reaches number {{{samp(10.)}}}, then the 2--digit numbers must be written -left-aligned with the other numbers in the list. An item ends before +left-aligned with the other numbers in the list. An item ends before the next line that is less or equally indented than its bullet/number. #+vindex: org-empty-line-terminates-plain-lists @@ -1090,7 +1090,7 @@ lines.[fn:171] In that case, all items are closed. Here is an example: Org supports these lists by tuning filling and wrapping commands to deal with them correctly.[fn:18] To turn this on, put into {{{file(.emacs)}}}: ~(require 'filladapt)~}, and by exporting them -properly (see [[Exporting]]). Since indentation is +properly (see [[Exporting]]). Since indentation is what governs the structure of these lists, many structural constructs like ~#+BEGIN_ ...~ blocks can be indented to signal that they belong to a particular item. @@ -1118,16 +1118,16 @@ to disable them individually. #+findex: org-cycle #+vindex: org-cycle-include-plain-lists - Items can be folded just like headline levels. Normally this - works only if the cursor is on a plain list item. For more - details, see the variable ~org-cycle-include-plain-lists~. If + Items can be folded just like headline levels. Normally this + works only if the cursor 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 will be - treated like low-level headlines. The level of an item is then - given by the indentation of the bullet/number. Items are always + 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, however; the hierarchies remain - completely separated. In a new item with no text yet, the first + completely separated. In a new item with no text yet, the first {{{key(TAB)}}} demotes the item to become a child of the - previous one. Subsequent {{{key(TAB)}}}s move the item to + previous one. Subsequent {{{key(TAB)}}}s move the item to meaningful levels in the list and eventually get it back to its initial position. @@ -1137,8 +1137,8 @@ to disable them individually. #+vindex: org-M-RET-may-split-line #+vindex: org-list-automatic-rules - Insert new item at current level. With a prefix argument, force - a new heading (see [[Structure editing]]). If this command is used + Insert new item at current level. With a prefix argument, force + a new heading (see [[Structure editing]]). If this command is used in the middle of an item, that item is /split/ in two, and the second part becomes the new item.[fn:19] If this command is executed /before item's body/, the new item is created /before/ @@ -1219,13 +1219,13 @@ to disable them individually. #+kindex: C-c - #+vindex: org-plain-list-ordered-item-terminator - {{{kbd(C-c *)}}} :: Turn a plain list item into a headline (so - that it becomes a subheading at its location). See + that it becomes a subheading at its location). See [[Structure editing]], for a detailed explanation. #+kindex: C-c * - {{{kbd(C-c C-*)}}} :: Turn the whole plain list into a subtree of the current heading. Checkboxes (see [[Checkboxes]]) will become - TODO (resp. DONE) keywords when unchecked (resp. checked). + TODO (resp. DONE) keywords when unchecked (resp. checked). #+kindex: C-c C-* - {{{kbd(S-left/right)}}} :: This command also cycles bullet styles @@ -1271,20 +1271,20 @@ look like this: You can interactively insert drawers at point by calling ~org-insert-drawer~, which is bound to {{{kbd(C-c C-x d)}}}. With an active region, this command will put the region inside the -drawer. With a prefix argument, this command calls +drawer. With a prefix argument, this command calls ~org-insert-property-drawer~ and add a property drawer right -below the current headline. Completion over drawer keywords is also +below the current headline. Completion over drawer keywords is also possible using {{{key(M-TAB)}}}. Visibility cycling (see [[Visibility cycling]]) on the headline will hide and show the entry, but keep the drawer collapsed to a -single line. In order to look inside the drawer, you need to move the -cursor to the drawer line and press {{{key(TAB)}}} there. Org mode +single line. In order to look inside the drawer, you need to move the +cursor to the drawer line and press {{{key(TAB)}}} there. Org mode uses the ~PROPERTIES~ drawer for storing properties (see [[Properties and columns]]), and you can also arrange for state change notes (see [[Tracking TODO state changes]) and clock times (see [[Clocking work time]) to be stored in a drawer -~LOGBOOK~. If you want to store a quick note in the LOGBOOK +~LOGBOOK~. If you want to store a quick note in the LOGBOOK drawer, in a similar way to state changes, use #+attr_texinfo: :table-type table :indic @asis @@ -1300,7 +1300,7 @@ drawer, in a similar way to state changes, use #+vindex: org-hide-block-startup #+cindex: blocks, folding -Org mode uses ~begin~ ... ~end~ blocks for various purposes from including +Org mode uses ~begin~ ... ~end~ blocks for various purposes from including source code examples (see [[Literal examples]]) to capturing time logging information (see [[Clocking work time]]). These blocks can be folded and unfolded by pressing TAB in the begin line. You can also get all @@ -1320,15 +1320,15 @@ blocks folded at startup by configuring the variable :END: #+cindex: footnotes -Org mode supports the creation of footnotes. In contrast to the +Org mode supports the creation of footnotes. In contrast to the {{{file(footnote.el)}}} package, Org mode's footnotes are designed for work on a larger document, not only for one-off documents like emails. The basic syntax is similar to the one used by {{{file(footnote.el)}}}, i.e., a footnote is defined in a paragraph that is started by a footnote marker in square brackets in column 0, -no indentation allowed. If you need a paragraph break inside a -footnote, use the LaTeX idiom ~\par~. The footnote reference is simply -the marker in square brackets, inside text. For example: +no indentation allowed. If you need a paragraph break inside a +footnote, use the LaTeX idiom ~\par~. The footnote reference is simply +the marker in square brackets, inside text. For example: #+begin_example The Org homepage[fn:1] now looks a lot better than it used to. @@ -1337,14 +1337,14 @@ the marker in square brackets, inside text. For example: #+end_example Org mode extends the number-based syntax to /named/ footnotes and -optional inline definition. Using plain numbers as markers (as +optional inline definition. Using plain numbers as markers (as {{{file(footnote.el)}}} does) is supported for backward compatibility, but not encouraged because of possible conflicts with LaTeX -snippets (see [[Embedded LaTeX]]). Here are +snippets (see [[Embedded LaTeX]]). Here are the valid references: #+attr_texinfo: :table-type table :indic @asis - - ~[1]~ :: A plain numeric footnote marker. Compatible with + - ~[1]~ :: A plain numeric footnote marker. Compatible with {{{file(footnote.el)}}}, but not recommended because something like ~[1]~ could easily be part of a code snippet. @@ -1356,16 +1356,16 @@ the valid references: LaTeX-like anonymous footnote where the definition is given directly at the reference point. - ~[fn:name: a definition]~ :: An inline definition of a footnote, - which also specifies a name for the note. Since Org allows + which also specifies a name for the note. Since Org allows multiple references to the same note, you can then use ~[fn:name]~ to create additional references. #+vindex: org-footnote-auto-label Footnote labels can be created automatically, or you can create names -yourself. This is handled by the variable +yourself. This is handled by the variable ~org-footnote-auto-label~ and its corresponding -~#+STARTUP~ keywords. See the docstring of that variable for +~#+STARTUP~ keywords. See the docstring of that variable for details. {{{noindent}}} The following command handles footnotes: @@ -1478,9 +1478,9 @@ calculations are supported using the Emacs {{{file(calc)}}} package :END: #+cindex: table editor, built-in -Org makes it easy to format tables in plain ASCII. Any line with +Org makes it easy to format tables in plain ASCII. Any line with {{{samp(|)}}} as the first non-whitespace character is considered part -of a table. {{{samp(|)}}} is also the column separator.[fn:22] A table +of a table. {{{samp(|)}}} is also the column separator.[fn:22] A table might look like this: #+begin_src org @@ -1495,10 +1495,10 @@ A table is re-aligned automatically each time you press {{{key(TAB)}}} or {{{key(RET)}}} or {{{kbd(C-c C-c)}}} inside the table. {{{key(TAB)}}} also moves to the next field ({{{key(RET)}}} to the next row) and creates new table rows at the end of the table or before -horizontal lines. The indentation of the table is set by the first -line. Any line starting with {{{samp(|-)}}} is considered as a +horizontal lines. The indentation of the table is set by the first +line. Any line starting with {{{samp(|-)}}} is considered as a horizontal separator line and will be expanded on the next re-align to -span the whole table width. So, to create the above table, you would +span the whole table width. So, to create the above table, you would only type #+begin_src org @@ -1508,7 +1508,7 @@ only type {{{noindent}}} and then press {{{key(TAB)}}} to align the table and -start filling in fields. Even faster would be to type +start filling in fields. Even faster would be to type ~|Name|Phone|Age~ followed by {{{kbdspckey(C-c,RET)}}}. #+vindex: org-enable-table-editor @@ -1528,16 +1528,16 @@ you, configure the variables ~org-enable-table-editor~ and :END: #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c |)}}}, ~org-table-create-or-convert-from-region~ :: Convert - the active region to table. If every line contains at least one + the active region to table. If every line contains at least one {{{key(TAB)}}} character, the function assumes that the material - is tab separated. If every line contains a comma, comma-separated - values (CSV) are assumed. If not, lines are split at whitespace - into fields. You can use a prefix argument to force a specific + is tab separated. If every line contains a comma, comma-separated + values (CSV) are assumed. If not, lines are split at whitespace + into fields. You can use a prefix argument to force a specific separator: {{{kbd(C-u)}}} forces CSV, {{{kbd(C-u C-u)}}} forces {{{key(TAB)}}}, and a numeric argument ~N~ indicates that at least N consecutive spaces, or alternatively a {{{key(TAB)}}} - will be the separator. If there is no active region, this command - creates an empty Org table. But it is easier just to start + will be the separator. If there is no active region, this command + creates an empty Org table. But it is easier just to start typing, like {{{kbdspckey(|Name|Phone|Age,RET)}}} {{{kbdkey(|- ,TAB)}}}. @@ -1861,14 +1861,14 @@ automatically when exporting the document. #+cindex: grouping columns in tables When Org exports tables, it does so by default without vertical lines -because that is visually more satisfying in general. Occasionally +because that is visually more satisfying in general. Occasionally however, vertical lines can be useful to structure a table into groups -of columns, much like horizontal lines can do for groups of rows. In +of columns, much like horizontal lines can do for groups of rows. In order to specify column groups, you can use a special row where the -first field contains only {{{samp(/)}}}. The further fields can either +first field contains only {{{samp(/)}}}. The further fields can either contain ~<~ to indicate that this column should start a group, ~>~ to indicate the end of a column, or ~<>~ (no space -between ~<~ and ~>~) to make a column a group of its own. Boundaries +between ~<~ and ~>~) to make a column a group of its own. Boundaries between column groups will upon export be marked with vertical lines. Here is an example: @@ -1972,23 +1972,23 @@ looks like this:[fn:25] Column specifications can be absolute like ~$1~, ~$2~, ..., ~$N~, or relative to the current column (i.e., the column of the field which is -being computed) like ~$+1~ or ~$-2~. ~$<~ and ~$>~ are immutable +being computed) like ~$+1~ or ~$-2~. ~$<~ and ~$>~ are immutable references to the first and last column, respectively, and you can use ~$>>>~ to indicate the third column from the right. The row specification only counts data lines and ignores horizontal -separator lines (hlines). Like with columns, you can use absolute row +separator lines (hlines). Like with columns, you can use absolute row numbers ~@1~, ~@2~, ..., ~@N~, and row numbers relative to the current -row like ~@+3~ or ~@-1~. ~@<~ and ~@>~ are immutable references the +row like ~@+3~ or ~@-1~. ~@<~ and ~@>~ are immutable references the first and last row in the table, respectively.[fn:26] You may also specify the row relative to one of the hlines: ~@I~ refers to the -first hline, ~@II~ to the second, etc. ~@-I~ refers to the first such +first hline, ~@II~ to the second, etc. ~@-I~ refers to the first such line above the current line, ~@+I~ to the first such line below the -current line. You can also write ~@III+2~ which is the second data +current line. You can also write ~@III+2~ which is the second data line after the third hline in the table. ~@0~ and ~$0~ refer to the current row and column, respectively, i.e., -to the row/column for the field being computed. Also, if you omit +to the row/column for the field being computed. Also, if you omit either the column or the row part of the reference, the current row/column is implied. @@ -2060,7 +2060,7 @@ and ~org-table-current-column~. Examples: column 3 of the current table {{{noindent}}} For the second example, table FOO must have at least as -many rows as the current table. Note that this is inefficient for +many rows as the current table. Note that this is inefficient for large number of rows.[fn:27] **** Named references @@ -2090,11 +2090,11 @@ line like this example: Also, properties (see [[Properties and columns]]) can be used as constants in table formulas: for a property ~:Xyz:~ use the name ~$PROP_Xyz~, and the property will be searched in the current outline entry and in -the hierarchy above it. If you have the {{{file(constants.el)}}} +the hierarchy above it. If you have the {{{file(constants.el)}}} package, it will also be used to resolve constants, including natural constants like ~$h~ for Planck's constant, and units like ~$km~ for -kilometers. Column names and parameters can be specified in special -table lines. These are described in the section, [[Advanced features]]. +kilometers. Column names and parameters can be specified in special +table lines. These are described in the section, [[Advanced features]]. All names must start with a letter, and further consist of letters and numbers.[fn:175] @@ -2118,9 +2118,9 @@ syntax is #+end_example {{{noindent}}} where NAME can be the name of a table in the current -file as set by a ~#+TBLNAME: NAME~ line before the table. It can also +file as set by a ~#+TBLNAME: NAME~ line before the table. It can also be the ID of an entry, even in a different file, and the reference -then refers to the first table in that entry. REF is an absolute field +then refers to the first table in that entry. REF is an absolute field or range reference as described above for example ~@3$3~ or ~$somename~, valid in the referenced table. @@ -2155,7 +2155,7 @@ variable ~org-calc-default-modes~. #+attr_texinfo: :table-type table :indic @code - p20 :: set the internal Calc calculation precision to 20 digits - n3 s3 e2 f4 :: normal, scientific, engineering, or fixed format of - the result of Calc passed back to Org. Calc + the result of Calc passed back to Org. Calc formatting is unlimited in precision as long as the Calc calculation precision is greater. - D R :: angle modes: degrees, radians @@ -2209,21 +2209,21 @@ useful for string manipulation and control structures, if Calc's functionality is not enough. If a formula starts with a single-quote followed by an opening -parenthesis, then it is evaluated as a Lisp form. The evaluation -should return either a string or a number. Just as with +parenthesis, then it is evaluated as a Lisp form. The evaluation +should return either a string or a number. Just as with {{{file(calc)}}} formulas, you can specify modes and a printf format after a semicolon. With Emacs Lisp forms, you need to be conscious about the way field -references are interpolated into the form. By default, a reference +references are interpolated into the form. By default, a reference will be interpolated as a Lisp string (in double-quotes) containing -the field. If you provide the {{{samp(N)}}} mode switch, all +the field. If you provide the {{{samp(N)}}} mode switch, all referenced elements will be numbers (non-number fields will be zero) -and interpolated as Lisp numbers, without quotes. If you provide the +and interpolated as Lisp numbers, without quotes. If you provide the {{{samp(L)}}} flag, all fields will be interpolated literally, without -quotes. I.e., if you want a reference to be interpreted as a string by +quotes. I.e., if you want a reference to be interpreted as a string by the Lisp form, enclose the reference operator itself in double-quotes, -like ~"$3"~. Ranges are inserted as space-separated fields, so you can +like ~"$3"~. Ranges are inserted as space-separated fields, so you can embed them in list or vector syntax. Here are a few examples---note how the {{{samp(N)}}} mode is used when @@ -2270,8 +2270,8 @@ formulas or Elisp formulas: #+end_example Input duration values must be of the form ~[HH:MM[:SS]~, where seconds -are optional. With the ~T~ flag, computed durations will be displayed -as ~HH:MM:SS~ (see the first formula above). With the ~t~ flag, +are optional. With the ~T~ flag, computed durations will be displayed +as ~HH:MM:SS~ (see the first formula above). With the ~t~ flag, computed durations will be displayed according to the value of the variable ~org-table-duration-custom-format~, which defaults to ~'hours~ and will display the result as a fraction of hours (see the @@ -2290,7 +2290,7 @@ be considered as seconds in addition and subtraction. #+cindex: formula, for range of fields To assign a formula to a particular field, type it directly into the -field, preceded by ~:=~, for example ~vsum(@II..III)~. When you press +field, preceded by ~:=~, for example ~vsum(@II..III)~. When you press {{{key(TAB)}}} or {{{key(RET)}}} or {{{kbd(C-c C-c)}}} with the cursor still in the field, the formula will be stored as the formula for this field, evaluated, and the current field will be replaced with the @@ -2298,14 +2298,14 @@ result. #+cindex: #+TBLFM Formulas are stored in a special line starting with ~#+TBLFM:~ -directly below the table. If you type the equation in the fourth field +directly below the table. If you type the equation in the fourth field of the third data line in the table, the formula will look like -~@3$4=$1+$2~. When inserting/deleting/swapping column and rows with +~@3$4=$1+$2~. When inserting/deleting/swapping column and rows with the appropriate commands, /absolute references/ (but not relative ones) in stored formulas are modified in order to still reference the -same field. To avoid this from happening, in particular in range +same field. To avoid this from happening, in particular in range references, anchor ranges at the table borders (using ~@<~, ~@>~, -~$<~, ~$>~), or at hlines using the ~@I~ notation. Automatic +~$<~, ~$>~), or at hlines using the ~@I~ notation. Automatic adaptation of field references does of course not happen if you edit the table structure with normal editing commands---then you must fix the equations yourself. @@ -2322,8 +2322,8 @@ following command #+kindex: C-u C-c = #+findex: org-table-eval-formula The left-hand side of a formula can also be a special expression in -order to assign the formula to a number of different fields. There is -no keyboard shortcut to enter such range formulas. To add them, use +order to assign the formula to a number of different fields. There is +no keyboard shortcut to enter such range formulas. To add them, use the formula editor (see [[Editing and debugging formulas]]) or edit the ~#+TBLFM:~ line directly. @@ -2353,25 +2353,25 @@ following very convenient exceptions: - If the table contains horizontal separator hlines with rows above and below, everything before the first such hline is considered part of the table /header/ and will not be modified by column - formulas. Therefore a header is mandatory when you use column + formulas. Therefore a header is mandatory when you use column formulas and want to add hlines to group rows, like for example to separate a total row at the bottom from the summand rows above. - Fields that already get a value from a field/range formula will - be left alone by column formulas. These conditions make column + be left alone by column formulas. These conditions make column formulas very easy to use. To assign a formula to a column, type it directly into any field in -the column, preceded by an equal sign, like {{{samp(=$1+$2)}}}. When +the column, preceded by an equal sign, like {{{samp(=$1+$2)}}}. When you press {{{key(TAB)}}} or {{{key(RET)}}} or {{{kbd(C-c C-c)}}} with the cursor still in the field, the formula will be stored as the formula for the current column, evaluated and the current field -replaced with the result. If the field contains only {{{samp(=)}}}, -the previously stored formula for this column is used. For each -column, Org will only remember the most recently used formula. In the +replaced with the result. If the field contains only {{{samp(=)}}}, +the previously stored formula for this column is used. For each +column, Org will only remember the most recently used formula. In the {{{samp(#+TBLFM:)}}} line, column formulas will look like -{{{samp($4=$1+$2)}}}. The left-hand side of a column formula can not +{{{samp($4=$1+$2)}}}. The left-hand side of a column formula can not be the name of column, it must be the numeric column reference or ~$>~. @@ -2611,11 +2611,11 @@ recalculation commands in the table. #+cindex: debugging, of table formulas When the evaluation of a formula leads to an error, the field content -becomes the string {{{samp(#ERROR)}}}. If you would like see what is +becomes the string {{{samp(#ERROR)}}}. If you would like see what is going on during variable substitution and calculation in order to find a bug, turn on formula debugging in the ~Tbl~ menu and repeat the calculation, for example by pressing {{{kbdspckey(C-u C-u C-c =,RET)}}} -in a field. Detailed information will be displayed. +in a field. Detailed information will be displayed. *** Updating the table :PROPERTIES: @@ -2705,7 +2705,7 @@ and makes use of these features: {{{noindent}}} Important: please note that for these special tables, recalculating the table with {{{kbd(C-u C-c *)}}} will only affect rows that are marked ~#~ or ~*~, and fields that -have a formula assigned to the field itself. The column formulas are +have a formula assigned to the field itself. The column formulas are not applied in rows with empty first field. #+cindex: marking characters, tables @@ -2768,7 +2768,7 @@ functions. #+cindex: #+PLOT Org-Plot can produce 2D and 3D graphs of information stored in org -tables using [[http://www.gnuplot.info/][Gnuplot]] and [[http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html][gnuplot-mode]]. To see this in action, ensure +tables using [[http://www.gnuplot.info/][Gnuplot]] and [[http://cars9.uchicago.edu/~ravel/software/gnuplot-mode.html][gnuplot-mode]]. To see this in action, ensure that you have both Gnuplot and Gnuplot-mode installed on your system, then call ~org-plot/gnuplot~ on the following table. @@ -2784,9 +2784,9 @@ then call ~org-plot/gnuplot~ on the following table. #+end_src Notice that Org Plot is smart enough to apply the table's headers as -labels. Further control over the labels, type, content, and appearance +labels. Further control over the labels, type, content, and appearance of plots can be exercised through the ~#+PLOT:~ lines preceding a -table. See below for a complete list of Org-plot options. For more +table. See below for a complete list of Org-plot options. For more information and examples see the [[http://orgmode.org/worg/org-tutorials/org-plot.html][Org-plot tutorial]]. Org-Plot recognizes the following options: @@ -2912,7 +2912,7 @@ links.[fn:31] If no dedicated target exists, Org will search for a headline that is exactly the link text but may also include a TODO keyword and tags.[fn:32] In non-Org files, the search will look for the words in -the link text. In the above example the search would be for ~my target~. +the link text. In the above example the search would be for ~my target~. Following a link pushes a mark onto Org's own mark ring. You can return to the previous position with {{{kbd(C-c &)}}}. Using this @@ -2928,13 +2928,13 @@ recorded earlier. #+cindex: links, radio targets Org can automatically turn any occurrences of certain target names in -normal text into a link. So without explicitly creating a link, the -text connects to the target radioing its position. Radio targets are -enclosed by triple angular brackets. For example, a target +normal text into a link. So without explicitly creating a link, the +text connects to the target radioing its position. Radio targets are +enclosed by triple angular brackets. For example, a target ~<<>>~ causes each occurrence of ~my target~ in -normal text to become activated as a link. The Org file is scanned +normal text to become activated as a link. The Org file is scanned automatically for radio targets only when the file is first loaded -into Emacs. To update the target list during editing, press +into Emacs. To update the target list during editing, press {{{kbd(C-c C-c)}}} with the cursor on or at a target. ** External links @@ -3082,7 +3082,7 @@ insert it into an Org file, and to follow the link. - Chat: IRC :: For IRC links, if you set the variable ~org-irc-link-to-logs~ to ~t~, a ~file:~ style link to the relevant point in the logs for - the current conversation is created. Otherwise an + the current conversation is created. Otherwise an ~irc:/~ style link to the user/channel/server under the point will be stored. @@ -3090,14 +3090,14 @@ insert it into an Org file, and to follow the link. - Other files :: For any other files, the link will point to the file, with a search string (see [[Search options]]) - pointing to the contents of the current line. If + pointing to the contents of the current line. If there is an active region, the selected words - will form the basis of the search string. If the + will form the basis of the search string. If the automatically created link is not working correctly or accurately enough, you can write custom functions to select the search string and to do the search for particular file types---see - [[Custom searches]]. The key binding {{{kbd(C-c l)}}} + [[Custom searches]]. The key binding {{{kbd(C-c l)}}} is only a suggestion---see [[Installation]]. - Agenda view :: When the cursor is in an agenda view, the created @@ -3105,9 +3105,9 @@ insert it into an Org file, and to follow the link. current line. - {{{kbd(C-c C-l)}}}, ~org-insert-link~ :: Insert a link.[fn:35] This - prompts for a link to be inserted into the buffer. You can just + prompts for a link to be inserted into the buffer. You can just type a link, using text for an internal link, or one of the - link type prefixes mentioned in the examples above. The link + link type prefixes mentioned in the examples above. The link will be inserted into the buffer, along with a descriptive text.[fn:36] If some text was selected when this command is called, the selected text becomes the default description. @@ -3126,7 +3126,7 @@ insert it into an Org file, and to follow the link. - Completion support :: Completion with {{{key(TAB)}}} will help you to insert valid link prefixes like ~http:~ or ~ftp:~, including the prefixes defined through link - abbreviations (see [[Link abbreviations]]). If you press + abbreviations (see [[Link abbreviations]]). If you press {{{key(RET)}}} after inserting only the {{{var(prefix)}}}, Org will offer specific completion support for some link types.[fn:37] For example, if you type @@ -3138,12 +3138,12 @@ insert it into an Org file, and to follow the link. - {{{kbd(C-u C-c C-l)}}} :: When {{{kbd(C-c C-l)}}} is called with a {{{kbd(C-u)}}} prefix argument, a link to a file will be inserted and you may use file name completion to select the - name of the file. The path to the file is inserted relative to + name of the file. The path to the file is inserted relative to the directory of the current Org file, if the linked file is in the current directory or in a sub-directory of it, or if the path is written relative to the current directory using - {{{samp(../)}}}. Otherwise an absolute path is used, if - possible with {{{samp(~/)}}} for your home directory. You can + {{{samp(../)}}}. Otherwise an absolute path is used, if + possible with {{{samp(~/)}}} for your home directory. You can force an absolute path with two {{{kbd(C-u)}}} prefixes. #+cindex: file name completion @@ -3157,23 +3157,23 @@ insert it into an Org file, and to follow the link. #+cindex: following links - {{{kbd(C-c C-o)}}}, ~org-open-at-point~ :: Open link at - point. This will launch a web browser for URLs (using + point. This will launch a web browser for URLs (using {{{command(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 the cursor is on an internal link, this command runs the - corresponding search. When the cursor is on a TAG list in a - headline, it creates the corresponding TAGS view. If the + corresponding search. When the cursor is on a TAG list in a + headline, it creates the corresponding TAGS view. If the cursor is on a timestamp, it compiles the agenda for that - date. Furthermore, it will visit text and remote files in + date. Furthermore, it will visit text and remote files in ~file:~ links with Emacs and select a suitable - application for local non-text files. Classification of files - is based on file extension only. See option ~org-file-apps~. + application for local non-text files. Classification of files + is based on file extension only. See option ~org-file-apps~. If you want to override the default application and visit the - file with Emacs, use a {{{kbd(C-u)}}} prefix. If you want to - avoid opening in Emacs, use a {{{kbd(C-u C-u)}}} prefix. If + file with Emacs, use a {{{kbd(C-u)}}} prefix. If you want to + avoid opening in Emacs, use a {{{kbd(C-u C-u)}}} prefix. If the cursor is on a headline, but not on a link, offer all - links in the headline and entry text. If you want to setup + links in the headline and entry text. If you want to setup the frame configuration for following links, customize ~org-link-frame-setup~. @@ -3188,7 +3188,7 @@ insert it into an Org file, and to follow the link. #+vindex: org-return-follows-link #+kindex: RET - {{{key(mouse-2)}}} or {{{key(mouse-1)}}} :: On links, - {{{kbd(mouse-2)}}} will open the link just as {{{kbd(C-c C-o)}}} would. Under Emacs 22 and later, {{{kbd(mouse-1)}}} + {{{kbd(mouse-2)}}} will open the link just as {{{kbd(C-c C-o)}}} would. Under Emacs 22 and later, {{{kbd(mouse-1)}}} will also follow a link. #+kindex: mouse-2 @@ -3222,7 +3222,7 @@ insert it into an Org file, and to follow the link. #+cindex: mark ring Push the current position onto the mark ring, to be able to - return easily. Commands following an internal link do this + return easily. Commands following an internal link do this automatically. - {{{kbd(C-c &)}}}, ~org-mark-ring-goto~ :: @@ -3230,8 +3230,8 @@ insert it into an Org file, and to follow the link. #+findex: org-mark-ring-goto #+cindex: links, returning to - Jump back to a recorded position. A position is recorded by - the commands following internal links, and by {{{kbd(C-c %)}}}. Using this command several times in direct succession + Jump back to a recorded position. A position is recorded by + the commands following internal links, and by {{{kbd(C-c %)}}}. Using this command several times in direct succession moves through a ring of previously recorded positions. - {{{kbd(C-c C-x C-n)}}}, ~org-next-link~ :: @@ -3243,9 +3243,9 @@ insert it into an Org file, and to follow the link. #+kindex: C-c C-x C-n #+findex: org-next-link - Move forward/backward to the next link in the buffer. At the + Move forward/backward to the next link in the buffer. At the limit of the buffer, the search fails once, and then wraps - around. The key bindings for this are really too long; you + around. The key bindings for this are really too long; you might want to bind this also to {{{kbd(C-n)}}} and {{{kbd(C-p)}}} @@ -3383,7 +3383,7 @@ link, together with an explanation: uses the Emacs command ~occur~ to list all matches in a separate window. If the target file is in Org mode, ~org-occur~ is used to create a sparse - tree with the matches. @c If the target file is a + tree with the matches. @c If the target file is a directory, @c ~grep~ will be used to search all files in the directory. @@ -3429,7 +3429,7 @@ implementation example. See the file {{{file(org-bibtex.el)}}}. Org mode does not maintain TODO lists as separate documents.[fn:40] Instead, TODO items are an integral part of the notes file, because TODO items usually come up while taking notes! With Org mode, simply -mark any entry in a tree as being a TODO item. In this way, +mark any entry in a tree as being a TODO item. In this way, information is not duplicated, and the entire context from which the TODO item emerged is always present. @@ -3485,8 +3485,8 @@ are: Select the following/preceding TODO state, similar to cycling. Useful mostly if more than two TODO states are possible - (see [[TODO extensions]]). See also [[Conflicts]], for a discussion of the - interaction with ~shift-selection-mode~. See also the variable + (see [[TODO extensions]]). See also [[Conflicts]], for a discussion of the + interaction with ~shift-selection-mode~. See also the variable ~org-treat-S-cursor-todo-selection-as-state-change~. - {{{kbd(C-c / t)}}}, ~org-show-todo-tree~ :: @@ -3495,14 +3495,14 @@ are: #+cindex: sparse tree, for TODO #+vindex: org-todo-keywords - View TODO items in a /sparse tree/ (see [[Sparse trees]]). Folds the entire + View TODO items in a /sparse tree/ (see [[Sparse trees]]). Folds the entire buffer, but shows all TODO items (with not-DONE state) and the - headings hierarchy above them. With a prefix argument (or by using - {{{kbd(C-c / T)}}}), search for a specific TODO. You will be + headings hierarchy above them. With a prefix argument (or by using + {{{kbd(C-c / T)}}}), search for a specific TODO. You will be prompted for the keyword, and you can also give a list of keywords like ~KWD1|KWD2|...~ to list entries that match any one of these - keywords. With a numeric prefix argument N, show the tree for the - Nth keyword in the variable ~org-todo-keywords~. With two prefix + keywords. With a numeric prefix argument N, show the tree for the + Nth keyword in the variable ~org-todo-keywords~. With two prefix arguments, find all TODO states, both un-done and done. - {{{kbd(C-c a t)}}}, ~org-todo-list~ :: @@ -3536,8 +3536,8 @@ option ~org-todo-state-tags-triggers~ for details. #+vindex: org-todo-keywords By default, marked TODO entries have one of only two states: TODO and -DONE. Org mode allows you to classify TODO items in more complex ways -with /TODO keywords/ (stored in ~org-todo-keywords~). With special +DONE. Org mode allows you to classify TODO items in more complex ways +with /TODO keywords/ (stored in ~org-todo-keywords~). With special setup, the TODO keyword system can work differently in different files. @@ -3571,13 +3571,13 @@ state. With this setup, the command {{{kbd(C-c C-t)}}} will cycle an entry from TODO to FEEDBACK, then to VERIFY, and finally to DONE and -DELEGATED. You may also use a numeric prefix argument to quickly -select a specific state. For example {{{kbd(C-3 C-c C-t)}}} will -change the state immediately to VERIFY. Or you can use -{{{kbdkey(S-,left)}}} to go backward through the sequence. If you +DELEGATED. You may also use a numeric prefix argument to quickly +select a specific state. For example {{{kbd(C-3 C-c C-t)}}} will +change the state immediately to VERIFY. Or you can use +{{{kbdkey(S-,left)}}} to go backward through the sequence. If you define many keywords, you can use in-buffer completion (see [[Completion]]) or even a special one-key selection scheme (see [[Fast access to TODO states]]) -to insert these words into the buffer. Changing a TODO state can be +to insert these words into the buffer. Changing a TODO state can be logged with a timestamp, see [[Tracking TODO state changes]], for more information. @@ -3654,10 +3654,10 @@ keyword or using completion, you may also apply the following commands: #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-u C-u C-c C-t)}}} {{{kbdkey(C-S-,right)}}} {{{kbdkey(C-S-,left)}}} :: - These keys jump from one TODO subset to the next. In the above + These keys jump from one TODO subset to the next. In the above example, {{{kbd(C-u C-u C-c C-t)}}} or {{{kbdkey(C-S-,right)}}} would jump from ~TODO~ or ~DONE~ to ~REPORT~, and any of the - words in the second row to ~CANCELED~. Note that the + words in the second row to ~CANCELED~. Note that the {{{kbd(C-S-)}}} key binding conflict with ~shift-selection-mode~ (see [[Conflicts]]). @@ -3692,7 +3692,7 @@ each keyword, in parentheses.[fn:43] For example: #+vindex: org-fast-tag-selection-include-todo If you then press {{{kbd(C-c C-t)}}} followed by the selection key, -the entry will be switched to this state. {{{kbd(SPC)}}} can be used +the entry will be switched to this state. {{{kbd(SPC)}}} can be used to remove any TODO keyword from an entry.[fn:44] *** Per-file keywords @@ -3873,9 +3873,9 @@ item was finished. This is achieved with:[fn:46] #+end_src {{{noindent}}} Then each time you turn an entry from a TODO (not-done) -state into any of the DONE states, a line {{{samp(CLOSED: [timestamp])}}} will be inserted just after the headline. If you turn +state into any of the DONE states, a line {{{samp(CLOSED: [timestamp])}}} will be inserted just after the headline. If you turn the entry back into a TODO item through further state cycling, that -line will be removed again. If you want to record a note along with +line will be removed again. If you want to record a note along with the timestamp, use:[fn:47] #+header: :exports code @@ -3904,21 +3904,21 @@ day, giving you an overview of what has been done. When TODO keywords are used as workflow states (see [[Workflow states]]), you might want to 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 for a change. These records will be +and maybe take a note about this change. You can either record just a +timestamp, or a time-stamped note for a change. These records will be inserted after the headline as an itemized list, newest first.[fn:48] 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 +way into a drawer (see [[Drawers]]). Customize the variable ~org-log-into-drawer~ to get this behavior---the recommended drawer for this is called ~LOGBOOK~.[fn:178] You can also overrule the setting of this variable for a subtree by setting a ~LOG_INTO_DRAWER~ property. Since it is normally too much to record a note for every state, Org -mode expects configuration on a per-keyword basis for this. This is +mode expects configuration on a per-keyword basis for this. This is achieved by adding special markers {{{samp(!)}}} (for a timestamp) or {{{samp(@)}}} (for a note with timestamp) in parentheses after each -keyword. For example, with the setting: +keyword. For example, with the setting: #+header: :exports code #+header: :eval no @@ -3937,8 +3937,8 @@ CANCELED.[fn:49] The setting for WAIT is even more special: the {{{samp(!)}}} after the slash means that in addition to the note taken when entering the state, a timestamp should be recorded when /leaving/ the WAIT state, if and only if the /target/ state does not configure logging -for entering it. So it has no effect when switching from WAIT to DONE, -because DONE is configured to record a timestamp only. But when +for entering it. So it has no effect when switching from WAIT to DONE, +because DONE is configured to record a timestamp only. But when switching from WAIT back to TODO, the {{{samp(/!)}}} in the WAIT setting now triggers a timestamp even though TODO has no logging configured. @@ -4000,7 +4000,7 @@ called "habits." A habit has the following properties: 3. The property ~STYLE~ is set to the value ~habit~. 4. The TODO has a scheduled date, usually with a ~.+~ style repeat - interval. A ~++~ style may be appropriate for habits with time + interval. A ~++~ style may be appropriate for habits with time constraints, e.g., must be done on weekends, or a ~+~ style for an unusual habit that can have a backlog, e.g., weekly reports. @@ -4011,7 +4011,7 @@ called "habits." A habit has the following properties: 6. You must also have state logging for the ~DONE~ state enabled (see [[Tracking TODO state changes]]), in order for historical - data to be represented in the consistency graph. If it is not + data to be represented in the consistency graph. If it is not enabled it is not an error, but the consistency graphs will be largely meaningless. @@ -4040,13 +4040,13 @@ actual habit with some history: What this habit says is: I want to shave at most every 2 days (given by the ~SCHEDULED~ date and repeat interval) and at least every 4 -days. If today is the 15th, then the habit first appears in the agenda +days. If today is the 15th, then the habit first appears in the agenda on Oct 17, after the minimum of 2 days has elapsed, and will appear overdue on Oct 19, after four days have elapsed. What's really useful about habits is that they are displayed along with a consistency graph, to show how consistent you've been at -getting that task done in the past. This graph shows every day that +getting that task done in the past. This graph shows every day that the task was done over the past three weeks, with colors for each day. The colors used are: @@ -4066,7 +4066,7 @@ the way habits are displayed in the agenda. #+attr_texinfo: :table-type table :indic @asis - ~org-habit-graph-column~ :: The buffer column at which the - consistency graph should be drawn. This will overwrite any text + consistency graph should be drawn. This will overwrite any text in that column, so it is a good idea to keep your habits' titles brief and to the point. @@ -4077,12 +4077,12 @@ the way habits are displayed in the agenda. will appear in consistency graphs. - ~org-habit-show-habits-only-for-today~ :: If non-nil, only show - habits in today's agenda view. This is set to true by default. + habits in today's agenda view. This is set to true by default. Lastly, pressing {{{kbd(K)}}} in the agenda buffer will cause habits -to temporarily be disabled and they won't appear at all. Press -{{{kbd(K)}}} again to bring them back. They are also subject to tag +to temporarily be disabled and they won't appear at all. Press +{{{kbd(K)}}} again to bring them back. They are also subject to tag filtering, if you have habits which should only be done in certain contexts, for example. @@ -4103,11 +4103,11 @@ placing a /priority cookie/ into the headline of a TODO item, like this: #+vindex: org-priority-faces {{{noindent}}} By default, Org mode supports three priorities: {{{samp(A)}}}, -{{{samp(B)}}}, and {{{samp(C)}}}. {{{samp(A)}}} is the highest -priority. An entry without a cookie is treated just like priority -{{{samp(B)}}}. Priorities make a difference only for sorting in the +{{{samp(B)}}}, and {{{samp(C)}}}. {{{samp(A)}}} is the highest +priority. An entry without a cookie is treated just like priority +{{{samp(B)}}}. Priorities make a difference only for sorting in the agenda (see [[Weekly/daily agenda]]); outside the agenda, they have no -inherent meaning to Org mode. The cookies can be highlighted with +inherent meaning to Org mode. The cookies can be highlighted with special faces by customizing the variable ~org-priority-faces~. Priorities can be attached to any outline node; they do not need to be TODO @@ -4120,10 +4120,10 @@ items. # Preceding line won't export to pdf #+findex: org-priority # Should be C-c , - Set the priority of the current headline (~org-priority~). The + Set the priority of the current headline (~org-priority~). The command prompts for a priority character {{{samp(A)}}}, {{{samp(B)}}} - or {{{samp(C)}}}. When you press {{{key(SPC)}}}} instead, the priority - cookie is removed from the headline. The priorities can also be + or {{{samp(C)}}}. When you press {{{key(SPC)}}}} instead, the priority + cookie is removed from the headline. The priorities can also be changed ``remotely'' from the timeline and agenda buffer with the {{{kbd(\,)}}} command (see [[Agenda commands]]). @@ -4132,7 +4132,7 @@ items. Increase/decrease priority of current headline.[fn:50] Note that these keys are also used to modify timestamps - (see [[Creating timestamps]]). See also [[Conflicts]], for a + (see [[Creating timestamps]]). See also [[Conflicts]], for a discussion of the interaction with ~shift-selection-mode~. @@ -4142,7 +4142,7 @@ items. You can change the range of allowed priorities by setting the variables ~org-highest-priority~, ~org-lowest-priority~, and -~org-default-priority~. For an individual buffer, you may set these +~org-default-priority~. For an individual buffer, you may set these values (highest, lowest, default) like this (please make sure that the highest priority is earlier in the alphabet than the lowest priority): @@ -4161,12 +4161,12 @@ highest priority is earlier in the alphabet than the lowest priority): #+vindex: org-agenda-todo-list-sublevels It is often advisable to break down large tasks into smaller, -manageable subtasks. You can do this by creating an outline tree below +manageable subtasks. You can do this by creating an outline tree below a TODO item, with detailed subtasks on the tree.[fn:51] To keep the overview over the fraction of subtasks that are already completed, insert either {{{samp([/])}}} or {{{samp([%])}}} anywhere in the -headline. These cookies will be updated each time the TODO status of a -child changes, or when pressing {{{kbd(C-c C-c)}}} on the cookie. For +headline. These cookies will be updated each time the TODO status of a +child changes, or when pressing {{{kbd(C-c C-c)}}} on the cookie. For example: #+begin_example @@ -4181,7 +4181,7 @@ example: #+cindex: property, COOKIE_DATA If a heading has both checkboxes and TODO children below it, the -meaning of the statistics cookie become ambiguous. Set the property +meaning of the statistics cookie become ambiguous. Set the property ~COOKIE_DATA~ to either {{{samp(checkbox)}}} or {{{samp(todo)}}} to resolve this issue. @@ -4189,7 +4189,7 @@ resolve this issue. If you would like to have the statistics cookie count any TODO entries in the subtree (not just direct children), configure the variable -~org-hierarchical-todo-statistics~. To do this for a single subtree, +~org-hierarchical-todo-statistics~. To do this for a single subtree, include the word {{{samp(recursive)}}} into the value of the ~COOKIE_DATA~ property. @@ -4228,9 +4228,9 @@ of) a large number of subtasks (see [[Checkboxes]]). Every item in a plain list (see [[Plain lists]]) can be made into a checkbox by starting it with the string {{{samp([ ])}}}.[fn:52] This feature is similar to TODO items (see [[TODO items]]), but is more -lightweight. Checkboxes are not included into the global TODO list, so -they are often great to split a task into a number of simple steps. Or -you can use them in a shopping list. To toggle a checkbox, use +lightweight. Checkboxes are not included into the global TODO list, so +they are often great to split a task into a number of simple steps. Or +you can use them in a shopping list. To toggle a checkbox, use {{{kbd(C-c C-c)}}}, or use the mouse (thanks to Piotr Zielinski's {{{file(org-mouse.el)}}}). @@ -4261,17 +4261,17 @@ The {{{samp([2/4])}}} and {{{samp([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 line of) a plain list item. Each cookie covers +opening a folded entry. The cookies can be placed into a headline 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 appears.[fn:53] You have to insert the cookie -yourself by typing either {{{samp([/])}}} or {{{samp([%])}}}. With +yourself by typing either {{{samp([/])}}} or {{{samp([%])}}}. With {{{samp([/])}}} you get an {{{samp(n out of m)}}} result, as in the -examples above. With {{{samp([%])}}} you get information about the +examples above. With {{{samp([%])}}} you get information about the percentage of checkboxes checked (in the above example, this would be -{{{samp([50%])}}} and {{{samp([33%])}}}, respectively). In a headline, +{{{samp([50%])}}} and {{{samp([33%])}}}, respectively). In a headline, a cookie can count either checkboxes below the heading or TODO states -of children, and it will display whatever was changed last. Set the +of children, and it will display whatever was changed last. Set the property ~COOKIE_DATA~ to either {{{samp(checkbox)}}} or {{{samp(todo)}}} to resolve this issue. @@ -4287,13 +4287,13 @@ check off a box while there are unchecked boxes above it. #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c C-c)}}}, ~org-toggle-checkbox~ :: Toggle checkbox status - or (with prefix arg) checkbox presence at point. With a single + or (with prefix arg) checkbox presence at point. With a single prefix argument, add an empty checkbox or remove the current one.[fn:54] With a double prefix argument, set it to {{{samp([-])}}}, which is considered to be an intermediate state. - {{{kbd(C-c C-x C-b)}}}, ~org-toggle-checkbox~ :: Toggle checkbox - status or (with prefix arg) checkbox presence at point. With + status or (with prefix arg) checkbox presence at point. With double prefix argument, set it to {{{samp([-])}}}, which is considered to be an intermediate state. @@ -4308,7 +4308,7 @@ check off a box while there are unchecked boxes above it. - {{{kbdkey(M-S-,RET)}}}, ~org-insert-todo-heading~ :: Insert a new - item with a checkbox. This works only if the cursor is already in + item with a checkbox. This works only if the cursor is already in a plain list item (see [[Plain lists]]). - {{{kbd(C-c C-x o)}}}, ~org-toggle-ordered-property~ :: @@ -4317,21 +4317,21 @@ check off a box while there are unchecked boxes above it. #+cindex: property, ORDERED Toggle the ~ORDERED~ property of the entry, to toggle if checkboxes - must be checked off in sequence. A property is used for this + must be checked off in sequence. A property is used for this behavior because this should be local to the current entry, not - inherited like a tag. However, if you would like to /track/ the + inherited like a tag. However, if you would like to /track/ the value of this property with a tag for better visibility, customize the variable ~org-track-ordered-property-with-tag~. - {{{kbd(C-c #)}}}, ~org-update-statistics-cookies~ :: #+kindex: C-c # - Update the statistics cookie in the current outline entry. When + Update the statistics cookie in the current outline entry. When called with a {{{kbd(C-u)}}} prefix, update the entire file. Checkbox statistic cookies are updated automatically if you toggle checkboxes with {{{kbd(C-c C-c)}}} and make new ones with - {{{kbdkey(M-S-,RET)}}}. TODO statistics cookies update when - changing TODO states. If you delete boxes/entries or add/change + {{{kbdkey(M-S-,RET)}}}. TODO statistics cookies update when + changing TODO states. If you delete boxes/entries or add/change them by hand, use this command to get things back into sync. * Tags @@ -4344,17 +4344,17 @@ check off a box while there are unchecked boxes above it. #+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 headlines. 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, -{{{samp(_)}}}, and {{{samp(@)}}}. Tags must be preceded and followed -by a single colon, e.g., {{{samp(:work:)}}}. Several tags can be -specified, as in {{{samp(:work:urgent:)}}}. Tags will by default be in -bold face with the same color as the headline. You may specify special +the headline. Tags are normal words containing letters, numbers, +{{{samp(_)}}}, and {{{samp(@)}}}. Tags must be preceded and followed +by a single colon, e.g., {{{samp(:work:)}}}. Several tags can be +specified, as in {{{samp(:work:urgent:)}}}. Tags will by default be in +bold face with the same color as the headline. 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]]). @@ -4366,9 +4366,9 @@ the same way as you can for TODO keywords (see [[Faces for TODO keywords]]). #+cindex: inheritance, of tags #+cindex: sublevels, inclusion into tags match -/Tags/ make use of the hierarchical structure of outline trees. If a +/Tags/ make use of the hierarchical structure of outline trees. If a heading has a certain tag, all subheadings will inherit the tag as -well. For example, in the list +well. For example, in the list #+begin_example ,* Meeting with the French group :work: @@ -4379,9 +4379,9 @@ well. For example, in the list {{{noindent}}} the final heading will have the tags {{{samp(:work:)}}}, {{{samp(:boss:)}}}, {{{samp(:notes:)}}}, and {{{samp(:action:)}}} even though the final heading is not explicitly -marked with those tags. You can also set tags that all entries in a +marked with those tags. You can also set tags that all entries in a file should inherit just as if these tags were defined in a -hypothetical level zero that surrounds the entire file. Use a line +hypothetical level zero that surrounds the entire file. Use a line like this:[fn:55] #+cindex: #+FILETAGS @@ -4401,7 +4401,7 @@ it off entirely, use the variables ~org-use-tag-inheritance~ and When a headline matches during a tags search while tag inheritance is turned on, all the sublevels in the same tree will (for a simple match form) match as well.[fn:56] The list of matches may then become very -long. If you only want to see the first tags match in a subtree, +long. If you only want to see the first tags match in a subtree, configure the variable ~org-tags-match-list-sublevels~ (not recommended). @@ -4440,10 +4440,10 @@ also a special command for inserting tags: #+vindex: org-tag-alist -Org supports tag insertion based on a /list of tags/. By default this +Org supports tag insertion based on a /list of tags/. By default this list is constructed dynamically, containing all tags currently used in -the buffer. You may also globally specify a hard list of tags with the -variable ~org-tag-alist~. Finally you can set the default tags for a +the buffer. You may also globally specify a hard list of tags with the +variable ~org-tag-alist~. Finally you can set the default tags for a given file with lines like #+cindex: #+TAGS @@ -4465,7 +4465,7 @@ in a specific file, add an empty TAGS option line to that file: If you have a preferred set of tags that you would like to use in every file, in addition to those defined on a per-file basis by TAGS option lines, then you may specify a list of tags with the variable -~org-tag-persistent-alist~. You may turn this off on a per-file basis +~org-tag-persistent-alist~. You may turn this off on a per-file basis by adding a STARTUP option line to that file: #+begin_example @@ -4473,14 +4473,14 @@ by adding a STARTUP option line to that file: #+end_example By default Org mode uses the standard minibuffer completion facilities -for entering tags. However, it also implements another, quicker, tag -selection method called /fast tag selection/. This allows you to -select and deselect tags with just a single key press. For this to +for entering tags. However, it also implements another, quicker, tag +selection method called /fast tag selection/. This allows you to +select and deselect tags with just a single key press. For this to work well you should assign unique letters to most of your commonly -used tags. You can do this globally by configuring the variable -~org-tag-alist~ in your {{{file(.emacs)}}} file. For example, you may +used tags. You can do this globally by configuring the variable +~org-tag-alist~ in your {{{file(.emacs)}}} file. For example, you may find the need to tag many items in different files with -{{{samp(:@home:)}}}. In this case you can set something like: +{{{samp(:@home:)}}}. In this case you can set something like: #+header: :eval no #+header: :exports code @@ -4527,8 +4527,8 @@ cursor in one of these lines to activate any changes. {{{noindent}}} To set these mutually exclusive groups in the variable ~org-tags-alist~, you must use the dummy tags ~:startgroup~ and -~:endgroup~ instead of the braces. Similarly, you can use ~:newline~ -to indicate a line break. The previous example would be set globally +~:endgroup~ instead of the braces. Similarly, you can use ~:newline~ +to indicate a line break. The previous example would be set globally by the following configuration: #+header: :eval no @@ -4593,11 +4593,11 @@ keys: {{{noindent}}} This method lets you assign tags to a headline with -very few keys. With the above setup, you could clear the current tags +very few keys. With the above setup, you could clear the current tags and set {{{samp(@home)}}}, {{{samp(laptop)}}} and {{{samp(pc)}}} tags -with just the following keys: {{{ksksksk(C-c C-c,SPC,h l p,RET)}}}. Switching from {{{samp(@home)}}} to +with just the following keys: {{{ksksksk(C-c C-c,SPC,h l p,RET)}}}. Switching from {{{samp(@home)}}} to {{{samp(@work)}}} would be done with {{{kbdspckey(C-c C-c w,RET)}}} or -alternatively with {{{kbd(C-c C-c C-c w)}}}. Adding the non-predefined +alternatively with {{{kbd(C-c C-c C-c w)}}}. Adding the non-predefined tag {{{samp(Sarah)}}} could be done with {{{ksksksksk(C-c C-c,TAB,S a r a h,RET,RET)}}}. @@ -4605,12 +4605,12 @@ tag {{{samp(Sarah)}}} could be done with If you find that most of the time you need only a single key press to modify your list of tags, set the variable -~org-fast-tag-selection-single-key~. Then you no longer have to press +~org-fast-tag-selection-single-key~. Then you no longer have to press {{{key(RET)}}} to exit fast tag selection---it will immediately exit after -the first change. If you then occasionally need more keys, press +the first change. If you then occasionally need more keys, press {{{kbd(C-c)}}} to turn off auto-exit for the current tag selection process (in effect: start selection with {{{kbd(C-c C-c C-c)}}} -instead of {{{kbd(C-c C-c)}}}). If you set the variable to the value +instead of {{{kbd(C-c C-c)}}}). If you set the variable to the value ~expert~, the special window is not even shown for single-key tag selection, it comes up only when you press an extra {{{kbd(C-c)}}}. @@ -4627,7 +4627,7 @@ information into special lists. #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c / m)}}}, ~C-c \~ ~org-match-sparse-tree~ :: - Create a sparse tree with all headlines matching a tags search. With a + Create a sparse tree with all headlines matching a tags search. With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not a TODO line. @@ -4650,9 +4650,9 @@ These commands all prompt for a match string which allows basic Boolean logic like {{{samp(+boss+urgent-project1)}}}, to find entries with tags {{{samp(boss)}}} and {{{samp(urgent)}}}, but not {{{samp(project1)}}}, or {{{samp(Kathy|Sally)}}} to find entries which -are tagged, like {{{samp(Kathy)}}} or {{{samp(Sally)}}}. The full +are tagged, like {{{samp(Kathy)}}} or {{{samp(Sally)}}}. The full syntax of the search string is rich and allows also matching against -TODO keywords, entry levels and properties. For a complete description +TODO keywords, entry levels and properties. For a complete description with many examples, see [[Matching tags and properties]]. * Properties and columns @@ -4662,17 +4662,17 @@ with many examples, see [[Matching tags and properties]]. :END: #+cindex: properties -A property is a key-value pair associated with an entry. Properties +A property is a key-value pair associated with an entry. Properties can be set so they are associated with a single entry, with every entry in a tree, or with every entry in an Org mode file. -There are two main applications for properties in Org mode. First, -properties are like tags, but with a value. Imagine maintaining a file +There are two main applications for properties in Org mode. First, +properties are like tags, but with a value. Imagine maintaining a file where you document bugs and plan releases for a piece of software. Instead of using tags like ~:release_1:~, ~:release_2:~, you can use a property, say ~:Release:~, that in different subtrees has different -values, such as ~1.0~ or ~2.0~. Second, you can use properties to -implement (very basic) database capabilities in an Org buffer. Imagine +values, such as ~1.0~ or ~2.0~. Second, you can use properties to +implement (very basic) database capabilities in an Org buffer. Imagine keeping track of your music CDs, where properties could be things such as the album, artist, date of release, number of tracks, and so on. @@ -4686,11 +4686,11 @@ Properties can be conveniently edited and viewed in column view #+cindex: property syntax #+cindex: drawer, for properties -Properties are key-value pairs. When they are associated with a single +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~. Each property is specified +(see [[Drawers]]) with the name ~PROPERTIES~. Each property is specified on a single line, with the key (surrounded by colons) first, and the -value after it. Here is an example: +value after it. Here is an example: #+begin_example ,* CD collection @@ -4710,11 +4710,11 @@ set this way will either be associated with a single entry, or the sub-tree defined by the entry, see [[Property inheritance]]. You may define the allowed values for a particular property -{{{samp(:Xyz:)}}} by setting a property {{{samp(:Xyz_ALL:)}}}. This +{{{samp(:Xyz:)}}} by setting a property {{{samp(:Xyz_ALL:)}}}. This special property is /inherited/, so if you set it in a level 1 entry, -it will apply to the entire tree. When allowed values are defined, +it will apply to the entire tree. When allowed values are defined, setting the corresponding property becomes easier and is less prone to -typing errors. For the example with the CD collection, we can +typing errors. For the example with the CD collection, we can predefine publishers and the number of disks in a box like this: #+begin_example @@ -4735,7 +4735,7 @@ file, use a line like: #+end_example If you want to add to the value of an existing property, append a ~+~ -to the property name. The following results in the property ~var~ +to the property name. The following results in the property ~var~ having the value ``foo=1 bar=2''. #+cindex: property, + @@ -4744,7 +4744,7 @@ having the value ``foo=1 bar=2''. ,#+PROPERTY: var+ bar=2 #+end_example -It is also possible to add to the values of inherited properties. The +It is also possible to add to the values of inherited properties. The following results in the ~genres~ property having the value ``Classic Baroque'' under the ~Goldberg Variations~ subtree. @@ -4779,19 +4779,19 @@ The following commands help to work with properties: - {{{kbdkey(M-,TAB)}}}, ~pcomplete~ :: #+kindex: M-@key{TAB} - After an initial colon in a line, complete property keys. All keys + After an initial colon in a line, complete property keys. All keys used in the current file will be offered as possible completions. - {{{kbd(C-c C-x p)}}}, ~org-set-property~ :: #+kindex: C-c C-x p - Set a property. This prompts for a property name and a value. If + Set a property. This prompts for a property name and a value. If necessary, the property drawer is created as well. - C-u M-x org-insert-drawer RET :: #+cindex: org-insert-drawer - Insert a property drawer into the current entry. The drawer will be + Insert a property drawer into the current entry. The drawer will be inserted early in the entry, but after the lines with planning information like deadlines. @@ -4835,9 +4835,9 @@ The following commands help to work with properties: Special properties provide an alternative access method to Org mode features, like the TODO state or the priority of an entry, discussed -in the previous chapters. This interface exists so that you can +in the previous chapters. This interface exists so that you can include these states in a column view (see [[Column view]]), or to use -them in queries. The following property names are special and (except +them in queries. The following property names are special and (except for ~:CATEGORY:~) should not be used as keys in the properties drawer: #+cindex: property, special, ID @@ -4894,7 +4894,7 @@ the same commands are used as for tag searches (see [[Tag searches]]). - {{{kbd(C-c / m)}}}, ~C-c \~ ~org-match-sparse-tree~ :: #+kindex: C-c / m - Create a sparse tree with all matching entries. With a {{{kbd(C-u)}}} + Create a sparse tree with all matching entries. With a {{{kbd(C-u)}}} prefix argument, ignore headlines that are not a TODO line. - {{{kbd(C-c a m)}}}, ~org-tags-view~ :: @@ -4922,10 +4922,10 @@ single property: - {{{kbd(C-c / p)}}} :: #+kindex: C-c / p - Create a sparse tree based on the value of a property. This first - prompts for the name of a property, and then for a value. A sparse + Create a sparse tree based on the value of a property. This first + prompts for the name of a property, and then for a value. A sparse tree is created with all entries that define this property with the - given value. If you enclose the value in curly braces, it is + given value. If you enclose the value in curly braces, it is interpreted as a regular expression and matched against the property values. @@ -4940,14 +4940,14 @@ single property: The outline structure of Org mode documents lends itself to an inheritance model of properties: if the parent in a tree has a certain -property, the children can inherit this property. Org mode does not +property, the children can inherit this property. Org mode does not turn this on by default, because it can slow down property searches -significantly and is often not needed. However, if you find +significantly and is often not needed. However, if you find inheritance useful, you can turn it on by setting the variable -~org-use-property-inheritance~. It may be set to ~t~ to make all +~org-use-property-inheritance~. It may be set to ~t~ to make all properties inherited from the parent, to a list of properties that should be inherited, or to a regular expression that matches inherited -properties. If a property has the value {{{samp(nil)}}}, this is +properties. If a property has the value {{{samp(nil)}}}, this is interpreted as an explicit undefine of the property, so that inheritance search will stop at this value and return ~nil~. @@ -4960,7 +4960,7 @@ least for the special applications for which they are used: #+cindex: property, COLUMNS The ~:COLUMNS:~ property defines the format of column view (see [[Column - view]]). It is inherited in the sense that the level where a ~:COLUMNS:~ + view]]). It is inherited in the sense that the level where a ~:COLUMNS:~ property is defined is used as the starting point for a column view table, independently of the location in the subtree from where columns view is turned on. @@ -4989,17 +4989,17 @@ least for the special applications for which they are used: :END: 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 +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 a +headline of each item. While the headlines 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 ({{{kbdkey(S-,TAB)}}}} {{{kbdkey(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 after +entry below each headline. 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 +the selected items. Column view also works in agenda buffers (see [[Agenda views]]) where queries have collected selected items, possibly from a number of files. @@ -5036,7 +5036,7 @@ To specify a format that only applies to a specific tree, add a #+end_example If a ~:COLUMNS:~ property is present in an entry, it defines columns -for the entry itself, and for the entire subtree below it. Since the +for the entry itself, and for the entire subtree below it. Since the column definition is part of the hierarchical structure of the document, you can define columns on level 1 that are general enough for all sublevels, and more specific columns further down, when you @@ -5052,7 +5052,7 @@ definition looks like this: %[{{{var(width)}}}]{{{var(property)}}}[({{{var(title)}}})][{{{{var(summary-type)}}}}] {{{noindent}}} Except for the percent sign and the property name, all -items are optional. The individual parts have the following meaning: +items are optional. The individual parts have the following meaning: #+attr_texinfo: :columns 0.2 0.8 | Variable | Meaning | @@ -5092,24 +5092,24 @@ items are optional. The individual parts have the following meaning: {{{noindent}}} Be aware that you can only have one summary type for -any property you include. Subsequent columns referencing the same +any property you include. Subsequent columns referencing the same property will all display the same summary information. -The ~est+~ summary type requires further explanation. It is used for -combining estimates, expressed as low-high ranges. For example, +The ~est+~ summary type requires further explanation. It is used for +combining estimates, expressed as low-high ranges. For example, instead of estimating a particular task will take 5 days, you might estimate it as 5-6 days if you're fairly confident you know how much work is required, or 1-10 days if you don't really know what needs to -be done. Both ranges average at 5.5 days, but the first represents a +be done. Both ranges average at 5.5 days, but the first represents a more predictable delivery. When combining a set of such estimates, simply adding the lows and -highs produces an unrealistically wide result. Instead, ~est+~ adds +highs produces an unrealistically wide result. Instead, ~est+~ adds the statistical mean and variance of the sub-tasks, generating a final -estimate from the sum. For example, suppose you had ten tasks, each of -which was estimated at 0.5 to 2 days of work. Straight addition +estimate from the sum. For example, suppose you had ten tasks, each of +which was estimated at 0.5 to 2 days of work. Straight addition produces an estimate of 5 to 20 days, representing what to expect if -everything goes either extremely well or extremely poorly. In +everything goes either extremely well or extremely poorly. In contrast, ~est+~ estimates the full job more realistically, at 10-15 days. @@ -5125,19 +5125,19 @@ values.[fn:58] #+end_example {{{noindent}}} The first column, {{{samp(%25ITEM)}}}, means the first -25 characters of the item itself, i.e., of the headline. You probably +25 characters of the item itself, i.e., of the headline. You probably always should start the column definition with the {{{samp(ITEM)}}} -specifier. The other specifiers create columns {{{samp(Owner)}}} with +specifier. The other specifiers create columns {{{samp(Owner)}}} with a list of names as allowed values, for {{{samp(Status)}}} with four different possible values, and for a checkbox field -{{{samp(Approved)}}}. When no width is given after the {{{samp(%)}}} +{{{samp(Approved)}}}. When no width is given after the {{{samp(%)}}} character, the column will be exactly as wide as it needs to be in -order to fully display all values. The {{{samp(Approved)}}} column +order to fully display all values. The {{{samp(Approved)}}} column does have a modified title ({{{samp(Approved?)}}}, with a question -mark). Summaries will be created for the {{{samp(Time_Estimate)}}} +mark). Summaries will be created for the {{{samp(Time_Estimate)}}} column by adding time duration expressions like HH:MM, and for the {{{samp(Approved)}}} column, by providing an {{{samp([X])}}} status if -all children have been checked. The {{{samp(CLOCKSUM)}}} and +all children have been checked. The {{{samp(CLOCKSUM)}}} and {{{samp(CLOCKSUM_T)}}} columns are special, they lists the sums of CLOCK intervals in the subtree, either for all clocks or just for today. @@ -5154,13 +5154,13 @@ The following commands turn column view on or off: #+kindex: C-c C-x C-c #+vindex: org-columns-default-format - Turn on column view. If the cursor is before the first headline in the + Turn on column view. If the cursor is before the first headline in the file, column view is turned on for the entire file, using the - ~#+COLUMNS~ definition. If the cursor is somewhere inside the outline, + ~#+COLUMNS~ definition. If the cursor is somewhere inside the outline, this command searches the hierarchy, up from point, for a ~:COLUMNS:~ - property that defines a format. When one is found, the column view + property that defines a format. When one is found, the column view table is established for the tree starting at the entry that contains - the ~:COLUMNS:~ property. If no such property is found, the format is + the ~:COLUMNS:~ property. If no such property is found, the format is taken from the ~#+COLUMNS~ line or from the variable ~org-columns-default-format~, and column view is established for the current entry and its subtree. @@ -5192,7 +5192,7 @@ The following commands let you edit information in column view: #+kindex: S-@key{left} #+kindex: S-@key{right} - Switch to the next/previous allowed value of the field. For this, you + Switch to the next/previous allowed value of the field. For this, you have to have specified allowed values for a property. - {{{kbd(1..9\,0)}}} :: @@ -5209,9 +5209,9 @@ The following commands let you edit information in column view: - {{{kbd(e)}}}, ~org-columns-edit-value~ :: #+kindex: e - Edit the property at point. For the special properties, this will + Edit the property at point. For the special properties, this will invoke the same interface that you normally use to change that - property. For example, when editing a TAGS property, the tag + property. For example, when editing a TAGS property, the tag completion or fast selection interface will pop up. - {{{kbd(C-c C-c)}}}, ~org-columns-set-tags-or-toggle~ :: @@ -5222,7 +5222,7 @@ The following commands let you edit information in column view: - {{{kbd(v)}}}, ~org-columns-show-value~ :: #+kindex: v - View the full value of this property. This is useful if the width of + View the full value of this property. This is useful if the width of the column is smaller than that of the value. - {{{kbd(a)}}}, ~org-columns-edit-allowed~ :: @@ -5258,8 +5258,8 @@ The following commands modify column view on-the-fly: :END: Since column view is just an overlay over a buffer, it cannot be -exported or printed directly. If you want to capture a column view, -use a ~columnview~ dynamic block (see [[Dynamic blocks]]). The frame of +exported or printed directly. If you want to capture a column view, +use a ~columnview~ dynamic block (see [[Dynamic blocks]]). The frame of this block looks like this: #+cindex: #+BEGIN, columnview @@ -5275,9 +5275,9 @@ this block looks like this: #+attr_texinfo: :table-type table :indic @asis - ~:id~ :: - This is the most important parameter. Column view is a feature that is + This is the most important parameter. Column view is a feature that is often localized to a certain (sub)tree, and the capture block might be - at a different location in the file. To identify the tree whose view + at a different location in the file. To identify the tree whose view to capture, you can use 4 values: #+cindex: property, ID @@ -5307,13 +5307,13 @@ this block looks like this: - ID :: Call column view in the tree that has an ~:ID:~ property with the - value /label/. You can use {{{kbd(M-x org-id-copy)}}} to + value /label/. You can use {{{kbd(M-x org-id-copy)}}} to create a globally unique ID for the current entry and copy it to the kill-ring. - ~:hlines~ :: - When ~t~, insert an hline after every line. When a number ~N~, + When ~t~, insert an hline after every line. When a number ~N~, insert an hline before each headline with level ~<=~ {{{var(N)}}}. @@ -5339,19 +5339,19 @@ block: - {{{kbd(C-c C-x i)}}}, ~org-insert-columns-dblock~ :: #+kindex: C-c C-x i - Insert a dynamic block capturing a column view. You will be prompted + Insert a dynamic block capturing a column view. You will be prompted for the scope or ID of the view. - {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}}, ~org-dblock-update~ :: #+kindex: C-c C-c - Update dynamic block at point. The cursor needs to be in the ~#+BEGIN~ + Update dynamic block at point. The cursor needs to be in the ~#+BEGIN~ line of the dynamic block. - {{{kbd(C-u C-c C-x C-u)}}}, ~org-update-all-dblocks~ :: #+kindex: C-u C-c C-x C-u - Update all dynamic blocks (see [[Dynamic blocks]]). This is useful if you + Update all dynamic blocks (see [[Dynamic blocks]]). This is useful if you have several clock table blocks, column-capturing blocks or other dynamic blocks in a buffer. @@ -5375,9 +5375,9 @@ or a dynamic block. #+cindex: properties, API #+cindex: API, for properties -There is a full API for accessing and changing properties. This API +There is a full API for accessing and changing properties. This API can be used by Emacs Lisp programs to work with properties and to -implement features based on them. For more information see [[Using the +implement features based on them. For more information see [[Using the property API]]. * Dates and times @@ -5412,16 +5412,16 @@ 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:60] A timestamp can appear anywhere in the headline 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: +entry. Its presence causes entries to be shown on specific dates in +the agenda (see [[Weekly/daily agenda]]). We distinguish: #+attr_texinfo: :table-type table :indic @asis - Plain timestamp; Event; Appointment :: #+cindex: timestamp #+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 + 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 timeline and agenda displays, the headline of an entry associated with a plain timestamp will be shown exactly on that date. @@ -5487,16 +5487,16 @@ the agenda (see [[Weekly/daily agenda]]). We distinguish: :DESCRIPTION: Commands to insert timestamps :END: For Org mode to recognize timestamps, they need to be in the specific -format. All commands listed below produce timestamps in the correct +format. All commands listed below produce timestamps in the correct format. #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c .)}}}, ~org-time-stamp~ :: #+kindex: C-c . - Prompt for a date and insert a corresponding timestamp. When the + Prompt for a date and insert a corresponding timestamp. When the cursor is at an existing timestamp in the buffer, the command is used - to modify this timestamp instead of inserting a new one. When this + to modify this timestamp instead of inserting a new one. When this command is used twice in succession, a time range is inserted. - {{{kbd(C-c !)}}}, ~org-time-stamp-inactive~ :: @@ -5512,7 +5512,7 @@ format. #+vindex: org-time-stamp-rounding-minutes Like {{{kbd(C-c .)}}} and {{{kbd(C-c !)}}}, but use the alternative - format which contains date and time. The default time can be rounded + format which contains date and time. The default time can be rounded to multiples of 5 minutes, see the option ~org-time-stamp-rounding-minutes~. @@ -5529,7 +5529,7 @@ format. - {{{kbd(C-c >)}}}, ~org-goto-calendar~ :: #+kindex: C-c > - Access the Emacs calendar for the current date. If there is a + Access the Emacs calendar for the current date. If there is a timestamp in the current line, go to the corresponding date instead. - {{{kbd(C-c C-o)}}}, ~org-open-at-point~ :: @@ -5547,13 +5547,13 @@ format. - {{{kbdkey(S-,up)}}} {{{kbdkey(S-,down)}}}, ~org-timestamp-up~ ~org-timestamp-down-down~ :: #+kindex: S-@key{up} - Change the item under the cursor in a timestamp. The cursor can be on - a year, month, day, hour or minute. When the timestamp contains a time + Change the item under the cursor in a timestamp. The cursor can be on + a year, month, day, hour or minute. When the timestamp contains a time range like {{{samp(15:30-16:30)}}}, modifying the first time will also - shift the second, shifting the time block with constant length. To - change the length, modify the second time. Note that if the cursor is + shift the second, shifting the time block with constant length. To + change the length, modify the second time. Note that if the cursor is in a headline and not at a timestamp, these same keys modify the - priority of an item. (see [[Priorities]]). The key bindings also conflict + priority of an item. (see [[Priorities]]). The key bindings also conflict with shift-selection and related modes (see [[Conflicts]]). - {{{kbd(C-c C-y)}}}, ~org-evaluate-time-range~ :: @@ -5561,7 +5561,7 @@ format. #+cindex: evaluate time range Evaluate a time range by computing the difference between start and - end. With a prefix argument, insert result after the time range (in a + end. With a prefix argument, insert result after the time range (in a table: into the following column). *** The date/time prompt @@ -5575,20 +5575,20 @@ format. When Org mode prompts for a date/time, the default is shown in default date/time format, and the prompt therefore seems to ask for a specific -format. But it will in fact accept date/time information in a variety -of formats. Generally, the information should start at the beginning -of the string. Org mode will find whatever information is in there and +format. But it will in fact accept date/time information in a variety +of formats. Generally, the information should start at the beginning +of the string. Org mode will find whatever information is in there and derive anything you have not specified from the /default date and -time/. The default is usually the current date and time, but when +time/. The default is usually the current date and time, but when modifying an existing timestamp, or when entering the second stamp of -a range, it is taken from the stamp in the buffer. When filling in +a range, it is taken from the stamp in the buffer. When filling in information, Org mode assumes that most of the time you will want to enter a date in the future: if you omit the month/year and the given day/month is /before/ today, it will assume that you mean a future date.[fn:62] If the date has been automatically shifted into the future, the time prompt will show this with {{{samp((=>F))}}}. -For example, let's assume that today is *June 13, 2006*. Here is how +For example, let's assume that today is *June 13, 2006*. Here is how various inputs will be interpreted, the items filled in by Org mode are in *bold*. @@ -5612,9 +5612,9 @@ are in *bold*. Furthermore you can specify a relative date by giving, as the /first/ thing in the input: a plus/minus sign, a number and a letter ([dwmy]) -to indicate change in days, weeks, months, or years. With a single -plus or minus, the date is always relative to today. With a double -plus or minus, it is relative to the default date. If instead of a +to indicate change in days, weeks, months, or years. With a single +plus or minus, the date is always relative to today. With a double +plus or minus, it is relative to the default date. If instead of a single letter, you use the abbreviation of day name, the date will be the Nth such day, e.g.: @@ -5632,20 +5632,20 @@ the Nth such day, e.g.: #+vindex: parse-time-months #+vindex: parse-time-weekdays -The function understands English month and weekday abbreviations. If +The function understands English month and weekday abbreviations. If you want to use unabbreviated names and/or other languages, configure the variables ~parse-time-months~ and ~parse-time-weekdays~. #+vindex: org-read-date-force-compatible-dates -Not all dates can be represented in a given Emacs implementation. By +Not all dates can be represented in a given Emacs implementation. By default Org mode forces dates into the compatibility range 1970--2037 -which works on all Emacs implementations. If you want to use dates +which works on all Emacs implementations. If you want to use dates outside of this range, read the docstring of the variable ~org-read-date-force-compatible-dates~. You can specify a time range by giving start and end times or by -giving a start time and a duration (in HH:MM format). Use one or two +giving a start time and a duration (in HH:MM format). Use one or two dash(es) as the separator in the former case and use '+' as the separator in the latter case, e.g.: @@ -5714,7 +5714,7 @@ minibuffer.[fn:64] #+vindex: org-time-stamp-custom-formats Org mode uses the standard ISO notation for dates and times as it is -defined in ISO 8601. If you cannot get used to this and require +defined in ISO 8601. If you cannot get used to this and require another representation of date and time to keep you happy, you can get it by customizing the variables ~org-display-custom-times~ and ~org-time-stamp-custom-formats~. @@ -5737,10 +5737,10 @@ following consequences: after. - The {{{kbdkey(S-,up)}}} {{{kbdkey(S-,down)}}} keys can no longer be - used to adjust each component of a timestamp. If the cursor is at + used to adjust each component of a timestamp. If the cursor is at the beginning of the stamp, {{{kbdkey(S-,up)}}} {{{kbdkey(S-,down)}}} will change the stamp by one day, just like - {{{kbdkey(S-,left)}}} {{{kbdkey(S-,right)}}}. At the end of the + {{{kbdkey(S-,left)}}} {{{kbdkey(S-,right)}}}. At the end of the stamp, the time will be changed by one minute. - If the timestamp contains a range of clock times or a repeater, @@ -5770,10 +5770,10 @@ A timestamp may be preceded by special keywords to facilitate planning: #+vindex: org-deadline-warning-days - On the deadline date, the task will be listed in the agenda. In + On the deadline date, the task will be listed in the agenda. In addition, the agenda for /today/ will carry a warning about the approaching or missed deadline, starting ~org-deadline-warning-days~ - before the due date, and continuing until the entry is marked DONE. An + before the due date, and continuing until the entry is marked DONE. An example: #+begin_example @@ -5783,7 +5783,7 @@ A timestamp may be preceded by special keywords to facilitate planning: #+end_example You can specify a different lead time for warnings for a specific - deadlines using the following syntax. Here is an example with a + deadlines using the following syntax. Here is an example with a warning period of 5 days ~DEADLINE: <2004-02-29 Sun -5d>~. - ~SCHEDULED~ :: @@ -5839,20 +5839,20 @@ an item:[fn:66] - {{{kbd(C-c C-d)}}}, ~org-deadline~ :: #+kindex: C-c C-d - Insert {{{samp(DEADLINE)}}} keyword along with a stamp. The insertion - will happen in the line directly following the headline. Any CLOSED - timestamp will be removed. When called with a prefix arg, an existing - deadline will be removed from the entry. Depending on the variable + Insert {{{samp(DEADLINE)}}} keyword along with a stamp. The insertion + will happen in the line directly following the headline. Any CLOSED + timestamp will be removed. When called with a prefix arg, an existing + deadline will be removed from the entry. Depending on the variable ~org-log-redeadline~, a note will be taken when changing an existing deadline.[fn:67] - {{{kbd(C-c C-s)}}}, ~org-schedule~ :: #+kindex: C-c C-s - Insert {{{samp(SCHEDULED)}}} keyword along with a stamp. The insertion - will happen in the line directly following the headline. Any - {{{samp(CLOSED)}}} timestamp will be removed. When called with a - prefix argument, remove the scheduling date from the entry. Depending + Insert {{{samp(SCHEDULED)}}} keyword along with a stamp. The insertion + will happen in the line directly following the headline. Any + {{{samp(CLOSED)}}} timestamp will be removed. When called with a + prefix argument, remove the scheduling date from the entry. Depending on the variable ~org-log-reschedule~, a note will be taken when changing an existing scheduling time.[fn:68] @@ -5861,9 +5861,9 @@ an item:[fn:66] #+kindex: k a #+kindex: k s - Mark the current entry for agenda action. After you have marked the + Mark the current entry for agenda action. After you have marked the entry like this, you can open the agenda or the calendar to find an - appropriate date. With the cursor on the selected date, press + appropriate date. With the cursor on the selected date, press {{{kbd(k s)}}} or {{{kbd(k d)}}} to schedule the marked item. - {{{kbd(C-c / d)}}}, ~org-check-deadlines~ :: @@ -5872,9 +5872,9 @@ an item:[fn:66] #+vindex: org-deadline-warning-days Create a sparse tree with all deadlines that are either past-due, or - which will become due within ~org-deadline-warning-days~. With - {{{kbd(C-u)}}} prefix, show all deadlines in the file. With a numeric - prefix, check that many days. For example, {{{kbd(C-1 C-c / d)}}} + which will become due within ~org-deadline-warning-days~. With + {{{kbd(C-u)}}} prefix, show all deadlines in the file. With a numeric + prefix, check that many days. For example, {{{kbd(C-1 C-c / d)}}} shows all deadlines due tomorrow. - {{{kbd(C-c / b)}}}, ~org-check-before-date~ :: @@ -5889,7 +5889,7 @@ an item:[fn:66] Note that ~org-schedule~ and ~org-deadline~ supports setting the date -by indicating a relative time: e.g. +1d will set the date to the next +by indicating a relative time: e.g. +1d will set the date to the next day after today, and --1w will set the date to the previous week before any current timestamp. @@ -5911,9 +5911,9 @@ or plain timestamp. In the following example: {{{noindent}}} the ~+1m~ is a repeater; the intended interpretation is that the task has a deadline on <2005-10-01> and repeats itself every -(one) month starting from that time. You can use yearly, monthly, +(one) month starting from that time. You can use yearly, monthly, weekly, daily and hourly repeat cookies by using the ~y/w/m/d/h~ -letters. If you need both a repeater and a special warning period in a +letters. If you need both a repeater and a special warning period in a deadline entry, the repeater should come first and the warning period last: ~DEADLINE: <2005-10-01 Sat +1m -3d>~. @@ -5921,10 +5921,10 @@ last: ~DEADLINE: <2005-10-01 Sat +1m -3d>~. Deadlines and scheduled items produce entries in the agenda when they are over-due, so it is important to be able to mark such an entry as -completed once you have done so. When you mark a DEADLINE or a +completed once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO keyword DONE, it will no longer produce entries -in the agenda. The problem with this is, however, that then also the -/next/ instance of the repeated entry will not be active. Org mode +in the agenda. The problem with this is, however, that then also the +/next/ instance of the repeated entry will not be active. Org mode deals with this in the following way: When you try to mark such an entry DONE (using {{{kbd(C-c C-t)}}}), it will shift the base date of the repeating timestamp by the repeater interval, and immediately set @@ -5973,7 +5973,7 @@ task---just make sure that the repeater intervals on both are the same. An alternative to using a repeater is to create a number of copies of -a task subtree, with dates shifted in each copy. The command +a task subtree, with dates shifted in each copy. The command {{{kbd(C-c C-x c)}}} was created for this purpose, it is described in [[Structure editing]]. @@ -6017,17 +6017,17 @@ about what to do with it.[fn:72] #+vindex: org-clock-continuously #+cindex: property, LOG_INTO_DRAWER - Start the clock on the current item (clock-in). This inserts the CLOCK - keyword together with a timestamp. If this is not the first clocking + Start the clock on the current item (clock-in). This inserts the CLOCK + keyword together with a timestamp. If this is not the first clocking of this item, the multiple CLOCK lines will be wrapped into a ~:LOGBOOK:~ drawer (see also the variable ~org-clock-into-drawer~). You can also overrule the setting of this variable for a subtree by - setting a ~CLOCK_INTO_DRAWER~ or ~LOG_INTO_DRAWER~ property. When + setting a ~CLOCK_INTO_DRAWER~ or ~LOG_INTO_DRAWER~ property. When called with a {{{kbd(C-u)}}} prefix argument, select the task from a - list of recently clocked tasks. With two {{{kbd(C-u C-u)}}} prefixes, + list of recently clocked tasks. With two {{{kbd(C-u C-u)}}} prefixes, clock into the task at point and mark it as the default task; the default task will then always be available with letter {{{kbd(d)}}} - when selecting a clocking task. With three {{{kbd(C-u C-u C-u)}}} + when selecting a clocking task. With three {{{kbd(C-u C-u C-u)}}} prefixes, force continuous clocking by starting the clock when the last clock stopped.@* @@ -6036,13 +6036,13 @@ about what to do with it.[fn:72] #+vindex: org-clock-modeline-total While the clock is running, the current clocking time is shown in the - mode line, along with the title of the task. The clock time shown will - be all time ever clocked for this task and its children. If the task + mode line, along with the title of the task. The clock time shown will + be all time ever clocked for this task and its children. If the task has an effort estimate (see [[Effort estimates]]), the mode line displays the current clocking time against it.[fn:73] If the task is a repeating one (see [[Repeated tasks]]), only the time since the last reset of the task will be shown.[fn:74] More control over what time is shown - can be exercised with the ~CLOCK_MODELINE_TOTAL~ property. It may have + can be exercised with the ~CLOCK_MODELINE_TOTAL~ property. It may have the values ~current~ to show only the current clocking instance, ~today~ to show all time clocked on this tasks today (see also the variable ~org-extend-today-until~), ~all~ to include all time, or @@ -6064,8 +6064,8 @@ about what to do with it.[fn:72] #+kindex: C-c C-x C-x #+vindex: org-clock-continuously - Reclock the last clocked task. With one {{{kbd(C-u)}}} prefix - argument, select the task from the clock history. With two + Reclock the last clocked task. With one {{{kbd(C-u)}}} prefix + argument, select the task from the clock history. With two {{{kbd(C-u)}}} prefixes, force continuous clocking by starting the clock when the last clock stopped. @@ -6078,8 +6078,8 @@ about what to do with it.[fn:72] #+kindex: C-c C-y #+kindex: C-c C-c - Recompute the time interval after changing one of the timestamps. This - is only necessary if you edit the timestamps directly. If you change + Recompute the time interval after changing one of the timestamps. This + is only necessary if you edit the timestamps directly. If you change them with {{{kbdkey(S-,cursor)}}} keys, the update is automatic. - {{{kbdkey(C-S-,up)}}} {{{kbdkey(C-S-,down)}}}, ~org-clock-timestamps-up/down~ :: @@ -6093,7 +6093,7 @@ about what to do with it.[fn:72] On ~CLOCK~ log lines, increase/decrease the timestamp at point and the one of the previous (or the next clock) timestamp by the same - duration. For example, if you hit {{{kbdkey(S-M-,up)}}} to increase a + duration. For example, if you hit {{{kbdkey(S-M-,up)}}} to increase a clocked-out timestamp by five minutes, then the clocked-in timestamp of the next clock will be increased by five minutes. @@ -6106,13 +6106,13 @@ about what to do with it.[fn:72] - {{{kbd(C-c C-x C-q)}}}, ~org-clock-cancel~ :: #+kindex: C-c C-x C-q - Cancel the current clock. This is useful if a clock was started by + Cancel the current clock. This is useful if a clock was started by mistake, or if you ended up working on something else. - {{{kbd(C-c C-x C-j)}}}, ~org-clock-goto~ :: #+kindex: C-c C-x C-j - Jump to the headline of the currently clocked in task. With a + Jump to the headline of the currently clocked in task. With a {{{kbd(C-u)}}} prefix arg, select the target task from a list of recently clocked tasks. @@ -6120,7 +6120,7 @@ about what to do with it.[fn:72] #+kindex: C-c C-x C-d #+vindex: org-remove-highlights-with-change - Display time summaries for each subtree in the current buffer. This + Display time summaries for each subtree in the current buffer. This puts overlays at the end of each headline, 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 @@ -6152,10 +6152,10 @@ formatted as one or several Org tables. #+kindex: C-c C-x C-r Insert a dynamic block (see [[Dynamic blocks]]) containing a clock report - as an Org mode table into the current file. When the cursor is at an - existing clock table, just update it. When called with a prefix + as an Org mode table into the current file. When the cursor is at an + existing clock table, just update it. When called with a prefix argument, jump to the first clock report in the current document and - update it. The clock table always includes also trees with ~:ARCHIVE:~ + update it. The clock table always includes also trees with ~:ARCHIVE:~ tag. - {{{kbd(C-c C-c)}}} {{{kbd(C-c C-x C-u)}}}, ~org-dblock-update~ :: @@ -6167,13 +6167,13 @@ formatted as one or several Org tables. - {{{kbd(C-u C-c C-x C-u)}}} :: #+kindex: C-u C-c C-x C-u - Update all dynamic blocks (see [[Dynamic blocks]]). This is useful if you + Update all dynamic blocks (see [[Dynamic blocks]]). This is useful if you have several clock table blocks in a buffer. - {{{kbdkey(S-,left)}}} {{{kbdkey(S-,right)}}}, ~org-clocktable-try-shift~ :: - Shift the current ~:block~ interval and update the table. The cursor - needs to be in the ~#+BEGIN: clocktable~ line for this command. If + Shift the current ~:block~ interval and update the table. The cursor + needs to be in the ~#+BEGIN: clocktable~ line for this command. If ~:block~ is ~today~, it will be shifted to ~today-1~ etc. @@ -6197,7 +6197,7 @@ be selected: #+attr_texinfo: :table-type table :indic @asis - :maxlevel :: - Maximum level depth to which times are listed in the table. Clocks at + Maximum level depth to which times are listed in the table. Clocks at deeper levels will be summed into the upper level. - :scope :: @@ -6216,7 +6216,7 @@ be selected: - :block :: - The time block to consider. This block is specified either absolute, + The time block to consider. This block is specified either absolute, or relative to the current time and may be any of these formats: - 2007-12-31 :: New year eve 2007 @@ -6242,7 +6242,7 @@ be selected: - :step :: - Set to ~week~ or ~day~ to split the table into chunks. To use this, + Set to ~week~ or ~day~ to split the table into chunks. To use this, ~:block~ or ~:tstart~, ~:tend~ are needed. - :stepskip0 :: @@ -6255,7 +6255,7 @@ be selected: - :tags :: - A tags match to select entries that should contribute. See [[Matching + A tags match to select entries that should contribute. See [[Matching tags and properties]] for the match syntax. @@ -6288,7 +6288,7 @@ but you can specify your own function using the ~:formatter~ parameter. - :tcolumns :: - Number of columns to be used for times. If this is smaller than + Number of columns to be used for times. If this is smaller than ~:maxlevel~, lower levels will be lumped into one column. - :level :: @@ -6297,17 +6297,17 @@ but you can specify your own function using the ~:formatter~ parameter. - :compact :: - Abbreviation for ~:level nil :indent t :narrow 40! :tcolumns 1~. All + Abbreviation for ~:level nil :indent t :narrow 40! :tcolumns 1~. All are overwritten except if there is an explicit ~:narrow~. - :timestamp :: - A timestamp for the entry, when available. Look for SCHEDULED, + A timestamp for the entry, when available. Look for SCHEDULED, DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order. - :properties :: - List of properties that should be shown in the table. Each property + List of properties that should be shown in the table. Each property will get its own column. - :inherit-props :: @@ -6316,8 +6316,8 @@ but you can specify your own function using the ~:formatter~ parameter. - :formula :: - Content of a ~#+TBLFM~ line to be added and evaluated. As a special - case, {{{samp(:formula %)}}} adds a column with % time. If you do not + Content of a ~#+TBLFM~ line to be added and evaluated. As a special + case, {{{samp(:formula %)}}} adds a column with % time. If you do not specify a formula here, any existing formula below the clock table will survive updates and be evaluated. @@ -6386,7 +6386,7 @@ choices to correct the discrepancy: #+kindex: k To keep some or all of the minutes and stay clocked in, press - {{{kbd(k)}}}. Org will ask how many of the minutes to keep. Press + {{{kbd(k)}}}. Org will ask how many of the minutes to keep. Press {{{key(RET)}}} to keep them all, effectively changing nothing, or enter a number to keep that many minutes. @@ -6409,14 +6409,14 @@ choices to correct the discrepancy: #+kindex: S To keep none of the minutes and just clock out at the start of the - away time, use the shift key and press {{{kbd(S)}}}. Remember that + away time, use the shift key and press {{{kbd(S)}}}. Remember that using shift will always leave you clocked out, no matter which option you choose. - {{{kbd(C)}}} :: #+kindex: C - To cancel the clock altogether, use {{{kbd(C)}}}. Note that if instead + To cancel the clock altogether, use {{{kbd(C)}}}. Note that if instead of canceling you subtract the away time, and the resulting clock amount is less than a minute, the clock will still be canceled rather than clutter up the log with an empty entry. @@ -6424,7 +6424,7 @@ choices to correct the discrepancy: What if you subtracted those away minutes from the current clock, and now want to apply them to a new clock? Simply clock in to any task -immediately after the subtraction. Org will notice that you have +immediately after the subtraction. Org will notice that you have subtracted time ``on the books'', so to speak, and will ask if you want to apply those minutes to the next task you clock in on. @@ -6437,9 +6437,9 @@ in. If you restart Emacs and clock into any task, Org will notice that you have a dangling clock which was never clocked out from your last -session. Using that clock's starting time as the beginning of the +session. Using that clock's starting time as the beginning of the unaccounted-for period, Org will ask how you want to resolve that -time. The logic and behavior is identical to dealing with away time +time. The logic and behavior is identical to dealing with away time due to idleness; it is just happening due to a recovery event rather than a set amount of idle time. @@ -6452,8 +6452,8 @@ dangling clocks at any time using {{{kbd(M-x org-resolve-clocks RET)}}} #+vindex: org-clock-continuously You may want to start clocking from the time when you clocked out the -previous task. To enable this systematically, set -~org-clock-continuously~ to ~t~. Each time you clock in, Org retrieves +previous task. To enable this systematically, set +~org-clock-continuously~ to ~t~. Each time you clock in, Org retrieves the clock-out time of the last clocked entry for this session, and start the new clock from there. @@ -6471,10 +6471,10 @@ arguments with ~org-clock-in~ and two {{{kbd(C-u C-u)}}} with If you want to plan your work in a very detailed way, or if you need to produce offers with quotations of the estimated work effort, you -may want to assign effort estimates to entries. If you are also +may want to assign effort estimates to entries. If you are also clocking your work, you may later want to compare the planned effort with the actual working time, a great way to improve planning -estimates. Effort estimates are stored in a special property +estimates. Effort estimates are stored in a special property {{{samp(Effort)}}}.[fn:80] You can set the effort for an entry with the following commands: @@ -6482,8 +6482,8 @@ the following commands: - {{{kbd(C-c C-x e)}}}, ~org-set-effort~ :: #+kindex: C-c C-x e - Set the effort estimate for the current entry. With a numeric prefix - argument, set it to the Nth allowed value (see below). This command is + Set the effort estimate for the current entry. With a numeric prefix + argument, set it to the Nth allowed value (see below). This command is also accessible from the agenda with the {{{kbd(e)}}} key. - {{{kbd(C-c C-x C-e)}}}, ~org-clock-modify-effort-estimate~ :: @@ -6493,9 +6493,9 @@ the following commands: Clearly the best way to work with effort estimates is through column -view (see [[Column view]]). You should start by setting up discrete values +view (see [[Column view]]). You should start by setting up discrete values for effort estimates, and a ~COLUMNS~ format that displays these -values together with clock sums (if you want to clock your time). For +values together with clock sums (if you want to clock your time). For a specific buffer you can use: #+begin_example @@ -6508,13 +6508,13 @@ a specific buffer you can use: {{{noindent}}} or, even better, you can set up these values globally by customizing the variables ~org-global-properties~ and -~org-columns-default-format~. In particular if you want to use this +~org-columns-default-format~. In particular if you want to use this setup also in the agenda, a global setup may be advised. The way to assign estimates to individual items is then to switch to column mode, and to use {{{kbdkey(S-,right)}}} and -{{{kbdkey(S-,left)}}} to change the value. The values you enter will -immediately be summed up in the hierarchy. In the column next to it, +{{{kbdkey(S-,left)}}} to change the value. The values you enter will +immediately be summed up in the hierarchy. In the column next to it, any clocked time will be displayed. #+vindex: org-agenda-columns-add-appointments-to-effort-sum @@ -6528,7 +6528,7 @@ then also be added to the load estimate of the day. Effort estimates can be used in secondary agenda filtering that is triggered with the {{{kbd(/)}}} key in the agenda (see [[Agenda -commands]]). If you have these estimates defined consistently, two or +commands]]). If you have these estimates defined consistently, two or three key presses will narrow down the list to stuff that fits into an available time slot. @@ -6574,21 +6574,21 @@ such a relative timer and make it easy to create timed notes. #+kindex: C-u C-c C-x , #+kindex: C-u C-c C-x , - Stop the timer. After this, you can only start a new timer, not - continue the old one. This command also removes the timer from the + Stop the timer. After this, you can only start a new timer, not + continue the old one. This command also removes the timer from the mode line. - {{{kbd(C-c C-x 0)}}}, ~org-timer-start~ :: #+kindex: C-c C-x 0 - Reset the timer without inserting anything into the buffer. By - default, the timer is reset to 0. When called with a {{{kbd(C-u)}}} - prefix, reset the timer to specific starting offset. The user is + Reset the timer without inserting anything into the buffer. By + default, the timer is reset to 0. When called with a {{{kbd(C-u)}}} + prefix, reset the timer to specific starting offset. The user is prompted for the offset, with a default taken from a timer string at point, if any, So this can be used to restart taking notes after a - break in the process. When called with a double prefix argument + break in the process. When called with a double prefix argument {{{kbd(C-u C-u)}}}, change all timer strings in the active region by a - certain amount. This can be used to fix timer strings if the timer was + certain amount. This can be used to fix timer strings if the timer was not started at exactly the right moment. ** Countdown timer @@ -6600,7 +6600,7 @@ such a relative timer and make it easy to create timed notes. #+kindex: ; Calling ~org-timer-set-timer~ from an Org mode buffer runs a countdown -timer. Use {{{kbd(;)}}} from agenda buffers, {{{key(C-c C-x ;)}}} +timer. Use {{{kbd(;)}}} from agenda buffers, {{{key(C-c C-x ;)}}} everywhere else. ~org-timer-set-timer~ prompts the user for a duration and displays a @@ -6616,9 +6616,9 @@ default value. An important part of any organization system is the ability to quickly capture new ideas and tasks, and to associate reference material with -them. Org does this using a process called /capture/. It also can +them. Org does this using a process called /capture/. It also can store files related to a task (/attachments/) in a special directory. -Once in the system, tasks and projects need to be moved around. Moving +Once in the system, tasks and projects need to be moved around. Moving completed project trees to an archive file keeps the system compact and fast. @@ -6629,10 +6629,10 @@ and fast. #+cindex: capture Org's method for capturing new items is heavily inspired by John -Wiegley excellent remember package. Up to version 6.36 Org used a +Wiegley excellent remember package. Up to version 6.36 Org used a special setup for {{{file(remember.el)}}}. The file {{{file(org-remember.el)}}} is still part of Org mode for backward compatibility with existing -setups. You can find the documentation for org-remember at +setups. You can find the documentation for org-remember at [[http://orgmode.org/org-remember.pdf]]. The new capturing setup described here is preferred and should be used by new @@ -6641,7 +6641,7 @@ users. To convert your ~org-remember-templates~, run the following command: {{{noindent}}} and then customize the new variable with {{{kbd(M-x customize-variable org-capture-templates)}}}, check the result, and -save the customization. You can then use both remember and capture +save the customization. You can then use both remember and capture until you are familiar with the new mechanism. Capture lets you quickly store notes with little interruption of your work @@ -6674,12 +6674,12 @@ a global key for capturing new material.[fn:81] #+kindex: C-c c #+cindex: date tree - Call the command ~org-capture~. Note that this keybinding is global - and not active by default - you need to install it. If you have + Call the command ~org-capture~. Note that this keybinding is global + and not active by default - you need to install it. If you have templates defined (see [[Capture templates]], it will offer these templates for selection or use a new Org outline node as the default - template. It will insert the template into the target file and switch - to an indirect buffer narrowed to this new node. You may then insert + template. It will insert the template into the target file and switch + to an indirect buffer narrowed to this new node. You may then insert the information you want. - {{{kbd(C-c C-c)}}}, ~org-capture-finalize~ :: @@ -6688,17 +6688,17 @@ a global key for capturing new material.[fn:81] Once you have finished entering information into the capture buffer, {{{kbd(C-c C-c)}}} will return you to the window configuration before the capture process, so that you can resume your work without further - distraction. When called with a prefix argument, finalize and then + distraction. When called with a prefix argument, finalize and then jump to the captured item. - {{{kbd(C-c C-w)}}}, ~org-capture-refile~ :: #+kindex: C-c C-w Finalize the capture process by refiling the note to a different place - (see [[Refile and copy]]). Please realize that this is a normal refiling + (see [[Refile and copy]]). Please realize that this is a normal refiling command that will be executed---so the cursor position at the moment - you run this command is important. If you have inserted a tree with a - parent and children, first move the cursor back to the parent. Any + you run this command is important. If you have inserted a tree with a + parent and children, first move the cursor back to the parent. Any prefix argument given to this command will be passed on to the ~org-refile~ command. @@ -6709,7 +6709,7 @@ a global key for capturing new material.[fn:81] You can also call ~org-capture~ in a special way from the agenda, -using the {{{kbd(k c)}}} key combination. With this access, timestamps +using the {{{kbd(k c)}}} key combination. With this access, timestamps inserted by the selected capture template will default to the cursor date in the agenda, rather than to the current date. @@ -6720,7 +6720,7 @@ prefix commands: - {{{kbd(C-u C-c c)}}} :: #+kindex: C-u C-c c - Visit the target location of a capture template. You get to select the + Visit the target location of a capture template. You get to select the template in the usual way. - {{{kbd(C-u C-u C-c c)}}} :: @@ -6746,7 +6746,7 @@ with a ~C-0~ prefix argument. #+cindex: templates, for Capture You can use templates for different types of capture items, and for -different target locations. The easiest way to create such templates +different target locations. The easiest way to create such templates is through the customize interface. #+attr_texinfo: :table-type table :indic @asis @@ -6757,11 +6757,11 @@ is through the customize interface. Before we give the formal description of template definitions, let's -look at an example. Say you would like to use one template to create +look at an example. Say you would like to use one template to create general TODO entries, and you want to put these entries under the heading {{{samp(Tasks)}}} in your file {{{file(~/org/gtd.org)}}}. Also, a date tree in the file {{{file(journal.org)}}} should capture -journal entries. A possible configuration would look like: +journal entries. A possible configuration would look like: #+header: :eval no #+header: :exports code @@ -6783,8 +6783,8 @@ the template for you like this: {{{noindent}}} During expansion of the template, ~%a~ has been replaced by a link to the location from where you called the capture -command. This can be extremely useful for deriving tasks from emails, -for example. You fill in the task definition, press ~C-c C-c~ and Org +command. This can be extremely useful for deriving tasks from emails, +for example. You fill in the task definition, press ~C-c C-c~ and Org returns you to the same place where you started the capture process. To define special keys to capture to a particular template without @@ -6837,23 +6837,23 @@ 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 the - target entry or as a top-level entry. The target file should be an Org + An Org mode node, with a headline. Will be filed as the child of the + target entry or as a top-level entry. The target file should be an Org mode file. - ~item~ :: A plain list item, placed in the first plain list at the target - location. Again the target file should be an Org file. + location. Again the target file should be an Org file. - ~checkitem~ :: - A checkbox item. This only differs from the plain list item by the + A checkbox item. This only differs from the plain list item by the default template. - ~table-line~ :: - A new line in the first table at the target location. Where exactly + A new line in the first table at the target location. Where exactly the line will be inserted depends on the properties ~:prepend~ and ~:table-line-pos~ (see below). @@ -6916,12 +6916,12 @@ Now lets look at the elements of a template definition. Each entry in - ~template~ :: - The template for creating the capture item. If you leave this empty, - an appropriate default template will be used. Otherwise this is a + The template for creating the capture item. If you leave this empty, + an appropriate default template will be used. Otherwise this is a string with escape codes, which will be replaced depending on time and - context of the capture call. The string with escapes may be loaded + context of the capture call. The string with escapes may be loaded from a template file, using the special syntax - ~(file "path/to/template")~. See below for more details. + ~(file "path/to/template")~. See below for more details. - ~properties~ :: @@ -6931,19 +6931,19 @@ Now lets look at the elements of a template definition. Each entry in - ~:prepend~ :: Normally new captured information will be appended at the target - location (last child, last table line, last list item, ...). Setting + location (last child, last table line, last list item, ...). Setting this property will change that. - ~:immediate-finish~ :: When set, do not offer to edit the information, just file it away - immediately. This makes sense if the template only needs information + immediately. This makes sense if the template only needs information that can be added automatically. - ~:empty-lines~ :: Set this to the number of lines to insert before and after the new - item. The default is 0, and the only other common value is 1. + item. The default is 0, and the only other common value is 1. - ~:clock-in~ :: @@ -6956,19 +6956,19 @@ Now lets look at the elements of a template definition. Each entry in - ~:clock-resume~ :: If starting the capture interrupted a clock, restart that clock when - finished with the capture. Note that ~:clock-keep~ has precedence over - ~:clock-resume~. When setting both to ~t~, the current clock will run + finished with the capture. Note that ~:clock-keep~ has precedence over + ~:clock-resume~. When setting both to ~t~, the current clock will run and the previous one will not be resumed. - ~:unnarrowed~ :: - Do not narrow the target buffer, simply show the full buffer. Default + Do not narrow the target buffer, simply show the full buffer. Default is to narrow it so that you only see the new material. - ~:table-line-pos~ :: Specification of the location in the table where the new line should - be inserted. It should be a string like "II-3" meaning that the new + be inserted. It should be a string like "II-3" meaning that the new line should become the third line before the second horizontal separator line. @@ -6993,12 +6993,12 @@ here: - %({{{var(sexp)}}}) :: - Evaluate Elisp {{{var(sexp)}}} and replace with the result. The + Evaluate Elisp {{{var(sexp)}}} and replace with the result. The {{{var(sexp)}}} must return a string. - %<...> :: - The result of format-time-string on the ... format specification. + The result of format-time-string on the ... format specification. - %t :: @@ -7015,7 +7015,7 @@ here: - %i :: Initial content, the region when capture is called while the region is - active. The entire text will be indented like ~%i~ itself. + active. The entire text will be indented like ~%i~ itself. - %a :: @@ -7071,7 +7071,7 @@ here: - %^t :: - Like ~%t~, but prompt for date. Similarly ~%^T~, ~%^u~, ~%^U~. You may + Like ~%t~, but prompt for date. Similarly ~%^T~, ~%^u~, ~%^U~. You may define a prompt like ~%^{Birthday}t~. - %^C :: @@ -7088,9 +7088,9 @@ here: - %^{PROMPT} :: - Prompt the user for a string and replace this sequence with it. You + Prompt the user for a string and replace this sequence with it. You may specify a default value and a completion table with - ~%^{prompt|default|completion2|completion3...}~. The arrow keys access + ~%^{prompt|default|completion2|completion3...}~. The arrow keys access a prompt-specific history. - %\n :: @@ -7141,7 +7141,7 @@ defined:[fn:83] To control whether a capture template should be accessible from a specific context, you can customize ~org-capture-templates-contexts~. Let's say, for example, that you have a capture template "p" for -storing Gnus emails containing patches. Then you would configure this +storing Gnus emails containing patches. Then you would configure this option like this: #+header: :eval no @@ -7172,20 +7172,20 @@ more information. #+vindex: org-attach-directory It is often useful to associate reference material with an outline -node/task. Small chunks of plain text can simply be stored in the -subtree of a project. Hyperlinks (see [[Hyperlinks]]) can establish +node/task. Small chunks of plain text can simply be stored in the +subtree of a project. Hyperlinks (see [[Hyperlinks]]) can establish associations with files that live elsewhere on your computer or in the cloud, like emails or source code files belonging to a project. Another method is /attachments/, which are files located in a -directory belonging to an outline node. Org uses directories named by -the unique ID of each entry. These directories are located in the +directory belonging to an outline node. Org uses directories named by +the unique ID of each entry. These directories are located in the {{{file(data)}}} directory which lives in the same directory where your Org file lives.[fn:85] If you initialize this directory with ~git init~, Org will automatically commit changes when it sees them. The attachment system has been contributed to Org by John Wiegley. In cases where it seems better to do so, you can also attach a -directory of your choice to an entry. You can also make children +directory of your choice to an entry. You can also make children inherit the attachment directory from a parent, so that an entire subtree uses the same attached directory. @@ -7195,7 +7195,7 @@ subtree uses the same attached directory. - {{{kbd(C-c C-a)}}}, ~org-attach~ :: #+kindex: C-c C-a - The dispatcher for commands related to the attachment system. After + The dispatcher for commands related to the attachment system. After these keys, a list of commands is displayed and you must press an additional key to select a command: @@ -7203,9 +7203,9 @@ subtree uses the same attached directory. #+kindex: C-c C-a a #+vindex: org-attach-method - Select a file and move it into the task's attachment directory. The + Select a file and move it into the task's attachment directory. The file will be copied, moved, or linked, depending on - ~org-attach-method~. Note that hard links are not supported on all + ~org-attach-method~. Note that hard links are not supported on all systems. - {{{kbd(c)}}}/{{{kbd(m)}}}/{{{kbd(l)}}} :: @@ -7213,7 +7213,7 @@ subtree uses the same attached directory. #+kindex: C-c C-a m #+kindex: C-c C-a l - Attach a file using the copy/move/link method. Note that hard links + Attach a file using the copy/move/link method. Note that hard links are not supported on all systems. - {{{kbd(n)}}}, ~org-attach-new~ :: @@ -7231,9 +7231,9 @@ subtree uses the same attached directory. #+kindex: C-c C-a o #+vindex: org-file-apps - Open current task's attachment. If there is more than one, prompt for - a file name first. Opening will follow the rules set by - ~org-file-apps~. For more details, see the information on following + Open current task's attachment. If there is more than one, prompt for + a file name first. Opening will follow the rules set by + ~org-file-apps~. For more details, see the information on following hyperlinks (see [[Handling links]]). - {{{kbd(O)}}}, ~org-attach-open-in-emacs~ :: @@ -7259,14 +7259,14 @@ subtree uses the same attached directory. - {{{kbd(D)}}}, ~org-attach-delete-all~ :: #+kindex: C-c C-a D - Delete all of a task's attachments. A safer way is to open the + Delete all of a task's attachments. A safer way is to open the directory in {{{command(dired)}}} and delete from there. - {{{kbd(s)}}}, ~org-attach-set-directory~ :: #+kindex: C-c C-a s #+cindex: property, ATTACH_DIR - Set a specific directory as the entry's attachment directory. This + Set a specific directory as the entry's attachment directory. This works by putting the directory path into the ~ATTACH_DIR~ property. - {{{kbd(i)}}}, ~org-attach-set-inherit~ :: @@ -7320,7 +7320,7 @@ whenever the following command is used: Under the same headline, Org will create a drawer {{{samp(FEEDSTATUS)}}} in which it will store information about the status of items in the feed, to avoid adding the same item several -times. You should add {{{samp(FEEDSTATUS)}}} to the list of drawers in +times. You should add {{{samp(FEEDSTATUS)}}} to the list of drawers in that file: #+begin_example @@ -7341,11 +7341,11 @@ For more information, including how to read atom feeds, see You can set up Org for handling protocol calls from outside applications that are passed to Emacs through the -{{{file(emacsserver)}}}. For example, you can configure bookmarks in +{{{file(emacsserver)}}}. For example, you can configure bookmarks in your web browser to send a link to the current page to Org and create -a note from it using capture (see [[Capture]]). Or you could create a +a note from it using capture (see [[Capture]]). Or you could create a bookmark that will tell Emacs to open the local source file of a -remote website you are looking at with the browser. See +remote website you are looking at with the browser. See [[http://orgmode.org/worg/org-contrib/org-protocol.php]] for detailed documentation and setup instructions. @@ -7379,21 +7379,21 @@ simplify this process, you can use the following special command: #+vindex: org-log-refile #+vindex: org-refile-use-cache - Refile the entry or region at point. This command offers possible + Refile the entry or region at point. This command offers possible locations for refiling the entry and lets you select one with - completion. The item (or all items in the region) is filed below the - target heading as a subitem. Depending on ~org-reverse-note-order~, it + completion. The item (or all items in the region) is filed below the + target heading as a subitem. Depending on ~org-reverse-note-order~, it will be either the first or last subitem. By default, all level 1 headlines 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 + number of files. See the variable ~org-refile-targets~ for details. If you would like to select a location via a file-path-like completion along the outline path, see the variables ~org-refile-use-outline-path~ and - ~org-outline-path-complete-in-steps~. If you would like to be able to + ~org-outline-path-complete-in-steps~. If you would like to be able to create new nodes as new parents for refiling on the fly, check the - variable ~org-refile-allow-creating-parent-nodes~. When the variable + variable ~org-refile-allow-creating-parent-nodes~. When the variable ~org-log-refile~ is set, a timestamp or a note will be recorded when an entry has been refiled.[fn:86] @@ -7428,7 +7428,7 @@ simplify this process, you can use the following special command: When a project represented by a (sub)tree is finished, you may want to move the tree out of the way and to stop it from contributing to the -agenda. Archiving is important to keep your working files compact and +agenda. Archiving is important to keep your working files compact and global searches like the construction of agenda views fast. #+attr_texinfo: :table-type table :indic @asis @@ -7462,9 +7462,9 @@ the archive file. #+kindex: C-u C-c C-x C-s Check if any direct children of the current headline could be moved to - the archive. To do this, each subtree is checked for open TODO - entries. If none are found, the command offers to move it to the - archive location. If the cursor is /not/ on a headline when this + the archive. To do this, each subtree is checked for open TODO + entries. If none are found, the command offers to move it to the + archive location. If the cursor is /not/ on a headline when this command is invoked, the level 1 trees will be checked. @@ -7472,9 +7472,9 @@ the archive file. The default archive location is a file in the same directory as the current file, with the name derived by appending {{{file(_archive)}}} -to the current file name. You can also choose what heading to file +to the current file name. You can also choose what heading to file archived items under, with the possibility to add them to a datetree -in a file. For information and examples on how to specify the file and +in a file. For information and examples on how to specify the file and the heading, see the documentation string of the variable ~org-archive-location~. @@ -7496,7 +7496,7 @@ property with the location as the value (see [[Properties and columns]]). When a subtree is moved, it receives a number of special properties that record context information like the file from where the entry -came, its outline path the archiving time etc. Configure the variable +came, its outline path the archiving time etc. Configure the variable ~org-archive-save-context-info~ to adjust the amount of information added. @@ -7513,9 +7513,9 @@ A headline that is marked with the ARCHIVE tag (see [[Tags]]) stays at its location in the outline tree, but behaves in the following way: - It does not open when you attempt to do so with a visibility cycling - command (see [[Visibility cycling]]). You can force cycling archived + command (see [[Visibility cycling]]). You can force cycling archived subtrees with {{{kbdkey(C-,TAB)}}}, or by setting the option - ~org-cycle-open-archived-trees~. Also normal outline commands like + ~org-cycle-open-archived-trees~. Also normal outline commands like ~show-all~ will open archived subtrees. #+vindex: org-cycle-open-archived-trees @@ -7535,7 +7535,7 @@ its location in the outline tree, but behaves in the following way: #+vindex: org-agenda-skip-archived-trees - Archived trees are not exported (see [[Exporting]]), only the headline - is. Configure the details using the variable + is. Configure the details using the variable ~org-export-with-archived-trees~. #+vindex: org-export-with-archived-trees @@ -7552,7 +7552,7 @@ The following commands help manage the ARCHIVE tag: - {{{kbd(C-c C-x a)}}}, ~org-toggle-archive-tag~ :: #+kindex: C-c C-x a - Toggle the ARCHIVE tag for the current headline. When the tag is set, + Toggle the ARCHIVE tag for the current headline. When the tag is set, the headline changes to a shadowed face, and the subtree below it is hidden. @@ -7560,9 +7560,9 @@ The following commands help manage the ARCHIVE tag: #+kindex: C-u C-c C-x a Check if any direct children of the current headline should be - archived. To do this, each subtree is checked for open TODO entries. + archived. To do this, each subtree is checked for open TODO entries. If none are found, the command offers to set the ARCHIVE tag for the - child. If the cursor is /not/ on a headline when this command is + child. If the cursor is /not/ on a headline when this command is invoked, the level 1 trees will be checked. - {{{kbdkey(C-,TAB)}}}, ~org-force-cycle-archived~ :: @@ -7572,9 +7572,9 @@ The following commands help manage the ARCHIVE tag: - {{{kbd(C-c C-x A)}}}, ~org-archive-to-archive-sibling~ :: #+kindex: C-c C-x A - Move the current entry to the /Archive Sibling/. This is a sibling of + Move the current entry to the /Archive Sibling/. This is a sibling of the entry with the heading {{{samp(Archive)}}} and the tag - {{{samp(ARCHIVE)}}}. The entry becomes a child of that sibling and in + {{{samp(ARCHIVE)}}}. The entry becomes a child of that sibling and in this way retains a lot of its original context, including inherited tags and approximate position in the outline. @@ -7586,7 +7586,7 @@ The following commands help manage the ARCHIVE tag: 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 -files. To get an overview of open action items, or of events that are +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. @@ -7615,7 +7615,7 @@ in a separate buffer. Seven different view types are provided: {{{noindent}}} The extracted information is displayed in a special -/agenda buffer/. This buffer is read-only, but provides commands to +/agenda buffer/. This buffer is read-only, but provides commands to visit the corresponding locations in the original Org files, and even to edit these files remotely. @@ -7648,9 +7648,9 @@ the easiest way to maintain it is through the following commands - {{{kbd(C-c [)}}}, ~org-agenda-file-to-front~ :: #+kindex: C-c [ - Add current file to the list of agenda files. The file is added to the - front of the list. If it was already in the list, it is moved to the - front. With a prefix argument, file is added/moved to the end. + Add current file to the list of agenda files. The file is added to the + front of the list. If it was already in the list, it is moved to the + front. With a prefix argument, file is added/moved to the end. - {{{kbd(C-c ])}}}, ~org-remove-file~ :: #+kindex: C-c ] @@ -7676,18 +7676,18 @@ be used to visit any of them. If you would like to focus the agenda temporarily on a file not in this list, or on just one file in the list, or even on only a subtree -in a file, then this can be done in different ways. For a single +in a file, then this can be done in different ways. For a single agenda command, you may press {{{kbd(<)}}} once or several times in -the dispatcher (see [[Agenda dispatcher]]). To restrict the agenda scope +the dispatcher (see [[Agenda dispatcher]]). To restrict the agenda scope for an extended period, use the following commands: #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c C-x <)}}}, ~org-agenda-set-restriction-lock~ :: #+kindex: C-c C-x < - Permanently restrict the agenda to the current subtree. When with a + Permanently restrict the agenda to the current subtree. When with a prefix argument, or with the cursor before the first headline in a - file, the agenda scope is set to the entire file. This restriction + file, the agenda scope is set 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 there is a window displaying an agenda view, the new restriction @@ -7707,7 +7707,7 @@ the following commands in the Speedbar frame: #+kindex: < Permanently restrict the agenda to the item---either an Org file or a - subtree in such a file---at the cursor in the Speedbar frame. If there + subtree in such a file---at the cursor in the Speedbar frame. If there is a window displaying an agenda view, the new restriction takes effect immediately. @@ -7725,11 +7725,11 @@ the following commands in the Speedbar frame: #+cindex: dispatching agenda commands The views are created through a dispatcher, which should be bound to a -global key---for example {{{kbd(C-c a)}}} (see [[Activation]]). In the +global key---for example {{{kbd(C-c a)}}} (see [[Activation]]). In the following we will assume that {{{kbd(C-c a)}}} is indeed how the dispatcher is accessed and list keyboard access to commands -accordingly. After pressing {{{kbd(C-c a)}}}, an additional letter is -required to execute a command. The dispatcher offers the following +accordingly. After pressing {{{kbd(C-c a)}}}, an additional letter is +required to execute a command. The dispatcher offers the following default commands: #+attr_texinfo: :table-type table :indic @asis @@ -7767,8 +7767,8 @@ default commands: #+vindex: org-agenda-text-search-extra-files Search for a regular expression in all agenda files and additionally - in the files listed in ~org-agenda-text-search-extra-files~. This uses - the Emacs command ~multi-occur~. A prefix argument can be used to + in the files listed in ~org-agenda-text-search-extra-files~. This uses + the Emacs command ~multi-occur~. A prefix argument can be used to specify the number of context lines for each match, default is 1. @@ -7788,7 +7788,7 @@ default commands: #+kindex: C-c a < < If there is an active region, restrict the following agenda command to - the region. Otherwise, restrict it to the current subtree.[fn:90] + the region. Otherwise, restrict it to the current subtree.[fn:90] After pressing {{{kbd(< <)}}}, you still need to press the character selecting the command. @@ -7796,22 +7796,22 @@ default commands: #+kindex: C-c a * #+vindex: org-agenda-sticky - Toggle sticky agenda views. By default, Org maintains only a single + Toggle sticky agenda views. By default, Org maintains only a single agenda buffer and rebuilds it each time you change the view, to make - sure everything is always up to date. If you switch between views + sure everything is always up to date. If you switch between views often and the build time bothers you, you can turn on sticky agenda buffers (make this the default by customizing the variable - ~org-agenda-sticky~). With sticky agendas, the dispatcher only + ~org-agenda-sticky~). With sticky agendas, the dispatcher only switches to the selected view, you need to update it by hand with - {{{kbd(r)}}} or {{{kbd(g)}}}. You can toggle sticky agenda view any + {{{kbd(r)}}} or {{{kbd(g)}}}. You can toggle sticky agenda view any time with ~org-toggle-sticky-agenda~. You can also define custom commands that will be accessible through -the dispatcher, just like the default commands. This includes the +the dispatcher, just like the default commands. This includes the possibility to create extended agenda buffers that contain several blocks together, for example the weekly agenda, the global TODO list -and a number of special tags matches. See [[Custom agenda views]]. +and a number of special tags matches. See [[Custom agenda views]]. ** Built-in agenda views :PROPERTIES: @@ -7835,8 +7835,8 @@ paper agenda, showing all the tasks for the current week or day. - {{{kbd(C-c a a)}}}, ~org-agenda-list~ :: #+cindex: org-agenda, command - Compile an agenda for the current week from a list of Org files. The - agenda shows the entries for each day. With a numeric prefix (like + Compile an agenda for the current week from a list of Org files. The + agenda shows the entries for each day. With a numeric prefix (like {{{kbd(C-u 2 1 C-c a a)}}}) you may set the number of days to be displayed.[fn:91] @@ -7862,7 +7862,7 @@ commands]]. #+cindex: diary integration #+cindex: Reingold, Edward M. -Emacs contains the calendar and diary by Edward M. Reingold. The +Emacs contains the calendar and diary by Edward M. Reingold. The calendar displays a three-month calendar with holidays from different countries and cultures. The diary allows you to keep track of anniversaries, lunar phases, sunrise/set, recurrent appointments @@ -7933,8 +7933,8 @@ Basically, you need to press {{{kbdspckey(C-o anniversary,RET)}}} with the cursor in a BBDB record and then add the date in the format ~YYYY-MM-DD~ or ~MM-DD~, followed by a space and the class of the anniversary ({{{samp(birthday)}}} or {{{samp(wedding)}}}, or a format -string). If you omit the class, it will default to -{{{samp(birthday)}}}. Here are a few examples, the header for the file +string). If you omit the class, it will default to +{{{samp(birthday)}}}. Here are a few examples, the header for the file {{{file(org-bbdb.el)}}} contains more detailed information. #+begin_example @@ -7946,7 +7946,7 @@ string). If you omit the class, it will default to After a change to BBDB, or for the first agenda display during an Emacs session, the agenda display will suffer a short delay as Org -updates its hash with anniversaries. However, from then on things will +updates its hash with anniversaries. However, from then on things will be very fast---much faster in fact than a long list of {{{samp(%%(diary-anniversary))}}} entries in an Org or Diary file. @@ -7980,9 +7980,9 @@ collected into a single place. #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c a t)}}}, ~org-todo-list~ :: - Show the global TODO list. This collects the TODO items from all - agenda files (see [[Agenda views]]) into a single buffer. By default, this - lists items with a state the is not a DONE state. The buffer is in + Show the global TODO list. This collects the TODO items from all + agenda files (see [[Agenda views]]) into a single buffer. By default, this + lists items with a state the is not a DONE state. The buffer is in ~agenda-mode~, so there are commands to examine and manipulate the TODO entries directly from that buffer (see [[Agenda commands]]). @@ -7991,11 +7991,11 @@ collected into a single place. #+cindex: TODO keyword matching #+vindex: org-todo-keywords - Like the above, but allows selection of a specific TODO keyword. You + Like the above, but allows selection of a specific TODO keyword. You can also do this by specifying a prefix argument to {{{kbd(C-c a - t)}}}. You are prompted for a keyword, and you may also specify + t)}}}. You are prompted for a keyword, and you may also specify several keywords by separating them with {{{samp(|)}}} as the boolean - OR operator. With a numeric prefix, the Nth keyword in + OR operator. With a numeric prefix, the Nth keyword in ~org-todo-keywords~ is selected. #+kindex: r @@ -8021,7 +8021,7 @@ it more compact: - Some people view a TODO item that has been /scheduled/ for execution - or have a /deadline/ (see [[Timestamps]]) as no longer /open/. Configure + or have a /deadline/ (see [[Timestamps]]) as no longer /open/. Configure the variables ~org-agenda-todo-ignore-scheduled~, ~org-agenda-todo-ignore-deadlines~, ~org-agenda-todo-ignore-timestamp~ and/or @@ -8033,9 +8033,9 @@ it more compact: #+vindex: org-agenda-todo-ignore-timestamp #+vindex: org-agenda-todo-ignore-with-date -- TODO items may have sublevels to break up the task into subtasks. In +- 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 + headline and omit the sublevels from the global list. Configure the variable ~org-agenda-todo-list-sublevels~ to get this behavior. #+vindex: org-agenda-todo-list-sublevels @@ -8051,17 +8051,17 @@ it more compact: If headlines 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 buffer. The +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)}}}. #+attr_texinfo: :table-type table :indic @asis - {{{kbd(C-c a m)}}}, ~org-tags-view~ :: - Produce a list of all headlines that match a given set of tags. The + Produce a list of all headlines that match a given set of tags. The command prompts for a selection criterion, which is a boolean logic expression with tags, like {{{samp(+work+urgent-withboss)}}} or - {{{samp(work|home)}}} (see [[Tags]]). If you often need a specific search, + {{{samp(work|home)}}} (see [[Tags]]). If you often need a specific search, define a custom command for it (see [[Agenda dispatcher]]). - {{{kbd(C-c a M)}}}, ~org-tags-view~ :: @@ -8071,8 +8071,8 @@ with {{{kbd(C-c / m)}}}. Like {{{kbd(C-c a m)}}}, but only select headlines that are also TODO items in a not-DONE state 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~. Matching + ~org-tags-match-list-sublevels~). To exclude scheduled/deadline items, + see the variable ~org-agenda-tags-todo-honor-ignore-options~. Matching specific TODO keywords together with a tags match is also possible, see [[Tag searches]]. @@ -8084,14 +8084,14 @@ commands]]. #+cindex: Boolean logic, for tag or property searches A search string can use Boolean operators {{{samp(&)}}} for AND and -{{{samp(|)}}} for OR. {{{samp(&)}}} binds more strongly than -{{{samp(|)}}}. Parentheses are currently not implemented. Each element +{{{samp(|)}}} for OR. {{{samp(&)}}} binds more strongly than +{{{samp(|)}}}. Parentheses are currently not implemented. Each element in the search is either a tag, a regular expression matching tags, or an expression like ~PROPERTY OPERATOR VALUE~ with a comparison -operator, accessing a property value. Each element may be preceded by +operator, accessing a property value. Each element may be preceded by {{{samp(-)}}}, to select against it, and {{{samp(+)}}} is syntactic -sugar for positive selection. The AND operator {{{samp(&)}}} is -optional when {{{samp(+)}}} or {{{samp(-)}}} is present. Here are some +sugar for positive selection. The AND operator {{{samp(&)}}} is +optional when {{{samp(+)}}} or {{{samp(-)}}} is present. Here are some examples, using only tags. #+attr_texinfo: :table-type table :indic @samp @@ -8113,7 +8113,7 @@ examples, using only tags. #+cindex: regular expressions, with tags search Instead of a tag, you may also specify a regular expression enclosed -in curly braces. For example, {{{samp(work+{^boss.*})}}} matches +in curly braces. For example, {{{samp(work+{^boss.*})}}} matches headlines that contain the tag {{{samp(:work:)}}} and any tag /starting/ with {{{samp(boss)}}}. @@ -8123,15 +8123,15 @@ headlines that contain the tag {{{samp(:work:)}}} and any tag #+vindex: org-odd-levels-only You may also test for properties (see [[Properties and columns]]) at the -same time as matching tags. The properties may be real properties, or +same time as matching tags. The properties may be real properties, or 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 a search {{{samp(+LEVEL=3+boss-TODO="DONE")}}} +properties]]). For example, the "property" ~TODO~ represents the TODO +keyword of the entry. Or, the "property" ~LEVEL~ represents the +level of an entry. So a search {{{samp(+LEVEL=3+boss-TODO="DONE")}}} lists all level three headlines that have the tag {{{samp(boss)}}} and -are /not/ marked with the TODO keyword DONE. In buffers with +are /not/ marked with the TODO keyword DONE. In buffers with ~org-odd-levels-only~ set, {{{samp(LEVEL)}}} does not count the number -of stars, but {{{samp(LEVEL=2)}}} will correspond to 3 stars etc. The +of stars, but {{{samp(LEVEL=2)}}} will correspond to 3 stars etc. The ITEM special property cannot currently be used in tags/property searches.[fn:92] @@ -8169,10 +8169,10 @@ comparison value is written: - If the comparison value is enclosed in double-quotes /and/ angular brackets (like {{{samp(DEADLINE<="<2008-12-24 18:30>")}}}), both values are assumed to be date/time specifications in the standard - Org way, and the comparison will be done accordingly. Special values + Org way, and the comparison will be done accordingly. Special values that will be recognized are ~""~ for now (including time), and ~""~, and ~""~ for these days at 0:00 hours, i.e.@: - without a time specification. Also strings like ~"<+5d>"~ or + without a time specification. Also strings like ~"<+5d>"~ or ~"<-2m>"~ with units ~d~, ~w~, ~m~, and ~y~ for day, week, month, and year, respectively, can be used. @@ -8189,28 +8189,28 @@ numerically smaller than 2, a {{{samp(:With:)}}} property that is matched by the regular expression {{{samp(Sarah|Denny)}}}, and that are scheduled on or after October 11, 2008. -Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing -any other properties will slow down the search. However, once you have +Accessing TODO, LEVEL, and CATEGORY during a search is fast. Accessing +any other properties will slow down the search. However, once you have paid the price by accessing one property, testing additional properties is cheap again. You can configure Org mode to use property inheritance during a -search, but beware that this can slow down searches considerably. See +search, but beware that this can slow down searches considerably. See [[Property inheritance]], for details. For backward compatibility, and also for typing speed, there is also a -different way to test TODO states in a search. For this, terminate the +different way to test TODO states in a search. For this, terminate the tags/property part of the search string (which may include several terms connected with {{{samp(|)}}}) with a {{{samp(/)}}} and then -specify a Boolean expression just for TODO keywords. The syntax is +specify a Boolean expression just for TODO keywords. The syntax is then similar to that for tags, but should be applied with care: for example, a positive selection on several TODO keywords cannot -meaningfully be combined with boolean AND. However, /negative -selection/ combined with AND can be meaningful. To make sure that only +meaningfully be combined with boolean AND. However, /negative +selection/ combined with AND can be meaningful. To make sure that only lines are checked that actually have any TODO keyword (resulting in a speed-up), use {{{kbd(C-c a M)}}}, or equivalently start the TODO part -after the slash with {{{samp(!)}}}. Using {{{kbd(C-c a M)}}} or -{{{samp(/!)}}} will not match TODO keywords in a DONE state. Examples: +after the slash with {{{samp(!)}}}. Using {{{kbd(C-c a M)}}} or +{{{samp(/!)}}} will not match TODO keywords in a DONE state. Examples: #+attr_texinfo: :table-type table :indic @samp - work/WAITING :: @@ -8271,15 +8271,15 @@ It is particularly useful to find notes. For example, the search string {{{samp(computer equipment)}}} will find entries that contain {{{samp(computer equipment)}}} as a -substring. If the two words are separated by more space or a line -break, the search will still match. Search view can also search for -specific keywords in the entry, using Boolean logic. The search string +substring. If the two words are separated by more space or a line +break, the search will still match. Search view can also search for +specific keywords in the entry, using Boolean logic. The search string {{{samp(+computer +wifi -ethernet -{8.11[bg]})}}} will search for note entries that contain the keywords ~computer~ and ~wifi~, but not the keyword ~ethernet~, and which are also not matched by the regular -expression ~8.11[bg]~, meaning to exclude both 8.11b and 8.11g. The +expression ~8.11[bg]~, meaning to exclude both 8.11b and 8.11g. The first {{{samp(+)}}} is necessary to turn on word search, other -{{{samp(+)}}} characters are optional. For more details, see the +{{{samp(+)}}} characters are optional. For more details, see the docstring of the command ~org-search-view~. #+vindex: org-agenda-text-search-extra-files @@ -8295,9 +8295,9 @@ search the files listed in ~org-agenda-text-search-extra-files~. If you are following a system like David Allen's GTD to organize your work, one of the "duties" you have is a regular review to make sure -that all projects move along. A /stuck/ project is a project that has +that all projects move along. A /stuck/ project is a project that has no defined next actions, so it will never show up in the TODO lists -Org mode produces. During the review, you need to identify such +Org mode produces. During the review, you need to identify such projects and define next actions for them. #+attr_texinfo: :table-type table :indic @asis @@ -8321,16 +8321,16 @@ 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 projects with a tag PROJECT, and that you use a TODO keyword MAYBE to -indicate a project that should not be considered yet. Let's further +indicate a project that should not be considered yet. Let's further assume that the TODO keyword DONE marks finished projects, and that -NEXT and TODO indicate next actions. The tag @SHOP indicates shopping -and is a next action even without the NEXT tag. Finally, if the +NEXT and TODO indicate next actions. The tag @SHOP indicates shopping +and is a next action even without the NEXT tag. Finally, if the project contains the special word IGNORE anywhere, it should not be -listed either. In this case you would start by identifying eligible +listed either. In this case you would start by identifying eligible projects with a tags/todo match (see [[Tag searches]]). {{{samp(+PROJECT/-MAYBE-DONE)}}}, and then check for TODO, NEXT, @SHOP, and IGNORE in the subtree to identify projects that are not -stuck. The correct customization for this is: +stuck. The correct customization for this is: #+begin_src emacs-lisp (setq org-stuck-projects @@ -8350,12 +8350,12 @@ will still be searched for stuck projects. #+vindex: org-agenda-tags-column Before displaying items in an agenda view, Org mode visually prepares -the items and sorts them. Each item occupies a single line. The line +the items and sorts them. Each item occupies a single line. The line starts with a /prefix/ that contains the /category/ (see [[Categories]]) -of the item and other important information. You can customize in +of the item and other important information. You can customize in which column tags will be 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 +~org-agenda-prefix-format~. This prefix is followed by a cleaned-up version of the outline headline associated with the item. *** Categories @@ -8366,7 +8366,7 @@ version of the outline headline associated with the item. #+cindex: category #+cindex: #+CATEGORY -The category is a broad label assigned to each agenda item. By +The category is a broad label assigned to each agenda item. By default, the category is simply derived from the file name, but you can also specify it with a special line in the buffer, like this:[fn:93] @@ -8403,7 +8403,7 @@ ranges can be specified with two timestamps, like: ~<2005-05-10 Tue 20:30>--<2005-05-10 Tue 22:15>~. In the headline of the entry itself, a time(range) may also appear as -plain text (like {{{samp(12:45)}}} or a {{{samp(8:30-1pm)}}}). If the +plain text (like {{{samp(12:45)}}} or a {{{samp(8:30-1pm)}}}). If the agenda integrates the Emacs diary (see [[Weekly/daily agenda]]), time specifications in diary entries are recognized as well. @@ -8459,7 +8459,7 @@ done depends on the type of view. time-of-day specification. These entries will be shown at the beginning of the list, as a /schedule/ for the day. After that, items remain grouped in categories, in the sequence given by - ~org-agenda-files~. Within each category, items are sorted by + ~org-agenda-files~. Within each category, items are sorted by priority (see [[Priorities]]), which is composed of the base priority (2000 for priority {{{samp(A)}}}, 1000 for {{{samp(B)}}}, and 0 for {{{samp(C)}}}), plus additional increments for overdue scheduled or deadline items. @@ -8521,7 +8521,7 @@ the other commands, the cursor needs to be in the desired line. #+kindex: @key{SPC} #+kindex: mouse-3 - Display the original location of the item in another window. With + Display the original location of the item in another window. With prefix arg, make sure that the entire entry is made visible in the outline, not only the heading. @@ -8545,9 +8545,9 @@ the other commands, the cursor needs to be in the desired line. #+kindex: F #+vindex: org-agenda-start-with-follow-mode - Toggle Follow mode. In Follow mode, as you move the cursor through the + Toggle Follow mode. In Follow mode, as you move the cursor through the agenda buffer, the other window always shows the corresponding - location in the Org file. The initial setting for this mode in new + location in the Org file. The initial setting for this mode in new agenda buffers can be set with the variable ~org-agenda-start-with-follow-mode~. @@ -8556,14 +8556,14 @@ the other commands, the cursor needs to be in the desired line. Display the entire subtree of the current item in an indirect buffer. With a numeric prefix argument N, go up to level N and then take that - tree. If N is negative, go up that many levels. With a {{{kbd(C-u)}}} + tree. If N is negative, go up that many levels. With a {{{kbd(C-u)}}} prefix, do not remove the previously used indirect buffer. - {{{kbd(C-c C-o)}}}, ~org-agenda-open-link~ :: #+kindex: C-c C-o - Follow a link in the entry. This will offer a selection of any links - in the text belonging to the referenced Org node. If there is only one + Follow a link in the entry. This will offer a selection of any links + in the text belonging to the referenced Org node. If there is only one link, it will be followed without a selection prompt. *** Change display @@ -8587,12 +8587,12 @@ the other commands, the cursor needs to be in the desired line. #+kindex: d #+vindex: org-agenda-span - Switch to day view. When switching to day view, this setting becomes - the default for subsequent agenda refreshes. A numeric prefix argument - may be used to jump directly to a specific day of the year. For - example, {{{kbd(32 d)}}} jumps to February 1st. When setting day view, - a year may be encoded in the prefix argument as well. For example, - {{{kbd(200712 d)}}} will jump to January 12, 2007. If such a year + Switch to day view. When switching to day view, this setting becomes + the default for subsequent agenda refreshes. A numeric prefix argument + may be used to jump directly to a specific day of the year. For + example, {{{kbd(32 d)}}} jumps to February 1st. When setting day view, + a year may be encoded in the prefix argument as well. For example, + {{{kbd(200712 d)}}} will jump to January 12, 2007. If such a year specification has only one or two digits, it will be mapped to the interval 1938-2037. @@ -8601,12 +8601,12 @@ the other commands, the cursor needs to be in the desired line. #+kindex: w #+vindex: org-agenda-span - Switch to week view. When switching week view, this setting becomes - the default for subsequent agenda refreshes. A numeric prefix argument - may be used to jump directly to a specific day of the ISO week. For - example {{{kbd(9 w)}}} to ISO week number 9. When setting week view, a - year may be encoded in the prefix argument as well. For example, - {{{kbd(200712 w)}}} will jump to week 12 in 2007. If such a year + Switch to week view. When switching week view, this setting becomes + the default for subsequent agenda refreshes. A numeric prefix argument + may be used to jump directly to a specific day of the ISO week. For + example {{{kbd(9 w)}}} to ISO week number 9. When setting week view, a + year may be encoded in the prefix argument as well. For example, + {{{kbd(200712 w)}}} will jump to week 12 in 2007. If such a year specification has only one or two digits, it will be mapped to the interval 1938-2037. @@ -8614,20 +8614,20 @@ the other commands, the cursor needs to be in the desired line. #+kindex: v m #+vindex: org-agenda-span - Switch to month view. Because month views are slow to create, they do - not become the default for subsequent agenda refreshes. A numeric + Switch to month view. Because month views are slow to create, they do + not become the default for subsequent agenda refreshes. A numeric prefix argument may be used to jump directly to a specific day of the - month. When setting month view, a year may be encoded in the prefix - argument as well. For example, {{{kbd(200712 m)}}} will jump to - December, 2007. If such a year specification has only one or two + month. When setting month view, a year may be encoded in the prefix + argument as well. For example, {{{kbd(200712 m)}}} will jump to + December, 2007. If such a year specification has only one or two digits, it will be mapped to the interval 1938-2037. - {{{kbd(v y)}}}, ~org-agenda-year-view~ :: #+kindex: v y #+vindex: org-agenda-span - Switch to year view. Because year views are slow to create, they do - not become the default for subsequent agenda refreshes. A numeric + Switch to year view. Because year views are slow to create, they do + not become the default for subsequent agenda refreshes. A numeric prefix argument may be used to jump directly to a specific day of the year. @@ -8641,8 +8641,8 @@ the other commands, the cursor needs to be in the desired line. #+kindex: f Go forward in time to display the following ~org-agenda-current-span~ - days. For example, if the display covers a week, switch to the - following week. With prefix arg, go forward that many times + days. For example, if the display covers a week, switch to the + following week. With prefix arg, go forward that many times ~org-agenda-current-span~ days. - {{{kbd(b)}}}, ~org-agenda-earlier~ :: @@ -8677,35 +8677,35 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-log-done #+vindex: org-agenda-log-mode-items - Toggle Logbook mode. In Logbook mode, entries that were marked DONE + Toggle Logbook mode. In Logbook mode, entries that were marked DONE while logging was on (see the variable ~org-log-done~) are shown in - the agenda, as are entries that have been clocked on that day. You can + the agenda, as are entries that have been clocked on that day. You can configure the entry types that should be included in log mode using - the variable ~org-agenda-log-mode-items~. When called with a + the variable ~org-agenda-log-mode-items~. When called with a {{{kbd(C-u)}}} prefix, show all possible logbook entries, including - state changes. When called with two prefix args {{{kbd(C-u C-u)}}}, - show only logging information, nothing else. {{{kbd(v L)}}} is + state changes. When called with two prefix args {{{kbd(C-u C-u)}}}, + show only logging information, nothing else. {{{kbd(v L)}}} is equivalent to {{{kbd(C-u v l)}}}. - {{{kbd(v [)}}} or short {{{kbd([)}}}, ~org-agenda-manipulate-query-add~ :: #+kindex: v [ #+kindex: [ - Include inactive timestamps into the current view. Only for + Include inactive timestamps into the current view. Only for weekly/daily agenda and timeline views. - {{{kbd(v a)}}}, ~org-agenda-archives-mode~ :: #+kindex: v a - Toggle Archives mode. In Archives mode, trees that are marked - ~ARCHIVED~ are also scanned when producing the agenda. To exit + Toggle Archives mode. In Archives mode, trees that are marked + ~ARCHIVED~ are also scanned when producing the agenda. To exit archives mode, press {{{kbd(v a)}}} again. - {{{kbd(v A)}}}, ~org-agenda-archives-mode 'files~ :: - Toggle Archives mode. In Archives mode, trees that are marked + Toggle Archives mode. In Archives mode, trees that are marked ~ARCHIVED~ are also scanned when producing the agenda, including all - archive files. To exit archives mode, press {{{kbd(v a)}}}. + archive files. To exit archives mode, press {{{kbd(v a)}}}. - {{{kbd(v R)}}} or short {{{kbd(R)}}}, ~org-agenda-clockreport-mode~ :: #+kindex: v R @@ -8713,11 +8713,11 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-start-with-clockreport-mode #+vindex: org-clock-report-include-clocking-task - Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda + Toggle Clockreport mode. In Clockreport mode, the daily/weekly agenda will always show a table with the clocked times for the timespan and - file scope covered by the current agenda view. The initial setting for + file scope covered by the current agenda view. The initial setting for this mode in new agenda buffers can be set with the variable - ~org-agenda-start-with-clockreport-mode~. By using a prefix argument + ~org-agenda-start-with-clockreport-mode~. By using a prefix argument when toggling this mode (i.e., {{{kbd(C-u R)}}}), the clock table will not show contributions from entries that are hidden by agenda filtering.[fn:94] See also the variable @@ -8728,10 +8728,10 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-clock-consistency-checks Show overlapping clock entries, clocking gaps, and other clocking - problems in the current agenda range. You can then visit clocking - lines and fix them manually. See the variable + problems in the current agenda range. You can then visit clocking + lines and fix them manually. See the variable ~org-agenda-clock-consistency-checks~ for information on how to - customize the definition of what constituted a clocking problem. To + customize the definition of what constituted a clocking problem. To return to normal agenda display, press {{{kbd(l)}}} to exit Logbook mode. @@ -8741,10 +8741,10 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-start-with-entry-text-mode #+vindex: org-agenda-entry-text-maxlines - Toggle entry text mode. In entry text mode, a number of lines from the + Toggle entry text mode. In entry text mode, a number of lines from the Org outline node referenced by an agenda line will be displayed below - the line. The maximum number of lines is given by the variable - ~org-agenda-entry-text-maxlines~. Calling this command with a numeric + the line. The maximum number of lines is given by the variable + ~org-agenda-entry-text-maxlines~. Calling this command with a numeric prefix argument will temporarily modify that number to the prefix value. @@ -8753,7 +8753,7 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-use-time-grid #+vindex: org-agenda-time-grid - Toggle the time grid on and off. See also the variables + Toggle the time grid on and off. See also the variables ~org-agenda-use-time-grid~ and ~org-agenda-time-grid~. - {{{kbd(r)}}}, ~org-agenda-redo~ :: @@ -8781,9 +8781,9 @@ the other commands, the cursor needs to be in the desired line. #+kindex: C-c C-x C-c #+vindex: org-columns-default-format - Invoke column view (see [[Column view]]) in the agenda buffer. The column + Invoke column view (see [[Column view]]) in the agenda buffer. The column view format is taken from the entry at point, or (if there is no entry - at point), from the first entry in the agenda view. So whatever the + at point), from the first entry in the agenda view. So whatever the format for that entry would be in the original buffer (taken from a property, from a ~#+COLUMNS~ line, or from the default variable ~org-columns-default-format~), will be used in the agenda. @@ -8807,8 +8807,8 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-category-filter-preset Filter the current agenda view with respect to the category of the - item at point. Pressing {{{kbd(<)}}} another time will remove this - filter. You can add a filter preset through the option + item at point. Pressing {{{kbd(<)}}} another time will remove this + filter. You can add a filter preset through the option ~org-agenda-category-filter-preset~ (see below). - {{{kbd(/)}}}, ~org-agenda-filter-by-tag~ :: @@ -8816,21 +8816,21 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-tag-filter-preset Filter the current agenda view with respect to a tag and/or effort - estimates. The difference between this and a custom agenda command is + estimates. The difference between this and a custom agenda command is that filtering is very fast, so that you can switch quickly between different filters without having to recreate the agenda.[fn:95] You will be prompted for a tag selection letter; {{{key(SPC)}}} will - mean any tag at all. Pressing {{{key(TAB)}}} at that prompt will offer + mean any tag at all. Pressing {{{key(TAB)}}} at that prompt will offer use completion to select a tag (including any tags that do not have a - selection character). The command then hides all entries that do not - contain or inherit this tag. When called with prefix arg, remove the - entries that /do/ have the tag. A second {{{kbd(/)}}} at the prompt - will turn off the filter and unhide any hidden entries. If the first + selection character). The command then hides all entries that do not + contain or inherit this tag. When called with prefix arg, remove the + entries that /do/ have the tag. A second {{{kbd(/)}}} at the prompt + will turn off the filter and unhide any hidden entries. If the first key you press is either {{{kbd(+)}}} or {{{kbd(-)}}}, the previous filter will be narrowed by requiring or forbidding the selected - additional tag. Instead of pressing {{{kbd(+)}}} or {{{kbd(-)}}} after + additional tag. Instead of pressing {{{kbd(+)}}} or {{{kbd(-)}}} after {{{kbd(/)}}}, you can also immediately use the ~\~ command. #+vindex: org-sort-agenda-noeffort-is-high @@ -8847,24 +8847,24 @@ the other commands, the cursor needs to be in the desired line. You can then filter for an effort by first typing an operator, one of {{{kbd(<)}}}, {{{kbd(>)}}}, and {{{kbd(=)}}}, and then the one-digit index of an effort estimate in your array of allowed values, where - {{{kbd(0)}}} means the 10th value. The filter will then restrict to + {{{kbd(0)}}} means the 10th value. The filter will then restrict to entries with effort smaller-or-equal, equal, or larger-or-equal than - the selected value. If the digits 0-9 are not used as fast access keys + the selected value. If the digits 0-9 are not used as fast access keys to tags, you can also simply press the index digit directly without an - operator. In this case, {{{kbd(<)}}} will be assumed. For application + operator. In this case, {{{kbd(<)}}} will be assumed. For application of the operator, entries without a defined effort will be treated - according to the value of ~org-sort-agenda-noeffort-is-high~. To + according to the value of ~org-sort-agenda-noeffort-is-high~. To filter for tasks without effort definition, press {{{kbd(?)}}} as the operator. - Org also supports automatic, context-aware tag filtering. If the + Org also supports automatic, context-aware tag filtering. If the variable ~org-agenda-auto-exclude-function~ is set to a user-defined function, that function can decide which tags should be excluded from - the agenda automatically. Once this is set, the {{{kbd(/)}}} command + the agenda automatically. Once this is set, the {{{kbd(/)}}} command then accepts {{{kbd(RET)}}} as a sub-option key and runs the auto - exclusion logic. For example, let's say you use a ~Net~ tag to + exclusion logic. For example, let's say you use a ~Net~ tag to identify tasks which need network access, an ~Errand~ tag for errands - in town, and a ~Call~ tag for making phone calls. You could + in town, and a ~Call~ tag for making phone calls. You could auto-exclude these tags based on the availability of the Internet, and outside of business hours, with something like this: @@ -8886,9 +8886,9 @@ the other commands, the cursor needs to be in the desired line. - ~\~ ~org-agenda-filter-by-tag-refine~ :: #+kindex: XXX #+comment: Should be \ - Narrow the current agenda filter by an additional condition. When + Narrow the current agenda filter by an additional condition. When called with prefix arg, remove the entries that /do/ have the tag, or - that do match the effort criterion. You can achieve the same effect by + that do match the effort criterion. You can achieve the same effect by pressing {{{kbd(+)}}} or {{{kbd(-)}}} as the first key after the {{{kbd(/)}}} command. @@ -8899,10 +8899,10 @@ the other commands, the cursor needs to be in the desired line. #+kindex: @} Add new search words ({{{kbd([)}}} and {{{kbd(])}}}) or new regular - expressions ({{{kbd({)}}} and {{{kbd(})}}}) to the query string. The + expressions ({{{kbd({)}}} and {{{kbd(})}}}) to the query string. The opening bracket/brace will add a positive search term prefixed by {{{samp(+)}}}, indicating that this search term /must/ occur/match in - the entry. The closing bracket/brace will add a negative search term + the entry. The closing bracket/brace will add a negative search term which /must not/ occur/match in the entry for it to be selected. *** FIXME Remote editing @@ -8918,7 +8918,7 @@ the other commands, the cursor needs to be in the desired line. #+cindex: undoing remote-editing events #+cindex: remote editing, undo - Undo a change due to a remote editing command. The change is undone + Undo a change due to a remote editing command. The change is undone both in the agenda buffer and in the remote buffer. - {{{kbd(t)}}}, ~org-agenda-todo~ :: @@ -8942,8 +8942,8 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-agenda-confirm-kill Delete the current agenda item along with the entire subtree belonging - to it in the original Org file. If the text to be deleted remotely is - longer than one line, the kill needs to be confirmed by the user. See + to it in the original Org file. If the text to be deleted remotely is + longer than one line, the kill needs to be confirmed by the user. See variable ~org-agenda-confirm-kill~. - {{{kbd(C-c C-w)}}}, ~org-agenda-refile~ :: @@ -8957,7 +8957,7 @@ the other commands, the cursor needs to be in the desired line. #+vindex: org-archive-default-command Archive the subtree corresponding to the entry at point using the - default archiving command set in ~org-archive-default-command~. When + default archiving command set in ~org-archive-default-command~. When using the ~a~ key, confirmation will be required. - {{{kbd(C-c C-x a)}}}, ~org-agenda-toggle-archive-tag~ :: @@ -8975,7 +8975,7 @@ the other commands, the cursor needs to be in the desired line. #+kindex: C-c C-x C-s #+kindex: $ - Archive the subtree corresponding to the current headline. This means + Archive the subtree corresponding to the current headline. This means the entry will be moved to the configured archive location, most likely a different file. @@ -8983,20 +8983,20 @@ the other commands, the cursor needs to be in the desired line. #+kindex: T #+vindex: org-agenda-show-inherited-tags - Show all tags associated with the current item. This is useful if you + 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. - {{{kbd(:)}}}, ~org-agenda-set-tags~ :: #+kindex: : - Set tags for the current headline. If there is an active region in the + Set tags for the current headline. If there is an active region in the agenda, change a tag for all headings in the region. - {{{kbd(\\\,)}}} :: #+kindex: , - Set the priority for the current item (~org-agenda-priority~). Org - mode prompts for the priority character. If you reply with + Set the priority for the current item (~org-agenda-priority~). Org + mode prompts for the priority character. If you reply with {{{key(SPC)}}}, the priority cookie is removed from the entry. - {{{kbd(P)}}}, ~org-agenda-show-priority~ :: @@ -9007,8 +9007,8 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(+)}}} {{{kbdkey(S-,up)}}}, ~org-agenda-priority-up~ :: #+kindex: + - Increase the priority of the current item. The priority is changed in - the original buffer, but the agenda is not resorted. Use the + Increase the priority of the current item. The priority is changed in + the original buffer, but the agenda is not resorted. Use the {{{kbd(r)}}} key for this. - {{{kbd(-)}}} {{{kbdkey(S-,down)}}}, ~org-agenda-priority-down~ :: @@ -9020,8 +9020,8 @@ the other commands, the cursor needs to be in the desired line. #+kindex: z #+vindex: org-log-into-drawer - Add a note to the entry. This note will be recorded, and then filed to - the same location where state change notes are put. Depending on + Add a note to the entry. This note will be recorded, and then filed to + the same location where state change notes are put. Depending on ~org-log-into-drawer~, this may be inside a drawer. - {{{kbd(C-c C-a)}}}, ~org-attach~ :: @@ -9043,15 +9043,15 @@ the other commands, the cursor needs to be in the desired line. #+kindex: S-@key{right} Change the timestamp associated with the current line by one day into - the future. If the date is in the past, the first call to this command - will move it to today. With a numeric prefix argument, change it by - that many days. For example, {{{kbdkey(3 6 5 S-,right)}}} will change - it by a year. With a {{{kbd(C-u)}}} prefix, change the time by one - hour. If you immediately repeat the command, it will continue to - change hours even without the prefix arg. With a double - {{{kbd(C-u C-u)}}} prefix, do the same for changing minutes. The stamp is changed + the future. If the date is in the past, the first call to this command + will move it to today. With a numeric prefix argument, change it by + that many days. For example, {{{kbdkey(3 6 5 S-,right)}}} will change + it by a year. With a {{{kbd(C-u)}}} prefix, change the time by one + hour. If you immediately repeat the command, it will continue to + change hours even without the prefix arg. With a double + {{{kbd(C-u C-u)}}} prefix, do the same for changing minutes. The stamp is changed in the original Org file, but the change is not directly reflected in - the agenda buffer. Use {{{kbd(r)}}} or {{{kbd(g)}}} to update the + the agenda buffer. Use {{{kbd(r)}}} or {{{kbd(g)}}} to update the buffer. - {{{kbdkey(S-,left)}}}, ~org-agenda-do-date-earlier~ :: @@ -9063,14 +9063,14 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(>)}}}, ~org-agenda-date-prompt~ :: #+kindex: > - Change the timestamp associated with the current line. The key + Change the timestamp associated with the current line. The key {{{kbd(>)}}} has been chosen, because it is the same as {{{kbd(S-.)}}} on my keyboard. - {{{kbd(I)}}}, ~org-agenda-clock-in~ :: #+kindex: I - Start the clock on the current item. If a clock is running already, it + Start the clock on the current item. If a clock is running already, it is stopped first. - {{{kbd(O)}}}, ~org-agenda-clock-out~ :: @@ -9106,7 +9106,7 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(m)}}}, ~org-agenda-bulk-mark~ :: #+kindex: m - Mark the entry at point for bulk action. With prefix arg, mark that + Mark the entry at point for bulk action. With prefix arg, mark that many successive entries. - {{{kbd(%)}}}, ~org-agenda-bulk-mark-regexp~ :: @@ -9127,11 +9127,11 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(B)}}}, ~org-agenda-bulk-action~ :: #+kindex: B - Bulk action: act on all marked entries in the agenda. This will prompt - for another key to select the action to be applied. The prefix arg to + Bulk action: act on all marked entries in the agenda. This will prompt + for another key to select the action to be applied. The prefix arg to {{{kbd(B)}}} will be passed through to the {{{kbd(s)}}} and - {{{kbd(d)}}} commands, to bulk-remove these special timestamps. By - default, marks are removed after the bulk. If you want them to + {{{kbd(d)}}} commands, to bulk-remove these special timestamps. By + default, marks are removed after the bulk. If you want them to persist, set ~org-agenda-bulk-persistent-marks~ to ~t~ or hit {{{kbd(p)}}} at the prompt. @@ -9149,7 +9149,7 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(t)}}} :: - Change TODO state. This prompts for a single TODO keyword and changes + Change TODO state. This prompts for a single TODO keyword and changes the state of all selected entries, bypassing blocking and suppressing logging notes (but not timestamps). @@ -9163,7 +9163,7 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(s)}}} :: - Schedule all items to a new date. To shift existing schedule dates by + Schedule all items to a new date. To shift existing schedule dates by a fixed number of days, use something starting with double plus at the prompt, for example {{{samp(++8d)}}} or {{{samp(++2w)}}}. @@ -9173,13 +9173,13 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(r)}}} :: - Prompt for a single refile target and move all entries. The entries + Prompt for a single refile target and move all entries. The entries will no longer be in the agenda; refresh ({{{kbd(g)}}}) to bring them back. - {{{kbd(S)}}} :: - Reschedule randomly into the coming N days. N will be prompted for. + Reschedule randomly into the coming N days. N will be prompted for. With prefix arg ({{{kbd(C-u B S)}}}), scatter only across weekdays. - {{{kbd(f)}}} :: @@ -9225,7 +9225,7 @@ the other commands, the cursor needs to be in the desired line. #+cindex: diary entries, creating from agenda Insert a new entry into the diary, using the date at the cursor and - (for block entries) the date at the mark. This will add to the Emacs + (for block entries) the date at the mark. This will add to the Emacs diary file, in a way similar to the {{{kbd(i)}}} command in the calendar.[fn:97] The diary file will pop up in another window, where you can add the entry. @@ -9235,12 +9235,12 @@ the other commands, the cursor needs to be in the desired line. Most entries will be stored in a date-based outline tree that will later make it easy to archive appointments from previous months/years. The tree will be built under an entry with a ~DATE_TREE~ property, or - else with years as top-level entries. Emacs will prompt you for the + else with years as top-level entries. Emacs will prompt you for the entry text---if you specify it, the entry will be created in - ~org-agenda-diary-file~ without further interaction. If you directly + ~org-agenda-diary-file~ without further interaction. If you directly press {{{key(RET)}}} at the prompt without typing text, the target file will be shown in another window for you to finish the entry - there. See also the {{{kbd(k r)}}} command. + there. See also the {{{kbd(k r)}}} command. - {{{kbd(M)}}}, ~org-agenda-phases-of-moon~ :: #+kindex: M @@ -9250,7 +9250,7 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(S)}}}, ~org-agenda-sunrise-sunset~ :: #+kindex: S - Show sunrise and sunset times. The geographical location must be set + Show sunrise and sunset times. The geographical location must be set with calendar variables, see the documentation for the Emacs calendar. - {{{kbd(C)}}}, ~org-agenda-convert-date~ :: @@ -9267,7 +9267,7 @@ the other commands, the cursor needs to be in the desired line. - {{{kbd(M-x org-export-icalendar-combine-agenda-files)}}} :: Export a single iCalendar file containing entries from all agenda - files. This is a globally available command, and also available in the + files. This is a globally available command, and also available in the agenda menu. *** Exporting to a file @@ -9278,12 +9278,12 @@ the other commands, the cursor needs to be in the desired line. #+cindex: agenda views, exporting #+vindex: org-agenda-exporter-settings - Write the agenda view to a file. Depending on the extension of the + Write the agenda view to a file. Depending on the extension of the selected file name, the view will be exported as HTML (extension {{{file(.html)}}} or {{{file(.htm)}}}), Postscript (extension {{{file(.ps)}}}), PDF (extension {{{file(.pdf)}}}), and plain text - (any other extension). When called with a {{{kbd(C-u)}}} prefix - argument, immediately open the newly created file. Use the variable + (any other extension). When called with a {{{kbd(C-u)}}} prefix + argument, immediately open the newly created file. Use the variable ~org-agenda-exporter-settings~ to set options for {{{file(ps-print)}}} and for {{{file(htmlize)}}} to be used during export. @@ -9299,7 +9299,7 @@ the other commands, the cursor needs to be in the desired line. #+cindex: agenda files, removing buffers Exit agenda, remove the agenda buffer and all buffers loaded by Emacs - for the compilation of the agenda. Buffers created by the user to + for the compilation of the agenda. Buffers created by the user to visit Org files will not be removed. ** Custom agenda views @@ -9328,9 +9328,9 @@ current buffer). #+vindex: org-agenda-custom-commands Custom commands are configured in the variable -~org-agenda-custom-commands~. You can customize this variable, for -example by pressing {{{kbd(C-c a C)}}}. You can also directly set it -with Emacs Lisp in {{{file(.emacs)}}}. The following example contains +~org-agenda-custom-commands~. You can customize this variable, for +example by pressing {{{kbd(C-c a C)}}}. You can also directly set it +with Emacs Lisp in {{{file(.emacs)}}}. The following example contains all valid search types: #+header: :eval no @@ -9351,12 +9351,12 @@ all valid search types: {{{noindent}}} The initial string in each entry defines the keys you have to press after the dispatcher command {{{kbd(C-c a)}}} in order -to access the command. Usually this will be just a single character, +to access the command. Usually this will be just a single character, but if you have many similar commands, you can also define two-letter combinations where the first character is the same in several combinations and serves as a prefix key.[fn:98] The second parameter is the search type, followed by the string or regular expression to be -used for the matching. The example above will therefore define: +used for the matching. The example above will therefore define: #+attr_texinfo: :table-type table :indic @kbd - C-c a w :: @@ -9405,11 +9405,11 @@ used for the matching. The example above will therefore define: Another possibility is the construction of agenda views that comprise the results of /several/ commands, each of which creates a block in -the agenda buffer. The available commands include ~agenda~ for the +the agenda buffer. The available commands include ~agenda~ for the daily or weekly agenda (as created with {{{kbd(C-c a a)}}}), ~alltodo~ for the global TODO list (as constructed with {{{kbd(C-c a t)}}}), and the matching commands discussed above: ~todo~, ~tags~, and -~tags-todo~. Here are two examples: +~tags-todo~. Here are two examples: #+header: :eval no #+header: :exports code @@ -9426,10 +9426,10 @@ the matching commands discussed above: ~todo~, ~tags~, and #+end_src {{{noindent}}} This will define {{{kbd(C-c a h)}}} to create a -multi-block view for stuff you need to attend to at home. The +multi-block view for stuff you need to attend to at home. The resulting agenda buffer will contain your agenda for the current week, all TODO items that carry the tag {{{samp(home)}}}, and also all lines -tagged with {{{samp(garden)}}}. Finally the command {{{kbd(C-c a o)}}} +tagged with {{{samp(garden)}}}. Finally the command {{{kbd(C-c a o)}}} provides a similar view for office tasks. *** Setting options for custom commands @@ -9440,11 +9440,11 @@ provides a similar view for office tasks. #+vindex: org-agenda-custom-commands Org mode contains a number of variables regulating agenda construction -and display. The global variables define the behavior for all agenda -commands, including the custom commands. However, if you want to +and display. The global variables define the behavior for all agenda +commands, including the custom commands. However, if you want to change some settings just for a single custom view, you can do so. Setting options requires inserting a list of variable names and values -at the right spot in ~org-agenda-custom-commands~. For example: +at the right spot in ~org-agenda-custom-commands~. For example: #+header: :eval no #+header: :exports code @@ -9464,23 +9464,23 @@ at the right spot in ~org-agenda-custom-commands~. For example: {{{noindent}}} Now the {{{kbd(C-c a w)}}} command will sort the collected entries only by priority, and the prefix format is modified to just say {{{samp( Mixed: )}}} instead of giving the category of the -entry. The sparse tags tree of {{{kbd(C-c a U)}}} will now turn out +entry. The sparse tags tree of {{{kbd(C-c a U)}}} will now turn out ultra-compact, because neither the headline hierarchy above the match, -nor the headline following the match will be shown. The command +nor the headline following the match will be shown. The command {{{kbd(C-c a N)}}} will do a text search limited to only a single file. #+vindex: org-agenda-custom-commands For command sets creating a block agenda, ~org-agenda-custom-commands~ -has two separate spots for setting options. You can add options that +has two separate spots for setting options. You can add options that should be valid for just a single command in the set, and options that -should be valid for all commands in the set. The former are just added +should be valid for all commands in the set. The former are just added to the command entry; the latter must come after the list of command -entries. Going back to the block agenda example (see [[Block +entries. Going back to the block agenda example (see [[Block agenda]]), let's change the sorting strategy for the {{{kbd(C-c a h)}}} commands to ~priority-down~, but let's sort the results for -GARDEN tags query in the opposite order, ~priority-up~. This would +GARDEN tags query in the opposite order, ~priority-up~. This would look like this: #+header: :eval no @@ -9501,8 +9501,8 @@ look like this: As you see, the values and parentheses setting is a little complex. When in doubt, use the customize interface to set this variable---it -fully supports its structure. Just one caveat: when setting options in -this interface, the /values/ are just Lisp expressions. So if the +fully supports its structure. Just one caveat: when setting options in +this interface, the /values/ are just Lisp expressions. So if the value is a string, you need to add the double-quotes around the value yourself. @@ -9510,9 +9510,9 @@ yourself. To control whether an agenda command should be accessible from a specific context, you can customize -~org-agenda-custom-commands-contexts~. Let's say for example that you +~org-agenda-custom-commands-contexts~. Let's say for example that you have an agenda command {{{kbd(o)}}} displaying a view that you only -need when reading emails. Then you would configure this option like +need when reading emails. Then you would configure this option like this: #+header: :eval no @@ -9541,7 +9541,7 @@ See the docstring of the variable for more information. #+cindex: agenda views, exporting If you are away from your computer, it can be very useful to have a -printed version of some agenda views to carry around. Org mode can +printed version of some agenda views to carry around. Org mode can export custom agenda views as plain text, HTML, Postscript, PDF, and iCalendar files.[fn:99] If you want to do this only occasionally, use the following command: @@ -9553,11 +9553,11 @@ do this only occasionally, use the following command: #+cindex: agenda views, exporting #+vindex: org-agenda-exporter-settings - Write the agenda view to a file. Depending on the extension of the + Write the agenda view to a file. Depending on the extension of the selected file name, the view will be exported as HTML (extension {{{file(.html)}}} or {{{file(.htm)}}}), Postscript (extension {{{file(.ps)}}}), iCalendar (extension {{{file(.ics)}}}), or plain - text (any other extension). Use the variable + text (any other extension). Use the variable ~org-agenda-exporter-settings~ to set options for {{{file(ps-print)}}} and for {{{file(htmlize)}}} to be used during export, for example: @@ -9581,8 +9581,8 @@ If you need to export certain agenda views frequently, you can associate any custom agenda command with a list of output file names.[fn:100] Here is an example that first defines custom commands for the agenda and the global TODO list, together with a number of -files to which to export them. Then we define two block agenda -commands and specify file names for them as well. File names can be +files to which to export them. Then we define two block agenda +commands and specify file names for them as well. File names can be relative to the current working directory, or absolute. #+header: :eval no @@ -9605,14 +9605,14 @@ relative to the current working directory, or absolute. ("~/views/office.ps" "~/calendars/office.ics")))) #+end_src -The extension of the file name determines the type of export. If it is +The extension of the file name determines the type of export. If it is {{{file(.html)}}}, Org mode will use the {{{file(htmlize.el)}}} package to convert the buffer to HTML and save it to this file name. If the extension is {{{file(.ps)}}}, ~ps-print-buffer-with-faces~ is -used to produce Postscript output. If the extension is +used to produce Postscript output. If the extension is {{{file(.ics)}}}, iCalendar export is run export over all files that were used to construct the agenda, and limit the export to entries -listed in the agenda. Any other extension produces a plain ASCII file. +listed in the agenda. Any other extension produces a plain ASCII file. The export files are /not/ created when you use one of those commands interactively because this might use too much overhead. @@ -9644,11 +9644,11 @@ set options for the export commands. For example: {{{noindent}}} This command sets two options for the Postscript exporter, to make it print in two columns in landscape format---the -resulting page can be cut in two and then used in a paper agenda. The +resulting page can be cut in two and then used in a paper agenda. The remaining settings modify the agenda prefix to omit category and scheduling information, and instead include a checkbox to check off -items. We also remove the tags to make the lines compact, and we don't -want to use colors for the black-and-white printer. Settings specified +items. We also remove the tags to make the lines compact, and we don't +want to use colors for the black-and-white printer. Settings specified in ~org-agenda-exporter-settings~ will also apply, but the settings in ~org-agenda-custom-commands~ take precedence. @@ -9687,7 +9687,7 @@ more information. <> Column view (see [[Column view]]) is normally used to view and edit -properties embedded in the hierarchical structure of an Org file. It +properties embedded in the hierarchical structure of an Org file. It can be quite useful to use column view also from the agenda, where entries are collected by certain criteria. @@ -9701,12 +9701,12 @@ To understand how to use this properly, it is important to realize that the entries in the agenda are no longer in their proper outline environment. This causes the following issues: -1. Org needs to make a decision which ~COLUMNS~ format to use. Since +1. Org needs to make a decision which ~COLUMNS~ format to use. Since the entries in the agenda are collected from different files, and different files may have different ~COLUMNS~ formats, this is a - non-trivial problem. Org first checks if the variable + non-trivial problem. Org first checks if the variable ~org-agenda-overriding-columns-format~ is currently set, and if so, - takes the format from there. Otherwise it takes the format + takes the format from there. Otherwise it takes the format associated with the first item in the agenda, or, if that item does not have a specific format (defined in a property, or in its file), it uses ~org-columns-default-format~. @@ -9717,25 +9717,25 @@ This causes the following issues: 2. If any of the columns has a summary type defined (see [[Column attributes]]), turning on column view in the agenda will visit all relevant agenda files and make sure that the computations of this - property are up to date. This is also true for the special - ~CLOCKSUM~ property. Org will then sum the values displayed in the - agenda. In the daily/weekly agenda, the sums will cover a single - day; in all other views they cover the entire block. It is vital to + property are up to date. This is also true for the special + ~CLOCKSUM~ property. Org will then sum the values displayed in the + agenda. In the daily/weekly agenda, the sums will cover a single + day; in all other views they cover the entire block. It is vital to realize that the agenda may show the same entry /twice/ (for example as scheduled and as a deadline), and it may show two entries from the same hierarchy (for example a /parent/ and its - /child/). In these cases, the summation in the agenda will lead to + /child/). In these cases, the summation in the agenda will lead to incorrect results because some values will count double. #+cindex: property, special, CLOCKSUM 3. When the column view in the agenda shows the ~CLOCKSUM~, that is - always the entire clocked time for this item. So even in the + always the entire clocked time for this item. So even in the daily/weekly agenda, the clocksum listed in column view may - originate from times outside the current view. This has the + originate from times outside the current view. This has the advantage that you can compare these values with a column listing the planned total effort for a task---one of the major applications - for column view in the agenda. If you want information about + for column view in the agenda. If you want information about clocked time in the displayed period use clock table mode (press {{{kbd(R)}}} in the agenda). @@ -9779,7 +9779,7 @@ special line: #+end_example {{{noindent}}} If this line does not exist, the title is derived from -the first non-empty, non-comment line in the buffer. If no such line +the first non-empty, non-comment line in the buffer. If no such line exists, or if you have turned off exporting of the text before the first headline (see below), the title will be the file name without extension. @@ -9787,7 +9787,7 @@ extension. #+cindex: property, EXPORT_TITLE If you are exporting only a subtree by marking is as the region, the -heading of the subtree will become the title of the document. If the +heading of the subtree will become the title of the document. If the subtree has a property ~EXPORT_TITLE~, that will take precedence. *** Headings and sections @@ -9800,9 +9800,9 @@ subtree has a property ~EXPORT_TITLE~, that will take precedence. The outline structure of the document as described in [[Document structure]], forms the basis for defining sections of the exported -document. However, since the outline structure is also used for (for +document. However, since the outline structure is also used for (for example) lists of tasks, only the first three outline levels will be -used as headings. Deeper levels will become itemized lists. You can +used as headings. Deeper levels will become itemized lists. You can change the location of this switch globally by setting the variable ~org-export-headline-levels~, or on a per-file basis with the ~H~ option: @@ -9820,9 +9820,9 @@ change the location of this switch globally by setting the variable #+vindex: org-export-with-toc The table of contents is normally inserted directly before the first -headline of the file. If you would like to get it to a different +headline of the file. If you would like to get it to a different location, insert the string ~[TABLE-OF-CONTENTS]~ on a line by itself -at the desired location. The depth of the table of contents is by +at the desired location. The depth of the table of contents is by default the same as the number of headline levels, but you can choose a smaller number, or turn off the table of contents entirely, by configuring the variable ~org-export-with-toc~, or on a per-file basis @@ -9850,7 +9850,7 @@ constructs described below in the sections for the individual exporters. Some people like to use the space before the first headline for setup and internal links and therefore would like to control the exported -text before the first headline in a different way. You can do so by +text before the first headline in a different way. You can do so by setting the variable ~org-export-skip-text-before-1st-heading~ to ~t~. On a per-file basis, you can get the same effect with {{{samp(#+OPTIONS: skip:t)}}}. @@ -9874,7 +9874,7 @@ If you still want to have some text before the first headline, use the #+cindex: lists, markup rules Plain lists as described in [[Plain lists]], are translated to the -backend's syntax for such lists. Most backends support unordered, +backend's syntax for such lists. Most backends support unordered, ordered, and description lists. *** Paragraphs @@ -9883,7 +9883,7 @@ ordered, and description lists. :END: #+cindex: paragraphs, markup rules -Paragraphs are separated by at least one empty line. If you need to +Paragraphs are separated by at least one empty line. If you need to enforce a line break within a paragraph, use ~\\~ at the end of a line. @@ -9904,7 +9904,7 @@ format poetry: When quoting a passage from another document, it is customary to format this as a paragraph that is indented on both the left and the -right margin. You can include quotations in Org mode documents like +right margin. You can include quotations in Org mode documents like this: #+cindex: #+BEGIN_QUOTE @@ -9972,8 +9972,8 @@ in LaTeX). Lines starting with zero or more whitespace characters followed by one {{{samp(#)}}} and a whitespace are treated as comments and will never -be exported. Also entire subtrees starting with the word -{{{samp(COMMENT)}}} will never be exported. Finally, regions +be exported. Also entire subtrees starting with the word +{{{samp(COMMENT)}}} will never be exported. Finally, regions surrounded by {{{samp(#+BEGIN_COMMENT)}}} ... {{{samp(#+END_COMMENT)}}} will not be exported. @@ -9993,9 +9993,9 @@ surrounded by {{{samp(#+BEGIN_COMMENT)}}} ... #+cindex: #+LABEL Both the native Org mode tables (see [[Tables]]) and tables formatted with -the {{{file(table.el)}}} package will be exported properly. For Org +the {{{file(table.el)}}} package will be exported properly. For Org mode tables, the lines before the first horizontal separator line will -become table header lines. You can use the following lines somewhere +become table header lines. You can use the following lines somewhere before the table to assign a caption and a label for cross references, and in the text you can refer to the object with ~\ref{tab:basic-data}~: @@ -10015,9 +10015,9 @@ Optionally, the caption can take the form: #+cindex: inlined images, markup rules Some backends (HTML, LaTeX, and DocBook) allow you to directly -include images into the exported document. Org does this, if a link to +include images into the exported document. Org does this, if a link to an image files does not have a description part, for example -~[[./img/a.jpg]]~. If you wish to define a caption for the image and maybe +~[[./img/a.jpg]]~. If you wish to define a caption for the image and maybe a label for internal cross references, make sure that the link is on a line by itself and precede it with ~#+CAPTION~ and ~#+LABEL~ as follows: @@ -10028,7 +10028,7 @@ follows: [[./img/a.jpg]] #+end_example -You may also define additional attributes for the figure. As this is +You may also define additional attributes for the figure. As this is backend-specific, see the sections about the individual backends for more information. @@ -10042,7 +10042,7 @@ See [[Handling links][the discussion of image links]]. #+cindex: code line references, markup rules You can include literal examples that should not be subjected to -markup. Such examples will be typeset in monospace, so this is well +markup. Such examples will be typeset in monospace, so this is well suited for source code and similar examples. #+cindex: #+BEGIN_EXAMPLE @@ -10054,8 +10054,8 @@ suited for source code and similar examples. Note that such blocks may be /indented/ in order to align nicely with indented text and in particular with plain list structure (see [[Plain -lists]]). For simplicity when using small examples, you can also start -the example lines with a colon followed by a space. There may also be +lists]]). For simplicity when using small examples, you can also start +the example lines with a colon followed by a space. There may also be additional whitespace before the colon: #+begin_example @@ -10085,17 +10085,17 @@ see [[Easy templates]] for shortcuts to easily insert code blocks.[fn:103] Both in ~example~ and in ~src~ snippets, you can add a ~-n~ switch to the end of the ~BEGIN~ line, to get the lines of the example numbered. If you use a ~+n~ switch, the numbering from the previous numbered -snippet will be continued in the current one. In literal examples, Org +snippet will be continued in the current one. In literal examples, Org will interpret strings like {{{samp((ref:name))}}} as labels, and use them as targets for special hyperlinks like ~[[(name)]]~ (i.e., the -reference name enclosed in single parenthesis). In HTML, hovering the +reference name enclosed in single parenthesis). In HTML, hovering the mouse over such a link will remote-highlight the corresponding code line, which is kind of cool. You can also add a ~-r~ switch which /removes/ the labels from the source code.[fn:104] With the ~-n~ switch, links to these references will be labeled by the line numbers from the code listing, otherwise -links will use the labels with no parentheses. Here is an example: +links will use the labels with no parentheses. Here is an example: #+begin_example #+BEGIN_SRC emacs-lisp -n -r @@ -10110,7 +10110,7 @@ links will use the labels with no parentheses. Here is an example: If the syntax for the label format conflicts with the language syntax, use a ~-l~ switch to change the format, for example -{{{samp(#+BEGIN_SRC pascal -n -r -l "((%s))")}}}. See also the +{{{samp(#+BEGIN_SRC pascal -n -r -l "((%s))")}}}. See also the variable ~org-coderef-label-format~. HTML export also allows examples to be published as text areas @@ -10124,10 +10124,10 @@ often, shortcuts are provided using the Easy Templates facility (see - {{{kbd(C-c ')}}} :: #+kindex: C-c ' - Edit the source code example at point in its native mode. This works - by switching to a temporary buffer with the source code. You need to + Edit the source code example at point in its native mode. This works + by switching to a temporary buffer with the source code. You need to exit by pressing {{{kbd(C-c ')}}} again.[fn:105] The edited version - will then replace the old version in the Org buffer. Fixed-width + will then replace the old version in the Org buffer. Fixed-width regions (where each line starts with a colon followed by a space) will be edited using ~artist-mode~ to allow creating ASCII drawings easily.[fn:106] Using this command in an empty line will create a new @@ -10138,9 +10138,9 @@ often, shortcuts are provided using the Easy Templates facility (see Calling ~org-store-link~ while editing a source code example in a temporary buffer created with {{{kbd(C-c ')}}} will prompt for a - label. Make sure that it is unique in the current buffer, and insert + label. Make sure that it is unique in the current buffer, and insert it with the proper formatting like {{{samp((ref:label))}}} at the end - of the current line. Then the label is stored as a link + of the current line. Then the label is stored as a link {{{samp((label))}}}, for retrieval with {{{kbd(C-c C-l)}}}. ** Include files @@ -10149,7 +10149,7 @@ often, shortcuts are provided using the Easy Templates facility (see :END: #+cindex: include files, markup rules -During export, you can include the content of another file. For +During export, you can include the content of another file. For example, to include your {{{file(.emacs)}}} file, you could use: #+cindex: #+INCLUDE @@ -10161,21 +10161,21 @@ example, to include your {{{file(.emacs)}}} file, you could use: {{{noindent}}} The optional second and third parameter are the markup (e.g., {{{samp(quote)}}}, {{{samp(example)}}}, or {{{samp(src)}}}), and, if the markup is {{{samp(src)}}}, the language for formatting the -contents. The markup is optional; if it is not given, the text will be -assumed to be in Org mode format and will be processed normally. The +contents. The markup is optional; if it is not given, the text will be +assumed to be in Org mode format and will be processed normally. The include line will also allow additional keyword parameters ~:prefix1~ and ~:prefix~ to specify prefixes for the first line and for each following line, ~:minlevel~ in order to get Org mode content demoted to a specified level, as well as any options accepted by the selected -markup. For example, to include a file as an item, use: +markup. For example, to include a file as an item, use: #+begin_example ,#+INCLUDE: "~/snippets/xx" :prefix1 " + " :prefix " " #+end_example You can also include a portion of a file by specifying a lines range -using the ~:lines~ parameter. The line at the upper end of the range -will not be included. The start and/or the end of the range may be +using the ~:lines~ parameter. The line at the upper end of the range +will not be included. The start and/or the end of the range may be omitted to use the obvious defaults. #+attr_texinfo: :table-type table :indic @asis @@ -10205,8 +10205,8 @@ omitted to use the obvious defaults. #+cindex: index entries, for publishing You can specify entries that will be used for generating an index -during publishing. This is done by lines starting with ~#+INDEX~. An -entry the contains an exclamation mark will create a sub item. See +during publishing. This is done by lines starting with ~#+INDEX~. An +entry the contains an exclamation mark will create a sub item. See [[Generating an index]] for more information. #+begin_example @@ -10251,7 +10251,7 @@ construct complex HTML code. Plain ASCII is normally sufficient for almost all note taking. Exceptions include scientific notes, which often require mathematical -symbols and the occasional formula. LaTeX is widely used to typeset +symbols and the occasional formula. LaTeX is widely used to typeset scientific documents.[fn:107] Org mode supports embedding LaTeX code into its files, because many academics are used to writing and reading LaTeX source code, and because it can be readily processed @@ -10270,9 +10270,9 @@ to produce pretty output for a number of export backends. You can use LaTeX macros to insert special symbols like ~\alpha~ to indicate the Greek letter, or ~\to~ to -indicate an arrow. Completion for these macros is available, just type +indicate an arrow. Completion for these macros is available, just type ~\~ and maybe a few letters, and press {{{kbdkey(M-,TAB)}}} -to see possible completions. Unlike LaTeX code, Org mode allows +to see possible completions. Unlike LaTeX code, Org mode allows these macros to be present without surrounding math delimiters, for example: @@ -10283,15 +10283,15 @@ example: #+vindex: org-entities During export, these symbols will be transformed into the native -format of the exporter backend. Strings like ~\alpha~ will be exported +format of the exporter backend. Strings like ~\alpha~ will be exported as ~α~ in the HTML output, and as ~$\alpha$~ in the LaTeX -output. Similarly, ~\nbsp~ will become ~ ~ in HTML and ~~~ in -LaTeX. If you need such a symbol inside a word, terminate it like +output. Similarly, ~\nbsp~ will become ~ ~ in HTML and ~~~ in +LaTeX. If you need such a symbol inside a word, terminate it like this: ~\Aacute{}stor~. A large number of entities is provided, with names taken from both HTML and LaTeX; see the variable ~org-entities~ for the complete -list. ~\-~ is treated as a shy hyphen, and {{{samp(--)}}}, +list. ~\-~ is treated as a shy hyphen, and {{{samp(--)}}}, {{{samp(---)}}}, and {{{samp(...)}}} are all converted into special commands creating hyphens of different lengths or a compact set of dots. @@ -10303,7 +10303,7 @@ following command:[fn:108] - {{{kbd(C-c C-x XXX)}}} :: #+kindex: C-c C-x XXX # Should be \ - Toggle display of entities as UTF-8 characters. This does not change + Toggle display of entities as UTF-8 characters. This does not change the buffer content which remains plain ASCII, but it overlays the UTF-8 character for display purposes only. @@ -10315,10 +10315,10 @@ following command:[fn:108] #+cindex: superscript Just like in LaTeX, {{{samp(^)}}} and {{{samp(_)}}} are used to -indicate super- and subscripts. Again, these can be used without -embedding them in math-mode delimiters. To increase the readability of +indicate super- and subscripts. Again, these can be used without +embedding them in math-mode delimiters. To increase the readability of ASCII text, it is not necessary (but OK) to surround multi-character -sub- and superscripts with curly braces. For example +sub- and superscripts with curly braces. For example #+begin_example The mass of the sun is M_sun = 1.989 x 10^30 kg. The radius of @@ -10328,10 +10328,10 @@ sub- and superscripts with curly braces. For example #+vindex: org-export-with-sub-superscripts To avoid interpretation as raised or lowered text, you can quote -{{{kbd(^)}}} and {{{kbd(_)}}} with a backslash: ~\^~ and ~\_~. If you +{{{kbd(^)}}} and {{{kbd(_)}}} with a backslash: ~\^~ and ~\_~. If you write a text where the underscore is often used in a different context, Org's convention to always interpret these as subscripts can -get in your way. Configure the variable +get in your way. Configure the variable ~org-export-with-sub-superscripts~ to globally change this convention, or use, on a per-file basis: @@ -10357,9 +10357,9 @@ subscript, but ~a_{b}~ will. #+vindex: org-format-latex-header Going beyond symbols and sub- and superscripts, a full formula -language is needed. Org mode can contain LaTeX math fragments, and -it supports ways to process these for several export backends. When -exporting to LaTeX, the code is obviously left as it is. When +language is needed. Org mode can contain LaTeX math fragments, and +it supports ways to process these for several export backends. When +exporting to LaTeX, the code is obviously left as it is. When exporting to HTML, Org invokes the [[http://www.mathjax.org][MathJax library]] (see [[Math formatting in HTML export]]) to process and display the math.[fn:109] Finally, it can also process the mathematical expressions into images @@ -10371,12 +10371,12 @@ snippets will be identified as LaTeX source code: - Environments of any kind.[fn:111] The only requirement is that the ~\begin~ statement appears on a new line, preceded by only whitespace. -- Text within the usual LaTeX math delimiters. To avoid conflicts +- Text within the usual LaTeX math delimiters. To avoid conflicts with currency specifications, single ~$~ characters are only recognized as math delimiters if the enclosed text contains at most two line breaks, is directly attached to the ~$~ characters with no whitespace in between, and if the closing - ~$~ is followed by whitespace, punctuation or a dash. For + ~$~ is followed by whitespace, punctuation or a dash. For the other delimiters, there is no such restriction, so when in doubt, use ~\(...\)~ as inline math delimiters. @@ -10403,9 +10403,9 @@ converter. #+vindex: org-export-with-LaTeX-fragments LaTeX processing can be configured with the variable -~org-export-with-LaTeX-fragments~. The default setting is ~t~ which +~org-export-with-LaTeX-fragments~. The default setting is ~t~ which means {{{file(MathJax)}}} for HTML, and no processing for DocBook, -ASCII and LaTeX backends. You can also set this variable on a +ASCII and LaTeX backends. You can also set this variable on a per-file basis using one of these lines: #+attr_texinfo: :table-type table :indic @asis @@ -10439,9 +10439,9 @@ processed to produce preview images of the typeset expressions: #+kindex: C-c C-x C-l 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). When called - with a prefix argument, process the entire subtree. When called with + it over the source code. If there is no fragment at point, process all + fragments in the current entry (between two headlines). When called + with a prefix argument, process the entire subtree. When called with two prefix arguments, or when the cursor is before the first headline, process the entire buffer. @@ -10454,7 +10454,7 @@ processed to produce preview images of the typeset expressions: #+vindex: org-format-latex-options You can customize the variable ~org-format-latex-options~ to influence -some aspects of the preview. In particular, the ~:scale~ (and for HTML +some aspects of the preview. In particular, the ~:scale~ (and for HTML export, ~:html-scale~) property can be used to adjust the size of the preview images. @@ -10467,13 +10467,13 @@ preview images. CDLaTeX mode is a minor mode that is normally used in combination with a major LaTeX mode like AUCTeX in order to speed-up -insertion of environments and math templates. Inside Org mode, you can -make use of some of the features of CDLaTeX mode. You need to +insertion of environments and math templates. Inside Org mode, you can +make use of some of the features of CDLaTeX mode. You need to install {{{file(cdlatex.el)}}} and {{{file(texmathp.el)}}} (the latter comes also with AUCTeX) from -[[http://www.astro.uva.nl/~dominik/Tools/cdlatex]]. Don't use CDLaTeX +[[http://www.astro.uva.nl/~dominik/Tools/cdlatex]]. Don't use CDLaTeX mode itself under Org mode, but use the light version -~org-cdlatex-mode~ that comes as part of Org mode. Turn it on for the +~org-cdlatex-mode~ that comes as part of Org mode. Turn it on for the current buffer with ~M-x org-cdlatex-mode~, or for all Org files with this hook: @@ -10497,12 +10497,12 @@ details see the documentation of CDLaTeX mode): Expand a template if the cursor is inside a LaTeX fragment.[fn:112] For example, {{{key(TAB)}}} will expand ~fr~ to ~\frac{}{}~ and - position the cursor correctly inside the first brace. Another - {{{key(TAB)}}} will get you into the second brace. Even outside + position the cursor correctly inside the first brace. Another + {{{key(TAB)}}} will get you into the second brace. Even outside fragments, {{{key(TAB)}}} will expand environment abbreviations at the - beginning of a line. For example, if you write {{{samp(equ)}}} at the + beginning of a line. For example, if you write {{{samp(equ)}}} at the beginning of a line and press {{{key(TAB)}}}, this abbreviation will - be expanded to an ~equation~ environment. To get a list of all + be expanded to an ~equation~ environment. To get a list of all abbreviations, type {{{kbd(M-x cdlatex-command-help)}}}. - {{{kbd(_)}}} {{{kbd(^)}}} :: @@ -10511,7 +10511,7 @@ details see the documentation of CDLaTeX mode): #+vindex: cdlatex-simplify-sub-super-scripts Pressing {{{kbd(_)}}} and {{{kbd(^)}}} inside a LaTeX fragment will - insert these characters together with a pair of braces. If you use + insert these characters together with a pair of braces. If you use {{{key(TAB)}}} to move out of the braces, and if the braces surround only a single character or macro, they are removed again (depending on the variable ~cdlatex-simplify-sub-super-scripts~). @@ -10520,14 +10520,14 @@ details see the documentation of CDLaTeX mode): #+kindex: ` Pressing the backquote followed by a character inserts math macros, - also outside LaTeX fragments. If you wait more than 1.5 seconds + also outside LaTeX fragments. If you wait more than 1.5 seconds after the backquote, a help window will pop up. - {{{kbd(')}}} :: #+kindex: ' Pressing the single-quote followed by another character modifies the - symbol before point with an accent or a font. If you wait more than + symbol before point with an accent or a font. If you wait more than 1.5 seconds after the single-quote, a help window will pop up. Character modification will work only inside LaTeX fragments; outside the quote is normal. @@ -10540,18 +10540,18 @@ details see the documentation of CDLaTeX mode): Org mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable -and simple version of an Org file. HTML export allows you to publish a +and simple version of an Org file. HTML export allows you to publish a notes file on the web, while the XOXO format provides a solid base for -exchange with a broad range of other applications. LaTeX export +exchange with a broad range of other applications. LaTeX export lets you use Org mode and its structured editing functions to easily -create LaTeX files. DocBook export makes it possible to convert Org -files to many other formats using DocBook tools. OpenDocument Text +create LaTeX files. DocBook export makes it possible to convert Org +files to many other formats using DocBook tools. OpenDocument Text (ODT) export allows seamless collaboration across organizational -boundaries. For project management you can create gantt and resource -charts by using TaskJuggler export. To incorporate entries with +boundaries. For project management you can create gantt and resource +charts by using TaskJuggler export. To incorporate entries with associated times like deadlines or appointments into a desktop calendar program like iCal, Org mode can also produce extracts in the -iCalendar format. Currently, Org mode only supports export, not import +iCalendar format. Currently, Org mode only supports export, not import of these different formats. Org supports export of selected regions when ~transient-mark-mode~ is @@ -10572,8 +10572,8 @@ or to exclude parts from export. This behavior is governed by two variables: respectively defaulting to ~:export:~ and ~:noexport:~. 1. Org first checks if any of the /select/ tags is present in the - buffer. If yes, all trees that do not carry one of these tags will - be excluded. If a selected tree is a subtree, the heading hierarchy + buffer. If yes, all trees that do not carry one of these tags will + be excluded. If a selected tree is a subtree, the heading hierarchy above it will also be selected for export, but not the text below those headings. @@ -10596,12 +10596,12 @@ variable for more information. #+cindex: completion, of option keywords The exporter recognizes special lines in the buffer which provide -additional information. These lines may be put anywhere in the file. +additional information. These lines may be put anywhere in the file. The whole set of lines can be inserted into the buffer with -{{{kbd(C-c C-e t)}}}. For individual lines, a good way to make sure the keyword +{{{kbd(C-c C-e t)}}}. For individual lines, a good way to make sure the keyword is correct is to type {{{samp(#+)}}} and then use {{{kbdkey(M-,TAB)}}} -completion (see [[Completion]]). For a summary of other in-buffer settings -not specifically related to export, see [[In-buffer settings]]. In +completion (see [[Completion]]). For a summary of other in-buffer settings +not specifically related to export, see [[In-buffer settings]]. In particular, note that you can place commonly-used (export) options in a separate file which can be included using ~#+SETUPFILE~. @@ -10677,7 +10677,7 @@ a separate file which can be included using ~#+SETUPFILE~. - #+BIND: :: - Lisp-var lisp-val, e.g., org-export-latex-low-levels itemize. You need + Lisp-var lisp-val, e.g., org-export-latex-low-levels itemize. You need to confirm using these, or configure ~org-export-allow-BIND~. - #+LINK_UP: :: @@ -10761,7 +10761,7 @@ export settings.[fn:114] Here you can: - ^: :: - Turn on/off TeX-like syntax for sub- and superscripts. If you write + Turn on/off TeX-like syntax for sub- and superscripts. If you write "^:{}", ~a_{b}~ will be interpreted, but the simple ~a_b~ will be left as it is. @@ -10836,7 +10836,7 @@ export, except for ~TeX~ and ~LaTeX~ options, which are respectively ~t~ and ~nil~ for the LaTeX export. The default values for these and many other options are given by a set -of variables. For a list of such variables, the corresponding OPTIONS +of variables. For a list of such variables, the corresponding OPTIONS keys and also the publishing keys (see [[Project alist]]), see the constant ~org-export-plist-vars~. @@ -10854,7 +10854,7 @@ overrule some of the file's export settings with properties All export commands can be reached using the export dispatcher, which is a prefix key that prompts for an additional key specifying the -command. Normally the entire file is exported, but if there is an +command. Normally the entire file is exported, but if there is an active region that contains one outline tree, the first heading is used as document title and the subtrees are exported. @@ -10863,9 +10863,9 @@ used as document title and the subtrees are exported. #+kindex: C-c C-e #+vindex: org-export-run-in-background - Dispatcher for export and publishing commands. Displays a help-window + Dispatcher for export and publishing commands. Displays a help-window listing the additional key(s) needed to launch an export or publishing - command. The prefix arg is passed through to the exporter. A double + command. The prefix arg is passed through to the exporter. A double prefix {{{kbd(C-u C-u)}}} causes most commands to be executed in the background, in a separate Emacs process.[fn:115] @@ -10892,7 +10892,7 @@ used as document title and the subtrees are exported. #+cindex: UTF-8 export ASCII export produces a simple and very readable version of an Org -mode file, containing only plain ASCII. Latin-1 and UTF-8 export +mode file, containing only plain ASCII. Latin-1 and UTF-8 export augment the file with special characters and symbols available in these encodings. @@ -10905,9 +10905,9 @@ these encodings. #+kindex: C-c C-e a #+cindex: property, EXPORT_FILE_NAME - Export as an ASCII file. For an Org file, {{{file(myfile.org)}}}, the - ASCII file will be {{{file(myfile.txt)}}}. The file will be - overwritten without warning. If there is an active region, only the + Export as an ASCII file. For an Org file, {{{file(myfile.org)}}}, the + ASCII file will be {{{file(myfile.txt)}}}. The file will be + overwritten without warning. If there is an active region, only the region will be exported.[fn:116] If the selected region is a single tree, the tree head will become the document title.[fn:117] If the tree head entry has or inherits an ~EXPORT_FILE_NAME~ property, that @@ -10950,8 +10950,8 @@ these encodings. #+cindex: headline levels, for exporting In the exported version, the first 3 outline levels will become -headlines, defining a general document structure. Additional levels -will be exported as itemized lists. If you want that transition to +headlines, defining a general document structure. Additional levels +will be exported as itemized lists. If you want that transition to occur at a different level, specify it with a prefix argument, e.g.: #+begin_example @@ -10959,18 +10959,18 @@ occur at a different level, specify it with a prefix argument, e.g.: #+end_example {{{noindent}}} This setting creates only top level headlines and -exports the rest as items. When headlines are converted to items, the +exports the rest as items. When headlines are converted to items, the indentation of the text following the headline is changed to fit -nicely under the item. This is done with the assumption that the first -body line indicates the base indentation of the body text. Any +nicely under the item. This is done with the assumption that the first +body line indicates the base indentation of the body text. Any indentation larger than this is adjusted to preserve the layout -relative to the first line. Should there be lines with less +relative to the first line. Should there be lines with less indentation than the first one, these are left alone. #+vindex: org-export-ascii-links-to-notes Links will be exported in a footnote-like style, with the descriptive -part in the text and the link in a note before the next heading. See +part in the text and the link in a note before the next heading. See the variable ~org-export-ascii-links-to-notes~ for details and other options. @@ -10998,9 +10998,9 @@ but with additional support for tables. #+kindex: C-c C-e h #+cindex: property, EXPORT_FILE_NAME - Export as an HTML file. For an Org file {{{file(myfile.org)}}}, the - HTML file will be {{{file(myfile.html)}}}. The file will be - overwritten without warning. If there is an active region, only the + Export as an HTML file. For an Org file {{{file(myfile.org)}}}, the + HTML file will be {{{file(myfile.html)}}}. The file will be + overwritten without warning. If there is an active region, only the active region will be exported.[fn:118] If the selected region is a single tree, the tree head will become the document title.[fn:119] If the tree head entry has, or inherits, an ~EXPORT_FILE_NAME~ property, @@ -11019,9 +11019,9 @@ but with additional support for tables. - {{{kbd(C-c C-e R)}}}, ~org-export-region-as-html~ :: #+kindex: C-c C-e R - Export the active region to a temporary buffer. With a prefix + Export the active region to a temporary buffer. With a prefix argument, do not produce the file header and footer, but just the - plain HTML section for the region. This is good for cut-and-paste + plain HTML section for the region. This is good for cut-and-paste operations. - {{{kbd(C-c C-e v h/b/H/R)}}} :: @@ -11035,7 +11035,7 @@ but with additional support for tables. - {{{kbd(M-x org-export-region-as-html)}}} :: Convert the region to HTML under the assumption that it was in Org - mode syntax before. This is a global command that can be invoked in + mode syntax before. This is a global command that can be invoked in any buffer. - {{{kbd(M-x org-replace-region-by-HTML)}}} :: @@ -11047,8 +11047,8 @@ but with additional support for tables. #+cindex: headline levels, for exporting In the exported version, the first three outline levels will become -headlines, defining a general document structure. Additional levels -will be exported as itemized lists. If you want that transition to +headlines, defining a general document structure. Additional levels +will be exported as itemized lists. If you want that transition to occur at a different level, specify it with a numeric prefix argument, e.g.: @@ -11091,9 +11091,9 @@ The default value for ~org-export-html-postamble~ is the value of ~org-export-author-info~, ~org-export-email-info~, ~org-export-creator-info~ and ~org-export-time-stamp-file~, ~org-export-html-validation-link~ and build the postamble from these -values. Setting ~org-export-html-postamble~ to ~t~ will insert the +values. Setting ~org-export-html-postamble~ to ~t~ will insert the postamble from the relevant format string found in -~org-export-html-postamble-format~. Setting it to ~nil~ will not +~org-export-html-postamble-format~. Setting it to ~nil~ will not insert any postamble. *** Quoting HTML tags @@ -11102,10 +11102,10 @@ insert any postamble. :END: Plain ~<~ and {{{samp(>)}}} are always transformed to -{{{samp(<)}}} and {{{samp(>)}}} in HTML export. If you want to +{{{samp(<)}}} and {{{samp(>)}}} in HTML export. If you want to include simple HTML tags which should be interpreted as such, mark -them with {{{samp(@)}}} as in {{{samp(@bold text@)}}}. Note -that this really works only for simple tags. For more extensive HTML +them with {{{samp(@)}}} as in {{{samp(@bold text@)}}}. Note +that this really works only for simple tags. For more extensive HTML that should be copied verbatim to the exported file use either ~#+HTML~: #+cindex: #+HTML @@ -11133,18 +11133,18 @@ that should be copied verbatim to the exported file use either ~#+HTML~: Internal links (see [[Internal links]]) will continue to work in HTML. This includes automatic links created by radio targets (see [[Radio -targets]]). Links to external files will still work if the target file -is on the same /relative/ path as the published Org file. Links to +targets]]). Links to external files will still work if the target file +is on the same /relative/ path as the published Org file. Links to other {{{file(.org)}}} files will be translated into HTML links under the assumption that a HTML version also exists of the linked file, at -the same relative path. ~id:~ links can then be used to jump -to specific entries across files. For information related to linking +the same relative path. ~id:~ links can then be used to jump +to specific entries across files. For information related to linking files while publishing them to a publishing directory see [[Publishing links]]. If you want to specify attributes for links, you can do so using a special ~#+ATTR_HTML~ line to define attributes that will be added to -the ~~ or ~~ tags. Here is an example that sets ~title~ and +the ~~ or ~~ tags. Here is an example that sets ~title~ and ~style~ attributes for a link: #+cindex: #+ATTR_HTML @@ -11161,8 +11161,8 @@ the ~~ or ~~ tags. Here is an example that sets ~title~ and #+vindex: org-export-html-table-tag Org mode tables are exported to HTML using the table tag defined in -~org-export-html-table-tag~. The default setting makes tables without -cell borders and frame. If you would like to change this for +~org-export-html-table-tag~. The default setting makes tables without +cell borders and frame. If you would like to change this for individual tables, place something like the following before the table: @@ -11182,13 +11182,13 @@ table: #+vindex: org-export-html-inline-images HTML export can inline images given as links in the Org file, and it -can make an image the clickable part of a link. By default, images are +can make an image the clickable part of a link. By default, images are inlined if a link does not have a description.[fn:120] So ~[[file:myimg.jpg]]~ will be inlined, while ~[[file:myimg.jpg][the image]]~ will just produce a link {{{samp(the image)}}} that points to -the image. If the description part itself is a ~file:~ link or +the image. If the description part itself is a ~file:~ link or a ~http:~ URL pointing to an image, this image will be inlined and -activated so that clicking on the image will activate the link. For +activated so that clicking on the image will activate the link. For example, to include a thumbnail that will link to a high resolution version of the image, you could use: @@ -11218,7 +11218,7 @@ support text viewers and accessibility, and align it to the right. #+cindex: dvipng LaTeX math snippets (see [[LaTeX fragments]]) can be displayed in two -different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax system]] +different ways on HTML pages. The default is to use the [[http://www.mathjax.org][MathJax system]] which should work out of the box with Org mode installation because ~http://orgmode.org~ serves {{{file(MathJax)}}} for Org mode users for small applications and for testing purposes.[fn:121] To configure @@ -11236,9 +11236,9 @@ this line. If you prefer, you can also request that LaTeX fragments are processed into small images that will be inserted into the browser -page. Before the availability of MathJax, this was the default method -for Org files. This method requires that the {{{file(dvipng)}}} -program is available on your system. You can still get this processing +page. Before the availability of MathJax, this was the default method +for Org files. This method requires that the {{{file(dvipng)}}} +program is available on your system. You can still get this processing with the following option: #+begin_example @@ -11253,12 +11253,12 @@ with the following option: An alternative way to publish literal code examples in HTML is to use text areas, where the example can even be edited before pasting it -into an application. It is triggered by a ~-t~ switch at an ~example~ -or ~src~ block. Using this switch disables any options for syntax and -label highlighting, and line numbering, which may be present. You may +into an application. It is triggered by a ~-t~ switch at an ~example~ +or ~src~ block. Using this switch disables any options for syntax and +label highlighting, and line numbering, which may be present. You may also use ~-h~ and ~-w~ switches to specify the height and width of the text area, which default to the number of lines in the example, and -80, respectively. For example +80, respectively. For example #+begin_example ,#+BEGIN_EXAMPLE -t -w 40 @@ -11277,7 +11277,7 @@ text area, which default to the number of lines in the example, and #+vindex: org-export-html-todo-kwd-class-prefix #+vindex: org-export-html-tag-class-prefix -You can also give style information for the exported file. The HTML +You can also give style information for the exported file. The HTML exporter assigns the following special CSS classes to appropriate parts of the document---your style specifications may change these, in addition to any of the standard classes like for headlines, tables, @@ -11331,11 +11331,11 @@ individually for each file, you can use a ~#+STYLE:~ line: #+end_example {{{noindent}}} For longer style definitions, you can use several such -lines. You could also directly write a ~~ section in +lines. You could also directly write a ~~ section in this way, without referring to an external file. In order to add styles to a subtree, use the ~:HTML_CONTAINER_CLASS:~ -property to assign a class to the tree. In order to specify CSS styles +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 a ~:CUSTOM_ID:~ property. @@ -11362,9 +11362,9 @@ not want to be dependent on ~orgmode.org~ and prefer to install a local copy on your own web server. To use the script, you need to make sure that the -{{{file(org-jsinfo.el)}}} module gets loaded. It should be loaded by +{{{file(org-jsinfo.el)}}} module gets loaded. It should be loaded by default, but you can try {{{ksksksk(M-x customize-variable,RET,org-modules,RET)}}} -to convince yourself that this is indeed the case. All it then takes to make use of the program +to convince yourself that this is indeed the case. All it then takes to make use of the program is adding a single line to the Org file: #+cindex: #+INFOJS_OPT @@ -11373,7 +11373,7 @@ is adding a single line to the Org file: #+end_example {{{noindent}}} If this line is found, the HTML header will -automatically contain the code needed to invoke the script. Using the +automatically contain the code needed to invoke the script. Using the line above, you can set the following viewing options: #+attr_texinfo: :table-type table :indic @code @@ -11395,8 +11395,8 @@ line above, you can set the following viewing options: - sdepth: :: Maximum headline level that will still become an independent section - for info and folding modes. The default is taken from - ~org-export-headline-levels~ (= the ~H~ switch in ~#+OPTIONS~). If + for info and folding modes. The default is taken from + ~org-export-headline-levels~ (= the ~H~ switch in ~#+OPTIONS~). If this is smaller than in ~org-export-headline-levels~, each info/folding section can still contain child headlines. @@ -11407,7 +11407,7 @@ line above, you can set the following viewing options: - tdepth: :: - The depth of the table of contents. The defaults are taken from the + The depth of the table of contents. The defaults are taken from the variables ~org-export-headline-levels~ and ~org-export-with-toc~. - ftoc: :: @@ -11422,7 +11422,7 @@ line above, you can set the following viewing options: - mouse: :: - Headings are highlighted when the mouse is over them. Should be + Headings are highlighted when the mouse is over them. Should be {{{samp(underline)}}} (default) or a background color like {{{samp(#cccccc)}}}. @@ -11436,7 +11436,7 @@ line above, you can set the following viewing options: #+vindex: org-export-html-use-infojs {{{noindent}}} You can choose default values for these options by -customizing the variable ~org-infojs-options~. If you always want to +customizing the variable ~org-infojs-options~. If you always want to apply the script to your pages, configure the variable ~org-export-html-use-infojs~. @@ -11448,11 +11448,11 @@ apply the script to your pages, configure the variable #+cindex: PDF export #+cindex: Guerry, Bastien -Org mode contains a LaTeX exporter written by Bastien Guerry. With +Org mode contains a LaTeX exporter written by Bastien Guerry. With further processing, this backend is also used to produce PDF output.[fn:124] Since the LaTeX output uses {{{file(hyperref)}}} to implement links and cross references, the PDF output file will be -fully linked. Beware of the fact that your ~org~ file has to be +fully linked. Beware of the fact that your ~org~ file has to be properly structured in order to be correctly exported: respect the hierarchy of sections. @@ -11469,9 +11469,9 @@ hierarchy of sections. #+kindex: C-c C-e l #+cindex: property EXPORT_FILE_NAME - Export as a LaTeX file. For an Org file {{{file(myfile.org)}}}, the - LaTeX file will be {{{file(myfile.tex)}}}. The file will be - overwritten without warning. If there is an active region, only the + Export as a LaTeX file. For an Org file {{{file(myfile.org)}}}, the + LaTeX file will be {{{file(myfile.tex)}}}. The file will be + overwritten without warning. If there is an active region, only the active region will be exported.[fn:125] If the selected region is a single tree, the tree head will become the document title.[fn:126] If the tree head entry has or inherits an ~EXPORT_FILE_NAME~ property, @@ -11489,7 +11489,7 @@ hierarchy of sections. - {{{kbd(M-x org-export-region-as-latex)}}} :: Convert the region to LaTeX under the assumption that it was in Org - mode syntax before. This is a global command that can be invoked in + mode syntax before. This is a global command that can be invoked in any buffer. - {{{kbd(M-x org-replace-region-by-latex)}}} :: @@ -11513,8 +11513,8 @@ hierarchy of sections. #+vindex: org-latex-low-levels In the exported version, the first 3 outline levels will become -headlines, defining a general document structure. Additional levels -will be exported as description lists. The exporter can ignore them or +headlines, defining a general document structure. Additional levels +will be exported as description lists. The exporter can ignore them or convert them to a custom string depending on ~org-latex-low-levels~. If you want that transition to occur at a different level, specify it @@ -11554,16 +11554,16 @@ You can change this globally by setting a different value for ~org-export-latex-default-class~ or locally by adding an option like ~#+LaTeX_CLASS: myclass~ in your file, or with a ~:LaTeX_CLASS:~ property that applies when exporting a region containing only this -(sub)tree. The class must be listed in ~org-export-latex-classes~. +(sub)tree. The class must be listed in ~org-export-latex-classes~. This variable defines a header template for each class, and allows you to define the sectioning structure for each class.[fn:127] You can -also define your own classes there. ~#+LaTeX_CLASS_OPTIONS~ or a +also define your own classes there. ~#+LaTeX_CLASS_OPTIONS~ or a ~:LaTeX_CLASS_OPTIONS:~ property can specify the options for the -~\documentclass~ macro. The options to documentclass have to be -provided, as expected by LaTeX, within square brackets. You can +~\documentclass~ macro. The options to documentclass have to be +provided, as expected by LaTeX, within square brackets. You can also use ~#+LaTeX_HEADER: \usepackage{xyz}~ to add lines to the -header. See the docstring of ~org-export-latex-classes~ for more -information. An example is shown below. +header. See the docstring of ~org-export-latex-classes~ for more +information. An example is shown below. #+begin_example ,#+LaTeX_CLASS: article @@ -11580,8 +11580,8 @@ information. An example is shown below. :END: Embedded LaTeX as described in [[Embedded LaTeX]], will be correctly -inserted into the LaTeX file. This includes simple macros like -~\ref{LABEL}~ to create a cross reference to a figure. Furthermore, +inserted into the LaTeX file. This includes simple macros like +~\ref{LABEL}~ to create a cross reference to a figure. Furthermore, you can add special code that should only be present in LaTeX export with the following constructs: @@ -11649,24 +11649,24 @@ or to specify a multicolumn table with ~tabulary~: Images that are linked to without a description part in the link, like ~[[file:img.jpg]]~ or ~[[./img.jpg]]~ will be inserted into the PDF -output file resulting from LaTeX processing. Org will use an -~\includegraphics~ macro to insert the image. If you have specified +output file resulting from LaTeX processing. Org will use an +~\includegraphics~ macro to insert the image. If you have specified a caption and/or a label as described in [[Images and tables]], the figure will be wrapped into a ~figure~ environment and thus become -a floating element. You can use an ~#+ATTR_LaTeX:~ line to specify -various other options. You can ask org to export an image as a float +a floating element. You can use an ~#+ATTR_LaTeX:~ line to specify +various other options. You can ask org to export an image as a float without specifying a label or a caption by using the keyword ~float~ -in this line. Various optional arguments to the ~\includegraphics~ -macro can also be specified in this fashion. To modify the placement +in this line. Various optional arguments to the ~\includegraphics~ +macro can also be specified in this fashion. To modify the placement option of the floating environment, add something like -{{{samp(placement=[h!])}}} to the attributes. It is to be noted this +{{{samp(placement=[h!])}}} to the attributes. It is to be noted this option can be used with tables as well.[fn:128] If you would like to let text flow around the image, add the word {{{samp(wrap)}}} to the ~#+ATTR_LaTeX:~ line, which will make the -figure occupy the left half of the page. To fine-tune, the ~placement~ +figure occupy the left half of the page. To fine-tune, the ~placement~ field will be the set of additional arguments needed by the -~wrapfigure~ environment. Note that if you change the size of the +~wrapfigure~ environment. Note that if you change the size of the image, you need to use compatible settings for ~\includegraphics~ and ~wrapfigure~. @@ -11696,7 +11696,7 @@ If you need references to a label created in this way, write :END: The LaTeX class {{{file(beamer)}}} allows production of high -quality presentations using LaTeX and pdf processing. Org mode has +quality presentations using LaTeX and pdf processing. Org mode has special support for turning an Org mode file or tree into a {{{file(beamer)}}} presentation. @@ -11713,7 +11713,7 @@ structure of the presentation. A template for useful in-buffer settings or properties can be inserted into the buffer with -{{{kbd(M-x org-insert-beamer-options-template)}}}. Among other things, this will +{{{kbd(M-x org-insert-beamer-options-template)}}}. Among other things, this will install a column view format which is very handy for editing special properties used by beamer. @@ -11723,44 +11723,44 @@ properties: #+attr_texinfo: :table-type table :indic @asis - ~BEAMER_env~ :: - The environment that should be used to format this entry. Valid + The environment that should be used to format this entry. Valid environments are defined in the constant ~org-beamer-environments-default~, and you can define more in - ~org-beamer-environments-extra~. If this property is set, the entry - will also get a ~:B_environment:~ tag to make this visible. This tag + ~org-beamer-environments-extra~. If this property is set, the entry + will also get a ~:B_environment:~ tag to make this visible. This tag has no semantic meaning, it is only a visual aid. - ~BEAMER_envargs~ :: The beamer-special arguments that should be used for the environment, - like ~[t]~ or ~[<+->]~ of ~<2-3>~. If the ~BEAMER_col~ property is + like ~[t]~ or ~[<+->]~ of ~<2-3>~. If the ~BEAMER_col~ property is also set, something like ~C[t]~ can be added here as well to set an - options argument for the implied ~columns~ environment. ~c[t]~ or + options argument for the implied ~columns~ environment. ~c[t]~ or ~c<2->~ will set an options for the implied ~column~ environment. - ~BEAMER_col~ :: - The width of a column that should start with this entry. If this + The width of a column that should start with this entry. If this property is set, the entry will also get a ~:BMCOL:~ property to make - this visible. Also this tag is only a visual aid. When this is a plain + this visible. Also this tag is only a visual aid. When this is a plain number, it will be interpreted as a fraction of ~\textwidth~. Otherwise it will be assumed that you have specified the units, like - {{{samp(3cm)}}}. The first such property in a frame will start a - ~columns~ environment to surround the columns. This environment is + {{{samp(3cm)}}}. The first such property in a frame will start a + ~columns~ environment to surround the columns. This environment is closed when an entry has a ~BEAMER_col~ property with value 0 or 1, or automatically at the end of the frame. - ~BEAMER_extra~ :: Additional commands that should be inserted after the environment has - been opened. For example, when creating a frame, this can be used to + been opened. For example, when creating a frame, this can be used to specify transitions. Frames will automatically receive a ~fragile~ option if they contain source code that uses the verbatim environment. Special {{{file(beamer)}}} specific code can be inserted using ~#+BEAMER:~ and -~#+BEGIN_BEAMER~ ... ~#+END_BEAMER~ constructs, similar to other export +~#+BEGIN_BEAMER~ ... ~#+END_BEAMER~ constructs, similar to other export backends, but with the difference that ~#+LaTeX:~ stuff will be included in the presentation as well. @@ -11788,8 +11788,8 @@ support with the following line: Column view provides a great way to set the environment of a node and -other important parameters. Make sure you are using a COLUMN format -that is geared toward this special purpose. The command +other important parameters. Make sure you are using a COLUMN format +that is geared toward this special purpose. The command {{{kbd(M-x org-insert-beamer-options-template)}}} defines such a format. Here is a simple example Org document that is intended for beamer export. @@ -11859,9 +11859,9 @@ Currently DocBook exporter only supports DocBook V5.0. #+kindex: C-c C-e D #+cindex: property EXPORT_FILE_NAME - Export as a DocBook file. For an Org file, {{{file(myfile.org)}}}, the - DocBook XML file will be {{{file(myfile.xml)}}}. The file will be - overwritten without warning. If there is an active region, only the + Export as a DocBook file. For an Org file, {{{file(myfile.org)}}}, the + DocBook XML file will be {{{file(myfile.xml)}}}. The file will be + overwritten without warning. If there is an active region, only the region will be exported.[fn:129] If the selected region is a single tree, the tree head will become the document title.[fn:130] If the tree head entry has, or inherits, an ~EXPORT_FILE_NAME~ property, that @@ -11878,7 +11878,7 @@ Currently DocBook exporter only supports DocBook V5.0. Note that, in order to produce PDF output based on an exported DocBook file, you need to have XSLT processor and XSL-FO processor software - installed on your system. Check variables + installed on your system. Check variables ~org-export-docbook-xslt-proc-command~ and ~org-export-docbook-xsl-fo-proc-command~. @@ -11940,10 +11940,10 @@ exported DocBook XML files invalid by not quoting DocBook code correctly. #+cindex: DocBook recursive sections DocBook exporter exports Org files as articles using the ~article~ -element in DocBook. Recursive sections, i.e., ~section~ elements, are -used in exported articles. Top level headlines in Org files are +element in DocBook. Recursive sections, i.e., ~section~ elements, are +used in exported articles. Top level headlines in Org files are exported as top level sections, and lower level headlines are exported -as nested sections. The entire structure of Org files will be exported +as nested sections. The entire structure of Org files will be exported completely, no matter how many nested levels of headlines there are. Using recursive sections makes it easy to port and reuse exported @@ -11971,10 +11971,10 @@ generated using the ~table~ element. Images that are linked to without a description part in the link, like ~[[file:img.jpg]]~ or ~[[./img.jpg]]~, will be exported to -DocBook using ~mediaobject~ elements. Each ~mediaobject~ element -contains an ~imageobject~ that wraps an ~imagedata~ element. If you +DocBook using ~mediaobject~ elements. Each ~mediaobject~ element +contains an ~imageobject~ that wraps an ~imagedata~ element. If you have specified a caption for an image as described in [[Images and -tables]], a ~caption~ element will be added in ~mediaobject~. If a label +tables]], a ~caption~ element will be added in ~mediaobject~. If a label is also specified, it will be exported as an ~xml:id~ attribute of the ~mediaobject~ element. @@ -11983,7 +11983,7 @@ is also specified, it will be exported as an ~xml:id~ attribute of the Image attributes supported by the ~imagedata~ element, like ~align~ or ~width~, can be specified in two ways: you can either customize variable ~org-export-docbook-default-image-attributes~ or use the -~#+ATTR_DOCBOOK:~ line. Attributes specified in variable +~#+ATTR_DOCBOOK:~ line. Attributes specified in variable ~org-export-docbook-default-image-attributes~ are applied to all inline images in the Org file to be exported (unless they are overridden by image attributes specified in ~#+ATTR_DOCBOOK:~ lines). @@ -11992,7 +11992,7 @@ The ~#+ATTR_DOCBOOK:~ line can be used to specify additional image attributes or override default image attributes for individual images. If the same attribute appears in both the ~#+ATTR_DOCBOOK:~ line and variable ~org-export-docbook-default-image-attributes~, the former -takes precedence. Here is an example about how image attributes can be +takes precedence. Here is an example about how image attributes can be set: #+cindex: #+CAPTION @@ -12009,7 +12009,7 @@ set: By default, DocBook exporter recognizes the following image file types: {{{file(jpeg)}}}, {{{file(jpg)}}}, {{{file(png)}}}, -{{{file(gif)}}}, and {{{file(svg)}}}. You can customize variable +{{{file(gif)}}}, and {{{file(svg)}}}. You can customize variable ~org-export-docbook-inline-image-extensions~ to add more types to this list as long as DocBook supports them. @@ -12025,11 +12025,11 @@ Special characters that are written in TeX-like syntax, such as ~\alpha~, ~\Gamma~, and ~\Zeta~, are supported by DocBook exporter. These characters are rewritten to XML entities, like ~α~, ~Γ~, and ~Ζ~, based on the list saved in variable -~org-entities~. As long as the generated DocBook file includes the +~org-entities~. As long as the generated DocBook file includes the corresponding entities, these special characters are recognized. You can customize variable ~org-export-docbook-doctype~ to include the -entities you need. For example, you can set variable +entities you need. For example, you can set variable ~org-export-docbook-doctype~ to the following value to recognize all special characters included in XHTML entities: @@ -12068,7 +12068,7 @@ are compatible with LibreOffice 3.4.[fn:132] #+cindex: zip The ODT exporter relies on the {{{file(zip)}}} program to create the -final output. Check the availability of this program before proceeding +final output. Check the availability of this program before proceeding further. *** ODT export commands @@ -12092,11 +12092,11 @@ further. #+vindex: org-export-odt-preferred-output-format If ~org-export-odt-preferred-output-format~ is specified, - automatically convert the exported file to that format. See + automatically convert the exported file to that format. See [[Automatically exporting to other formats]]. For an Org file {{{file(myfile.org)}}}, the ODT file will be - {{{file(myfile.odt)}}}. The file will be overwritten without warning. + {{{file(myfile.odt)}}}. The file will be overwritten without warning. If there is an active region, only the region will be exported.[fn:133] If the selected region is a single tree, the tree head will become the document title.[fn:134] If the tree head entry @@ -12119,7 +12119,7 @@ further. :END: The ODT exporter can interface with a variety of document converters -and supports popular converters out of the box. As a result, you can +and supports popular converters out of the box. As a result, you can use it to export to formats like {{{samp(doc)}}} or convert a document from one format (say {{{samp(csv)}}}) to another format (say {{{samp(ods)}}} or {{{samp(xls)}}}). @@ -12128,12 +12128,12 @@ from one format (say {{{samp(csv)}}}) to another format (say #+cindex: LibreOffice If you have a working installation of LibreOffice, a document -converter is pre-configured for you and you can use it right away. If +converter is pre-configured for you and you can use it right away. If you would like to use {{{file(unoconv)}}} as your preferred converter, customize the variable ~org-export-odt-convert-process~ to point to -~unoconv~. You can also use your own favorite converter or tweak the +~unoconv~. You can also use your own favorite converter or tweak the default settings of the {{{file(LibreOffice)}}} and -{{{samp(unoconv)}}} converters. See [[Configuring a document converter]]. +{{{samp(unoconv)}}} converters. See [[Configuring a document converter]]. **** Automatically exporting to other formats :PROPERTIES: @@ -12146,7 +12146,7 @@ default settings of the {{{file(LibreOffice)}}} and Very often, you will find yourself exporting to ODT format, only to immediately save the exported document to other formats like {{{samp(doc)}}}, {{{samp(docx)}}}, {{{samp(rtf)}}}, {{{samp(pdf)}}} -etc. In such cases, you can specify your preferred output format by +etc. In such cases, you can specify your preferred output format by customizing the variable ~org-export-odt-preferred-output-format~. This way, the export commands (see [[x-export-to-odt][Exporting to ODT]]) can be extended to export to a format that is of immediate interest to @@ -12160,15 +12160,15 @@ you. There are many document converters in the wild that support conversion to and from various file formats, including, but not -limited to the ODT format. LibreOffice converter, mentioned above, is -one such converter. Once a converter is configured, you can interact +limited to the ODT format. LibreOffice converter, mentioned above, is +one such converter. Once a converter is configured, you can interact with it using the following command. #+attr_texinfo: :table-type table :indic @asis - {{{kbd(M-x org-export-odt-convert)}}} :: #+vindex: org-export-odt-convert - Convert an existing document from one format to another. With a prefix + Convert an existing document from one format to another. With a prefix argument, also open the newly produced file. *** Applying custom styles @@ -12183,7 +12183,7 @@ The ODT exporter ships with a set of OpenDocument styles These factory styles, however, may not cater to your specific tastes. To customize the output, you can either modify the above styles files directly, or generate the required styles using an application like -LibreOffice. The latter method is suitable for expert and non-expert +LibreOffice. The latter method is suitable for expert and non-expert users alike, and is described here. Custom styles can be applied in three easy steps: @@ -12195,7 +12195,7 @@ Custom styles can be applied in three easy steps: ,#+OPTIONS: H:10 num:t #+end_example -2. Open the above {{{file(example.odt)}}} using LibreOffice. Use the +2. Open the above {{{file(example.odt)}}} using LibreOffice. Use the {{{file(Stylist)}}} to locate the target styles---these typically have the {{{samp(Org)}}} prefix---and modify those to your taste. Save the modified file either as an OpenDocument Text @@ -12203,14 +12203,14 @@ Custom styles can be applied in three easy steps: file. 3. Customize the variable ~org-export-odt-styles-file~ and point it to - the newly created file. For additional configuration options see + the newly created file. For additional configuration options see [[x-overriding-factory-styles][Overriding factory styles]]. #+cindex: #+ODT_STYLES_FILE #+vindex: org-export-odt-styles-file If you would like to choose a style on a per-file basis, you can use - the ~#+ODT_STYLES_FILE~ option. A typical setting will look like + the ~#+ODT_STYLES_FILE~ option. A typical setting will look like one of these two examples: #+begin_example @@ -12226,8 +12226,8 @@ Custom styles can be applied in three easy steps: Although you can use third-party styles and templates for customizing your output, this will produce the desired output only if the template provides all style names that the {{{samp(ODT)}}} exporter relies -upon. Unless this condition is met, the output is going to be less -than satisfactory. It is highly recommended that you only work with +upon. Unless this condition is met, the output is going to be less +than satisfactory. It is highly recommended that you only work with templates that are directly derived from the factory settings. *** Links in ODT export @@ -12236,15 +12236,15 @@ templates that are directly derived from the factory settings. :END: #+cindex: tables, in DocBook export -ODT exporter creates native cross-references for internal links. It +ODT exporter creates native cross-references for internal links. It creates Internet-style links for all other links. A link with no description and destined to a regular (un-itemized) outline heading is replaced with a cross-reference and section number of the heading. -A ~\ref{label}~-style reference to an image, table etc. is replaced -with a cross-reference and sequence number of the labeled entity. See +A ~\ref{label}~-style reference to an image, table etc. is replaced +with a cross-reference and sequence number of the labeled entity. See [[Labels and captions in ODT export]]. *** Tables in ODT export @@ -12255,14 +12255,14 @@ with a cross-reference and sequence number of the labeled entity. See #+cindex: tables, in DocBook export Export of native Org mode tables (see [[Tables]]) and simple -{{{file(table.el)}}} tables is supported. However, export of complex +{{{file(table.el)}}} tables is supported. However, export of complex {{{file(table.el)}}} tables---tables that have column or row -spans---is not supported. Such tables are stripped from the exported +spans---is not supported. Such tables are stripped from the exported document. By default, a table is exported with top and bottom frames and with rules separating row and column groups (see [[Column groups]]). -Furthermore, all tables are typeset to occupy the same width. If the +Furthermore, all tables are typeset to occupy the same width. If the table specifies alignment and relative width for its columns (see [[Column width and alignment]]) then these are honored on export.[fn:135] @@ -12287,16 +12287,16 @@ rules mentioned above. | Sum | 16 | 123 | 2560 | 2699 | #+end_example -On export, the table will occupy 50% of text area. The columns will be -sized (roughly) in the ratio of 13:5:5:5:6. The first column will be -left-aligned and rest of the columns will be right-aligned. There will +On export, the table will occupy 50% of text area. The columns will be +sized (roughly) in the ratio of 13:5:5:5:6. The first column will be +left-aligned and rest of the columns will be right-aligned. There will be vertical rules after separating the header and last columns from -other columns. There will be horizontal rules separating the header +other columns. There will be horizontal rules separating the header and last rows from other rows. If you are not satisfied with the above formatting options, you can create custom table styles and associate them with a table using the -~#+ATTR_ODT~ line. See [[Customizing tables in ODT export]]. +~#+ATTR_ODT~ line. See [[Customizing tables in ODT export]]. *** Images in ODT export :PROPERTIES: @@ -12318,7 +12318,7 @@ desired image file with no link description. For example, to embed #+end_example You can create clickable images by providing a link whose description -is a link to an image file. For example, to embed an image +is a link to an image file. For example, to embed an image {{{file(org-mode-unicorn.png)}}}, which when clicked jumps to [[http://Orgmode.org]] website, do the following: @@ -12335,13 +12335,13 @@ You can control the size and scale of the embedded images using the #+vindex: org-export-odt-pixels-per-inch The exporter specifies the desired size of the image in the final -document in units of centimeters. In order to scale the embedded +document in units of centimeters. In order to scale the embedded images, the exporter queries for pixel dimensions of the images using either ImageMagick's {{{file(identify)}}} program, or Emacs' `create-image' and `image-size' APIs.[fn:136] The pixel dimensions are subsequently converted to centimeters using -~org-export-odt-pixels-per-inch~. The default value of this variable -is set to ~display-pixels-per-inch~. You can tweak this variable to +~org-export-odt-pixels-per-inch~. The default value of this variable +is set to ~display-pixels-per-inch~. You can tweak this variable to achieve the best results. The examples below illustrate the various possibilities. @@ -12389,7 +12389,7 @@ The examples below illustrate the various possibilities. #+cindex: #+ATTR_ODT You can control the manner in which an image is anchored by setting -the ~:anchor~ property of it's ~#+ATTR_ODT~ line. You can specify one +the ~:anchor~ property of it's ~#+ATTR_ODT~ line. You can specify one of the the following three values for the ~:anchor~ property - {{{samp("as-char")}}}, {{{samp("paragraph")}}} and {{{samp("page")}}}. @@ -12473,7 +12473,7 @@ document in one of the following ways: #+end_example With this option, LaTeX fragments are processed into PNG images and - the resulting images are embedded in the exported document. This + the resulting images are embedded in the exported document. This method requires that the {{{file(dvipng)}}} program be available on your system. @@ -12483,7 +12483,7 @@ document in one of the following ways: :END: For various reasons, you may find embedding LaTeX math snippets in -an ODT document less than reliable. In that case, you can embed a math +an ODT document less than reliable. In that case, you can embed a math equation by linking to its MathML ({{{file(.mml)}}}) source or its OpenDocument formula ({{{file(.odf)}}}) file as shown below: @@ -12504,13 +12504,13 @@ or You can label and caption various category of objects---an inline image, a table, a LaTeX fragment or a Math formula---using -~#+LABEL~ and ~#+CAPTION~ lines. See [[Images and tables]]. ODT exporter +~#+LABEL~ and ~#+CAPTION~ lines. See [[Images and tables]]. ODT exporter enumerates each labeled or captioned object of a given category -separately. As a result, each such object is assigned a sequence +separately. As a result, each such object is assigned a sequence number based on order of its appearance in the Org file. In the exported document, a user-provided caption is augmented with -the category and sequence number. Consider the following inline image +the category and sequence number. Consider the following inline image in an Org file: #+begin_example @@ -12528,7 +12528,7 @@ It could be rendered as shown below in the exported document. #+vindex: org-export-odt-category-strings You can modify the category component of the caption by customizing -the variable ~org-export-odt-category-strings~. For example, to tag +the variable ~org-export-odt-category-strings~. For example, to tag all embedded images with the string {{{samp(Illustration)}}} (instead of the default {{{samp(Figure)}}}) use the following setting. @@ -12552,7 +12552,7 @@ document. :END: Export of literal examples (see [[Literal examples]]) with full -fontification is supported. Internally, the exporter relies on +fontification is supported. Internally, the exporter relies on {{{file(htmlfontify.el)}}} to generate all style definitions needed for a fancy listing.[fn:138] The auto-generated styles have {{{samp(OrgSrc)}}} as prefix and inherit their color from the faces @@ -12575,7 +12575,7 @@ variable ~org-export-odt-fontify-srcblocks~. :END: If you rely heavily on ODT export, you may want to exploit the full -set of features that the exporter offers. This section describes +set of features that the exporter offers. This section describes features that would be of interest to power users. **** Configuring a document converter @@ -12587,7 +12587,7 @@ features that would be of interest to power users. #+cindex: converter The ODT exporter can work with popular converters with little or no -extra configuration from your side. See [[Extending ODT export]]. If you +extra configuration from your side. See [[Extending ODT export]]. If you are using a converter that is not supported by default or if you would like to tweak the default converter settings, proceed as below. @@ -12597,7 +12597,7 @@ like to tweak the default converter settings, proceed as below. #+vindex: org-export-odt-convert-processes Name your converter and add it to the list of known converters by - customizing the variable ~org-export-odt-convert-processes~. Also + customizing the variable ~org-export-odt-convert-processes~. Also specify how the converter can be invoked via command-line to effect the conversion. @@ -12628,7 +12628,7 @@ like to tweak the default converter settings, proceed as below. #+cindex: template, custom This section explores the internals of the ODT exporter and the means -by which it produces styled documents. Read this section if you are +by which it produces styled documents. Read this section if you are interested in exploring the automatic and custom OpenDocument styles used by the exporter. @@ -12643,7 +12643,7 @@ by the variable ~org-odt-styles-dir~. The two files are: <> This file contributes to the {{{file(styles.xml)}}} file of the final - {{{samp(ODT)}}} document. This file is modified to control outline + {{{samp(ODT)}}} document. This file is modified to control outline numbering based on user settings, and To add styles generated by {{{file(htmlfontify.el)}}} for fontification of code blocks. @@ -12651,14 +12651,14 @@ by the variable ~org-odt-styles-dir~. The two files are: <> This file contributes to the {{{file(content.xml)}}} file of the final - {{{samp(ODT)}}} document. The contents of the Org outline are inserted + {{{samp(ODT)}}} document. The contents of the Org outline are inserted between the ~~ and ~~ elements of this file. In addition to serving as a template file for the final {{{file(content.xml)}}}, the file also contains automatic styles for formatting of tables which are referenced by the exporter, and - ~~ ... ~~ + ~~ ... ~~ elements that control how various entities---tables, images, equations, etc.---are numbered. @@ -12666,7 +12666,7 @@ by the variable ~org-odt-styles-dir~. The two files are: <> The following two variables control the location from which the ODT -exporter picks up the custom styles and content template files. You +exporter picks up the custom styles and content template files. You can customize these variables to override the factory styles used by the exporter. @@ -12675,7 +12675,7 @@ the exporter. <> Use this variable to specify the {{{file(styles.xml)}}} that will be - used in the final output. You can specify one of the following values: + used in the final output. You can specify one of the following values: - A {{{file(styles.xml)}}} file :: @@ -12689,7 +12689,7 @@ the exporter. - A {{{file(.odt)}}} or {{{file(.ott)}}} file and a subset of files contained within them :: Use the {{{file(styles.xml)}}} contained in the specified OpenDocument - Text or Template file. Additionally extract the specified member files + Text or Template file. Additionally extract the specified member files and embed those within the final {{{samp(ODT)}}} document. Use this option if the {{{file(styles.xml)}}} file references @@ -12711,15 +12711,15 @@ the exporter. :END: There are times when you would want one-off formatting in the exported -document. You can achieve this by embedding raw OpenDocument XML in -the Org file. The use of this feature is better illustrated with +document. You can achieve this by embedding raw OpenDocument XML in +the Org file. The use of this feature is better illustrated with couple of examples. #+attr_texinfo: :table-type table :indic @asis - Embedding ODT tags as part of regular text :: You can include simple OpenDocument tags by prefixing them with - {{{samp(@)}}}. For example, to highlight a region of text do the + {{{samp(@)}}}. For example, to highlight a region of text do the following: #+begin_example @@ -12761,7 +12761,7 @@ couple of examples. - Embedding a block of OpenDocument XML :: You can add a large block of OpenDocument XML using the - ~#+BEGIN_ODT~ ... ~#+END_ODT~ construct. + ~#+BEGIN_ODT~ ... ~#+END_ODT~ construct. For example, to create a one-off paragraph that uses bold text, do the following: @@ -12782,7 +12782,7 @@ couple of examples. #+cindex: #+ATTR_ODT You can override the default formatting of the table by specifying a -custom table style with the ~#+ATTR_ODT~ line. For a discussion on +custom table style with the ~#+ATTR_ODT~ line. For a discussion on default formatting of tables see [[Tables in ODT export]]. This feature closely mimics the way table templates are defined in the @@ -12814,12 +12814,12 @@ export the example table. In the above example, you used a template named {{{samp(Custom)}}} and installed two table styles with the names {{{samp(TableWithHeaderRowAndColumn)}}} and -{{{samp(TableWithFirstRowandLastRow)}}}. (*Important:* The +{{{samp(TableWithFirstRowandLastRow)}}}. (*Important:* The OpenDocument styles needed for producing the above template have been -pre-defined for you. These styles are available under the section +pre-defined for you. These styles are available under the section marked {{{samp(Custom Table Template)}}} in {{{file(OrgOdtContentTemplate.xml)}}} (see -[[x-orgodtcontenttemplate-xml][Factory styles]]). If you need additional +[[x-orgodtcontenttemplate-xml][Factory styles]]). If you need additional templates you have to define these styles yourself. @@ -12845,7 +12845,7 @@ To use this feature proceed as follows: The names for the above styles must be chosen based on the name of the table template using a well-defined convention. - The naming convention is better illustrated with an example. For a + The naming convention is better illustrated with an example. For a table template with the name {{{samp(Custom)}}}, the needed style names are listed in the following table. @@ -12881,7 +12881,7 @@ To use this feature proceed as follows: For example, the entry below defines two different table styles {{{samp(TableWithHeaderRowAndColumn)}}} and {{{samp(TableWithFirstRowandLastRow)}}} based on the same template - {{{samp(Custom)}}}. The styles achieve their intended effect by + {{{samp(Custom)}}}. The styles achieve their intended effect by selectively activating the individual cell styles in that template. #+header: :eval no @@ -12915,13 +12915,13 @@ To use this feature proceed as follows: :END: Occasionally, you will discover that the document created by the ODT -exporter cannot be opened by your favorite application. One of the +exporter cannot be opened by your favorite application. One of the common reasons for this is that the {{{file(.odt)}}} file is corrupt. In such cases, you may want to validate the document against the OpenDocument RELAX NG Compact Syntax (RNC) schema. For de-compressing the {{{file(.odt)}}} file[fn:142]: -[[info:emacs#File Archives]]. For general help with validation (and +[[info:emacs#File Archives]]. For general help with validation (and schema-sensitive editing) of XML files: [[info:nxml-mode#Introduction]]. #+vindex: org-export-odt-schema-dir @@ -12938,7 +12938,7 @@ The ODT exporter will take care of updating the #+cindex: TaskJuggler export #+cindex: Project management -[[http://www.taskjuggler.org/][TaskJuggler]] is a project management tool. It provides an optimizing +[[http://www.taskjuggler.org/][TaskJuggler]] is a project management tool. It provides an optimizing scheduler that computes your project time lines and resource assignments based on the project outline and the constraints that you have provided. @@ -12950,7 +12950,7 @@ nodes in the document. Instead the TaskJuggler exporter looks for a tree that defines the tasks and optionally trees that define the resources and reports for -this project. It then creates a TaskJuggler file based on these trees +this project. It then creates a TaskJuggler file based on these trees and the attributes defined in all the nodes. *** TaskJuggler export commands @@ -12976,14 +12976,14 @@ and the attributes defined in all the nodes. :END: #+vindex: org-export-taskjuggler-project-tag -Create your tasks as you usually do with Org mode. Assign efforts to +Create your tasks as you usually do with Org mode. Assign efforts to each task using properties (it is easiest to do this in the column -view). You should end up with something similar to the example by +view). You should end up with something similar to the example by Peter Jones in [[http://www.contextualdevelopment.com/static/artifacts/articles/2008/project-planning/project-planning.org]]. Now mark the top node of your tasks with a tag named ~:taskjuggler_project:~ (or whatever you customized -~org-export-taskjuggler-project-tag~ to). You are now ready to export +~org-export-taskjuggler-project-tag~ to). You are now ready to export the project plan with {{{kbd(C-c C-e J)}}} which will export the project plan and open a gantt chart in TaskJugglerUI. @@ -12994,17 +12994,17 @@ project plan and open a gantt chart in TaskJugglerUI. #+vindex: org-export-taskjuggler-resource-tag Next you can define resources and assign those to work on specific -tasks. You can group your resources hierarchically. Tag the top node +tasks. You can group your resources hierarchically. Tag the top node of the resources with ~:taskjuggler_resource:~ (or whatever you -customized ~org-export-taskjuggler-resource-tag~ to). You can +customized ~org-export-taskjuggler-resource-tag~ to). You can optionally assign an identifier (named {{{samp(resource_id)}}}) to the resources (using the standard Org properties commands, see [[Property syntax]]) or you can let the exporter generate identifiers automatically (the exporter picks the first word of the headline as the identifier as long as it is unique---see the documentation of -~org-taskjuggler-get-unique-id~). Using that identifier you can then -allocate resources to tasks. This is again done with the -{{{samp(allocate)}}} property on the tasks. Do this in column view or +~org-taskjuggler-get-unique-id~). Using that identifier you can then +allocate resources to tasks. This is again done with the +{{{samp(allocate)}}} property on the tasks. Do this in column view or when on the task type {{{ksksksk(C-c C-x p allocate,RET,,RET)}}}. @@ -13019,7 +13019,7 @@ task at what time. The exporter also takes TODO state information into consideration, i.e., if a task is marked as done it will have the corresponding -attribute in TaskJuggler ({{{samp(complete 100)}}}). Scheduling +attribute in TaskJuggler ({{{samp(complete 100)}}}). Scheduling information is also taken into account to set start/end dates for tasks. @@ -13041,14 +13041,14 @@ resource node which is known to TaskJuggler, such as The exporter will handle dependencies that are defined in the tasks either with the {{{samp(ORDERED)}}} attribute (see [[TODO dependencies]]), with the {{{samp(BLOCKER)}}} attribute (see {{{file(org-depend.el)}}}) -or alternatively with a {{{samp(depends)}}} attribute. Both the +or alternatively with a {{{samp(depends)}}} attribute. Both the {{{samp(BLOCKER)}}} and the {{{samp(depends)}}} attribute can be either {{{samp(previous-sibling)}}} or a reference to an identifier (named {{{samp(task_id)}}}) which is defined for another task in the -project. {{{samp(BLOCKER)}}} and the {{{samp(depends)}}} attribute can -define multiple dependencies separated by either space or comma. You +project. {{{samp(BLOCKER)}}} and the {{{samp(depends)}}} attribute can +define multiple dependencies separated by either space or comma. You can also specify optional attributes on the dependency by simply -appending it. The following examples should illustrate this: +appending it. The following examples should illustrate this: #+begin_example ,* Preparation @@ -13083,20 +13083,20 @@ appending it. The following examples should illustrate this: #+vindex: org-export-taskjuggler-default-reports TaskJuggler can produce many kinds of reports (e.g., gantt chart, -resource allocation, etc). The user defines what kind of reports -should be generated for a project in the TaskJuggler file. By default, +resource allocation, etc). The user defines what kind of reports +should be generated for a project in the TaskJuggler file. By default, the exporter will automatically insert some pre-set reports in the -file. These defaults are defined in -~org-export-taskjuggler-default-reports~. They can be modified using -customize along with a number of other options. For a more complete +file. These defaults are defined in +~org-export-taskjuggler-default-reports~. They can be modified using +customize along with a number of other options. For a more complete list, see {{{ksksksk(M-x customize-group,RET,org-export-taskjuggler,RET)}}}. Alternately, the user can tag a tree with ~org-export-taskjuggler-report-tag~, and define reports in sub-nodes, -similarly to what is done with tasks or resources. The properties used +similarly to what is done with tasks or resources. The properties used for report generation are defined in -~org-export-taskjuggler-valid-report-attributes~. In addition, a +~org-export-taskjuggler-valid-report-attributes~. In addition, a special property named {{{samp(report-kind)}}} is used to define the kind of report one wants to generate (by default, a {{{samp(taskreport)}}}). @@ -13117,7 +13117,7 @@ The Freemind exporter was written by Lennart Borgman. - {{{kbd(C-c C-e m)}}}, ~org-export-as-freemind~ :: #+kindex: C-c C-e m - Export as a Freemind mind map. For an Org file {{{file(myfile.org)}}}, + Export as a Freemind mind map. For an Org file {{{file(myfile.org)}}}, the Freemind file will be {{{file(myfile.mm)}}}. ** XOXO export @@ -13134,7 +13134,7 @@ and does not interpret any additional Org mode features. - {{{kbd(C-c C-e x)}}}, ~org-export-as-xoxo~ :: #+kindex: C-c C-e x - Export as an XOXO file. For an Org file {{{file(myfile.org)}}}, the + Export as an XOXO file. For an Org file {{{file(myfile.org)}}}, the XOXO file will be {{{file(myfile.html)}}}. - {{{kbd(C-c C-e v x)}}} :: @@ -13156,13 +13156,13 @@ and does not interpret any additional Org mode features. Some people use Org mode for keeping track of projects, but still prefer a standard calendar application for anniversaries and -appointments. In this case it can be useful to show deadlines and -other time-stamped items in Org files in the calendar application. Org +appointments. In this case it can be useful to show deadlines and +other time-stamped items in Org files in the calendar application. Org mode can export calendar information in the standard iCalendar format. If you also want to have TODO entries included in the export, -configure the variable ~org-icalendar-include-todo~. Plain timestamps -are exported as VEVENT, and TODO items as VTODO. It will also create -events from deadlines that are in non-TODO items. Deadlines and +configure the variable ~org-icalendar-include-todo~. Plain timestamps +are exported as VEVENT, and TODO items as VTODO. It will also create +events from deadlines that are in non-TODO items. Deadlines and scheduling dates in TODO items will be used to set the start and due dates for the TODO entry.[fn:143] As categories, it will use the tags locally defined in the heading, and the file/tree category.[fn:144] @@ -13173,13 +13173,13 @@ to entries with a time. #+cindex: property, ID The iCalendar standard requires each entry to have a globally unique -identifier (UID). Org creates these identifiers during export. If you +identifier (UID). Org creates these identifiers during export. If you set the variable ~org-icalendar-store-UID~, the UID will be stored in the ~:ID:~ property of the entry and re-used next time you report this -entry. Since a single entry can give rise to multiple iCalendar +entry. Since a single entry can give rise to multiple iCalendar entries (as a timestamp, a deadline, a scheduled item, and as a TODO item), Org adds prefixes to the UID, depending on what triggered the -inclusion of the entry. In this way the UID remains unique, but a +inclusion of the entry. In this way the UID remains unique, but a synchronization program can still figure out from which entry all the different instances originate. @@ -13195,7 +13195,7 @@ different instances originate. #+vindex: org-agenda-files Like {{{kbd(C-c C-e i)}}}, but do this for all files in - ~org-agenda-files~. For each of these files, a separate iCalendar file + ~org-agenda-files~. For each of these files, a separate iCalendar file will be written. - {{{kbd(C-c C-e c)}}}, ~org-export-icalendar-combine-agenda-files~ :: @@ -13230,7 +13230,7 @@ you are using. The FAQ covers this issue. Org includes a publishing management system that allows you to configure automatic HTML conversion of /projects/ composed of -interlinked org files. You can also configure Org to automatically +interlinked org files. You can also configure Org to automatically upload your exported HTML pages and related attachments, such as images and source code files, to a web server. @@ -13257,7 +13257,7 @@ destination and many other properties of a project. #+vindex: org-publish-project-alist Publishing is configured almost entirely through setting the value of -one variable, called ~org-publish-project-alist~. Each element of the +one variable, called ~org-publish-project-alist~. Each element of the list configures one project, and may be in one of the two following forms: @@ -13278,10 +13278,10 @@ or: In both cases, projects are configured by specifying property values. A project defines the set of files that will be published, as well as -the publishing configuration to use when publishing those files. When +the publishing configuration to use when publishing those files. When a project takes the second form listed above, the individual members of the ~:components~ property are taken to be sub-projects, which -group together files requiring different publishing options. When you +group together files requiring different publishing options. When you publish such a "meta-project," all the components will also be published, in the sequence given. @@ -13292,7 +13292,7 @@ published, in the sequence given. :END: #+cindex: directories, for publishing -Most properties are optional, but some should always be set. In +Most properties are optional, but some should always be set. In particular, Org needs to know where to look for source files, and where to put published files. @@ -13303,9 +13303,9 @@ where to put published files. - ~:publishing-directory~ :: - Directory where output files will be published. You can directly + Directory where output files will be published. You can directly publish to a webserver using a file name syntax appropriate for the - Emacs {{{file(tramp)}}} package. Or you can publish to a local + Emacs {{{file(tramp)}}} package. Or you can publish to a local directory and use external tools to upload your website (see [[Uploading files]]). @@ -13313,7 +13313,7 @@ where to put published files. Function or list of functions to be called before starting the publishing process, for example, to run ~make~ for updating files to - be published. The project property list is scoped into this call as + be published. The project property list is scoped into this call as the variable ~project-plist~. - ~:completion-function~ :: @@ -13336,8 +13336,8 @@ following properties: #+attr_texinfo: :table-type table :indic @asis - ~:base-extension~ :: - Extension (without the dot!) of source files. This actually is a - regular expression. Set this to the symbol ~any~ if you want to get + Extension (without the dot!) of source files. This actually is a + regular expression. Set this to the symbol ~any~ if you want to get all files in ~:base-directory~, even without extension. - ~:exclude~ :: @@ -13378,7 +13378,7 @@ For non-Org files, you always need to specify the publishing function: #+attr_texinfo: :table-type table :indic @asis - ~:publishing-function~ :: - Function executing the publication of a file. This may also be a list + Function executing the publication of a file. This may also be a list of functions, which will all be called in turn. - ~:plain-source~ :: @@ -13393,7 +13393,7 @@ For non-Org files, you always need to specify the publishing function: The function must accept three arguments: a property list containing at least a ~:publishing-directory~ property, the name of the file to be published, and the path to the publishing directory of the output -file. It should take the specified file, make the necessary +file. It should take the specified file, make the necessary transformation (if any) and place the result into the destination folder. @@ -13513,13 +13513,13 @@ respective variable for details. Most of the ~org-export-with-*~ variables have the same effect in both HTML and LaTeX exporters, except for ~:TeX-macros~ and ~:LaTeX-fragments~ options, respectively ~nil~ and ~t~ in the LaTeX -export. See ~org-export-plist-vars~ to check this list of options. +export. See ~org-export-plist-vars~ to check this list of options. #+vindex: org-publish-project-alist When a property is given a value in ~org-publish-project-alist~, its setting overrides the value of the corresponding user variable (if -any) during publishing. Options set within a file (see [[Export +any) during publishing. Options set within a file (see [[Export options]]), however, override everything. *** Publishing links @@ -13530,22 +13530,22 @@ options]]), however, override everything. To create a link from one Org file to another, you would use something like ~[[file:foo.org][The foo]]~ or simply ~[[file:foo.org]]~ (see -[[Hyperlinks]]). When published, this link becomes a link to -{{{file(foo.html)}}}. In this way, you can interlink the pages of your +[[Hyperlinks]]). When published, this link becomes a link to +{{{file(foo.html)}}}. In this way, you can interlink the pages of your "org web" project and the links will work as expected when you publish -them to HTML. If you also publish the Org source file and want to link +them to HTML. If you also publish the Org source file and want to link to that, use an ~http:~ link instead of a ~file:~ link, because ~file:~ links are converted to link to the corresponding {{{file(html)}}} file. -You may also link to related files, such as images. Provided you are +You may also link to related files, such as images. Provided you are careful with relative file names, and provided you have also configured Org to upload the related files, these links will work too. See [[Complex example]], for an example of this usage. Sometimes an Org file to be published may contain links that are only valid in your production environment, but not in the publishing -location. In this case, use the following property to define a +location. In this case, use the following property to define a function for checking link validity: #+attr_texinfo: :table-type table :indic @asis @@ -13555,9 +13555,9 @@ function for checking link validity: {{{noindent}}} This function must accept two arguments, the file name and a directory relative to which the file name is interpreted in the -production environment. If this function returns ~nil~, then the HTML +production environment. If this function returns ~nil~, then the HTML generator will only insert a description into the HTML file, but no -link. One option for this function is ~org-publish-validate-link~ +link. One option for this function is ~org-publish-validate-link~ which checks if the given file is part of any project in ~org-publish-project-alist~. @@ -13588,23 +13588,23 @@ a map of files for a given project. - ~:sitemap-function~ :: - Plug-in function to use for generation of the sitemap. Defaults to + Plug-in function to use for generation of the sitemap. Defaults to ~org-publish-org-sitemap~, which generates a plain list of links to all files in the project. - ~:sitemap-sort-folders~ :: - Where folders should appear in the sitemap. Set this to ~first~ + Where folders should appear in the sitemap. Set this to ~first~ (default) or ~last~ to display folders first or last, respectively. Any other value will mix files and folders. - ~:sitemap-sort-files~ :: - How the files are sorted in the site map. Set this to ~alphabetically~ + How the files are sorted in the site map. Set this to ~alphabetically~ (default), ~chronologically~ or ~anti-chronologically~. ~chronologically~ sorts the files with older date first while ~anti-chronologically~ sorts the files with newer date first. - ~alphabetically~ sorts the files alphabetically. The date of a file is + ~alphabetically~ sorts the files alphabetically. The date of a file is retrieved with ~org-publish-find-date~. - ~:sitemap-ignore-case~ :: @@ -13614,16 +13614,16 @@ a map of files for a given project. - ~:sitemap-file-entry-format~ :: With this option one can tell how a sitemap's entry is formatted in - the sitemap. This is a format string with some escape sequences: ~%t~ + the sitemap. This is a format string with some escape sequences: ~%t~ stands for the title of the file, ~%a~ stands for the author of the - file and ~%d~ stands for the date of the file. The date is retrieved + file and ~%d~ stands for the date of the file. The date is retrieved with the ~org-publish-find-date~ function and formatted with - ~org-publish-sitemap-date-format~. Default ~%t~. + ~org-publish-sitemap-date-format~. Default ~%t~. - ~:sitemap-date-format~ :: Format string for the ~format-time-string~ function that tells how a - sitemap entry's date is to be formatted. This property bypasses + sitemap entry's date is to be formatted. This property bypasses ~org-publish-sitemap-date-format~ which defaults to ~%Y-%m-%d~. - ~:sitemap-sans-extension~ :: @@ -13648,8 +13648,8 @@ Org mode can generate an index across the files of a publishing project. The file will be created when first publishing a project with the -~:makeindex~ set. The file only contains a statement -{{{samp(#+INCLUDE: "theindex.inc")}}}. You can then build around this +~:makeindex~ set. The file only contains a statement +{{{samp(#+INCLUDE: "theindex.inc")}}}. You can then build around this include statement by adding a title, style information, etc. ** Uploading files @@ -13662,22 +13662,22 @@ include statement by adding a title, style information, etc. For those people already utilizing third party sync tools such as {{{command(rsync)}}} or {{{command(unison)}}}, it might be preferable not to use the built in remote publishing facilities of Org mode -which rely heavily on Tramp. Tramp, while very useful and powerful, +which rely heavily on Tramp. Tramp, while very useful and powerful, tends not to be so efficient for multiple file transfer and has been known to cause problems under heavy usage. -Specialized synchronization utilities offer several advantages. In +Specialized synchronization utilities offer several advantages. In addition to timestamp comparison, they also do content and -permissions/attribute checks. For this reason you might prefer to +permissions/attribute checks. For this reason you might prefer to publish your web to a local directory (possibly even in place with your Org files) and then use {{{file(unison)}}} or {{{file(rsync)}}} to do the synchronization with the remote host. Since Unison (for example) can be configured as to which files to transfer to a certain remote destination, it can greatly simplify the -project publishing definition. Simply keep all files in the correct +project publishing definition. Simply keep all files in the correct location, process your Org files with ~org-publish~ and let the -synchronization tool do the rest. You do not need, in this scenario, +synchronization tool do the rest. You do not need, in this scenario, to include attachments such as {{{file(jpg)}}}, {{{file(css)}}} or {{{file(gif)}}} files in the project definition since the 3rd party tool syncs them. @@ -13686,7 +13686,7 @@ Publishing to a local directory is also much faster than to a remote one, so that you can afford more easily to republish entire projects. If you set ~org-publish-use-timestamps-flag~ to ~nil~, you gain the main benefit of re-including any changed external files such as source -example files you might include with ~#+INCLUDE:~. The timestamp +example files you might include with ~#+INCLUDE:~. The timestamp mechanism in Org is not smart enough to detect if included files have been modified. @@ -13732,7 +13732,7 @@ excluded. To ensure that links are preserved, care should be taken to replicate your directory structure on the web server, and to use relative file -paths. For example, if your Org files are kept in {{{file(~/org)}}} +paths. For example, if your Org files are kept in {{{file(~/org)}}} and your publishable images in {{{file(~/images)}}}, you would link to an image with @@ -13805,11 +13805,11 @@ Once properly configured, Org can publish with the following commands: #+vindex: org-publish-use-timestamps-flag -Org uses timestamps to track when a file has changed. The above -functions normally only publish changed files. You can override this +Org uses timestamps to track when a file has changed. The above +functions normally only publish changed files. You can override this and force publishing of all files by giving a prefix argument to any of the commands above, or by customizing the variable -~org-publish-use-timestamps-flag~. This may be necessary in particular +~org-publish-use-timestamps-flag~. This may be necessary in particular if files include other files via ~#+SETUPFILE:~ or ~#+INCLUDE:~. * Working with source code @@ -13836,7 +13836,7 @@ Org mode provides a number of features for working with live source code, including editing of code blocks in their native major-mode, evaluation of code blocks, converting code blocks into source files (known as "tangling" in literate programming), and exporting code -blocks and their results in several formats. This functionality was +blocks and their results in several formats. This functionality was contributed by Eric Schulte and Dan Davison, and was originally named Org-babel. @@ -13863,8 +13863,8 @@ the following example: #+end_example The ~#+NAME:~ line is optional, and can be used to name the code -block. Live code blocks require that a language be specified on the -~#+BEGIN_SRC~ line. Switches and header arguments are optional. +block. Live code blocks require that a language be specified on the +~#+BEGIN_SRC~ line. Switches and header arguments are optional. #+cindex: source code, inline Live code blocks can also be specified inline using the following @@ -13884,11 +13884,11 @@ or - ~<#+NAME: name>~ :: #+cindex: #+NAME - This line associates a name with the code block. This is similar to + This line associates a name with the code block. This is similar to the ~#+TBLNAME: NAME~ lines that can be used to name tables in Org - mode files. Referencing the name of a code block makes it possible to + mode files. Referencing the name of a code block makes it possible to evaluate the block from other places in the file, from other files, or - from Org mode table formulas (see [[The spreadsheet]]). Names are assumed + from Org mode table formulas (see [[The spreadsheet]]). Names are assumed to be unique and the behavior of Org mode when two or more blocks share the same name is undefined. @@ -13907,7 +13907,7 @@ or #+cindex: source code, header arguments Optional header arguments control many aspects of evaluation, export - and tangling of code blocks (see [[Header arguments]]). Header arguments + and tangling of code blocks (see [[Header arguments]]). Header arguments can also be set on a per-buffer or per-subtree basis using properties. - ~~ :: @@ -13922,14 +13922,14 @@ or #+cindex: source code, editing #+kindex: C-c ' -Use {{{kbd(C-c ')}}} to edit the current code block. This brings up a +Use {{{kbd(C-c ')}}} to edit the current code block. This brings up a language major-mode edit buffer containing the body of the code block. Saving this buffer will write the new contents back to the Org buffer. Use {{{kbd(C-c ')}}} again to exit. -The ~org-src-mode~ minor mode will be active in the edit buffer. The +The ~org-src-mode~ minor mode will be active in the edit buffer. The following variables can be used to configure the behavior of the edit -buffer. See also the customization group ~org-edit-structure~ for +buffer. See also the customization group ~org-edit-structure~ for further configuration options. #+attr_texinfo: :table-type table :indic @asis @@ -13968,9 +13968,9 @@ the variable ~org-src-fontify-natively~. It is possible to export the /code/ of code blocks, the /results/ of code block evaluation, /both/ the code and the results of code block -evaluation, or /none/. For most languages, the default exports code. +evaluation, or /none/. For most languages, the default exports code. However, for some languages (e.g., ~ditaa~) the default exports the -results of code block evaluation. For information on exporting code +results of code block evaluation. For information on exporting code block bodies, see [[Literal examples]]. The ~:exports~ header argument can be used to specify export @@ -13987,7 +13987,7 @@ behavior with the following arguments: The code block will be evaluated and the results will be placed in the Org mode buffer for export, either updating previous results of the code block located anywhere in the buffer or, if no previous results - exist, placing the results immediately after the code block. The body + exist, placing the results immediately after the code block. The body of the code block will not be exported. - ~:exports both~ :: @@ -14001,7 +14001,7 @@ behavior with the following arguments: It is possible to inhibit the evaluation of code blocks during export. Setting the ~org-export-babel-evaluate~ variable to ~nil~ will ensure -that no code blocks are evaluated as part of the export process. This +that no code blocks are evaluated as part of the export process. This can be useful in situations where potentially untrusted Org mode files are exported in an automated fashion, for example when Org mode is used as the markup language for a wiki. @@ -14016,7 +14016,7 @@ used as the markup language for a wiki. Creating pure source code files by extracting code from source blocks is referred to as "tangling"---a term adopted from the literate -programming community. During tangling of code blocks their bodies are +programming community. During tangling of code blocks their bodies are expanded using ~org-babel-expand-src-block~ which can expand both variable and ``noweb'' style references (see [[Noweb reference syntax]]). @@ -14028,7 +14028,7 @@ variable and ``noweb'' style references (see [[Noweb reference syntax]]). - ~:tangle yes~ :: - Include the code block in the tangled output. The output file name is + Include the code block in the tangled output. The output file name is the name of the org file with the extension {{{samp(.org)}}} replaced by the extension for the block language. @@ -14070,11 +14070,11 @@ Code blocks can be evaluated and the results of evaluation optionally placed in the Org mode buffer.[fn:148] The results of evaluation are placed following a line that begins by default with ~#+RESULTS~ and optionally a cache identifier and/or the name of the evaluated code -block. The default value of ~#+RESULTS~ can be changed with the +block. The default value of ~#+RESULTS~ can be changed with the customizable variable ~org-babel-results-keyword~. By default, the evaluation facility is only enabled for Lisp code -blocks specified as ~emacs-lisp~. However, source code blocks in many +blocks specified as ~emacs-lisp~. However, source code blocks in many languages can be evaluated within Org mode (see [[Languages]] for a list of supported languages and [[Structure of code blocks]] for information on the syntax used to define a code block). @@ -14082,7 +14082,7 @@ the syntax used to define a code block). #+kindex: C-c C-c #+kindex: C-c C-v e -There are a number of ways to evaluate code blocks. The simplest is to +There are a number of ways to evaluate code blocks. The simplest is to press {{{kbd(C-c C-c)}}} or {{{kbd(C-c C-v e)}}} with the point on a code block.[fn:149] This will call the ~org-babel-execute-src-block~ function to evaluate the block and insert its results into the Org @@ -14091,9 +14091,9 @@ mode buffer. #+cindex: #+CALL It is also possible to evaluate named code blocks from anywhere in an -Org mode buffer or an Org mode table. Live code blocks located in the +Org mode buffer or an Org mode table. Live code blocks located in the current Org mode buffer or in the ``Library of Babel'' (see [[Library of -Babel]]) can be executed. Named code blocks can be executed with a +Babel]]) can be executed. Named code blocks can be executed with a separate ~#+CALL:~ line or inline within a block of text. The syntax of the ~#+CALL:~ line is: @@ -14120,25 +14120,25 @@ The syntax for inline evaluation of named code blocks is: Arguments specified in this section will be passed to the code block. These arguments use standard function call syntax, rather than header - argument syntax. For example, a ~#+CALL:~ line that passes the number + argument syntax. For example, a ~#+CALL:~ line that passes the number four to a code block named ~double~, which declares the header argument ~:var n=2~, would be written as ~#+CALL: double(n=4)~. - ~~ :: Inside header arguments are passed through and applied to the named - code block. These arguments use header argument syntax rather than - standard function call syntax. Inside header arguments affect how the - code block is evaluated. For example, ~[:results output]~ will collect + code block. These arguments use header argument syntax rather than + standard function call syntax. Inside header arguments affect how the + code block is evaluated. For example, ~[:results output]~ will collect the results of everything printed to ~STDOUT~ during execution of the code block. - ~~ :: End header arguments are applied to the calling instance and do not - affect evaluation of the named code block. They affect how the results + affect evaluation of the named code block. They affect how the results are incorporated into the Org mode buffer and how the call line is - exported. For example, ~:results html~ will insert the results of the + exported. For example, ~:results html~ will insert the results of the call line evaluation in the Org buffer, wrapped in a ~BEGIN_HTML:~ block. @@ -14155,7 +14155,7 @@ For more examples of passing header arguments to ~#+CALL:~ lines see #+cindex: code block, library The ``Library of Babel'' consists of code blocks that can be called -from any Org mode file. Code blocks defined in the ``Library of +from any Org mode file. Code blocks defined in the ``Library of Babel'' can be called remotely as if they were in the current Org mode buffer (see [[Evaluating code blocks]] for information on the syntax of remote code block evaluation). @@ -14208,12 +14208,12 @@ Code blocks in the following languages are supported. | SQL | sql | | SQLite | sqlite | -Language-specific documentation is available for some languages. If +Language-specific documentation is available for some languages. If available, it can be found at [[http://orgmode.org/worg/org-contrib/babel/languages.html]]. The variable ~org-babel-load-languages~ controls which languages are -enabled for evaluation (by default only ~emacs-lisp~ is enabled). This +enabled for evaluation (by default only ~emacs-lisp~ is enabled). This variable can be set using the customization interface or by adding code like the following example, disables ~emacs-lisp~ evaluation and enables evaluation of ~R~ code blocks, to your emacs configuration: @@ -14246,7 +14246,7 @@ related elisp file with ~require~. #+cindex: code block, header arguments #+cindex: source code, block header arguments -Code block functionality can be configured with header arguments. This +Code block functionality can be configured with header arguments. This section provides an overview of the use of header arguments, and then describes each header argument in detail. @@ -14290,7 +14290,7 @@ the ~org-babel-default-header-args~ variable: # #+end_example For example, the following code could be used to set the default -value of ~:noweb~ header arguments to ~yes~. This would have the +value of ~:noweb~ header arguments to ~yes~. This would have the effect of expanding ~:noweb~ references by default when evaluating source code blocks. @@ -14307,7 +14307,7 @@ source code blocks. :DESCRIPTION: Set default values by language :END: -Each language can define its own set of default header arguments. See +Each language can define its own set of default header arguments. See the language-specific documentation available online at [[http://orgmode.org/worg/org-contrib/babel]]. @@ -14336,7 +14336,7 @@ inserted into the buffer. :END: Header arguments are also read from Org mode properties (see [[Property -syntax]]), which can be set on a buffer-wide or per-heading basis. An +syntax]]), which can be set on a buffer-wide or per-heading basis. An example of setting a header argument for all code blocks in a buffer is as follows: @@ -14348,7 +14348,7 @@ is as follows: When properties are used to set default header arguments, they are looked up with inheritance, regardless of the value of -~org-use-property-inheritance~. In the following example the value of +~org-use-property-inheritance~. In the following example the value of the ~:cache~ header argument will default to ~yes~ in all code blocks in the subtree rooted at the following heading: @@ -14363,7 +14363,7 @@ in the subtree rooted at the following heading: #+vindex: org-babel-default-header-args Properties defined in this way override the properties set in -~org-babel-default-header-args~. It is convenient to use the +~org-babel-default-header-args~. It is convenient to use the ~org-set-property~ function bound to {{{kbd(C-c C-x p)}}} to set properties in Org mode documents. @@ -14373,11 +14373,11 @@ properties in Org mode documents. :END: The most common way to assign values to header arguments is at the -code block level. This can be done by listing a sequence of header +code block level. This can be done by listing a sequence of header arguments and their values as part of the ~#+BEGIN_SRC~ line. Properties set in this way override both the values of ~org-babel-default-header-args~ and header arguments specified as -properties. In the following example, the ~:results~ header argument +properties. In the following example, the ~:results~ header argument is set to ~silent~, meaning the results of execution will not be inserted in the buffer, and the ~:exports~ header argument is set to ~code~, meaning only the body of the code block will be preserved on @@ -14436,7 +14436,7 @@ This is an example of multi-line header arguments on a named code block: :END: At the most specific level, header arguments for ``Library of Babel'' -or ~#+CALL:~ lines can be set as shown in the two examples below. For +or ~#+CALL:~ lines can be set as shown in the two examples below. For more information on the structure of ~#+CALL:~ lines see [[Evaluating code blocks]]. @@ -14459,7 +14459,7 @@ argument to the evaluation of the ~factorial~ code block: :DESCRIPTION: List of header arguments :END: Header arguments consist of an initial colon followed by the name of -the argument in lowercase letters. Additional header arguments are +the argument in lowercase letters. Additional header arguments are defined on a language-specific basis, see [[Languages]]. The following header arguments are defined: @@ -14472,13 +14472,13 @@ The ~:var~ header argument is used to pass arguments to code blocks. The specifics of how arguments are included in a code block vary by language; these are addressed in the language-specific documentation. However, the syntax used to specify arguments is the same across all -languages. In every case, variables require a default value when they +languages. In every case, variables require a default value when they are declared. The values passed to arguments can either be literal values, references, or Emacs Lisp code (see [[Emacs Lisp evaluation of -variables]]). References include anything in the Org mode file that -takes a ~#+NAME:~, ~#+TBLNAME:~, or ~#+RESULTS:~ line. This includes +variables]]). References include anything in the Org mode file that +takes a ~#+NAME:~, ~#+TBLNAME:~, or ~#+RESULTS:~ line. This includes tables, lists, ~#+BEGIN_EXAMPLE~ blocks, other code blocks, and the results of other code blocks. @@ -14591,7 +14591,7 @@ Here are examples of passing values by reference: <> It is also possible to specify arguments in a potentially more natural -way using the ~#+NAME:~ line of a code block. As in the following +way using the ~#+NAME:~ line of a code block. As in the following example, arguments can be packed inside of parentheses, separated by commas, following the source name. @@ -14606,12 +14606,12 @@ commas, following the source name. <> It is possible to reference portions of variable values by -/indexing/ into the variables. Indexes are 0 based with negative -values counting back from the end. If an index is separated by commas +/indexing/ into the variables. Indexes are 0 based with negative +values counting back from the end. If an index is separated by commas then each subsequent section will index into the next deepest nesting -or dimension of the value. Note that this indexing occurs /before/ +or dimension of the value. Note that this indexing occurs /before/ other table related header arguments like ~:hlines~, ~:colnames~, and -~:rownames~ are applied. The following example assigns the last cell +~:rownames~ are applied. The following example assigns the last cell of the first row the table ~example-table~ to the variable ~data~: #+begin_example @@ -14631,7 +14631,7 @@ of the first row the table ~example-table~ to the variable ~data~: Ranges of variable values can be referenced using two integers separated by a ~:~, in which case the entire inclusive range is -referenced. The following example assigns the middle three rows of +referenced. The following example assigns the middle three rows of ~example-table~ to ~data~. #+begin_example @@ -14673,7 +14673,7 @@ column is referenced: #+end_example It is possible to index into the results of code blocks as well as -tables. Any number of dimensions can be indexed. Dimensions are +tables. Any number of dimensions can be indexed. Dimensions are separated from one another by commas, as shown in the following example: @@ -14696,10 +14696,10 @@ example: # ***** Emacs Lisp evaluation of variables <> -Emacs lisp code can be used to initialize variable values. When a +Emacs lisp code can be used to initialize variable values. When a variable value starts with ~(~, ~[~, ~'~ or ~`~ it will be evaluated as Emacs Lisp and the result of the evaluation will be assigned as the -variable value. The following example demonstrates use of this +variable value. The following example demonstrates use of this evaluation to reliably pass the file-name of the Org mode buffer to a code block:[fn:150] @@ -14759,87 +14759,87 @@ how the results should be collected from the code block. #+attr_texinfo: :table-type table :indic @asis - ~value~ :: - This is the default. The result is the value of the last statement in - the code block. This header argument places the evaluation in - functional mode. Note that in some languages, e.g., Python, use of + This is the default. The result is the value of the last statement in + the code block. This header argument places the evaluation in + functional mode. Note that in some languages, e.g., Python, use of this result type requires that a ~return~ statement be included in the body of the source code block. - ~output~ :: The result is the collection of everything printed to STDOUT during - the execution of the code block. This header argument places the + the execution of the code block. This header argument places the evaluation in scripting mode. # ***** Type <> The following ~:results~ options are mutually exclusive and specify -what type of results the code block will return. By default, results +what type of results the code block will return. By default, results are inserted as either a table or scalar depending on their value. #+attr_texinfo: :table-type table :indic @asis - ~table~, ~vector~ :: - The results should be interpreted as an Org mode table. If a single + The results should be interpreted as an Org mode table. If a single value is returned, it will be converted into a table with one row and - one column. E.g., ~:results value table~. + one column. E.g., ~:results value table~. - ~scalar~, ~verbatim~ :: The results should be interpreted literally---they will not be - converted into a table. The results will be inserted into the Org mode - buffer as quoted text. E.g., ~:results value verbatim~. + converted into a table. The results will be inserted into the Org mode + buffer as quoted text. E.g., ~:results value verbatim~. - ~list~ :: - The results should be interpreted as an Org mode list. If a single + The results should be interpreted as an Org mode list. If a single scalar value is returned it will be converted into a list with only one element. - ~file~ :: The results will be interpreted as the path to a file, and will be - inserted into the Org mode buffer as a file link. E.g., ~:results + inserted into the Org mode buffer as a file link. E.g., ~:results value file~. - ~raw~ :: The results are interpreted as raw Org mode code and are inserted - directly into the buffer. If the results look like a table they will - be aligned as such by Org mode. E.g., ~:results value raw~. + directly into the buffer. If the results look like a table they will + be aligned as such by Org mode. E.g., ~:results value raw~. - ~org~ :: - The results are will be enclosed in a ~BEGIN_SRC org~ block. They are + The results are will be enclosed in a ~BEGIN_SRC org~ block. They are not comma-escaped by default but they will be if you hit - {{{kbd(TAB)}}} in the block and/or if you export the file. E.g., + {{{kbd(TAB)}}} in the block and/or if you export the file. E.g., ~:results value org~. - ~html~ :: Results are assumed to be HTML and will be enclosed in a ~BEGIN_HTML~ - block. E.g., ~:results value html~. + block. E.g., ~:results value html~. - ~latex~ :: Results assumed to be LaTeX and are enclosed in a ~BEGIN_LaTeX~ - block. E.g., ~:results value latex~. + block. E.g., ~:results value latex~. - ~code~ :: Result are assumed to be parsable code and are enclosed in a code - block. E.g., ~:results value code~. + block. E.g., ~:results value code~. - ~pp~ :: The result is converted to pretty-printed code and is enclosed in a - code block. This option currently supports Emacs Lisp, Python, and - Ruby. E.g., ~:results value pp~. + code block. This option currently supports Emacs Lisp, Python, and + Ruby. E.g., ~:results value pp~. - ~drawer~ :: - The result is wrapped in a RESULTS drawer. This can be useful for + The result is wrapped in a RESULTS drawer. This can be useful for inserting ~raw~ or ~org~ syntax results in such a way that their extent is known and they can be automatically removed or replaced. @@ -14851,26 +14851,26 @@ results once they are collected. #+attr_texinfo: :table-type table :indic @asis - ~replace~ :: - The default value. Any existing results will be removed, and the new + The default value. Any existing results will be removed, and the new results will be inserted into the Org mode buffer in their place. E.g., ~:results output replace~. - ~append~ :: If there are pre-existing results of the code block then the new - results will be appended to the existing results. Otherwise the new + results will be appended to the existing results. Otherwise the new results will be inserted as with ~replace~. - ~prepend~ :: If there are pre-existing results of the code block then the new - results will be prepended to the existing results. Otherwise the new + results will be prepended to the existing results. Otherwise the new results will be inserted as with ~replace~. - ~silent~ :: The results will be echoed in the minibuffer but will not be inserted - into the Org mode buffer. E.g., ~:results output silent~. + into the Org mode buffer. E.g., ~:results output silent~. **** file :PROPERTIES: @@ -14878,12 +14878,12 @@ results once they are collected. :END: The header argument ~:file~ is used to specify an external file in -which to save code block results. After code block evaluation an Org +which to save code block results. After code block evaluation an Org mode style ~[[file:]]~ link (see [[Link format]]) to the file will be inserted -into the Org mode buffer. Some languages including R, gnuplot, dot, +into the Org mode buffer. Some languages including R, gnuplot, dot, and ditaa provide special handling of the ~:file~ header argument, automatically wrapping the code block body in the boilerplate code -required to save output to the specified file. This is often useful +required to save output to the specified file. This is often useful for saving graphical output of a code block to the specified file. The argument to ~:file~ should be either a string specifying the path @@ -14898,7 +14898,7 @@ the link. The value of the ~:file-desc~ header argument is used to provide a description for file code block results which are inserted as Org mode -links (see [[Link format]]). If the ~:file-desc~ header argument is given +links (see [[Link format]]). If the ~:file-desc~ header argument is given with no value the link path will be placed in both the ``link'' and the ``description'' portion of the Org mode link. @@ -14910,10 +14910,10 @@ the ``description'' portion of the Org mode link. While the ~:file~ header argument can be used to specify the path to the output file, ~:dir~ specifies the default directory during code -block execution. If it is absent, then the directory associated with -the current buffer is used. In other words, supplying ~:dir path~ +block execution. If it is absent, then the directory associated with +the current buffer is used. In other words, supplying ~:dir path~ temporarily has the same effect as changing the current directory with -{{{kbd(M-x cd path)}}}, and then not supplying ~:dir~. Under the +{{{kbd(M-x cd path)}}}, and then not supplying ~:dir~. Under the surface, ~:dir~ simply sets the value of the Emacs variable ~default-directory~. @@ -14936,7 +14936,7 @@ like the following example: A directory on a remote machine can be specified using tramp file syntax, in which case the code will be evaluated on the remote -machine. An example is: +machine. An example is: #+begin_example #+BEGIN_SRC R :file plot.png :dir /dand@yakuba.princeton.edu: @@ -14946,7 +14946,7 @@ machine. An example is: Text results will be returned to the local Org mode buffer as usual, and file output will be created on the remote machine with relative -paths interpreted relative to the remote directory. An Org mode link +paths interpreted relative to the remote directory. An Org mode link to the remote file will be created. So, in the above example a plot will be created on the remote machine, @@ -14958,7 +14958,7 @@ and a link of the following form will be inserted in the org buffer: Most of this functionality follows immediately from the fact that ~:dir~ sets the value of the Emacs variable ~default-directory~, -thanks to tramp. Those using XEmacs, or GNU Emacs prior to version 23 +thanks to tramp. Those using XEmacs, or GNU Emacs prior to version 23 may need to install tramp separately in order for these features to work correctly. @@ -14989,7 +14989,7 @@ or LaTeX exports of the Org mode file. #+attr_texinfo: :table-type table :indic @asis - ~code~ :: - The default. The body of code is included into the exported file. + The default. The body of code is included into the exported file. E.g., ~:exports code~. - ~results~ :: @@ -14999,7 +14999,7 @@ or LaTeX exports of the Org mode file. - ~both~ :: - Both the code and results are included in the exported file. E.g., + Both the code and results are included in the exported file. E.g., ~:exports both~. - ~none~ :: @@ -15019,11 +15019,11 @@ block should be included in tangled extraction of source code files. The code block is exported to a source code file named after the full path (including the directory) and file name (w/o extension) of the - Org mode file. E.g., ~:tangle yes~. + Org mode file. E.g., ~:tangle yes~. - ~no~ :: - The default. The code block is not exported to a source code file. + The default. The code block is not exported to a source code file. E.g., ~:tangle no~. - other :: @@ -15039,7 +15039,7 @@ block should be included in tangled extraction of source code files. :END: The ~:mkdirp~ header argument can be used to create parent directories -of tangled files when missing. This can be set to ~yes~ to enable +of tangled files when missing. This can be set to ~yes~ to enable directory creation or to ~no~ to inhibit directory creation. **** comments @@ -15049,7 +15049,7 @@ directory creation or to ~no~ to inhibit directory creation. By default code blocks are tangled to source-code files without any insertion of comments beyond those which may already exist in the body -of the code block. The ~:comments~ header argument can be set as +of the code block. The ~:comments~ header argument can be set as follows to control the insertion of extra comments into the tangled code file. @@ -15109,9 +15109,9 @@ are accepted: :END: By default, code blocks are expanded with ~org-babel-expand-src-block~ -during tangling. This has the effect of assigning values to variables +during tangling. This has the effect of assigning values to variables specified with ~:var~ (see [[var]]), and of replacing ``noweb'' references -(see [[Noweb reference syntax]]) with their targets. The ~:no-expand~ +(see [[Noweb reference syntax]]) with their targets. The ~:no-expand~ header argument can be used to turn off this behavior. **** session @@ -15125,7 +15125,7 @@ language where state is preserved. By default, a session is not started. A string passed to the ~:session~ header argument will give the -session a name. This makes it possible to run concurrent sessions for +session a name. This makes it possible to run concurrent sessions for each interpreted language. **** noweb @@ -15135,14 +15135,14 @@ each interpreted language. The ~:noweb~ header argument controls expansion of ``noweb'' syntax references (see [[Noweb reference syntax]]) when the code block is -evaluated, tangled, or exported. The ~:noweb~ header argument can have +evaluated, tangled, or exported. The ~:noweb~ header argument can have one of the five values: ~no~, ~yes~, ~tangle~, ~no-export~, or ~strip-export~. #+attr_texinfo: :table-type table :indic @asis - ~no~ :: - The default. ``Noweb'' syntax references in the body of the code block + The default. ``Noweb'' syntax references in the body of the code block will not be expanded before the code block is evaluated, tangled or exported. @@ -15154,21 +15154,21 @@ one of the five values: ~no~, ~yes~, ~tangle~, ~no-export~, or - ~tangle~ :: ``Noweb'' syntax references in the body of the code block will be - expanded before the code block is tangled. However, ``noweb'' syntax + expanded before the code block is tangled. However, ``noweb'' syntax references will not be expanded when the code block is evaluated or exported. - ~no-export~ :: ``Noweb'' syntax references in the body of the code block will be - expanded before the block is evaluated or tangled. However, ``noweb'' + expanded before the block is evaluated or tangled. However, ``noweb'' syntax references will not be expanded when the code block is exported. - ~strip-export~ :: ``Noweb'' syntax references in the body of the code block will be - expanded before the block is evaluated or tangled. However, ``noweb'' + expanded before the block is evaluated or tangled. However, ``noweb'' syntax references will not be removed when the code block is exported. - ~eval~ :: @@ -15180,7 +15180,7 @@ one of the five values: ~no~, ~yes~, ~tangle~, ~no-export~, or <> Noweb insertions are placed behind the line prefix of the -~<>~. Because the ~<>~ noweb reference appears +~<>~. Because the ~<>~ noweb reference appears behind the SQL comment syntax in the following example, each line of the expanded noweb reference will be commented. @@ -15248,7 +15248,7 @@ the resulting pure code file.[fn:151] #+end_example The ~:noweb-sep~ (see [[noweb-sep]]) header argument holds the string used -to separate accumulate noweb references like those above. By default a +to separate accumulate noweb references like those above. By default a newline is used. **** noweb-sep @@ -15257,7 +15257,7 @@ newline is used. :END: The ~:noweb-sep~ header argument holds the string used to separate -accumulated noweb references (see [[noweb-ref]]). By default a newline is +accumulated noweb references (see [[noweb-ref]]). By default a newline is used. **** cache @@ -15266,25 +15266,25 @@ used. :END: The ~:cache~ header argument controls the use of in-buffer caching of -the results of evaluating code blocks. It can be used to avoid -re-evaluating unchanged code blocks. Note that the ~:cache~ header +the results of evaluating code blocks. It can be used to avoid +re-evaluating unchanged code blocks. Note that the ~:cache~ header argument will not attempt to cache results when the ~:session~ header argument is used, because the results of the code block execution may -be stored in the session outside of the Org mode buffer. The ~:cache~ +be stored in the session outside of the Org mode buffer. The ~:cache~ header argument can have one of two values: ~yes~ or ~no~. #+attr_texinfo: :table-type table :indic @asis - ~no~ :: - The default. No caching takes place, and the code block will be + The default. No caching takes place, and the code block will be evaluated every time it is called. - ~yes~ :: Every time the code block is run a SHA1 hash of the code and arguments - passed to the block will be generated. This hash is packed into the + passed to the block will be generated. This hash is packed into the ~#+RESULTS:~ line and will be checked on subsequent executions of the - code block. If the code block has not changed since the last time it + code block. If the code block has not changed since the last time it was evaluated, it will not be re-evaluated. @@ -15319,7 +15319,7 @@ changed since it was last run. #+kindex: C-c C-o The ~:sep~ header argument can be used to control the delimiter used -when writing tabular results out to files external to Org mode. This +when writing tabular results out to files external to Org mode. This is used either when opening tabular results of a code block by calling the ~org-open-at-point~ function bound to {{{kbd(C-c C-o)}}} on the code block, or when writing code block results to an external file @@ -15334,15 +15334,15 @@ delimited. :END: Tables are frequently represented with one or more horizontal lines, -or hlines. The ~:hlines~ argument to a code block accepts the values +or hlines. The ~:hlines~ argument to a code block accepts the values ~yes~ or ~no~, with a default value of ~no~. #+attr_texinfo: :table-type table :indic @asis - ~no~ :: - Strips horizontal lines from the input table. In most languages this + Strips horizontal lines from the input table. In most languages this is the desired effect because an ~hline~ symbol is interpreted as an - unbound variable and raises an error. Setting ~:hlines no~ or relying + unbound variable and raises an error. Setting ~:hlines no~ or relying on the default value yields the following results. #+begin_example @@ -15366,7 +15366,7 @@ or hlines. The ~:hlines~ argument to a code block accepts the values - ~yes~ :: - Leaves hlines in the table. Setting ~:hlines yes~ has this effect. + Leaves hlines in the table. Setting ~:hlines yes~ has this effect. #+begin_example #+TBLNAME: many-cols @@ -15395,9 +15395,9 @@ or hlines. The ~:hlines~ argument to a code block accepts the values :END: The ~:colnames~ header argument accepts the values ~yes~, ~no~, or -~nil~ for unassigned. The default value is ~nil~. Note that the +~nil~ for unassigned. The default value is ~nil~. Note that the behavior of the ~:colnames~ header argument may differ across -languages. For example Emacs Lisp code blocks ignore the ~:colnames~ +languages. For example Emacs Lisp code blocks ignore the ~:colnames~ header argument entirely given the ease with which tables with column names may be handled directly in Emacs Lisp. @@ -15428,7 +15428,7 @@ names may be handled directly in Emacs Lisp. #+end_example Please note that column names are not removed before the table is - indexed using variable indexing. See [[Indexable variable values]]. + indexed using variable indexing. See [[Indexable variable values]]. - ~no~ :: @@ -15474,7 +15474,7 @@ or ~no~, with a default value of ~no~. #+end_example Please note that row names are not removed before the table is indexed - using variable indexing. See [[Indexable variable values]]. + using variable indexing. See [[Indexable variable values]]. **** shebang :PROPERTIES: @@ -15492,10 +15492,10 @@ permissions of the tangled file are set to make it executable. :END: The ~:eval~ header argument can be used to limit the evaluation of -specific code blocks. The ~:eval~ header argument can be useful for +specific code blocks. The ~:eval~ header argument can be useful for protecting against the evaluation of dangerous code blocks or to ensure that evaluation will require a query regardless of the value of -the ~org-confirm-babel-evaluate~ variable. The possible values of +the ~org-confirm-babel-evaluate~ variable. The possible values of ~:eval~ and their effects are shown below. #+attr_texinfo: :table-type table :indic @asis @@ -15529,9 +15529,9 @@ security]]). :END: The ~:wrap~ header argument is used to mark the results of source -block evaluation. The header argument can be passed a string that will +block evaluation. The header argument can be passed a string that will be appended to ~#+BEGIN_~ and ~#+END_~, which will then be used to -wrap the results. If no string is specified then the results will be +wrap the results. If no string is specified then the results will be wrapped in a ~#+BEGIN/END_RESULTS~ block. ** Results of evaluation @@ -15543,7 +15543,7 @@ wrapped in a ~#+BEGIN/END_RESULTS~ block. The way in which results are handled depends on whether a session is invoked, as well as on whether ~:results value~ or ~:results output~ -is used. The following table shows the table possibilities. For a full +is used. The following table shows the table possibilities. For a full listing of the possible results header arguments, see [[results]]. | | *Non-session* | *Session* | @@ -15561,10 +15561,10 @@ two-dimensional vector of strings or numbers) when appropriate. #+attr_texinfo: :table-type table :indic @asis - ~:results value~ :: - This is the default. Internally, the value is obtained by wrapping the + This is the default. Internally, the value is obtained by wrapping the code in a function definition in the external language, and evaluating - that function. Therefore, code should be written as if it were the - body of such a function. In particular, note that Python does not + that function. Therefore, code should be written as if it were the + body of such a function. In particular, note that Python does not automatically return a value from a function unless a ~return~ statement is present, and so a {{{samp(return)}}} statement will usually be required in Python. @@ -15583,7 +15583,7 @@ two-dimensional vector of strings or numbers) when appropriate. - ~:results value~ :: The code is passed to an interpreter running as an interactive Emacs - inferior process. Only languages which provide tools for interactive + inferior process. Only languages which provide tools for interactive evaluation of code have session support, so some language (e.g., C and ditaa) do not support the ~:session~ header argument, and in other languages (e.g., Python and Haskell) which have limitations on the @@ -15598,11 +15598,11 @@ two-dimensional vector of strings or numbers) when appropriate. - ~:results output~ :: The code is passed to the interpreter running as an interactive Emacs - inferior process. The result returned is the concatenation of the - sequence of (text) output from the interactive interpreter. Notice + inferior process. The result returned is the concatenation of the + sequence of (text) output from the interactive interpreter. Notice that this is not necessarily the same as what would be sent to ~STDOUT~ if the same code were passed to a non-interactive interpreter - running as an external process. Compare the following two + running as an external process. Compare the following two examples: #+begin_example @@ -15633,7 +15633,7 @@ two-dimensional vector of strings or numbers) when appropriate. #+end_example But in ~:session~ mode, the interactive interpreter receives input `2' - and prints out its value, `2'. (Indeed, the other print statements are + and prints out its value, `2'. (Indeed, the other print statements are unnecessary here). ** Noweb reference syntax @@ -15654,13 +15654,13 @@ the familiar Noweb syntax: When a code block is tangled or evaluated, whether or not ``noweb'' references are expanded depends upon the value of the ~:noweb~ header -argument. If ~:noweb yes~, then a Noweb reference is expanded before -evaluation. If ~:noweb no~, the default, then the reference is not -expanded before evaluation. See the [[noweb-ref]] header argument for a +argument. If ~:noweb yes~, then a Noweb reference is expanded before +evaluation. If ~:noweb no~, the default, then the reference is not +expanded before evaluation. See the [[noweb-ref]] header argument for a more flexible way to resolve noweb references. It is possible to include the /results/ of a code block rather than -the body. This is done by appending parenthesis to the code block +the body. This is done by appending parenthesis to the code block name, which may optionally contain arguments to the code block as shown below. @@ -15670,13 +15670,13 @@ shown below. Note that the default value, ~:noweb no~, was chosen to ensure that correct code is not broken in a language, such as Ruby, where -~<>~ is a syntactically valid construct. If ~<>~ is not +~<>~ is a syntactically valid construct. If ~<>~ is not syntactically valid in languages that you use, then please consider setting the default value. If noweb tangling is slow in large Org mode files, consider setting the ~*org-babel-use-quick-and-dirty-noweb-expansion*~ variable -to true. This will result in faster noweb reference resolution at the +to true. This will result in faster noweb reference resolution at the expense of not correctly resolving inherited values of the ~:noweb-ref~ header argument. @@ -15854,13 +15854,13 @@ Be sure to adjust the paths to fit your system. #+cindex: link abbreviations, completion of Emacs would not be Emacs without completion, and Org mode uses it -whenever it makes sense. If you prefer an iswitchb- or ido-like +whenever it makes sense. If you prefer an iswitchb- or ido-like interface for some of the completion prompts, you can specify your preference by setting at most one of the variables ~org-completion-use-iswitchb~ or ~org-completion-use-ido~. -Org supports in-buffer completion. This type of completion does not -make use of the minibuffer. You simply type a few letters into the +Org supports in-buffer completion. This type of completion does not +make use of the minibuffer. You simply type a few letters into the buffer and use the {{{key(TAB)}}} key to complete text right there. #+attr_texinfo: :table-type table :indic @asis @@ -15888,14 +15888,14 @@ buffer and use the {{{key(TAB)}}} key to complete text right there. - After {{{samp(:)}}} in a headline :: - Complete tags. The list of tags is taken from the variable + Complete tags. The list of tags is taken from the variable ~org-tag-alist~ (possibly set through the {{{samp(#+TAGS)}}} in-buffer option, see [[Setting tags]]), or it is created dynamically from all tags used in the current buffer. - After {{{samp(:)}}} and not in a headline :: - Complete property keys. The list of keys is constructed dynamically + Complete property keys. The list of keys is constructed dynamically from all keys used in the current buffer. - After {{{samp([)}}} :: @@ -15905,7 +15905,7 @@ buffer and use the {{{key(TAB)}}} key to complete text right there. - After {{{samp(#+)}}} :: Complete the special keywords like {{{samp(TYP_TODO)}}} or - {{{samp(OPTIONS)}}} which set file-specific options for Org mode. When + {{{samp(OPTIONS)}}} which set file-specific options for Org mode. When the option keyword is already complete, pressing {{{kbdkey(M-,TAB)}}} again will insert example settings for this keyword. @@ -15925,13 +15925,13 @@ buffer and use the {{{key(TAB)}}} key to complete text right there. #+cindex: insertion, of templates Org mode supports insertion of empty structural elements (like -~#+BEGIN_SRC~ and ~#+END_SRC~ pairs) with just a few key strokes. This -is achieved through a native template expansion mechanism. Note that +~#+BEGIN_SRC~ and ~#+END_SRC~ pairs) with just a few key strokes. This +is achieved through a native template expansion mechanism. Note that Emacs has several other template mechanisms which could be used in a similar way, for example {{{file(yasnippet)}}}. To insert a structural element, type a {{{kbd(<)}}}, followed by a -template selector and {{{kbdkey(,TAB)}}}. Completion takes effect only +template selector and {{{kbdkey(,TAB)}}}. Completion takes effect only when the above keystrokes are typed on a line by itself. The following template selectors are currently supported: @@ -15982,10 +15982,10 @@ additional details. #+vindex: org-speed-commands-user Single keys can be made to execute commands when the cursor is at the -beginning of a headline, i.e., before the first star. Configure the -variable ~org-use-speed-commands~ to activate this feature. There is a +beginning of a headline, i.e., before the first star. Configure the +variable ~org-use-speed-commands~ to activate this feature. There is a pre-defined list of commands, and you can add more such commands using -the variable ~org-speed-commands-user~. Speed keys do not only speed +the variable ~org-speed-commands-user~. Speed keys do not only speed up navigation and other commands, but they also provide an alternative way to execute commands bound to keys that are not or not easily available on a TTY, or on a small mobile device with a limited @@ -16003,14 +16003,14 @@ To see which commands are available, activate the feature and press Org provides tools to work with the code snippets, including evaluating them. -Running code on your machine always comes with a security risk. Badly +Running code on your machine always comes with a security risk. Badly written or malicious code can be executed on purpose or by accident. Org has default settings that will only evaluate source code if you give explicit permission to do so, and as a casual user of these features you should leave these precautions intact. For people who regularly work with source code, the confirmation -prompts can become annoying, and you might want to turn them off. This +prompts can become annoying, and you might want to turn them off. This can be done, but you must be aware of the risks that are involved. Code evaluation can happen under the following circumstances: @@ -16019,9 +16019,9 @@ Code evaluation can happen under the following circumstances: - Source code blocks :: Source code blocks can be evaluated during export, or when pressing - {{{kbd(C-c C-c)}}} in the block. The most important thing to realize + {{{kbd(C-c C-c)}}} in the block. The most important thing to realize here is that Org mode files which contain code snippets are, in a - certain sense, like executable files. So you should accept them and + certain sense, like executable files. So you should accept them and load them into Emacs only from trusted sources---just like you would do with a program you install on your computer. @@ -16031,7 +16031,7 @@ Code evaluation can happen under the following circumstances: - ~org-confirm-babel-evaluate~ :: When ~t~ (the default), the user is asked before every code block - evaluation. When ~nil~, the user is not asked. When set to a function, + evaluation. When ~nil~, the user is not asked. When set to a function, it is called with two arguments (language and body of the code block) and should return ~t~ to ask and ~nil~ not to ask. @@ -16049,7 +16049,7 @@ Code evaluation can happen under the following circumstances: - Following ~shell~ and ~elisp~ links :: Org has two link types that can directly evaluate code (see [[External - links]]). These links can be problematic because the code to be + links]]). These links can be problematic because the code to be evaluated is not visible. - ~org-confirm-shell-link-function~ :: @@ -16075,9 +16075,9 @@ Code evaluation can happen under the following circumstances: There are more than 500 variables that can be used to customize Org. For the sake of compactness of the manual, I am not describing the -variables here. A structured overview of customization variables is -available with {{{kbd(M-x org-customize)}}}. Or select ~Browse Org -Group~ from the ~Org->Customization~ menu. Many settings can also be +variables here. A structured overview of customization variables is +available with {{{kbd(M-x org-customize)}}}. Or select ~Browse Org +Group~ from the ~Org->Customization~ menu. Many settings can also be activated on a per-file basis, by putting special lines into the buffer (see [[In-buffer settings]]). @@ -16090,35 +16090,35 @@ buffer (see [[In-buffer settings]]). #+cindex: special keywords Org mode uses special lines in the buffer to define settings on a -per-file basis. These lines start with a {{{samp(#+)}}} followed by a +per-file basis. These lines start with a {{{samp(#+)}}} followed by a keyword, a colon, and then individual words defining a setting. Several setting words can be in the same line, but you can also have -multiple lines for the keyword. While these settings are described -throughout the manual, here is a summary. After changing any of those +multiple lines for the keyword. While these settings are described +throughout the manual, here is a summary. After changing any of those lines in the buffer, press {{{kbd(C-c C-c)}}} with the cursor still in -the line to activate the changes immediately. Otherwise they become +the line to activate the changes immediately. Otherwise they become effective only when the file is visited again in a new Emacs session. #+vindex: org-archive-location #+attr_texinfo: :table-type table :indic @asis - {{{kbd(#+ARCHIVE: %s_done)}}} :: - This line sets the archive location for the agenda file. It applies to + This line sets the archive location for the agenda file. It applies to all subsequent lines, until the next {{{samp(#+ARCHIVE)}}} line or the - end of the file. The first such line also applies to any entries - before it. The corresponding variable is ~org-archive-location~. + end of the file. The first such line also applies to any entries + before it. The corresponding variable is ~org-archive-location~. - {{{kbd(#+CATEGORY:)}}} :: - This line sets the category for the agenda file. The category applies + This line sets the category for the agenda file. The category applies to all subsequent lines, until the next {{{samp(#+CATEGORY)}}} line or - the end of the file. The first such line also applies to any entries + the end of the file. The first such line also applies to any entries before it. - {{{kbd(#+COLUMNS: %25ITEM ...)}}} :: #+cindex: property, COLUMNS - Set the default format for columns view. This format applies when + Set the default format for columns view. This format applies when columns view is invoked in locations where no ~COLUMNS~ property applies. @@ -16126,8 +16126,8 @@ effective only when the file is visited again in a new Emacs session. #+vindex: org-table-formula-constants #+vindex: org-table-formula - Set file-local values for constants to be used in table formulas. This - line sets the local variable ~org-table-formula-constants-local~. The + Set file-local values for constants to be used in table formulas. This + line sets the local variable ~org-table-formula-constants-local~. The global version of this variable is ~org-table-formula-constants~. - {{{kbd(#+FILETAGS: :tag1:tag2:tag3:)}}} :: @@ -16138,22 +16138,22 @@ effective only when the file is visited again in a new Emacs session. - {{{kbd(#+DRAWERS: NAME1 ...)}}} :: #+vindex: org-drawers - Set the file-local set of additional drawers. The corresponding global + Set the file-local set of additional drawers. The corresponding global variable is ~org-drawers~. - {{{kbd(#+LINK: linkword replace)}}} :: #+vindex: org-link-abbrev-alist - These lines (several are allowed) specify link abbreviations. See - [[Link abbreviations]]. The corresponding variable is ~org-link-abbrev-alist~. + These lines (several are allowed) specify link abbreviations. See + [[Link abbreviations]]. The corresponding variable is ~org-link-abbrev-alist~. - {{{kbd(#+PRIORITIES: highest lowest default)}}} :: #+vindex: org-highest-priority #+vindex: org-lowest-priority #+vindex: org-default-priority - This line sets the limits and the default for the priorities. All - three must be either letters A-Z or numbers 0-9. The highest priority + This line sets the limits and the default for the priorities. All + three must be either letters A-Z or numbers 0-9. The highest priority must have a lower ASCII number than the lowest priority. - {{{kbd(#+PROPERTY: Property_Name Value)}}} :: @@ -16164,13 +16164,13 @@ effective only when the file is visited again in a new Emacs session. - {{{kbd(#+SETUPFILE: file)}}} :: #+cindex: #+SETUPFILE - This line defines a file that holds more in-buffer setup. Normally - this is entirely ignored. Only when the buffer is parsed for + This line defines a file that holds more in-buffer setup. Normally + this is entirely ignored. Only when the buffer is parsed for option-setting lines (i.e., when starting Org mode for a file, when pressing {{{kbd(C-c C-c)}}} in a settings line, or when exporting), then the contents of this file are parsed as if they had been included - in the buffer. In particular, the file can be any other Org mode file - with internal setup. You can visit the file the cursor is in the line + in the buffer. In particular, the file can be any other Org mode file + with internal setup. You can visit the file the cursor is in the line with {{{kbd(C-c ')}}}. - {{{kbd(#+STARTUP:)}}} :: @@ -16180,7 +16180,7 @@ effective only when the file is visited again in a new Emacs session. Org file is being visited. The first set of options deals with the initial visibility of the - outline tree. The corresponding variable for global default settings + outline tree. The corresponding variable for global default settings is ~org-startup-folded~, with a default value ~t~, which means ~overview~. @@ -16283,7 +16283,7 @@ effective only when the file is visited again in a new Emacs session. #+vindex: org-odd-levels-only Here are the options for hiding leading stars in outline headings, and - for indenting outlines. The corresponding variables are + for indenting outlines. The corresponding variables are ~org-hide-leading-stars~ and ~org-odd-levels-only~, both with a default setting ~nil~ (meaning ~showstars~ and ~oddeven~). @@ -16328,7 +16328,7 @@ effective only when the file is visited again in a new Emacs session. #+vindex: org-footnote-auto-label #+vindex: org-footnote-auto-adjust - To influence footnote settings, use the following keywords. The + To influence footnote settings, use the following keywords. The corresponding variables are ~org-footnote-define-inline~, ~org-footnote-auto-label~, and ~org-footnote-auto-adjust~. @@ -16355,7 +16355,7 @@ effective only when the file is visited again in a new Emacs session. #+cindex: org-hide-block-startup - To hide blocks on startup, use these keywords. The corresponding + To hide blocks on startup, use these keywords. The corresponding variable is ~org-hide-block-startup~. #+cindex: @code{hideblocks}, STARTUP keyword @@ -16382,7 +16382,7 @@ effective only when the file is visited again in a new Emacs session. These lines (several such lines are allowed) specify the valid tags in this file, and (potentially) the corresponding /fast tag selection/ - keys. The corresponding variable is ~org-tag-alist~. + keys. The corresponding variable is ~org-tag-alist~. - {{{kbd(#+TBLFM:)}}} :: @@ -16397,7 +16397,7 @@ effective only when the file is visited again in a new Emacs session. #+vindex: org-todo-keywords These lines set the TODO keywords and their interpretation in the - current file. The corresponding variable is ~org-todo-keywords~. + current file. The corresponding variable is ~org-todo-keywords~. ** The very busy C-c C-c key :PROPERTIES: @@ -16419,12 +16419,12 @@ what this means in different contexts. - If the cursor is in one of the special ~#+KEYWORD~ lines, this triggers scanning the buffer for these lines and updating the information. -- If the cursor is inside a table, realign the table. This command +- If the cursor is inside a table, realign the table. This command works even if the automatic table editor has been turned off. - If the cursor is on a ~#+TBLFM~ line, re-apply the formulas to the entire table. - If the current buffer is a capture buffer, close the note and file - it. With a prefix argument, file it, without further interaction, to + it. With a prefix argument, file it, without further interaction, to the default location. - If the cursor is on a ~<<>>~, update radio targets and corresponding links in this buffer. @@ -16453,7 +16453,7 @@ what this means in different contexts. Some people find it noisy and distracting that the Org headlines start with a potentially large number of stars, and that text below the -headlines is not indented. While this is no problem when writing a +headlines is not indented. While this is no problem when writing a /book-like/ document where the outline headings are really section headings, in a more /list-oriented/ outline, indented structure is a lot cleaner: @@ -16510,7 +16510,7 @@ display, Org supports you in the following way: #+vindex: org-hide-leading-stars You can modify the display in such a way that all leading stars become - invisible. To do this in a global way, configure the variable + invisible. To do this in a global way, configure the variable ~org-hide-leading-stars~ or change this on a per-file basis with #+begin_example @@ -16531,9 +16531,9 @@ display, Org supports you in the following way: {{{noindent}}} The leading stars are not truly replaced by whitespace, they are only fontified with the face ~org-hide~ that uses the - background color as font color. If you are not using either white or + background color as font color. If you are not using either white or black background, you may have to customize this face to get the - wanted effect. Another possibility is to set this font such that the + wanted effect. Another possibility is to set this font such that the extra stars are /almost/ invisible, for example using the color ~grey90~ on a white background. - Odd levels :: @@ -16542,7 +16542,7 @@ display, Org supports you in the following way: Things become cleaner still if you skip all the even levels and use only odd levels 1, 3, 5, ..., effectively adding two stars to go from one outline level to the next.[fn:158] In this way we get the outline - view shown at the beginning of this section. In order to make the + view shown at the beginning of this section. In order to make the structure editing and export commands handle this convention correctly, configure the variable ~org-odd-levels-only~, or set this on a per-file basis with one of the following lines: @@ -16554,7 +16554,7 @@ display, Org supports you in the following way: You can convert an Org file from single-star-per-level to the double-star-per-level convention with {{{kbdkey(M-x - org-convert-to-odd-levels , RET)}}} in that file. The reverse + org-convert-to-odd-levels , RET)}}} in that file. The reverse operation is {{{kbd(M-x org-convert-to-oddeven-levels)}}}. ** TTY keys @@ -16568,11 +16568,11 @@ Org's core commands are bound to keys that are generally not accessible on a tty, such as the cursor keys ({{{key(left)}}}, {{{key(right)}}}, {{{key(up)}}}, {{{key(down)}}}), {{{key(TAB)}}} and {{{key(RET)}}}, in particular when used together with modifiers like -{{{key(Meta)}}} and/or {{{key(Shift)}}}. To access these commands on a +{{{key(Meta)}}} and/or {{{key(Shift)}}}. To access these commands on a tty when special keys are unavailable, the following alternative -bindings can be used. The tty bindings below will likely be more +bindings can be used. The tty bindings below will likely be more cumbersome; you may find for some of the bindings below that a -customized workaround suits you better. For example, changing a +customized workaround suits you better. For example, changing a timestamp is really only fun with {{{kbdkey(S-,cursor)}}} keys, whereas on a tty you would rather use {{{kbd(C-c .)}}} to re-insert the timestamp. @@ -16620,12 +16620,12 @@ with other code out there. #+cindex: Gillespie, Dave Org uses the Calc package for implementing spreadsheet functionality - in its tables (see [[The spreadsheet]]). Org checks for the availability + in its tables (see [[The spreadsheet]]). Org checks for the availability of Calc by looking for the function ~calc-eval~ which will have been - autoloaded during setup if Calc has been installed properly. As of - Emacs 22, Calc is part of the Emacs distribution. Another possibility + autoloaded during setup if Calc has been installed properly. As of + Emacs 22, Calc is part of the Emacs distribution. Another possibility for interaction between the two packages is using Calc for embedded - calculations. See [[info:calc:Embedded Mode][GNU Emacs Calc Manual]]. + calculations. See [[info:calc:Embedded Mode][GNU Emacs Calc Manual]]. - {{{file(constants.el)}}} by Carsten Dominik :: #+cindex: @file{constants.el} @@ -16633,14 +16633,14 @@ with other code out there. #+vindex: org-table-formula-constants In a table formula (see [[The spreadsheet]]), it is possible to use names - for natural constants or units. Instead of defining your own constants + for natural constants or units. Instead of defining your own constants in the variable ~org-table-formula-constants~, install the {{{file(constants)}}} package which defines a large number of constants and units, and lets you use unit prefixes like {{{samp(M)}}} - for {{{samp(Mega)}}}, etc. You will need version 2.0 of this package, - available at [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks for + for {{{samp(Mega)}}}, etc. You will need version 2.0 of this package, + available at [[http://www.astro.uva.nl/~dominik/Tools]]. Org checks for the function ~constants-get~, which has to be autoloaded in your - setup. See the installation instructions in the file + setup. See the installation instructions in the file {{{file(constants.el)}}}. - {{{file(cdlatex.el)}}} by Carsten Dominik :: @@ -16648,7 +16648,7 @@ with other code out there. #+cindex: Dominik, Carsten Org mode can make use of the CDLaTeX package to efficiently enter - LaTeX fragments into Org files. See [[CDLaTeX mode]]. + LaTeX fragments into Org files. See [[CDLaTeX mode]]. - {{{file(imenu.el)}}} by Ake Stenhoff and Lars Lindberg :: #+cindex: @file{imenu.el} @@ -16701,15 +16701,15 @@ with other code out there. - {{{kbd(C-c ')}}}, ~org-edit-special~ :: #+kindex: C-c ' - Edit a {{{file(table.el)}}} table. Works when the cursor is in a + Edit a {{{file(table.el)}}} table. Works when the cursor is in a table.el table. - {{{kbd(C-c XXX)}}}, ~org-table-create-with-table.el~ :: #+kindex: C-c ~ # Should be ~ - Insert a {{{file(table.el)}}} table. If there is already a table at + Insert a {{{file(table.el)}}} table. If there is already a table at point, this command converts it between the {{{file(table.el)}}} - format and the Org mode format. See the documentation string of the + format and the Org mode format. See the documentation string of the command ~org-convert-table~ for the restrictions under which this is possible. @@ -16734,12 +16734,12 @@ with other code out there. In Emacs 23, ~shift-selection-mode~ is on by default, meaning that cursor motions combined with the shift key should start or enlarge -regions. This conflicts with the use of {{{kbdkey(S-,cursor)}}} +regions. This conflicts with the use of {{{kbdkey(S-,cursor)}}} commands in Org to change timestamps, TODO keywords, priorities, and -item bullet types if the cursor is at such a location. By default, +item bullet types if the cursor is at such a location. By default, {{{kbdkey(S-,cursor)}}} commands outside special contexts don't do anything, but you can customize the variable -~org-support-shift-select~. Org mode then tries to accommodate shift +~org-support-shift-select~. Org mode then tries to accommodate shift selection by using it outside of the special contexts where special commands apply, and by extending an existing active region even if the cursor moves across a special context. @@ -16752,12 +16752,12 @@ region even if the cursor moves across a special context. Key bindings in Org conflict with the {{{kbdkey(S-,)}}} keys used by CUA mode (as well as ~pc-select-mode~ and ~s-region-mode~) to - select and extend the region. In fact, Emacs 23 has this built-in in - the form of ~shift-selection-mode~, see previous paragraph. If you are + select and extend the region. In fact, Emacs 23 has this built-in in + the form of ~shift-selection-mode~, see previous paragraph. If you are using Emacs 23, you probably don't want to use another package for - this purpose. However, if you prefer to leave these keys to a + this purpose. However, if you prefer to leave these keys to a different package while working in Org mode, configure the variable - ~org-replace-disputed-keys~. When set, Org will move the following key + ~org-replace-disputed-keys~. When set, Org will move the following key bindings in Org files, and in the agenda buffer (but not during date selection). @@ -16767,7 +16767,7 @@ region even if the cursor moves across a special context. #+vindex: org-disputed-keys - Yes, these are unfortunately more difficult to remember. If you want + Yes, these are unfortunately more difficult to remember. If you want to have other replacement keys, look at the variable ~org-disputed-keys~. @@ -16776,7 +16776,7 @@ region even if the cursor moves across a special context. #+cindex: Jones, Kyle Org mode tries to do the right thing when filling paragraphs, list - items and other elements. Many users reported they had problems using + items and other elements. Many users reported they had problems using both {{{file(filladapt.el)}}} and Org mode, so a safe thing to do is to disable it like this: @@ -16788,7 +16788,7 @@ region even if the cursor moves across a special context. #+cindex: @file{yasnippet.el} The way Org mode binds the {{{key(TAB)}}} key (binding to ~[tab]~ - instead of ~"\t"~) overrules YASnippet's access to this key. The + instead of ~"\t"~) overrules YASnippet's access to this key. The following code fixed this problem: #+begin_src emacs-lisp @@ -16823,7 +16823,7 @@ region even if the cursor moves across a special context. #+cindex: Shacham, Hovav This package also uses the {{{kbd(S-)}}} keys, so everything - written in the paragraph above about CUA mode also applies here. If + written in the paragraph above about CUA mode also applies here. If you want make the windmove function active in locations where Org mode does not have special functionality on {{{kbdkey(S-,cursor)}}}, add this to your configuration: @@ -16858,11 +16858,11 @@ region even if the cursor moves across a special context. #+cindex: @code{org-decrypt-entry} Org-crypt will encrypt the text of an entry, but not the headline, or -properties. Org-crypt uses the Emacs EasyPG library to encrypt and +properties. Org-crypt uses the Emacs EasyPG library to encrypt and decrypt files. Any text below a headline that has a {{{samp(:crypt:)}}} tag will -automatically be encrypted when the file is saved. If you want to use +automatically be encrypted when the file is saved. If you want to use a different tag just customize the ~org-crypt-tag-matcher~ setting. To use org-crypt it is suggested that you have the following in your @@ -16922,9 +16922,9 @@ maintained by the Worg project and can be found at #+cindex: add-on packages A large number of add-on packages have been written by various -authors. These packages are not part of Emacs, but they are +authors. These packages are not part of Emacs, but they are distributed as contributed packages with the separate release -available at the Org mode home page at [[http://orgmode.org]]. The +available at the Org mode home page at [[http://orgmode.org]]. The list of contributed packages, along with documentation about each package, is maintained by the Worg project at [[http://orgmode.org/worg/org-contrib/]]. @@ -16937,7 +16937,7 @@ package, is maintained by the Worg project at Org has a large number of hyperlink types built-in (see [[Hyperlinks]]). If you would like to add new link types, Org provides an interface for -doing so. Let's look at an example file, {{{file(org-man.el)}}}, that +doing so. Let's look at an example file, {{{file(org-man.el)}}}, that will add support for creating links like: #+begin_example @@ -17016,21 +17016,21 @@ PATH should be a topic that can be thrown at the man command." The rest of the file defines the necessary variables and functions. First there is a customization variable that determines which Emacs -command should be used to display man pages. There are two options, -~man~ and ~woman~. Then the function to follow a link is defined. It +command should be used to display man pages. There are two options, +~man~ and ~woman~. Then the function to follow a link is defined. It gets the link path as an argument---in this case the link path is just -a topic for the manual command. The function calls the value of +a topic for the manual command. The function calls the value of ~org-man-command~ to display the man page. -Finally the function ~org-man-store-link~ is defined. When you try to +Finally the function ~org-man-store-link~ is defined. When you try to store a link with {{{kbd(C-c l)}}}, this function will be called to -try to make a link. The function must first decide if it is supposed +try to make a link. The function must first decide if it is supposed to create the link for this buffer type; we do this by checking the -value of the variable ~major-mode~. If not, the function must exit and -return the value ~nil~. If yes, the link is created by getting the +value of the variable ~major-mode~. If not, the function must exit and +return the value ~nil~. If yes, the link is created by getting the manual topic from the buffer name and prefixing it with the string -{{{samp(man:)}}}. Then it must call the command ~org-store-link-props~ -and set the ~:type~ and ~:link~ properties. Optionally you can also +{{{samp(man:)}}}. Then it must call the command ~org-store-link-props~ +and set the ~:type~ and ~:link~ properties. Optionally you can also set the ~:description~ property to provide a default for the link description when the link is later inserted into an Org buffer with {{{kbd(C-c C-l)}}}. @@ -17051,12 +17051,12 @@ link with prefix. Org has several commands that act differently depending on context. The most important example is the {{{kbd(C-c C-c)}}} (see [[The very -busy C-c C-c key]]). Also the {{{kbd(M-cursor)}}} and +busy C-c C-c key]]). Also the {{{kbd(M-cursor)}}} and {{{kbd(M-S-cursor)}}} keys have this property. Add-ons can tap into this functionality by providing a function that detects special context for that add-on and executes functionality -appropriate for the context. Here is an example from Dan Davison's +appropriate for the context. Here is an example from Dan Davison's {{{file(org-R.el)}}} which allows you to evaluate commands based on the {{{file(R)}}} programming language.[fn:159] For this package, special contexts are lines that start with ~#+R:~ or ~#+RR:~. @@ -17076,10 +17076,10 @@ special contexts are lines that start with ~#+R:~ or ~#+RR:~. (add-hook 'org-ctrl-c-ctrl-c-hook 'org-R-apply-maybe) #+end_src -The function first checks if the cursor is in such a line. If that is +The function first checks if the cursor is in such a line. If that is the case, ~org-R-apply~ is called and the function returns ~t~ to signal that action was taken, and {{{kbd(C-c C-c)}}} will stop looking -for other contexts. If the function finds it should do nothing +for other contexts. If the function finds it should do nothing locally, it returns ~nil~ so that other, similar functions can have a try. @@ -17093,7 +17093,7 @@ try. Since Orgtbl mode can be used as a minor mode in arbitrary buffers, a frequent feature request has been to make it work with native tables -in specific languages, for example LaTeX. However, this is +in specific languages, for example LaTeX. However, this is extremely hard to do in a general way, would lead to a customization nightmare, and would take away much of the simplicity of the Orgtbl mode table editor. @@ -17106,7 +17106,7 @@ the burden of writing conversion functions on the user, but it allows for a very flexible system. Bastien added the ability to do the same with lists, in Orgstruct -mode. You can use Org's facilities to edit and structure lists by +mode. You can use Org's facilities to edit and structure lists by turning ~orgstruct-mode~ on, then locally exporting such lists in another format (HTML, LaTeX or Texinfo.) @@ -17118,8 +17118,8 @@ another format (HTML, LaTeX or Texinfo.) To define the location of the target table, you first need to create two lines that are comments in the current mode, but contain magic -words for Orgtbl mode to find. Orgtbl mode will insert the translated -table between these lines, replacing whatever was there before. For +words for Orgtbl mode to find. Orgtbl mode will insert the translated +table between these lines, replacing whatever was there before. For example: #+begin_example @@ -17137,22 +17137,22 @@ For example: #+end_example {{{noindent}}} Here, ~table_name~ is the reference name for the table -that is also used in the receiver lines. ~translation_function~ is the -Lisp function that does the translation. Furthermore, the line can +that is also used in the receiver lines. ~translation_function~ is the +Lisp function that does the translation. Furthermore, the line can contain a list of arguments (alternating key and value) at the end. The arguments will be passed as a property list to the translation -function for interpretation. A few standard parameters are already +function for interpretation. A few standard parameters are already recognized and acted upon before the translation function is called: #+attr_texinfo: :table-type table :indic @asis - ~:skip N~ :: - Skip the first N lines of the table. Hlines do count as separate lines + Skip the first N lines of the table. Hlines do count as separate lines for this parameter! - ~:skipcols (n1 n2 ...)~ :: - List of columns that should be skipped. If the table has a column with + List of columns that should be skipped. If the table has a column with calculation marks, that column is automatically discarded as well. Please note that the translator function sees the table /after/ the removal of these columns, the function never knows that there have @@ -17161,13 +17161,13 @@ recognized and acted upon before the translation function is called: - ~:no-escape t~ :: When non-nil, do not escape special characters ~&%#_^~ when exporting - the table. The default value is nil. + the table. The default value is nil. {{{noindent}}} The one problem remaining is how to keep the source table in the buffer without disturbing the normal workings of the file, for example during compilation of a C file or processing of a -LaTeX file. There are a number of different solutions: +LaTeX file. There are a number of different solutions: - The table could be placed in a block comment if that is supported by the language. For example, in C mode you could wrap the table @@ -17179,7 +17179,7 @@ LaTeX file. There are a number of different solutions: - You can just comment the table line-by-line whenever you want to process the file, and uncomment it whenever you need to edit the - table. This only sounds tedious---the command {{{kbd(M-x + table. This only sounds tedious---the command {{{kbd(M-x orgtbl-toggle-comment)}}} makes this comment-toggling very easy, in particular if you bind it to a key. @@ -17191,11 +17191,11 @@ LaTeX file. There are a number of different solutions: #+cindex: @LaTeX{}, and Orgtbl mode The best way to wrap the source table in LaTeX is to use the -~comment~ environment provided by {{{file(comment.sty)}}}. It has to +~comment~ environment provided by {{{file(comment.sty)}}}. It has to be activated by placing ~\usepackage{comment}~ into the document -header. Orgtbl mode can insert a radio table skeleton with the command +header. Orgtbl mode can insert a radio table skeleton with the command {{{kbd(M-x orgtbl-insert-radio-table)}}}.[fn:160] You will be prompted -for a table name, let's say we use {{{samp(salesfigures)}}}. You will +for a table name, let's say we use {{{samp(salesfigures)}}}. You will then get the following template: #+cindex: #+ORGTBL, SEND @@ -17212,7 +17212,7 @@ then get the following template: {{{noindent}}} The ~#+ORGTBL: SEND~ line tells Orgtbl mode to use the function ~orgtbl-to-latex~ to convert the table into LaTeX and to -put it into the receiver location with name ~salesfigures~. You may +put it into the receiver location with name ~salesfigures~. You may now fill in the table---feel free to use the spreadsheet features:[fn:161] #+begin_example @@ -17235,7 +17235,7 @@ table to get the converted table inserted between the two marker lines. Now let's assume you want to make the table header by hand, because -you want to control how columns are aligned, etc. In this case we make +you want to control how columns are aligned, etc. In this case we make sure that the table translator skips the first 2 lines of the source table, and tell the command to work as a splice, i.e., to not produce header and footer commands of the target table: @@ -17259,28 +17259,28 @@ produce header and footer commands of the target table: #+end_example The LaTeX translator function ~orgtbl-to-latex~ is already part of -Orgtbl mode. It uses a ~tabular~ environment to typeset the table and -marks horizontal lines with ~\hline~. Furthermore, it interprets the +Orgtbl mode. It uses a ~tabular~ environment to typeset the table and +marks horizontal lines with ~\hline~. Furthermore, it interprets the following parameters (see also see [[Translator functions]]): #+attr_texinfo: :table-type table :indic @asis - ~:splice nil/t~ :: When set to ~t~, return only table body lines, don't wrap them into a - tabular environment. Default is ~nil~. + tabular environment. Default is ~nil~. - ~:fmt fmt~ :: A format to be used to wrap each field, it should contain ~%s~ for the - original field value. For example, to wrap each field value in - dollars, you could use ~:fmt "$%s$"~. This may also be a property list + original field value. For example, to wrap each field value in + dollars, you could use ~:fmt "$%s$"~. This may also be a property list with column numbers and formats, for example ~:fmt (2 "$%s$" 4 - "%s\\%%")~. A function of one argument can be used in place of the + "%s\\%%")~. A function of one argument can be used in place of the strings; the function must return a formatted string. - ~:efmt efmt~ :: - Use this format to print numbers with exponentials. The format should + Use this format to print numbers with exponentials. The format should have ~%s~ twice for inserting mantissa and exponent, for example: #+begin_example @@ -17313,12 +17313,12 @@ following parameters (see also see [[Translator functions]]): Orgtbl mode has several translator functions built-in: ~orgtbl-to-csv~ (comma-separated values), ~orgtbl-to-tsv~ (TAB-separated values) -~orgtbl-to-latex~, ~orgtbl-to-html~, and ~orgtbl-to-texinfo~. Except +~orgtbl-to-latex~, ~orgtbl-to-html~, and ~orgtbl-to-texinfo~. Except for ~orgtbl-to-html~, these all use a generic translator, ~orgtbl-to-generic~.[fn:162] For example, ~orgtbl-to-latex~ itself is a very short function that computes the column definitions for the ~tabular~ environment, defines a few field and line separators and -then hands processing over to the generic translator. Here is the +then hands processing over to the generic translator. Here is the entire code: #+header: :eval no @@ -17339,8 +17339,8 @@ entire code: As you can see, the properties passed into the function (variable ~PARAMS~) are combined with the ones newly defined in the function -(variable ~PARAMS2~). The ones passed into the function (i.e., the -ones set by the {{{samp(ORGTBL SEND)}}} line) take precedence. So if +(variable ~PARAMS2~). The ones passed into the function (i.e., the +ones set by the {{{samp(ORGTBL SEND)}}} line) take precedence. So if you would like to use the LaTeX translator, but wanted the line endings to be ~\\[2mm]~ instead of the default ~\\~, you could just overrule the default with: @@ -17351,7 +17351,7 @@ overrule the default with: For a new language, you can either write your own converter function in analogy with the LaTeX translator, or you can use the generic -function directly. For example, if you have a language where a table +function directly. For example, if you have a language where a table is started with {{{samp(!BTBL!)}}}, ended with {{{samp(!ETBL!)}}}, and where table lines are started with {{{samp(!BL!)}}}, ended with {{{samp(!EL!)}}}, and where the field separator is a TAB, you could @@ -17369,12 +17369,12 @@ function, and remember that you can pass each of them into the generic function. Of course you can also write a completely new function doing -complicated things the generic translator cannot do. A translator -function takes two arguments. The first argument is the table, a list -of lines, each line either the symbol ~hline~ or a list of fields. The +complicated things the generic translator cannot do. A translator +function takes two arguments. The first argument is the table, a list +of lines, each line either the symbol ~hline~ or a list of fields. The second argument is the property list containing all parameters -specified in the {{{samp(#+ORGTBL: SEND)}}} line. The function must -return a single string containing the formatted table. If you write a +specified in the {{{samp(#+ORGTBL: SEND)}}} line. The function must +return a single string containing the formatted table. If you write a generally useful translator, please post it to the [[mailto:emacs-orgmode@gnu.org][mailing list]] so that others can benefit from your work. @@ -17386,7 +17386,7 @@ that others can benefit from your work. #+cindex: org-list-insert-radio-list Sending and receiving radio lists works exactly the same way as -sending and receiving radio tables (see [[Radio tables]]). As for radio +sending and receiving radio tables (see [[Radio tables]]). As for radio tables, you can insert radio list templates in HTML, LaTeX and Texinfo modes by calling ~org-list-insert-radio-list~. @@ -17429,8 +17429,8 @@ LaTeX list between the two marker lines. :END: #+cindex: dynamic blocks -Org documents can contain /dynamic blocks/. These are specially marked -regions that are updated by some user-written function. A good example +Org documents can contain /dynamic blocks/. These are specially marked +regions that are updated by some user-written function. A good example for such a block is the clock table inserted by the command {{{kbd(C-c C-x C-r)}}} (see [[Clocking work time]]). @@ -17461,7 +17461,7 @@ Dynamic blocks are updated with the following commands: Updating a dynamic block means to remove all the text between ~BEGIN~ and ~END~, parse the ~BEGIN~ line for parameters and then call the -specific writer function for this block to insert the new content. If +specific writer function for this block to insert the new content. If you want to use the original content in the writer function, you can use the extra parameter ~:content~. @@ -17491,7 +17491,7 @@ this: If you want to make sure that all dynamic blocks are always up-to-date, you could add the function ~org-update-all-dblocks~ to a -hook, for example ~before-save-hook~. ~org-update-all-dblocks~ is +hook, for example ~before-save-hook~. ~org-update-all-dblocks~ is written in a way such that it does nothing in buffers that are not in ~org-mode~. @@ -17508,19 +17508,19 @@ any other block) with ~org-narrow-to-block~. Org provides a special hook that can be used to narrow down the selection made by these agenda views: ~agenda~, ~todo~, ~alltodo~, -~tags~, ~tags-todo~, ~tags-tree~. You may specify a function that is +~tags~, ~tags-todo~, ~tags-tree~. You may specify a function that is used at each match to verify if the match should indeed be part of the -agenda view, and if not, how much should be skipped. You can specify a +agenda view, and if not, how much should be skipped. You can specify a global condition that will be applied to all agenda views, this condition would be stored in the variable -~org-agenda-skip-function-global~. More commonly, such a definition is +~org-agenda-skip-function-global~. More commonly, such a definition is applied only to specific custom searches, using ~org-agenda-skip-function~. Let's say you want to produce a list of projects that contain a -~WAITING~ tag anywhere in the project tree. Let's further assume that +~WAITING~ tag anywhere in the project tree. Let's further assume that you have marked all tree headings that define a project with the TODO -keyword PROJECT. In this case you would run a TODO search for the +keyword PROJECT. In this case you would run a TODO search for the keyword PROJECT, but skip the match unless there is a ~WAITING~ tag anywhere in the subtree belonging to the project line. @@ -17562,7 +17562,7 @@ meaningful header in the agenda view. #+vindex: org-agenda-skip-function A general way to create custom searches is to base them on a search -for entries with a certain level limit. If you want to study all +for entries with a certain level limit. If you want to study all entries with your custom search function, simply do a search for {{{samp(LEVEL>0)}}}, and then use ~org-agenda-skip-function~ to select the entries you really want to have.[fn:163] @@ -17636,14 +17636,14 @@ like this, even without defining a special function: #+vindex: org-agenda-custom-commands Org provides commands to access agenda information for the command -line in Emacs batch mode. This extracted information can be sent +line in Emacs batch mode. This extracted information can be sent directly to a printer, or it can be read by a program that does -further processing of the data. The first of these commands is the +further processing of the data. The first of these commands is the function ~org-batch-agenda~, that produces an agenda view and sends it -as ASCII text to STDOUT. The command takes a single string as -parameter. If the string has length 1, it is used as a key to one of +as ASCII text to STDOUT. The command takes a single string as +parameter. If the string has length 1, it is used as a key to one of the commands you have configured in ~org-agenda-custom-commands~, -basically any key you can use after {{{kbd(C-c a)}}}. For example, to +basically any key you can use after {{{kbd(C-c a)}}}. For example, to directly print the current TODO list, you could use: #+header: :eval no @@ -17653,7 +17653,7 @@ emacs -batch -l ~/.emacs -eval '(org-batch-agenda "t")' | lpr #+end_src If the parameter is a string with 2 or more characters, it is used as -a tags/TODO match string. For example, to print your local shopping +a tags/TODO match string. For example, to print your local shopping list (all items with the tag {{{samp(shop)}}}, but excluding the tag {{{samp(NewYork)}}}), you could use: @@ -17894,7 +17894,7 @@ SCOPE determines the scope of this command. It can be any of: {{{noindent}}} The remaining args are treated as settings for the -skipping facilities of the scanner. The following items can be given +skipping facilities of the scanner. The following items can be given here: #+vindex: org-agenda-skip-function @@ -17976,12 +17976,12 @@ The following example counts the number of entries with TODO keyword #+cindex: Jones, Matt MobileOrg is the name of the mobile companion app for Org mode, -currently available for iOS and for Android. MobileOrg offers +currently available for iOS and for Android. MobileOrg offers offline viewing and capture support for an Org mode system rooted on a -``real'' computer. It does also allow you to record changes to -existing entries. The [[http://mobileorg.ncogni.to/][iOS implementation]] for the iPhone/iPod +``real'' computer. It does also allow you to record changes to +existing entries. The [[http://mobileorg.ncogni.to/][iOS implementation]] for the iPhone/iPod Touch/iPad series of devices, was developed by Richard Moreland. -Android users should check out [[http://wiki.github.com/matburt/mobileorg-android/][MobileOrg Android]] by Matt Jones. The +Android users should check out [[http://wiki.github.com/matburt/mobileorg-android/][MobileOrg Android]] by Matt Jones. The two implementations are not identical but offer similar features. This appendix describes the support Org has for creating agenda views @@ -17991,7 +17991,7 @@ notes captured and changes made by MobileOrg into the main system. For changing tags and TODO states in MobileOrg, you should have set up the customization variables ~org-todo-keywords~ and ~org-tags-alist~ to cover all important tags and TODO keywords, even if individual -files use only part of these. MobileOrg will also offer you states and +files use only part of these. MobileOrg will also offer you states and tags set up with in-buffer settings, but it will understand the logistics of TODO state /sets/ (see [[Per-file keywords]]) and /mutually exclusive/ tags (see [[Setting tags]]) only for those set in these @@ -18003,16 +18003,16 @@ variables. :END: MobileOrg needs to interact with Emacs through a directory on a -server. If you are using a public server, you should consider to -encrypt the files that are uploaded to the server. This can be done +server. If you are using a public server, you should consider to +encrypt the files that are uploaded to the server. This can be done with Org mode 7.02 and with MobileOrg 1.5 (iPhone version), and you -need an {{{file(openssl)}}} installation on your system. To turn on +need an {{{file(openssl)}}} installation on your system. To turn on encryption, set a password in MobileOrg and, on the Emacs side, configure the variable ~org-mobile-use-encryption~.[fn:164] The easiest way to create that directory is to use a free [[http://dropbox.com][Dropbox]] account.[fn:165] When MobileOrg first connects to your Dropbox, it -will create a directory MobileOrg inside the Dropbox. After the +will create a directory MobileOrg inside the Dropbox. After the directory has been created, tell Emacs about it: #+header: :eval no @@ -18030,9 +18030,9 @@ directory, and to read captured notes from there. :END: This operation copies all files currently listed in ~org-mobile-files~ -to the directory ~org-mobile-directory~. By default this list contains +to the directory ~org-mobile-directory~. By default this list contains all agenda files (as listed in ~org-agenda-files~), but additional -files can be included by customizing ~org-mobile-files~. File names +files can be included by customizing ~org-mobile-files~. File names will be staged with paths relative to ~org-directory~, so all files should be inside this directory.[fn:184] @@ -18041,8 +18041,8 @@ The push operation also creates a special Org file user.[fn:166] Finally, Org writes the file {{{file(index.org)}}}, containing links -to all other files. MobileOrg first reads this file from the server, -and then downloads all agendas and Org files listed in it. To speed up +to all other files. MobileOrg first reads this file from the server, +and then downloads all agendas and Org files listed in it. To speed up the download, MobileOrg will only read files whose checksums have changed.[fn:167] @@ -18052,11 +18052,11 @@ changed.[fn:167] :END: When MobileOrg synchronizes with the server, it not only pulls the -Org files for viewing. It also appends captured entries and pointers +Org files for viewing. It also appends captured entries and pointers to flagged and changed entries to the file {{{file(mobileorg.org)}}} -on the server. Org has a /pull/ operation that integrates this +on the server. Org has a /pull/ operation that integrates this information into an inbox file and operates on the pointers to flagged -entries. Here is how it works: +entries. Here is how it works: 1. Org moves all entries found in {{{file(mobileorg.org)}}} and appends them to the file pointed to by the variable @@ -18064,18 +18064,18 @@ entries. Here is how it works: editing event will be a top-level entry in the inbox file. 2. After moving the entries, Org will attempt to implement the changes - made in MobileOrg. Some changes are applied directly and without - user interaction. Examples are all changes to tags, TODO state, - headline and body text that can be cleanly applied. Entries that + made in MobileOrg. Some changes are applied directly and without + user interaction. Examples are all changes to tags, TODO state, + headline and body text that can be cleanly applied. Entries that have been flagged for further action will receive a tag - ~:FLAGGED:~, so that they can be easily found again. When there is + ~:FLAGGED:~, so that they can be easily found again. When there is a problem finding an entry or applying the change, the pointer entry will remain in the inbox and will be marked with an error - message. You need to later resolve these issues by hand. + message. You need to later resolve these issues by hand. -3. Org will then generate an agenda view with all flagged entries. The +3. Org will then generate an agenda view with all flagged entries. The user should then go through these entries and do whatever actions - are necessary. If a note has been stored while flagging an entry in + are necessary. If a note has been stored while flagging an entry in MobileOrg, that note will be displayed in the echo area when the cursor is on the corresponding agenda line. @@ -18086,9 +18086,9 @@ entries. Here is how it works: Pressing {{{kbd(?)}}} in that special agenda will display the full flagging note in another window and also push it onto the kill ring. So you could use {{{kbd(? z C-y C-c C-c)}}} to store that flagging - note as a normal note in the entry. Pressing {{{kbd(?)}}} twice in + note as a normal note in the entry. Pressing {{{kbd(?)}}} twice in succession will offer to remove the ~:FLAGGED:~ tag along with the - recorded flagging note (which is stored in a property). In this way + recorded flagging note (which is stored in a property). In this way you indicate that the intended processing for this flagged entry is finished. @@ -18107,28 +18107,28 @@ return to this agenda view using {{{kbd(C-c a ?)}}}.[fn:169] ** From Carsten Org was born in 2003, out of frustration over the user interface of -the Emacs Outline mode. I was trying to organize my notes and -projects, and using Emacs seemed to be the natural way to go. However, +the Emacs Outline mode. I was trying to organize my notes and +projects, and using Emacs seemed to be the natural way to go. However, having to remember eleven different commands with two or three keys per command, only to hide and show parts of the outline tree, that -seemed entirely unacceptable to me. Also, when using outlines to take +seemed entirely unacceptable to me. Also, when using outlines to take notes, I constantly wanted to restructure the tree, organizing it -parallel to my thoughts and plans. /Visibility cycling/ and /structure +parallel to my thoughts and plans. /Visibility cycling/ and /structure editing/ were originally implemented in the package {{{file(outline-magic.el)}}}, but quickly moved to the more general -{{{file(org.el)}}}. As this environment became comfortable for project +{{{file(org.el)}}}. As this environment became comfortable for project planning, the next step was adding /TODO entries/, basic /timestamps/, -and /table support/. These areas highlighted the two main goals that +and /table support/. These areas highlighted the two main goals that Org still has today: to be a new, outline-based, plain text mode with innovative and intuitive editing features, and to incorporate project planning functionality directly into a notes file. Since the first release, literally thousands of emails to me or to the [[mailto:emacs-orgmode@gnu.org][mailing list]] have provided a constant stream of bug reports, feedback, -new ideas, and sometimes patches and add-on code. Many thanks to -everyone who has helped to improve this package. I am trying to keep +new ideas, and sometimes patches and add-on code. Many thanks to +everyone who has helped to improve this package. I am trying to keep here a list of the people who had significant influence in shaping one -or more aspects of Org. The list may not be complete, if I have +or more aspects of Org. The list may not be complete, if I have forgotten someone, please accept my apologies and let me know. Before I get to this list, a few special mentions are in order: @@ -18138,9 +18138,9 @@ Before I get to this list, a few special mentions are in order: Bastien has written a large number of extensions to Org (most of them integrated into the core by now), including the LaTeX exporter and - the plain list parser. His support during the early days, when he + the plain list parser. His support during the early days, when he basically acted as co-maintainer, was central to the success of this - project. Bastien also invented Worg, helped establishing the Web + project. Bastien also invented Worg, helped establishing the Web presence of Org, and sponsored hosting costs for the ~orgmode.org~ website. @@ -18157,14 +18157,14 @@ Before I get to this list, a few special mentions are in order: integration with Apple Mail ({{{file(org-mac-message.el)}}}), hierarchical dependencies of TODO items, habit tracking ({{{file(org-habits.el)}}}), and encryption - ({{{file(org-crypt.el)}}}). Also, the capture system is really an + ({{{file(org-crypt.el)}}}). Also, the capture system is really an extended copy of his great {{{file(remember.el)}}}. - Sebastian Rose :: Without Sebastian, the HTML/XHTML publishing of Org would be the - pitiful work of an ignorant amateur. Sebastian has pushed this part of - Org onto a much higher level. He also wrote {{{file(org-info.js)}}}, a + pitiful work of an ignorant amateur. Sebastian has pushed this part of + Org onto a much higher level. He also wrote {{{file(org-info.js)}}}, a Java script for displaying webpages derived from Org using an Info-like or a folding interface with single-key navigation. @@ -18174,24 +18174,24 @@ please let me know what I am missing here! ** From Bastien -I (Bastien) have been maintaining Org since January 2011. This +I (Bastien) have been maintaining Org since January 2011. This appendix would not be complete without adding a few more acknowledgements and thanks to Carsten's ones above. I am first grateful to Carsten for his trust while handing me over the -maintainership of Org. His support as been great since day one of this +maintainership of Org. His support as been great since day one of this new adventure, and it helped a lot. When I took over maintainership, I knew I would have to make Org more collaborative than ever, as I would have to rely on people that are -more knowledgeable than I am on many parts of the code. Here is a list +more knowledgeable than I am on many parts of the code. Here is a list of the persons I could rely on, they should really be considered co-maintainers, either of the code or the community: #+attr_texinfo: :table-type table :indic @asis - Eric Schulte :: - Eric is maintaining the Babel parts of Org. His reactivity here kept + Eric is maintaining the Babel parts of Org. His reactivity here kept me away from worrying about possible bugs here and let me focus on other parts. @@ -18205,21 +18205,21 @@ co-maintainers, either of the code or the community: - Jambunathan K :: Jambunathan contributed the ODT exporter, definitly a killer feature - of Org mode. He also contributed the new HTML exporter, which is - another core feature of Org. Here too, I knew I could rely on him to + of Org mode. He also contributed the new HTML exporter, which is + another core feature of Org. Here too, I knew I could rely on him to fix bugs in these areas and to patiently explain the users what was the problems and solutions. - Achim Gratz :: Achim rewrote the building process of Org, turning some /ad hoc/ tools - into a flexible and conceptually clean process. He patiently coped + into a flexible and conceptually clean process. He patiently coped with the many hicups that such a change can create for users. - Nick Dokos :: The Org mode mailing list would not be such a nice place without Nick, - who patiently helped users so many times. It is impossible to + who patiently helped users so many times. It is impossible to overestimate such a great help, and the list would not be so active without him. @@ -18269,7 +18269,7 @@ complete if the ones above were not mentioned in this manual. inspired some of the early development, including HTML export. He also asked for a way to narrow wide table columns. -- Thomas S. Dye contributed documentation on Worg and helped +- Thomas S. Dye contributed documentation on Worg and helped integrating the Org-Babel documentation into the manual. - Christian Egli converted the documentation into Texinfo format, @@ -18281,7 +18281,7 @@ complete if the ones above were not mentioned in this manual. - Nic Ferrier contributed mailcap and XOXO support. -- Miguel A. Figueroa-Villanueva implemented hierarchical checkboxes. +- Miguel A. Figueroa-Villanueva implemented hierarchical checkboxes. - John Foerch figured out how to make incremental search show context around a match in a hidden outline tree. @@ -18308,7 +18308,7 @@ complete if the ones above were not mentioned in this manual. a book. - Bernt Hansen has driven much of the support for auto-repeating - tasks, task state change logging, and the clocktable. His clear + tasks, task state change logging, and the clocktable. His clear explanations have been critical when we started to adopt the Git version control system. @@ -18334,7 +18334,7 @@ complete if the ones above were not mentioned in this manual. file for Org, and is a prolific contributor on the mailing list with competent replies, small fixes and patches. -- Jason F. McBrayer suggested agenda export to CSV format. +- Jason F. McBrayer suggested agenda export to CSV format. - Max Mikhanosha came up with the idea of refiling. @@ -18373,7 +18373,7 @@ complete if the ones above were not mentioned in this manual. - Martin Pohlack provided the code snippet to bundle character insertion into bundles of 20 for undo. -- T.V. Raman reported bugs and suggested improvements. +- T.V. Raman reported bugs and suggested improvements. - Matthias Rempe (Oelde) provided ideas, Windows support, and quality control. @@ -18485,7 +18485,7 @@ complete if the ones above were not mentioned in this manual. :END: This is not a complete index of variables and faces, only the ones -that are mentioned in the manual. For a more complete list, use +that are mentioned in the manual. For a more complete list, use {{{kbdspckey(M-x org-customize,RET)}}} and then click yourself through the tree. @@ -18546,9 +18546,9 @@ All occurrences of "#+LABEL:" should be replaced with "#+NAME:". :PROPERTIES: :CATEGORY: Ch. 2 :END: -In "2. Document Structure", one section could be added about -cross-referencing, which would point to "Internal links". There, targets -in comments can be removed. Also most back-ends will turn links to +In "2. Document Structure", one section could be added about +cross-referencing, which would point to "Internal links". There, targets +in comments can be removed. Also most back-ends will turn links to targets into proper cross-reference number (see `org-export-get-ordinal' docstring for cases handled). @@ -18558,8 +18558,8 @@ docstring for cases handled). :PROPERTIES: :CATEGORY: Ch. 4 :END: -"Internal links". There, targets -in comments can be removed. Also most back-ends will turn links to +"Internal links". There, targets +in comments can be removed. Also most back-ends will turn links to targets into proper cross-reference number (see `org-export-get-ordinal' docstring for cases handled). @@ -18570,7 +18570,7 @@ docstring for cases handled). :CATEGORY: Ch. 11 :END: *** Include Keyword -The "#+INCLUDE:" keyword syntax and effect is slightly different. You +The "#+INCLUDE:" keyword syntax and effect is slightly different. You may want to look at `org-export-expand-include-keyword'. **** TODO Revise Include keyword @@ -18579,10 +18579,10 @@ may want to look at `org-export-expand-include-keyword'. :CATEGORY: Ch. 12 :END: *** Export Options -In "12. Exporting", "Export options" section need an overhaul. See -`org-export-options-alist' for the default list of export options. Other +In "12. Exporting", "Export options" section need an overhaul. See +`org-export-options-alist' for the default list of export options. Other options are back-end specific and should be introduced in their own -section. Also "#+KEYWORD:" renaming into ":EXPORT_KEYWORD:" property is +section. Also "#+KEYWORD:" renaming into ":EXPORT_KEYWORD:" property is systematic. **** TODO Overhaul Export options section @@ -18593,9 +18593,9 @@ systematic. There should also be a section about macros (and move it out of "11 Markup for rich export"), general, hard-coded ({{{time(...)}}}, {{{property(...)}}}, {{{input-file}}} and {{{modification-time(...)}}}) -and specific ({{{date}}}, {{{author}}}, {{{title}}} and {{{email}}}). It +and specific ({{{date}}}, {{{author}}}, {{{title}}} and {{{email}}}). It should be specified that macros are recursive and only apply to one -line. Therefore, they are appropriate for small replacements. For more +line. Therefore, they are appropriate for small replacements. For more complex ones, one may use Babel instead. **** TODO Write macros section @@ -18623,9 +18623,9 @@ They are a generalization for @ tags. **** TODO Write export snippets section *** Captions -There may be a section about captions and their syntax. A note should -specify that export back-ends may or may not respect a caption. On the -other hand "11.2 Images and Tables" focuses on captions. Since these are +There may be a section about captions and their syntax. A note should +specify that export back-ends may or may not respect a caption. On the +other hand "11.2 Images and Tables" focuses on captions. Since these are not specific to Images and Tables, it may be removed. **** TODO Write captions section @@ -18655,8 +18655,8 @@ too. ***** TODO Remove Taskjuggler backend **** Back-end template -These are only suggestion. There is also probably many more things to -do. But I think that the hardest part is to start writing it. If you +These are only suggestion. There is also probably many more things to +do. But I think that the hardest part is to start writing it. If you come up with a good organization for e-latex back-end documentation, we can use it for other back-ends thereafter. @@ -18665,12 +18665,12 @@ can use it for other back-ends thereafter. ****** TODO Does back-end turn links to targets? **** LaTeX Back-end -About the latex back-end, you know certainly a lot. It should be +About the latex back-end, you know certainly a lot. It should be specified that it introduces 3 new keywords, namely "LATEX_CLASS", -"LATEX_CLASS_OPTIONS" and "LATEX_HEADER". It also introduces +"LATEX_CLASS_OPTIONS" and "LATEX_HEADER". It also introduces "BEGIN_LATEX" and "BEGIN_TEX" blocks (the latter being just a synonym -for the former). It would be worth to add that it handles footnotes in -item tags and footnotes within footnotes. It also handles booktabs, +for the former). It would be worth to add that it handles footnotes in +item tags and footnotes within footnotes. It also handles booktabs, paralist types, automatic babel language selection with #+LANGUAGE: in addition to already present features (minted/listings package handling). @@ -18689,7 +18689,7 @@ though texinfo back-end can export to DocBook ***** TODO Write texinfo backend *** Export dispatcher -I think that the export dispatcher doesn't deserve its own section. The +I think that the export dispatcher doesn't deserve its own section. The introduction to Export subsystem can talk about "M-x org-export-dispatch" (bound to C-c C-e) instead. **** TODO Remove export dispatcher section @@ -19031,9 +19031,9 @@ the function ~org-version~ will not be defined. [fn:3] The ~master~ branch is where development takes place. -[fn:4] The output from install-info (if any) is system dependent. In +[fn:4] The output from install-info (if any) is system dependent. In particular, Debian and its derivatives use two different versions of -install-info. You may safely ignore the message: +install-info. You may safely ignore the message: #+begin_example This is not dpkg install-info anymore, but GNU install-info See the man page for ginstall-info for command line arguments @@ -19051,16 +19051,16 @@ inserts ~#+results~. [fn:8] See the variables ~org-special-ctrl-a/e~, ~org-special-ctrl-k~, and ~org-ctrl-k-protect-subtree~ to configure special behavior of -{{{kbd(C-a)}}}, {{{kbd(C-e)}}}, and {{{kbd(C-k)}}} in headlines. Note +{{{kbd(C-a)}}}, {{{kbd(C-e)}}}, and {{{kbd(C-k)}}} in headlines. Note also that clocking only works with headings indented less than 30 stars. [fn:9] See the option ~org-cycle-global-at-bob~. [fn:10] The indirect buffer will contain the entire buffer, but will -be narrowed to the current tree. Editing the indirect buffer will also +be narrowed to the current tree. Editing the indirect buffer will also change the original buffer, but without affecting visibility in that -buffer. For more information about indirect buffers, +buffer. For more information about indirect buffers, [[info:emacs:Indirect Buffers][GNU Emacs Manual]]. [fn:11] If you do not want the line to be split, customize the @@ -19090,8 +19090,8 @@ items. _before_ the checkbox. If you have activated alphabetical lists, you can also use counters like ~[@b]~. -[fn:18] Org only changes the filling settings for Emacs. For XEmacs, -you should use Kyle E. Jones' {{{file(filladapt.el)}}}. +[fn:18] Org only changes the filling settings for Emacs. For XEmacs, +you should use Kyle E. Jones' {{{file(filladapt.el)}}}. [fn:19] If you do not want the item to be split, customize the variable ~org-M-RET-may-split-line~. @@ -19106,13 +19106,13 @@ effect when exporting to HTML. [fn:26] For backward compatibility you can also use special names like ~$LR5~ and ~$LR12~ to refer in a stable way to the fifth and twelfth -field in the last row of the table. However, this syntax is -deprecated, it should not be used for new documents. Use ~@>$~ +field in the last row of the table. However, this syntax is +deprecated, it should not be used for new documents. Use ~@>$~ instead. [fn:25] Org will understand references typed by the user as {{{samp(B4)}}}, but it will not use this syntax when offering a -formula for editing. You can customize this behavior using the +formula for editing. You can customize this behavior using the variable ~org-table-use-standard-references~. [fn:22] To insert a vertical bar into a table field, use ~\vert~ or, @@ -19128,9 +19128,9 @@ convention that ~/~ has lower precedence than ~*~, so that ~a/b*c~ is interpreted as ~a/(b*c)~. [fn:29] The ~printf~ reformatting is limited in precision because the -value passed to it is converted into an ~integer~ or ~double~. The +value passed to it is converted into an ~integer~ or ~double~. The ~integer~ is limited in size by truncating the signed value to 32 -bits. The ~double~ is limited in precision to 64 bits overall which +bits. The ~double~ is limited in precision to 64 bits overall which leaves approximately 16 significant decimal digits. [fn:30] Such names must start with an alphabetic character and use @@ -19141,14 +19141,14 @@ exported, so the first such target should be after the first headline, or in the line directly before the first headline. [fn:32] To insert a link targeting a headline, in-buffer completion -can be used. Just type a star followed by a few optional letters into -the buffer and press {{{kbdkey(M-,TAB)}}}. All headlines in the +can be used. Just type a star followed by a few optional letters into +the buffer and press {{{kbdkey(M-,TAB)}}}. All headlines in the current buffer will be offered as completions. [fn:33] The actual behavior of the search will depend on the value of -the variable ~org-link-search-must-match-exact-headline~. If its value -is ~nil~, then a fuzzy text search will be done. If it is ~t~, then -only the exact headline will be matched. If the value is +the variable ~org-link-search-must-match-exact-headline~. If its value +is ~nil~, then a fuzzy text search will be done. If it is ~t~, then +only the exact headline will be matched. If the value is {{{samp('query-to-create)}}}, then an exact headline will be searched; if it is not found, then the user will be queried to create it. @@ -19158,12 +19158,12 @@ timestamp in the headline. [fn:35] Note that you don't have to use this command to insert a link. Links in Org are plain text, and you can type or paste them straight -into the buffer. By using this command, the links are automatically +into the buffer. By using this command, the links are automatically enclosed in double brackets, and you will be asked for the optional descriptive text. [fn:36] After insertion of a stored link, the link will be removed -from the list of stored links. To keep it in the list later use, use a +from the list of stored links. To keep it in the list later use, use a triple {{{kbd(C-u)}}} prefix argument to {{{kbd(C-c C-l)}}}, or configure the option ~org-keep-stored-link-after-insertion~. @@ -19174,7 +19174,7 @@ configure the option ~org-keep-stored-link-after-insertion~. [fn:44] Check also the variable ~org-fast-tag-selection-include-todo~, it allows you to change the TODO state through the tags interface -([[Setting tags]]), in case you like to mingle the two concepts. Note that +([[Setting tags]]), in case you like to mingle the two concepts. Note that this means you need to come up with unique keys across both sets of keywords. @@ -19194,7 +19194,7 @@ and agenda buffers. meaning here. [fn:45] Org mode parses these lines only when Org mode is activated -after visiting a file. {{{kbd(C-c C-c)}}} with the cursor in a line +after visiting a file. {{{kbd(C-c C-c)}}} with the cursor in a line starting with {{{samp(#+)}}} is simply restarting Org mode for the current buffer. @@ -19208,7 +19208,7 @@ current buffer. checkbox will add checkboxes to the rest of the list. [fn:49] It is possible that Org mode will record two timestamps when -you are using both ~org-log-done~ and state change logging. However, +you are using both ~org-log-done~ and state change logging. However, it will never prompt for two notes---if you have configured both, the state change recording note will take precedence and cancel the {{{samp(Closing Note)}}}. @@ -19218,7 +19218,7 @@ state change recording note will take precedence and cancel the [fn:51] To keep subtasks out of the global TODO list, see the ~org-agenda-todo-list-sublevels~. -[fn:52] With the exception of description lists. But you can allow it +[fn:52] With the exception of description lists. But you can allow it by modifying ~org-list-automatic-rules~ accordingly. [fn:53] Set the variable ~org-hierarchical-checkbox-statistics~ if you @@ -19242,25 +19242,25 @@ distributed with the main distribution of Org (visit [[http://orgmode.org]]). [fn:60] The Org date format is inspired by the standard ISO 8601 -date/time format. To use an alternative format, see [[Custom time -format]]. The day name is optional when you type the date yourself. +date/time format. To use an alternative format, see [[Custom time +format]]. The day name is optional when you type the date yourself. However, any dates inserted or modified by Org will add that day name, for reading convenience. [fn:61] When working with the standard diary sexp functions, you need -to be very careful with the order of the arguments. That order depends +to be very careful with the order of the arguments. That order depends evilly on the variable ~calendar-date-style~ (or, for older Emacs -versions, ~european-calendar-style~). For example, to specify a date +versions, ~european-calendar-style~). For example, to specify a date December 12, 2005, the call might look like ~(diary-date 12 1 2005)~ or ~(diary-date 1 12 2005)~ or ~(diary-date 2005 12 1)~, depending on -the settings. This has been the source of much confusion. Org mode +the settings. This has been the source of much confusion. Org mode users can resort to special versions of these functions like -~org-date~ or ~org-anniversary~. These work just like the +~org-date~ or ~org-anniversary~. These work just like the corresponding ~diary-~ functions, but with stable ISO order of arguments (year, month, day) wherever applicable, independent of the value of ~calendar-date-style~. -[fn:62] See the variable ~org-read-date-prefer-future~. You may +[fn:62] See the variable ~org-read-date-prefer-future~. You may set that variable to the symbol ~time~ to even make a time before now shift the date to tomorrow. @@ -19271,11 +19271,11 @@ shift the date to tomorrow. ~org-read-date-display-live~. [fn:65] It will still be listed on that date after it has been marked -DONE. If you don't like this, set the variable +DONE. If you don't like this, set the variable ~org-agenda-skip-scheduled-if-done~. [fn:66] The {{{samp(SCHEDULED)}}} and {{{samp(DEADLINE)}}} dates are -inserted on the line right below the headline. Don't put any text +inserted on the line right below the headline. Don't put any text between this line and the headline. [fn:67] Note the corresponding ~#+STARTUP~ keywords ~logredeadline~, @@ -19294,7 +19294,7 @@ first state of the TODO state sequence. With ~lognoterepeat~, you will also be prompted for a note. [fn:71] Clocking only works if all headings are indented with less -than 30 stars. This is a hardcoded limitation of ~lmax~ in +than 30 stars. This is a hardcoded limitation of ~lmax~ in ~org-clock-sum~. [fn:72] To resume the clock under the assumption that you have worked @@ -19318,10 +19318,10 @@ property. line---the line is broken here only to fit it into the manual. [fn:79] On computers using Mac OS X, idleness is based on actual user -idleness, not just Emacs' idle time. For X11, you can install a +idleness, not just Emacs' idle time. For X11, you can install a utility program {{{file(x11idle.c)}}}, available in the ~contrib/scripts~ directory of the Org git distribution, to get the -same general treatment of idleness. On other systems, idle time refers +same general treatment of idleness. On other systems, idle time refers to Emacs idle time only. [fn:80] You may change the property being used with the variable @@ -19349,10 +19349,10 @@ an absolute path. [fn:87] For backward compatibility, the following also works: If there are several such lines in a file, each specifies the archive location -for the text below it. The first such line also applies to any text -before its definition. However, using this method is /strongly/ +for the text below it. The first such line also applies to any text +before its definition. However, using this method is /strongly/ deprecated as it is incompatible with the outline structure of the -document. The correct method for setting multiple archive locations in +document. The correct method for setting multiple archive locations in a buffer is using properties. [fn:94] Only tags filtering will be respected here, effort filtering @@ -19377,16 +19377,16 @@ agenda instead (see [[Block agenda]]). [fn:93] For backward compatibility, the following also works: if there are several such lines in a file, each specifies the category -for the text below it. The first category also applies to any text -before the first CATEGORY line. However, using this method is +for the text below it. The first category also applies to any text +before the first CATEGORY line. However, using this method is /strongly/ deprecated as it is incompatible with the outline structure -of the document. The correct method for setting multiple categories in +of the document. The correct method for setting multiple categories in a buffer is using a property. [fn:95] Custom commands can preset a filter by binding the variable -~org-agenda-tag-filter-preset~ as an option. This filter will then be +~org-agenda-tag-filter-preset~ as an option. This filter will then be applied to the view and persist as a basic filter through refreshes -and more secondary filtering. The filter is a global property of the +and more secondary filtering. The filter is a global property of the entire agenda view---in a block agenda, you should only set this in the global options section, not in the section of an individual block. @@ -19400,8 +19400,8 @@ the global options section, not in the section of an individual block. cons cell with the prefix and the description. [fn:99] For HTML you need to install Hrvoje Niksic's -{{{file(htmlize.el)}}}. To create PDF output, the ghostscript -{{{file(ps2pdf)}}} utility must be installed on the system. Selecting +{{{file(htmlize.el)}}}. To create PDF output, the ghostscript +{{{file(ps2pdf)}}} utility must be installed on the system. Selecting a PDF file will also create the postscript file. [fn:100] If you want to store standard views like the weekly agenda or @@ -19413,12 +19413,12 @@ for examples. [fn:102] This works automatically for the HTML backend (it requires version 1.34 of the {{{file(htmlize.el)}}} package, which is -distributed with Org). Fontified code chunks in LaTeX can be +distributed with Org). Fontified code chunks in LaTeX can be achieved using either the listings package or the [[http://code.google.com/p/minted][minted]] package. Refer to ~org-export-latex-listings~ documentation for details. [fn:103] Code in {{{samp(src)}}} blocks may also be evaluated either -interactively or on export. See see [[Working with source code]] for more +interactively or on export. See [[Working with source code]] for more information on evaluating code blocks. [fn:104] Adding ~-k~ to ~-n -r~ will /keep/ the labels in the source @@ -19434,8 +19434,8 @@ also for export. [fn:106] You may select a different-mode with the variable ~org-edit-fixed-width-region-mode~. -[fn:107] LaTeX is a macro system based on Donald E. Knuth's TeX -system. Many of the features described here as LaTeX are really +[fn:107] LaTeX is a macro system based on Donald\nbsp{}E.\nbsp{}Knuth's TeX +system. Many of the features described here as LaTeX are really from TeX, but for simplicity I am blurring this distinction. [fn:108] You can turn this on by default by setting the variable @@ -19447,15 +19447,15 @@ significant page views, you should install {{{file(MathJax)}}} on your own server in order to limit the load of our server. [fn:110] For this to work you need to be on a system with a working -LaTeX installation. You also need the {{{file(dvipng)}}} program or +LaTeX installation. You also need the {{{file(dvipng)}}} program or the {{{file(convert)}}}, respectively available at [[http://sourceforge.net/projects/dvipng/]] and from the -{{{file(ImageMagick)}}} suite. The LaTeX header that will be used +{{{file(ImageMagick)}}} suite. The LaTeX header that will be used when processing a fragment can be configured with the variable ~org-format-latex-header~. [fn:111] When {{{file(MathJax)}}} is used, only the environment -recognized by {{{file(MathJax)}}} will be processed. When +recognized by {{{file(MathJax)}}} will be processed. When {{{file(dvipng)}}} is used to create images, any LaTeX environments will be handled. @@ -19484,7 +19484,7 @@ several ~#+OPTIONS~ lines. [fn:121] If you plan to use this regularly or on pages with significant page views, you should install MathJax on your own server -in order to limit the load of our server. Installation instructions +in order to limit the load of our server. Installation instructions can be found on the MathJax website, see [[http://www.mathjax.org/resources/docs/?installation.html]]. @@ -19493,13 +19493,13 @@ use the variables ~org-export-html-todo-kwd-class-prefix~ and ~org-export-html-tag-class-prefix~ to make them unique. [fn:123] This style is defined in the constant -~org-export-html-style-default~, which you should not modify. To turn +~org-export-html-style-default~, which you should not modify. To turn inclusion of these defaults off, customize ~org-export-html-style-include-default~. [fn:124] The default LaTeX output is designed for processing with -~pdftex~ or LaTeX. It includes packages that are not compatible -with ~xetex~ and possibly ~luatex~. See the variables +~pdftex~ or LaTeX. It includes packages that are not compatible +with ~xetex~ and possibly ~luatex~. See the variables ~org-export-latex-default-packages-alist~ and ~org-export-latex-packages-alist~. @@ -19512,7 +19512,7 @@ with ~xetex~ and possibly ~luatex~. See the variables ~org-export-latex-packages-alist~ are spliced. [fn:128] One can also take advantage of this option to pass other, -unrelated options into the figure or table environment. For an example +unrelated options into the figure or table environment. For an example see the section ``Exporting org files'' in [[http://orgmode.org/worg/org-hacks.html]]. @@ -19532,7 +19532,7 @@ Version 1.2]]. [fn:135] The column widths are interpreted as weighted ratios with the default weight being 1. -[fn:136] Use of {{{file(ImageMagick)}}} is only desirable. However, if +[fn:136] Use of {{{file(ImageMagick)}}} is only desirable. However, if you routinely produce documents that have large images or you export your Org files that has images using a Emacs batch script, then the use of {{{file(ImageMagick)}}} is mandatory. @@ -19567,7 +19567,7 @@ hierarchy if you configure ~org-use-property-inheritance~ accordingly. [fn:146] The files {{{file(file-source.org)}}} and {{{file(file-source.org.html)}}} if source and publishing directories -are equal. Note that with this kind of setup, you need to add +are equal. Note that with this kind of setup, you need to add ~:exclude "-source\\.org"~ to the project definition in ~org-publish-project-alist~ to prevent the published source files from being considered as new org files the next time the project is @@ -19577,8 +19577,8 @@ published. mode's [[Easy templates]] system. [fn:148] Whenever code is evaluated there is a potential for that code -to do harm. Org mode provides safeguards to ensure that code is only -evaluated after explicit confirmation from the user. For information +to do harm. Org mode provides safeguards to ensure that code is only +evaluated after explicit confirmation from the user. For information on these safeguards (and on how to disable them) see [[Code evaluation security]]. @@ -19601,9 +19601,9 @@ and Ruby, and the value of ~.Last.value~ in R. [fn:161] If the {{{samp(#+TBLFM)}}} line contains an odd number of dollar characters, this may cause problems with font-lock in LaTeX -mode. As shown in the example you can fix this by adding an extra line +mode. As shown in the example you can fix this by adding an extra line inside the ~comment~ environment that is used to balance the dollar -expressions. If you are using AUCTeX with the font-latex library, a +expressions. If you are using AUCTeX with the font-latex library, a much better solution is to add the ~comment~ environment to the variable ~LaTeX-verbatim-environments~. @@ -19642,15 +19642,15 @@ only to the contents of the `.org' files. The file names themselves will remain visible. [fn:165] If you cannot use Dropbox, or if your version of MobileOrg -does not support it, you can use a webdav server. For more +does not support it, you can use a webdav server. For more information, check out the documentation of MobileOrg and also this [[http://orgmode.org/worg/org-faq.html#mobileorg_webdav][FAQ entry]]. [fn:166] While creating the agendas, Org mode will force ID properties on all referenced entries, so that these entries can be uniquely -identified if /MobileOrg/ flags them for further action. If you do not +identified if /MobileOrg/ flags them for further action. If you do not want to get these properties in so many entries, you can set the -variable ~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode will +variable ~org-mobile-force-id-on-agenda-items~ to ~nil~. Org mode will then rely on outline paths, in the hope that these will be unique enough. @@ -19660,11 +19660,11 @@ enough. [fn:168] The file {{{file(mobileorg.org)}}} will be empty after this operation. -[fn:169] Note, however, that there is a subtle difference. The view +[fn:169] Note, however, that there is a subtle difference. The view created automatically by {{{kbdspckey(M-x org-mobile-pull,RET)}}} is guaranteed to search all files that have been addressed by the last -pull. This might include a file that is not currently in your list of -agenda files. If you later use {{{kbd(C-c a ?)}}} to regenerate the +pull. This might include a file that is not currently in your list of +agenda files. If you later use {{{kbd(C-c a ?)}}} to regenerate the view, only the current agenda files will be searched. [fn:170] You can also get `a.', `A.', `a)' and `A)' by configuring @@ -19719,3 +19719,8 @@ always according to ISO and therefore independent of the value of [fn:184] Symbolic links in ~org-directory~ need to have the same name as their targets. + + +# Local Variables: +# sentence-end-double-space: t +# End: