diff options
| author | Rasmus | 2017-09-18 12:01:12 +0200 |
|---|---|---|
| committer | Rasmus | 2017-09-18 12:01:12 +0200 |
| commit | ab351d442d7bb4d17cbb43638aaed1775d8c0344 (patch) | |
| tree | 19da4c93526d3de543efe21a53ab2d098fb9f50b /doc | |
| parent | 5490ccc5ebf39759dfd084bbd31f464701a3e775 (diff) | |
| download | emacs-ab351d442d7bb4d17cbb43638aaed1775d8c0344.tar.gz emacs-ab351d442d7bb4d17cbb43638aaed1775d8c0344.zip | |
Update Org to v9.1.1
Please see etc/ORG-NEWS for major changes.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/org.texi | 407 |
1 files changed, 220 insertions, 187 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index ca57501f3d8..37f2ba551ae 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -4,8 +4,8 @@ | |||
| 4 | @settitle The Org Manual | 4 | @settitle The Org Manual |
| 5 | @include docstyle.texi | 5 | @include docstyle.texi |
| 6 | 6 | ||
| 7 | @set VERSION 9.0.10 | 7 | @set VERSION 9.1.1 |
| 8 | @set DATE 2017-08-27 | 8 | @set DATE 2017-09-17 |
| 9 | 9 | ||
| 10 | @c Version and Contact Info | 10 | @c Version and Contact Info |
| 11 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} | 11 | @set MAINTAINERSITE @uref{http://orgmode.org,maintainers web page} |
| @@ -527,7 +527,6 @@ The built-in agenda views | |||
| 527 | * Weekly/daily agenda:: The calendar page with current tasks | 527 | * Weekly/daily agenda:: The calendar page with current tasks |
| 528 | * Global TODO list:: All unfinished action items | 528 | * Global TODO list:: All unfinished action items |
| 529 | * Matching tags and properties:: Structured information with fine-tuned search | 529 | * Matching tags and properties:: Structured information with fine-tuned search |
| 530 | * Timeline:: Time-sorted view for single file | ||
| 531 | * Search view:: Find entries by searching for text | 530 | * Search view:: Find entries by searching for text |
| 532 | * Stuck projects:: Find projects you need to review | 531 | * Stuck projects:: Find projects you need to review |
| 533 | 532 | ||
| @@ -1311,8 +1310,8 @@ Show the current subtree in an indirect buffer@footnote{The indirect buffer | |||
| 1311 | buffer, but will be narrowed to the current tree. Editing the indirect | 1310 | buffer, but will be narrowed to the current tree. Editing the indirect |
| 1312 | buffer will also change the original buffer, but without affecting visibility | 1311 | buffer will also change the original buffer, but without affecting visibility |
| 1313 | in that buffer.}. With a numeric prefix argument N, go up to level N and | 1312 | in that buffer.}. With a numeric prefix argument N, go up to level N and |
| 1314 | then take that tree. If N is negative then go up that many levels. With a | 1313 | then take that tree. If N is negative then go up that many levels. With |
| 1315 | @kbd{C-u} prefix, do not remove the previously used indirect buffer. | 1314 | a @kbd{C-u} prefix, do not remove the previously used indirect buffer. |
| 1316 | @orgcmd{C-c C-x v,org-copy-visible} | 1315 | @orgcmd{C-c C-x v,org-copy-visible} |
| 1317 | Copy the @i{visible} text in the region into the kill ring. | 1316 | Copy the @i{visible} text in the region into the kill ring. |
| 1318 | @end table | 1317 | @end table |
| @@ -1422,9 +1421,9 @@ See also the option @code{org-goto-interface}. | |||
| 1422 | @cindex subtrees, cut and paste | 1421 | @cindex subtrees, cut and paste |
| 1423 | 1422 | ||
| 1424 | @table @asis | 1423 | @table @asis |
| 1425 | @orgcmd{M-@key{RET},org-insert-heading} | 1424 | @orgcmd{M-@key{RET},org-meta-return} |
| 1426 | @vindex org-M-RET-may-split-line | 1425 | @vindex org-M-RET-may-split-line |
| 1427 | Insert a new heading/item with the same level as the one at point. | 1426 | Insert a new heading, item or row. |
| 1428 | 1427 | ||
| 1429 | If the command is used at the @emph{beginning} of a line, and if there is | 1428 | If the command is used at the @emph{beginning} of a line, and if there is |
| 1430 | a heading or a plain list item (@pxref{Plain lists}) at point, the new | 1429 | a heading or a plain list item (@pxref{Plain lists}) at point, the new |
| @@ -2108,16 +2107,14 @@ create the above table, you would only type | |||
| 2108 | fields. Even faster would be to type @code{|Name|Phone|Age} followed by | 2107 | fields. Even faster would be to type @code{|Name|Phone|Age} followed by |
| 2109 | @kbd{C-c @key{RET}}. | 2108 | @kbd{C-c @key{RET}}. |
| 2110 | 2109 | ||
| 2111 | @vindex org-enable-table-editor | ||
| 2112 | @vindex org-table-auto-blank-field | 2110 | @vindex org-table-auto-blank-field |
| 2113 | When typing text into a field, Org treats @key{DEL}, | 2111 | When typing text into a field, Org treats @key{DEL}, @key{Backspace}, and all |
| 2114 | @key{Backspace}, and all character keys in a special way, so that | 2112 | character keys in a special way, so that inserting and deleting avoids |
| 2115 | inserting and deleting avoids shifting other fields. Also, when | 2113 | shifting other fields. Also, when typing @emph{immediately after the cursor |
| 2116 | typing @emph{immediately after the cursor was moved into a new field | 2114 | was moved into a new field with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or |
| 2117 | with @kbd{@key{TAB}}, @kbd{S-@key{TAB}} or @kbd{@key{RET}}}, the | 2115 | @kbd{@key{RET}}}, the field is automatically made blank. If this behavior is |
| 2118 | field is automatically made blank. If this behavior is too | 2116 | too unpredictable for you, configure the option |
| 2119 | unpredictable for you, configure the options | 2117 | @code{org-table-auto-blank-field}. |
| 2120 | @code{org-enable-table-editor} and @code{org-table-auto-blank-field}. | ||
| 2121 | 2118 | ||
| 2122 | @table @kbd | 2119 | @table @kbd |
| 2123 | @tsubheading{Creation and conversion} | 2120 | @tsubheading{Creation and conversion} |
| @@ -2672,7 +2669,7 @@ calculation precision is greater. | |||
| 2672 | Degree and radian angle modes of Calc. | 2669 | Degree and radian angle modes of Calc. |
| 2673 | @item @code{F}, @code{S} | 2670 | @item @code{F}, @code{S} |
| 2674 | Fraction and symbolic modes of Calc. | 2671 | Fraction and symbolic modes of Calc. |
| 2675 | @item @code{T}, @code{t} | 2672 | @item @code{T}, @code{t}, @code{U} |
| 2676 | Duration computations in Calc or Lisp, @pxref{Durations and time values}. | 2673 | Duration computations in Calc or Lisp, @pxref{Durations and time values}. |
| 2677 | @item @code{E} | 2674 | @item @code{E} |
| 2678 | If and how to consider empty fields. Without @samp{E} empty fields in range | 2675 | If and how to consider empty fields. Without @samp{E} empty fields in range |
| @@ -2789,26 +2786,31 @@ Compute the sum of columns 1 to 4, like Calc's @code{vsum($1..$4)}. | |||
| 2789 | @cindex Time, computing | 2786 | @cindex Time, computing |
| 2790 | @vindex org-table-duration-custom-format | 2787 | @vindex org-table-duration-custom-format |
| 2791 | 2788 | ||
| 2792 | If you want to compute time values use the @code{T} flag, either in Calc | 2789 | If you want to compute time values use the @code{T}, @code{t}, or @code{U} |
| 2793 | formulas or Elisp formulas: | 2790 | flag, either in Calc formulas or Elisp formulas: |
| 2794 | 2791 | ||
| 2795 | @example | 2792 | @example |
| 2796 | @group | 2793 | @group |
| 2797 | | Task 1 | Task 2 | Total | | 2794 | | Task 1 | Task 2 | Total | |
| 2798 | |---------+----------+----------| | 2795 | |---------+----------+----------| |
| 2799 | | 2:12 | 1:47 | 03:59:00 | | 2796 | | 2:12 | 1:47 | 03:59:00 | |
| 2797 | | 2:12 | 1:47 | 03:59 | | ||
| 2800 | | 3:02:20 | -2:07:00 | 0.92 | | 2798 | | 3:02:20 | -2:07:00 | 0.92 | |
| 2801 | #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;t | 2799 | #+TBLFM: @@2$3=$1+$2;T::@@3$3=$1+$2;U::@@4$3=$1+$2;t |
| 2802 | @end group | 2800 | @end group |
| 2803 | @end example | 2801 | @end example |
| 2804 | 2802 | ||
| 2805 | Input duration values must be of the form @code{HH:MM[:SS]}, where seconds | 2803 | Input duration values must be of the form @code{HH:MM[:SS]}, where seconds |
| 2806 | are optional. With the @code{T} flag, computed durations will be displayed | 2804 | are optional. With the @code{T} flag, computed durations will be displayed |
| 2807 | as @code{HH:MM:SS} (see the first formula above). With the @code{t} flag, | 2805 | as @code{HH:MM:SS} (see the first formula above). With the @code{U} flag, |
| 2808 | computed durations will be displayed according to the value of the option | 2806 | seconds will be omitted so that the result will be only @code{HH:MM} (see |
| 2809 | @code{org-table-duration-custom-format}, which defaults to @code{'hours} and | 2807 | second formula above). Zero-padding of the hours field will depend upon the |
| 2810 | will display the result as a fraction of hours (see the second formula in the | 2808 | value of the variable @code{org-table-duration-hour-zero-padding}. |
| 2811 | example above). | 2809 | |
| 2810 | With the @code{t} flag, computed durations will be displayed according to the | ||
| 2811 | value of the option @code{org-table-duration-custom-format}, which defaults | ||
| 2812 | to @code{'hours} and will display the result as a fraction of hours (see the | ||
| 2813 | third formula in the example above). | ||
| 2812 | 2814 | ||
| 2813 | Negative duration values can be manipulated as well, and integers will be | 2815 | Negative duration values can be manipulated as well, and integers will be |
| 2814 | considered as seconds in addition and subtraction. | 2816 | considered as seconds in addition and subtraction. |
| @@ -4034,8 +4036,8 @@ states}), you will be prompted for a TODO keyword through the fast selection | |||
| 4034 | interface; this is the default behavior when | 4036 | interface; this is the default behavior when |
| 4035 | @code{org-use-fast-todo-selection} is non-@code{nil}. | 4037 | @code{org-use-fast-todo-selection} is non-@code{nil}. |
| 4036 | 4038 | ||
| 4037 | The same rotation can also be done ``remotely'' from the timeline and agenda | 4039 | The same rotation can also be done ``remotely'' from agenda buffers with the |
| 4038 | buffers with the @kbd{t} command key (@pxref{Agenda commands}). | 4040 | @kbd{t} command key (@pxref{Agenda commands}). |
| 4039 | 4041 | ||
| 4040 | @orgkey{C-u C-c C-t} | 4042 | @orgkey{C-u C-c C-t} |
| 4041 | When TODO keywords have no selection keys, select a specific keyword using | 4043 | When TODO keywords have no selection keys, select a specific keyword using |
| @@ -4151,19 +4153,19 @@ be set up like this: | |||
| 4151 | @end lisp | 4153 | @end lisp |
| 4152 | 4154 | ||
| 4153 | In this case, different keywords do not indicate a sequence, but rather | 4155 | In this case, different keywords do not indicate a sequence, but rather |
| 4154 | different types. So the normal work flow would be to assign a task to a | 4156 | different types. So the normal work flow would be to assign a task to |
| 4155 | person, and later to mark it DONE@. Org mode supports this style by adapting | 4157 | a person, and later to mark it DONE@. Org mode supports this style by |
| 4156 | the workings of the command @kbd{C-c C-t}@footnote{This is also true for the | 4158 | adapting the workings of the command @kbd{C-c C-t}@footnote{This is also true |
| 4157 | @kbd{t} command in the timeline and agenda buffers.}. When used several | 4159 | for the @kbd{t} command in the agenda buffers.}. When used several times in |
| 4158 | times in succession, it will still cycle through all names, in order to first | 4160 | succession, it will still cycle through all names, in order to first select |
| 4159 | select the right type for a task. But when you return to the item after some | 4161 | the right type for a task. But when you return to the item after some time |
| 4160 | time and execute @kbd{C-c C-t} again, it will switch from any name directly | 4162 | and execute @kbd{C-c C-t} again, it will switch from any name directly to |
| 4161 | to DONE@. Use prefix arguments or completion to quickly select a specific | 4163 | DONE@. Use prefix arguments or completion to quickly select a specific name. |
| 4162 | name. You can also review the items of a specific TODO type in a sparse tree | 4164 | You can also review the items of a specific TODO type in a sparse tree by |
| 4163 | by using a numeric prefix to @kbd{C-c / t}. For example, to see all things | 4165 | using a numeric prefix to @kbd{C-c / t}. For example, to see all things Lucy |
| 4164 | Lucy has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items | 4166 | has to do, you would use @kbd{C-3 C-c / t}. To collect Lucy's items from all |
| 4165 | from all agenda files into a single buffer, you would use the numeric prefix | 4167 | agenda files into a single buffer, you would use the numeric prefix argument |
| 4166 | argument as well when creating the global TODO list: @kbd{C-3 C-c a t}. | 4168 | as well when creating the global TODO list: @kbd{C-3 C-c a t}. |
| 4167 | 4169 | ||
| 4168 | @node Multiple sets in one file | 4170 | @node Multiple sets in one file |
| 4169 | @subsection Multiple keyword sets in one file | 4171 | @subsection Multiple keyword sets in one file |
| @@ -4435,11 +4437,6 @@ lognotedone}.} | |||
| 4435 | You will then be prompted for a note, and that note will be stored below | 4437 | You will then be prompted for a note, and that note will be stored below |
| 4436 | the entry with a @samp{Closing Note} heading. | 4438 | the entry with a @samp{Closing Note} heading. |
| 4437 | 4439 | ||
| 4438 | In the timeline (@pxref{Timeline}) and in the agenda | ||
| 4439 | (@pxref{Weekly/daily agenda}), you can then use the @kbd{l} key to | ||
| 4440 | display the TODO items with a @samp{CLOSED} timestamp on each day, | ||
| 4441 | giving you an overview of what has been done. | ||
| 4442 | |||
| 4443 | @node Tracking TODO state changes | 4440 | @node Tracking TODO state changes |
| 4444 | @subsection Tracking TODO state changes | 4441 | @subsection Tracking TODO state changes |
| 4445 | @cindex drawer, for state change recording | 4442 | @cindex drawer, for state change recording |
| @@ -4654,8 +4651,8 @@ items. | |||
| 4654 | Set the priority of the current headline (@command{org-priority}). The | 4651 | Set the priority of the current headline (@command{org-priority}). The |
| 4655 | command prompts for a priority character @samp{A}, @samp{B} or @samp{C}. | 4652 | command prompts for a priority character @samp{A}, @samp{B} or @samp{C}. |
| 4656 | When you press @key{SPC} instead, the priority cookie is removed from the | 4653 | When you press @key{SPC} instead, the priority cookie is removed from the |
| 4657 | headline. The priorities can also be changed ``remotely'' from the timeline | 4654 | headline. The priorities can also be changed ``remotely'' from the agenda |
| 4658 | and agenda buffer with the @kbd{,} command (@pxref{Agenda commands}). | 4655 | buffer with the @kbd{,} command (@pxref{Agenda commands}). |
| 4659 | @c | 4656 | @c |
| 4660 | @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down} | 4657 | @orgcmdkkcc{S-@key{up},S-@key{down},org-priority-up,org-priority-down} |
| 4661 | @vindex org-priority-start-cycle-with-default | 4658 | @vindex org-priority-start-cycle-with-default |
| @@ -5901,10 +5898,10 @@ agenda (@pxref{Weekly/daily agenda}). We distinguish: | |||
| 5901 | @item Plain timestamp; Event; Appointment | 5898 | @item Plain timestamp; Event; Appointment |
| 5902 | @cindex timestamp | 5899 | @cindex timestamp |
| 5903 | @cindex appointment | 5900 | @cindex appointment |
| 5904 | A simple timestamp just assigns a date/time to an item. This is just | 5901 | A simple timestamp just assigns a date/time to an item. This is just like |
| 5905 | like writing down an appointment or event in a paper agenda. In the | 5902 | writing down an appointment or event in a paper agenda. In the agenda |
| 5906 | timeline and agenda displays, the headline of an entry associated with a | 5903 | display, the headline of an entry associated with a plain timestamp will be |
| 5907 | plain timestamp will be shown exactly on that date. | 5904 | shown exactly on that date. |
| 5908 | 5905 | ||
| 5909 | @example | 5906 | @example |
| 5910 | * Meet Peter at the movies | 5907 | * Meet Peter at the movies |
| @@ -6584,9 +6581,8 @@ buffer (see variable @code{org-remove-highlights-with-change}) or press | |||
| 6584 | @kbd{C-c C-c}. | 6581 | @kbd{C-c C-c}. |
| 6585 | @end table | 6582 | @end table |
| 6586 | 6583 | ||
| 6587 | The @kbd{l} key may be used in the timeline (@pxref{Timeline}) and in | 6584 | The @kbd{l} key may be used the agenda (@pxref{Weekly/daily agenda}) to show |
| 6588 | the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been | 6585 | which tasks have been worked on or closed during a day. |
| 6589 | worked on or closed during a day. | ||
| 6590 | 6586 | ||
| 6591 | @strong{Important:} note that both @code{org-clock-out} and | 6587 | @strong{Important:} note that both @code{org-clock-out} and |
| 6592 | @code{org-clock-in-last} can have a global key binding and will not | 6588 | @code{org-clock-in-last} can have a global key binding and will not |
| @@ -6649,6 +6645,7 @@ be selected: | |||
| 6649 | tree @r{the surrounding level 1 tree} | 6645 | tree @r{the surrounding level 1 tree} |
| 6650 | agenda @r{all agenda files} | 6646 | agenda @r{all agenda files} |
| 6651 | ("file"..) @r{scan these files} | 6647 | ("file"..) @r{scan these files} |
| 6648 | function @r{the list of files returned by a function of no argument} | ||
| 6652 | file-with-archives @r{current file and its archives} | 6649 | file-with-archives @r{current file and its archives} |
| 6653 | agenda-with-archives @r{all agenda files, including archives} | 6650 | agenda-with-archives @r{all agenda files, including archives} |
| 6654 | :block @r{The time block to consider. This block is specified either} | 6651 | :block @r{The time block to consider. This block is specified either} |
| @@ -7083,7 +7080,7 @@ would look like: | |||
| 7083 | (setq org-capture-templates | 7080 | (setq org-capture-templates |
| 7084 | '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") | 7081 | '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks") |
| 7085 | "* TODO %?\n %i\n %a") | 7082 | "* TODO %?\n %i\n %a") |
| 7086 | ("j" "Journal" entry (file+datetree "~/org/journal.org") | 7083 | ("j" "Journal" entry (file+olp+datetree "~/org/journal.org") |
| 7087 | "* %?\nEntered on %U\n %i\n %a"))) | 7084 | "* %?\nEntered on %U\n %i\n %a"))) |
| 7088 | @end group | 7085 | @end group |
| 7089 | @end smalllisp | 7086 | @end smalllisp |
| @@ -7191,21 +7188,19 @@ For non-unique headings, the full path is safer. | |||
| 7191 | @item (file+regexp "path/to/file" "regexp to find location") | 7188 | @item (file+regexp "path/to/file" "regexp to find location") |
| 7192 | Use a regular expression to position the cursor. | 7189 | Use a regular expression to position the cursor. |
| 7193 | 7190 | ||
| 7194 | @item (file+datetree "path/to/file") | 7191 | @item (file+olp+datetree "path/to/file" [ "Level 1 heading" ....]) |
| 7195 | Will create a heading in a date tree for today's date@footnote{Datetree | 7192 | This target@footnote{Org used to offer four different targets for date/week |
| 7196 | headlines for years accept tags, so if you use both @code{* 2013 :noexport:} | 7193 | tree capture. Now, Org automatically translates these to use |
| 7197 | and @code{* 2013} in your file, the capture will refile the note to the first | 7194 | @code{file+olp+datetree}, applying the @code{:time-prompt} and |
| 7198 | one matched.}. | 7195 | @code{:tree-type} properties. Please rewrite your date/week-tree targets |
| 7199 | 7196 | using @code{file+olp+datetree} since the older targets are now deprecated.} | |
| 7200 | @item (file+datetree+prompt "path/to/file") | 7197 | will create a heading in a date tree@footnote{A date tree is an outline |
| 7201 | Will create a heading in a date tree, but will prompt for the date. | 7198 | structure with years on the highest level, months or ISO-weeks as sublevels |
| 7202 | 7199 | and then dates on the lowest level. Tags are allowed in the tree structure.} | |
| 7203 | @item (file+weektree "path/to/file") | 7200 | for today's date. If the optional outline path is given, the tree will be |
| 7204 | Will create a heading in a week tree for today's date. Week trees are sorted | 7201 | built under the node it is pointing to, instead of at top level. Check out |
| 7205 | by week and not by month unlike datetrees. | 7202 | the @code{:time-prompt} and @code{:tree-type} properties below for additional |
| 7206 | 7203 | options. | |
| 7207 | @item (file+weektree+prompt "path/to/file") | ||
| 7208 | Will create a heading in a week tree, but will prompt for the date. | ||
| 7209 | 7204 | ||
| 7210 | @item (file+function "path/to/file" function-finding-location) | 7205 | @item (file+function "path/to/file" function-finding-location) |
| 7211 | A function to find the right location in the file. | 7206 | A function to find the right location in the file. |
| @@ -7257,6 +7252,16 @@ with the capture. Note that @code{:clock-keep} has precedence over | |||
| 7257 | @code{:clock-resume}. When setting both to @code{t}, the current clock will | 7252 | @code{:clock-resume}. When setting both to @code{t}, the current clock will |
| 7258 | run and the previous one will not be resumed. | 7253 | run and the previous one will not be resumed. |
| 7259 | 7254 | ||
| 7255 | @item :time-prompt | ||
| 7256 | Prompt for a date/time to be used for date/week trees and when filling the | ||
| 7257 | template. Without this property, capture uses the current date and time. | ||
| 7258 | Even if this property has not been set, you can force the same behavior by | ||
| 7259 | calling @code{org-capture} with a @kbd{C-1} prefix argument. | ||
| 7260 | |||
| 7261 | @item :tree-type | ||
| 7262 | When `week', make a week tree instead of the month tree, i.e. place the | ||
| 7263 | headings for each day under a heading with the current iso week. | ||
| 7264 | |||
| 7260 | @item :unnarrowed | 7265 | @item :unnarrowed |
| 7261 | Do not narrow the target buffer, simply show the full buffer. Default is to | 7266 | Do not narrow the target buffer, simply show the full buffer. Default is to |
| 7262 | narrow it so that you only see the new material. | 7267 | narrow it so that you only see the new material. |
| @@ -7428,6 +7433,9 @@ Note that hard links are not supported on all systems. | |||
| 7428 | Attach a file using the copy/move/link method. | 7433 | Attach a file using the copy/move/link method. |
| 7429 | Note that hard links are not supported on all systems. | 7434 | Note that hard links are not supported on all systems. |
| 7430 | 7435 | ||
| 7436 | @orgcmdtkc{u,C-c C-a u,org-attach-url} | ||
| 7437 | Attach a file from URL | ||
| 7438 | |||
| 7431 | @orgcmdtkc{n,C-c C-a n,org-attach-new} | 7439 | @orgcmdtkc{n,C-c C-a n,org-attach-new} |
| 7432 | Create a new attachment as an Emacs buffer. | 7440 | Create a new attachment as an Emacs buffer. |
| 7433 | 7441 | ||
| @@ -7920,7 +7928,7 @@ important for a particular date, this information must be collected, | |||
| 7920 | sorted and displayed in an organized way. | 7928 | sorted and displayed in an organized way. |
| 7921 | 7929 | ||
| 7922 | Org can select items based on various criteria and display them | 7930 | Org can select items based on various criteria and display them |
| 7923 | in a separate buffer. Seven different view types are provided: | 7931 | in a separate buffer. Six different view types are provided: |
| 7924 | 7932 | ||
| 7925 | @itemize @bullet | 7933 | @itemize @bullet |
| 7926 | @item | 7934 | @item |
| @@ -7933,9 +7941,6 @@ action items, | |||
| 7933 | a @emph{match view}, showings headlines based on the tags, properties, and | 7941 | a @emph{match view}, showings headlines based on the tags, properties, and |
| 7934 | TODO state associated with them, | 7942 | TODO state associated with them, |
| 7935 | @item | 7943 | @item |
| 7936 | a @emph{timeline view} that shows all events in a single Org file, | ||
| 7937 | in time-sorted view, | ||
| 7938 | @item | ||
| 7939 | a @emph{text search view} that shows all entries from multiple files | 7944 | a @emph{text search view} that shows all entries from multiple files |
| 7940 | that contain specified keywords, | 7945 | that contain specified keywords, |
| 7941 | @item | 7946 | @item |
| @@ -8075,8 +8080,6 @@ Create a list of all TODO items (@pxref{Global TODO list}). | |||
| 8075 | @item m @r{/} M | 8080 | @item m @r{/} M |
| 8076 | Create a list of headlines matching a TAGS expression (@pxref{Matching | 8081 | Create a list of headlines matching a TAGS expression (@pxref{Matching |
| 8077 | tags and properties}). | 8082 | tags and properties}). |
| 8078 | @item L | ||
| 8079 | Create the timeline view for the current buffer (@pxref{Timeline}). | ||
| 8080 | @item s | 8083 | @item s |
| 8081 | Create a list of entries selected by a boolean expression of keywords | 8084 | Create a list of entries selected by a boolean expression of keywords |
| 8082 | and/or regular expressions that must or must not occur in the entry. | 8085 | and/or regular expressions that must or must not occur in the entry. |
| @@ -8130,7 +8133,6 @@ In this section we describe the built-in views. | |||
| 8130 | * Weekly/daily agenda:: The calendar page with current tasks | 8133 | * Weekly/daily agenda:: The calendar page with current tasks |
| 8131 | * Global TODO list:: All unfinished action items | 8134 | * Global TODO list:: All unfinished action items |
| 8132 | * Matching tags and properties:: Structured information with fine-tuned search | 8135 | * Matching tags and properties:: Structured information with fine-tuned search |
| 8133 | * Timeline:: Time-sorted view for single file | ||
| 8134 | * Search view:: Find entries by searching for text | 8136 | * Search view:: Find entries by searching for text |
| 8135 | * Stuck projects:: Find projects you need to review | 8137 | * Stuck projects:: Find projects you need to review |
| 8136 | @end menu | 8138 | @end menu |
| @@ -8528,26 +8530,6 @@ Select @samp{:work:}-tagged TODO lines that are either @samp{WAITING} or | |||
| 8528 | @samp{NEXT}. | 8530 | @samp{NEXT}. |
| 8529 | @end table | 8531 | @end table |
| 8530 | 8532 | ||
| 8531 | @node Timeline | ||
| 8532 | @subsection Timeline for a single file | ||
| 8533 | @cindex timeline, single file | ||
| 8534 | @cindex time-sorted view | ||
| 8535 | |||
| 8536 | The timeline summarizes all time-stamped items from a single Org mode | ||
| 8537 | file in a @emph{time-sorted view}. The main purpose of this command is | ||
| 8538 | to give an overview over events in a project. | ||
| 8539 | |||
| 8540 | @table @kbd | ||
| 8541 | @orgcmd{C-c a L,org-timeline} | ||
| 8542 | Show a time-sorted view of the Org file, with all time-stamped items. | ||
| 8543 | When called with a @kbd{C-u} prefix, all unfinished TODO entries | ||
| 8544 | (scheduled or not) are also listed under the current date. | ||
| 8545 | @end table | ||
| 8546 | |||
| 8547 | @noindent | ||
| 8548 | The commands available in the timeline buffer are listed in | ||
| 8549 | @ref{Agenda commands}. | ||
| 8550 | |||
| 8551 | @node Search view | 8533 | @node Search view |
| 8552 | @subsection Search view | 8534 | @subsection Search view |
| 8553 | @cindex search view | 8535 | @cindex search view |
| @@ -9068,7 +9050,7 @@ prefix arguments @kbd{C-u C-u}, show only logging information, nothing else. | |||
| 9068 | @c | 9050 | @c |
| 9069 | @orgcmdkskc{v [,[,org-agenda-manipulate-query-add} | 9051 | @orgcmdkskc{v [,[,org-agenda-manipulate-query-add} |
| 9070 | Include inactive timestamps into the current view. Only for weekly/daily | 9052 | Include inactive timestamps into the current view. Only for weekly/daily |
| 9071 | agenda and timeline views. | 9053 | agenda. |
| 9072 | @c | 9054 | @c |
| 9073 | @orgcmd{v a,org-agenda-archives-mode} | 9055 | @orgcmd{v a,org-agenda-archives-mode} |
| 9074 | @xorgcmd{v A,org-agenda-archives-mode 'files} | 9056 | @xorgcmd{v A,org-agenda-archives-mode 'files} |
| @@ -9708,8 +9690,9 @@ See the docstring of the variable for more information. | |||
| 9708 | 9690 | ||
| 9709 | If you are away from your computer, it can be very useful to have a printed | 9691 | If you are away from your computer, it can be very useful to have a printed |
| 9710 | version of some agenda views to carry around. Org mode can export custom | 9692 | version of some agenda views to carry around. Org mode can export custom |
| 9711 | agenda views as plain text, HTML@footnote{You need to install Hrvoje Niksic's | 9693 | agenda views as plain text, HTML@footnote{You need to install |
| 9712 | @file{htmlize.el}.}, Postscript, PDF@footnote{To create PDF output, the | 9694 | @file{htmlize.el} from @uref{https://github.com/hniksic/emacs-htmlize,Hrvoje |
| 9695 | Niksic's repository.}}, Postscript, PDF@footnote{To create PDF output, the | ||
| 9713 | ghostscript @file{ps2pdf} utility must be installed on the system. Selecting | 9696 | ghostscript @file{ps2pdf} utility must be installed on the system. Selecting |
| 9714 | a PDF file will also create the postscript file.}, and iCalendar files. If | 9697 | a PDF file will also create the postscript file.}, and iCalendar files. If |
| 9715 | you want to do this only occasionally, use the command | 9698 | you want to do this only occasionally, use the command |
| @@ -9771,13 +9754,13 @@ or absolute. | |||
| 9771 | @end lisp | 9754 | @end lisp |
| 9772 | 9755 | ||
| 9773 | The extension of the file name determines the type of export. If it is | 9756 | The extension of the file name determines the type of export. If it is |
| 9774 | @file{.html}, Org mode will use the @file{htmlize.el} package to convert | 9757 | @file{.html}, Org mode will try to use the @file{htmlize.el} package to |
| 9775 | the buffer to HTML and save it to this file name. If the extension is | 9758 | convert the buffer to HTML and save it to this file name. If the extension |
| 9776 | @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce | 9759 | is @file{.ps}, @code{ps-print-buffer-with-faces} is used to produce |
| 9777 | Postscript output. If the extension is @file{.ics}, iCalendar export is | 9760 | Postscript output. If the extension is @file{.ics}, iCalendar export is run |
| 9778 | run export over all files that were used to construct the agenda, and | 9761 | export over all files that were used to construct the agenda, and limit the |
| 9779 | limit the export to entries listed in the agenda. Any other | 9762 | export to entries listed in the agenda. Any other extension produces a plain |
| 9780 | extension produces a plain ASCII file. | 9763 | ASCII file. |
| 9781 | 9764 | ||
| 9782 | The export files are @emph{not} created when you use one of those | 9765 | The export files are @emph{not} created when you use one of those |
| 9783 | commands interactively because this might use too much overhead. | 9766 | commands interactively because this might use too much overhead. |
| @@ -10085,7 +10068,7 @@ If the example is source code from a programming language, or any other text | |||
| 10085 | that can be marked up by font-lock in Emacs, you can ask for the example to | 10068 | that can be marked up by font-lock in Emacs, you can ask for the example to |
| 10086 | look like the fontified Emacs buffer@footnote{This works automatically for | 10069 | look like the fontified Emacs buffer@footnote{This works automatically for |
| 10087 | the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package, | 10070 | the HTML back-end (it requires version 1.34 of the @file{htmlize.el} package, |
| 10088 | which is distributed with Org). Fontified code chunks in @LaTeX{} can be | 10071 | which you need to install). Fontified code chunks in @LaTeX{} can be |
| 10089 | achieved using either the | 10072 | achieved using either the |
| 10090 | @url{https://www.ctan.org/tex-archive/macros/latex/contrib/listings/?lang=en, listings,} | 10073 | @url{https://www.ctan.org/tex-archive/macros/latex/contrib/listings/?lang=en, listings,} |
| 10091 | or the | 10074 | or the |
| @@ -10424,7 +10407,7 @@ major @LaTeX{} mode like AUC@TeX{} in order to speed-up insertion of | |||
| 10424 | environments and math templates. Inside Org mode, you can make use of | 10407 | environments and math templates. Inside Org mode, you can make use of |
| 10425 | some of the features of CD@LaTeX{} mode. You need to install | 10408 | some of the features of CD@LaTeX{} mode. You need to install |
| 10426 | @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with | 10409 | @file{cdlatex.el} and @file{texmathp.el} (the latter comes also with |
| 10427 | AUC@TeX{}) from @url{http://www.astro.uva.nl/~dominik/Tools/cdlatex}. | 10410 | AUC@TeX{}) from @url{https://staff.fnwi.uva.nl/c.dominik/Tools/cdlatex}. |
| 10428 | Don't use CD@LaTeX{} mode itself under Org mode, but use the light | 10411 | Don't use CD@LaTeX{} mode itself under Org mode, but use the light |
| 10429 | version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it | 10412 | version @code{org-cdlatex-mode} that comes as part of Org mode. Turn it |
| 10430 | on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all | 10413 | on for the current buffer with @kbd{M-x org-cdlatex-mode RET}, or for all |
| @@ -10624,14 +10607,14 @@ override options set at a more general level. | |||
| 10624 | 10607 | ||
| 10625 | @cindex #+SETUPFILE | 10608 | @cindex #+SETUPFILE |
| 10626 | In-buffer settings may appear anywhere in the file, either directly or | 10609 | In-buffer settings may appear anywhere in the file, either directly or |
| 10627 | indirectly through a file included using @samp{#+SETUPFILE: filename} syntax. | 10610 | indirectly through a file included using @samp{#+SETUPFILE: filename or URL} |
| 10628 | Option keyword sets tailored to a particular back-end can be inserted from | 10611 | syntax. Option keyword sets tailored to a particular back-end can be |
| 10629 | the export dispatcher (@pxref{The export dispatcher}) using the @code{Insert | 10612 | inserted from the export dispatcher (@pxref{The export dispatcher}) using the |
| 10630 | template} command by pressing @key{#}. To insert keywords individually, | 10613 | @code{Insert template} command by pressing @key{#}. To insert keywords |
| 10631 | a good way to make sure the keyword is correct is to type @code{#+} and then | 10614 | individually, a good way to make sure the keyword is correct is to type |
| 10632 | to use @kbd{M-@key{TAB}}@footnote{Many desktops intercept @kbd{M-TAB} to | 10615 | @code{#+} and then to use @kbd{M-@key{TAB}}@footnote{Many desktops intercept |
| 10633 | switch windows. Use @kbd{C-M-i} or @kbd{@key{ESC} @key{TAB}} instead.} for | 10616 | @kbd{M-TAB} to switch windows. Use @kbd{C-M-i} or @kbd{@key{ESC} @key{TAB}} |
| 10634 | completion. | 10617 | instead.} for completion. |
| 10635 | 10618 | ||
| 10636 | The export keywords available for every back-end, and their equivalent global | 10619 | The export keywords available for every back-end, and their equivalent global |
| 10637 | variables, include: | 10620 | variables, include: |
| @@ -10690,6 +10673,12 @@ code blocks contained in them. | |||
| 10690 | @cindex #+TITLE | 10673 | @cindex #+TITLE |
| 10691 | @cindex document title | 10674 | @cindex document title |
| 10692 | Org displays this title. For long titles, use multiple @code{#+TITLE} lines. | 10675 | Org displays this title. For long titles, use multiple @code{#+TITLE} lines. |
| 10676 | |||
| 10677 | @item EXPORT_FILE_NAME | ||
| 10678 | @cindex #+EXPORT_FILE_NAME | ||
| 10679 | The name of the output file to be generated. Otherwise, Org generates the | ||
| 10680 | file name based on the buffer name and the extension based on the back-end | ||
| 10681 | format. | ||
| 10693 | @end table | 10682 | @end table |
| 10694 | 10683 | ||
| 10695 | The @code{#+OPTIONS} keyword is a compact form. To configure multiple | 10684 | The @code{#+OPTIONS} keyword is a compact form. To configure multiple |
| @@ -10862,9 +10851,10 @@ Toggle inclusion of tables (@code{org-export-with-tables}). | |||
| 10862 | 10851 | ||
| 10863 | When exporting sub-trees, special node properties in them can override the | 10852 | When exporting sub-trees, special node properties in them can override the |
| 10864 | above keywords. They are special because they have an @samp{EXPORT_} prefix. | 10853 | above keywords. They are special because they have an @samp{EXPORT_} prefix. |
| 10865 | For example, @samp{DATE} and @samp{OPTIONS} keywords become, respectively, | 10854 | For example, @samp{DATE} and @samp{EXPORT_FILE_NAME} keywords become, |
| 10866 | @samp{EXPORT_DATE} and @samp{EXPORT_OPTIONS}. Except for @samp{SETUPFILE}, | 10855 | respectively, @samp{EXPORT_DATE} and @samp{EXPORT_FILE_NAME}. Except for |
| 10867 | all other keywords listed above have an @samp{EXPORT_} equivalent. | 10856 | @samp{SETUPFILE}, all other keywords listed above have an @samp{EXPORT_} |
| 10857 | equivalent. | ||
| 10868 | 10858 | ||
| 10869 | @cindex #+BIND | 10859 | @cindex #+BIND |
| 10870 | @vindex org-export-allow-bind-keywords | 10860 | @vindex org-export-allow-bind-keywords |
| @@ -10873,11 +10863,6 @@ can become buffer-local during export by using the BIND keyword. Its syntax | |||
| 10873 | is @samp{#+BIND: variable value}. This is particularly useful for in-buffer | 10863 | is @samp{#+BIND: variable value}. This is particularly useful for in-buffer |
| 10874 | settings that cannot be changed using keywords. | 10864 | settings that cannot be changed using keywords. |
| 10875 | 10865 | ||
| 10876 | @cindex property, EXPORT_FILE_NAME | ||
| 10877 | Normally Org generates the file name based on the buffer name and the | ||
| 10878 | extension based on the back-end format. For sub-trees, Org can export to a | ||
| 10879 | file name as specified in the @code{EXPORT_FILE_NAME} property. | ||
| 10880 | |||
| 10881 | @node Table of contents | 10866 | @node Table of contents |
| 10882 | @section Table of contents | 10867 | @section Table of contents |
| 10883 | @cindex table of contents | 10868 | @cindex table of contents |
| @@ -11014,8 +10999,9 @@ Visit the include file at point. | |||
| 11014 | @cindex macro replacement, during export | 10999 | @cindex macro replacement, during export |
| 11015 | @cindex #+MACRO | 11000 | @cindex #+MACRO |
| 11016 | 11001 | ||
| 11017 | Macros replace text snippets during export. This is a macro definition in | 11002 | @vindex org-export-global-macros |
| 11018 | Org: | 11003 | Macros replace text snippets during export. Macros are defined globally in |
| 11004 | @code{org-export-global-macros}, or document-wise with the following syntax: | ||
| 11019 | 11005 | ||
| 11020 | @example | 11006 | @example |
| 11021 | #+MACRO: name replacement text $1, $2 are arguments | 11007 | #+MACRO: name replacement text $1, $2 are arguments |
| @@ -11074,6 +11060,19 @@ This macro refers to the filename of the exported file. | |||
| 11074 | This macro returns the value of property @var{PROPERTY-NAME} in the current | 11060 | This macro returns the value of property @var{PROPERTY-NAME} in the current |
| 11075 | entry. If @var{SEARCH-OPTION} (@pxref{Search options}) refers to a remote | 11061 | entry. If @var{SEARCH-OPTION} (@pxref{Search options}) refers to a remote |
| 11076 | entry, that will be used instead. | 11062 | entry, that will be used instead. |
| 11063 | |||
| 11064 | @item @{@{@{n@}@}@} | ||
| 11065 | @itemx @{@{@{n(@var{NAME})@}@}@} | ||
| 11066 | @itemx @{@{@{n(@var{NAME},@var{ACTION})@}@}@} | ||
| 11067 | @cindex n, macro | ||
| 11068 | @cindex counter, macro | ||
| 11069 | This macro implements custom counters by returning the number of times the | ||
| 11070 | macro has been expanded so far while exporting the buffer. You can create | ||
| 11071 | more than one counter using different @var{NAME} values. If @var{ACTION} is | ||
| 11072 | @code{-}, previous value of the counter is held, i.e. the specified counter | ||
| 11073 | is not incremented. If the value is a number, the specified counter is set | ||
| 11074 | to that value. If it is any other non-empty string, the specified counter is | ||
| 11075 | reset to 1. You may leave @var{NAME} empty to reset the default counter. | ||
| 11077 | @end table | 11076 | @end table |
| 11078 | 11077 | ||
| 11079 | The surrounding brackets can be made invisible by setting | 11078 | The surrounding brackets can be made invisible by setting |
| @@ -13939,21 +13938,45 @@ This paragraph is preceded by... | |||
| 13939 | @node Plain lists in Texinfo export | 13938 | @node Plain lists in Texinfo export |
| 13940 | @subsection Plain lists in Texinfo export | 13939 | @subsection Plain lists in Texinfo export |
| 13941 | @cindex #+ATTR_TEXINFO, in plain lists | 13940 | @cindex #+ATTR_TEXINFO, in plain lists |
| 13941 | @cindex Two-column tables, in Texinfo export | ||
| 13942 | |||
| 13943 | @cindex :table-type attribute, in Texinfo export | ||
| 13942 | The Texinfo export back-end by default converts description lists in the Org | 13944 | The Texinfo export back-end by default converts description lists in the Org |
| 13943 | file using the default command @code{@@table}, which results in a table with | 13945 | file using the default command @code{@@table}, which results in a table with |
| 13944 | two columns. To change this behavior, specify @code{:table-type} with | 13946 | two columns. To change this behavior, specify @code{:table-type} with |
| 13945 | @code{@@ftable} or @code{@@vtable} attributes. For more information, | 13947 | @code{ftable} or @code{vtable} attributes. For more information, |
| 13946 | @inforef{Two-column Tables,,texinfo}. | 13948 | @inforef{Two-column Tables,,texinfo}. |
| 13947 | 13949 | ||
| 13948 | @vindex org-texinfo-def-table-markup | 13950 | @vindex org-texinfo-table-default-markup |
| 13951 | @cindex :indic attribute, in Texinfo export | ||
| 13949 | The Texinfo export back-end by default also applies a text highlight based on | 13952 | The Texinfo export back-end by default also applies a text highlight based on |
| 13950 | the defaults stored in @code{org-texinfo-def-table-markup}. To override the | 13953 | the defaults stored in @code{org-texinfo-table-default-markup}. To override |
| 13951 | default highlight command, specify another one with the @code{:indic} | 13954 | the default highlight command, specify another one with the @code{:indic} |
| 13952 | attribute as shown in this example: | 13955 | attribute. |
| 13956 | |||
| 13957 | @cindex Multiple entries in two-column tables, in Texinfo export | ||
| 13958 | @cindex :sep attribute, in Texinfo export | ||
| 13959 | Org syntax is limited to one entry per list item. Nevertheless, the Texinfo | ||
| 13960 | export back-end can split that entry according to any text provided through | ||
| 13961 | the @code{:sep} attribute. Each part then becomes a new entry in the first | ||
| 13962 | column of the table. | ||
| 13963 | |||
| 13964 | The following example illustrates all the attributes above: | ||
| 13953 | 13965 | ||
| 13954 | @example | 13966 | @example |
| 13955 | #+ATTR_TEXINFO: :indic @@asis | 13967 | #+ATTR_TEXINFO: :table-type vtable :sep , :indic asis |
| 13956 | - foo :: This is the text for /foo/, with no highlighting. | 13968 | - foo, bar :: This is the common text for variables foo and bar. |
| 13969 | @end example | ||
| 13970 | |||
| 13971 | @noindent | ||
| 13972 | becomes | ||
| 13973 | |||
| 13974 | @example | ||
| 13975 | @@vtable @@asis | ||
| 13976 | @@item foo | ||
| 13977 | @@itemx bar | ||
| 13978 | This is the common text for variables foo and bar. | ||
| 13979 | @@end table | ||
| 13957 | @end example | 13980 | @end example |
| 13958 | 13981 | ||
| 13959 | @node Tables in Texinfo export | 13982 | @node Tables in Texinfo export |
| @@ -14011,8 +14034,9 @@ A somewhat obsessive function. | |||
| 14011 | @node A Texinfo example | 14034 | @node A Texinfo example |
| 14012 | @subsection A Texinfo example | 14035 | @subsection A Texinfo example |
| 14013 | 14036 | ||
| 14014 | Here is a more detailed example Org file. @inforef{GNU Sample | 14037 | Here is a more detailed example Org file. @xref{GNU Sample |
| 14015 | Texts,,texinfo} for an equivalent example using Texinfo code. | 14038 | Texts,,,texinfo,GNU Texinfo Manual} for an equivalent example using Texinfo |
| 14039 | code. | ||
| 14016 | 14040 | ||
| 14017 | @example | 14041 | @example |
| 14018 | #+TITLE: GNU Sample @{@{@{version@}@}@} | 14042 | #+TITLE: GNU Sample @{@{@{version@}@}@} |
| @@ -14140,9 +14164,10 @@ and write it to @code{org-icalendar-combined-agenda-file} file name. | |||
| 14140 | @cindex property, SUMMARY | 14164 | @cindex property, SUMMARY |
| 14141 | @cindex property, DESCRIPTION | 14165 | @cindex property, DESCRIPTION |
| 14142 | @cindex property, LOCATION | 14166 | @cindex property, LOCATION |
| 14143 | The iCalendar export back-end includes SUMMARY, DESCRIPTION and LOCATION | 14167 | @cindex property, TIMEZONE |
| 14144 | properties from the Org entries when exporting. To force the back-end to | 14168 | The iCalendar export back-end includes SUMMARY, DESCRIPTION, LOCATION and |
| 14145 | inherit the LOCATION property, configure the | 14169 | TIMEZONE properties from the Org entries when exporting. To force the |
| 14170 | back-end to inherit the LOCATION and TIMEZONE properties, configure the | ||
| 14146 | @code{org-use-property-inheritance} variable. | 14171 | @code{org-use-property-inheritance} variable. |
| 14147 | 14172 | ||
| 14148 | When Org entries do not have SUMMARY, DESCRIPTION and LOCATION properties, | 14173 | When Org entries do not have SUMMARY, DESCRIPTION and LOCATION properties, |
| @@ -14151,6 +14176,12 @@ derives the description from the body of the Org item. The | |||
| 14151 | @code{org-icalendar-include-body} variable limits the maximum number of | 14176 | @code{org-icalendar-include-body} variable limits the maximum number of |
| 14152 | characters of the content are turned into its description. | 14177 | characters of the content are turned into its description. |
| 14153 | 14178 | ||
| 14179 | The TIMEZONE property can be used to specify a per-entry time zone, and will | ||
| 14180 | be applied to any entry with timestamp information. Time zones should be | ||
| 14181 | specified as per the IANA time zone database format, e.g.@: ``Asia/Almaty''. | ||
| 14182 | Alternately, the property value can be ``UTC'', to force UTC time for this | ||
| 14183 | entry only. | ||
| 14184 | |||
| 14154 | Exporting to iCalendar format depends in large part on the capabilities of | 14185 | Exporting to iCalendar format depends in large part on the capabilities of |
| 14155 | the destination application. Some are more lenient than others. Consult the | 14186 | the destination application. Some are more lenient than others. Consult the |
| 14156 | Org mode FAQ for advice on specific applications. | 14187 | Org mode FAQ for advice on specific applications. |
| @@ -14772,7 +14803,7 @@ however, override everything. | |||
| 14772 | @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format} | 14803 | @item @code{:texinfo-active-timestamp-format} @tab @code{org-texinfo-active-timestamp-format} |
| 14773 | @item @code{:texinfo-classes} @tab @code{org-texinfo-classes} | 14804 | @item @code{:texinfo-classes} @tab @code{org-texinfo-classes} |
| 14774 | @item @code{:texinfo-class} @tab @code{org-texinfo-default-class} | 14805 | @item @code{:texinfo-class} @tab @code{org-texinfo-default-class} |
| 14775 | @item @code{:texinfo-def-table-markup} @tab @code{org-texinfo-def-table-markup} | 14806 | @item @code{:texinfo-table-default-markup} @tab @code{org-texinfo-table-default-markup} |
| 14776 | @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format} | 14807 | @item @code{:texinfo-diary-timestamp-format} @tab @code{org-texinfo-diary-timestamp-format} |
| 14777 | @item @code{:texinfo-filename} @tab @code{org-texinfo-filename} | 14808 | @item @code{:texinfo-filename} @tab @code{org-texinfo-filename} |
| 14778 | @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function} | 14809 | @item @code{:texinfo-format-drawer-function} @tab @code{org-texinfo-format-drawer-function} |
| @@ -14834,15 +14865,30 @@ becomes @file{sitemap.html}). | |||
| 14834 | @item @code{:sitemap-title} | 14865 | @item @code{:sitemap-title} |
| 14835 | @tab Title of sitemap page. Defaults to name of file. | 14866 | @tab Title of sitemap page. Defaults to name of file. |
| 14836 | 14867 | ||
| 14868 | @item @code{:sitemap-format-entry} | ||
| 14869 | @tab With this option one can tell how a site-map entry is formatted in the | ||
| 14870 | site-map. It is a function called with three arguments: the file or | ||
| 14871 | directory name relative to base directory of the project, the site-map style | ||
| 14872 | and the current project. It is expected to return a string. Default value | ||
| 14873 | turns file names into links and use document titles as descriptions. For | ||
| 14874 | specific formatting needs, one can use @code{org-publish-find-date}, | ||
| 14875 | @code{org-publish-find-title} and @code{org-publish-find-property}, to | ||
| 14876 | retrieve additional information about published documents. | ||
| 14877 | |||
| 14837 | @item @code{:sitemap-function} | 14878 | @item @code{:sitemap-function} |
| 14838 | @tab Plug-in function to use for generation of the sitemap. | 14879 | @tab Plug-in function to use for generation of the sitemap. It is called |
| 14839 | Defaults to @code{org-publish-org-sitemap}, which generates a plain list | 14880 | with two arguments: the title of the site-map and a representation of the |
| 14840 | of links to all files in the project. | 14881 | files and directories involved in the project as a radio list (@pxref{Radio |
| 14882 | lists}). The latter can further be transformed using | ||
| 14883 | @code{org-list-to-generic}, @code{org-list-to-subtree} and alike. Default | ||
| 14884 | value generates a plain list of links to all files in the project. | ||
| 14841 | 14885 | ||
| 14842 | @item @code{:sitemap-sort-folders} | 14886 | @item @code{:sitemap-sort-folders} |
| 14843 | @tab Where folders should appear in the sitemap. Set this to @code{first} | 14887 | @tab Where folders should appear in the sitemap. Set this to @code{first} |
| 14844 | (default) or @code{last} to display folders first or last, | 14888 | (default) or @code{last} to display folders first or last, respectively. |
| 14845 | respectively. Any other value will mix files and folders. | 14889 | When set to @code{ignore}, folders are ignored altogether. Any other value |
| 14890 | will mix files and folders. This variable has no effect when site-map style | ||
| 14891 | is @code{tree}. | ||
| 14846 | 14892 | ||
| 14847 | @item @code{:sitemap-sort-files} | 14893 | @item @code{:sitemap-sort-files} |
| 14848 | @tab How the files are sorted in the site map. Set this to | 14894 | @tab How the files are sorted in the site map. Set this to |
| @@ -14855,24 +14901,11 @@ a file is retrieved with @code{org-publish-find-date}. | |||
| 14855 | @item @code{:sitemap-ignore-case} | 14901 | @item @code{:sitemap-ignore-case} |
| 14856 | @tab Should sorting be case-sensitive? Default @code{nil}. | 14902 | @tab Should sorting be case-sensitive? Default @code{nil}. |
| 14857 | 14903 | ||
| 14858 | @item @code{:sitemap-file-entry-format} | ||
| 14859 | @tab With this option one can tell how a sitemap's entry is formatted in the | ||
| 14860 | sitemap. This is a format string with some escape sequences: @code{%t} stands | ||
| 14861 | for the title of the file, @code{%a} stands for the author of the file and | ||
| 14862 | @code{%d} stands for the date of the file. The date is retrieved with the | ||
| 14863 | @code{org-publish-find-date} function and formatted with | ||
| 14864 | @code{org-publish-sitemap-date-format}. Default @code{%t}. | ||
| 14865 | |||
| 14866 | @item @code{:sitemap-date-format} | 14904 | @item @code{:sitemap-date-format} |
| 14867 | @tab Format string for the @code{format-time-string} function that tells how | 14905 | @tab Format string for the @code{format-time-string} function that tells how |
| 14868 | a sitemap entry's date is to be formatted. This property bypasses | 14906 | a sitemap entry's date is to be formatted. This property bypasses |
| 14869 | @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}. | 14907 | @code{org-publish-sitemap-date-format} which defaults to @code{%Y-%m-%d}. |
| 14870 | 14908 | ||
| 14871 | @item @code{:sitemap-sans-extension} | ||
| 14872 | @tab When non-@code{nil}, remove filenames' extensions from the generated sitemap. | ||
| 14873 | Useful to have cool URIs (see @uref{http://www.w3.org/Provider/Style/URI}). | ||
| 14874 | Defaults to @code{nil}. | ||
| 14875 | |||
| 14876 | @end multitable | 14909 | @end multitable |
| 14877 | 14910 | ||
| 14878 | @node Generating an index | 14911 | @node Generating an index |
| @@ -15300,9 +15333,12 @@ Org exports both the code block and the results. | |||
| 15300 | Org does not export the code block nor the results. | 15333 | Org does not export the code block nor the results. |
| 15301 | @end table | 15334 | @end table |
| 15302 | 15335 | ||
| 15303 | @vindex org-export-babel-evaluate | 15336 | @vindex org-export-use-babel |
| 15304 | To stop Org from evaluating code blocks during export, set | 15337 | To stop Org from evaluating code blocks to speed exports, use the header |
| 15305 | @code{org-export-babel-evaluate} variable to @code{nil}. | 15338 | argument @code{:eval never-export} (@pxref{eval}). To stop Org from |
| 15339 | evaluating code blocks for greater security, set the | ||
| 15340 | @code{org-export-use-babel} variable to @code{nil}, but understand that | ||
| 15341 | header arguments will have no effect. | ||
| 15306 | 15342 | ||
| 15307 | Turning off evaluation comes in handy when batch processing. For example, | 15343 | Turning off evaluation comes in handy when batch processing. For example, |
| 15308 | markup languages for wikis, which have a high risk of untrusted code. | 15344 | markup languages for wikis, which have a high risk of untrusted code. |
| @@ -15312,12 +15348,6 @@ during export, to allow evaluation of just the header arguments but not any | |||
| 15312 | code evaluation in the source block, set @code{:eval never-export} | 15348 | code evaluation in the source block, set @code{:eval never-export} |
| 15313 | (@pxref{eval}). | 15349 | (@pxref{eval}). |
| 15314 | 15350 | ||
| 15315 | To evaluate just the inline code blocks, set @code{org-export-babel-evaluate} | ||
| 15316 | to @code{inline-only}. Isolating the option to allow inline evaluations | ||
| 15317 | separate from @samp{src} code block evaluations during exports is not for | ||
| 15318 | security but for avoiding any delays due to recalculations, such as calls to | ||
| 15319 | a remote database. | ||
| 15320 | |||
| 15321 | Org never evaluates code blocks in commented sub-trees when exporting | 15351 | Org never evaluates code blocks in commented sub-trees when exporting |
| 15322 | (@pxref{Comment lines}). On the other hand, Org does evaluate code blocks in | 15352 | (@pxref{Comment lines}). On the other hand, Org does evaluate code blocks in |
| 15323 | sub-trees excluded from export (@pxref{Export settings}). | 15353 | sub-trees excluded from export (@pxref{Export settings}). |
| @@ -15471,10 +15501,10 @@ For more examples of header arguments for @code{#+CALL:} lines, | |||
| 15471 | @cindex code block, library | 15501 | @cindex code block, library |
| 15472 | 15502 | ||
| 15473 | The ``Library of Babel'' is a collection of code blocks. Like a function | 15503 | The ``Library of Babel'' is a collection of code blocks. Like a function |
| 15474 | library, these code blocks can be called from other Org files. This | 15504 | library, these code blocks can be called from other Org files. A collection |
| 15475 | collection is in a repository file in Org mode format in the @samp{doc} | 15505 | of useful code blocks is available on |
| 15476 | directory of Org mode installation. For remote code block evaluation syntax, | 15506 | @uref{http://orgmode.org/worg/library-of-babel.html,Worg}. For remote code |
| 15477 | @pxref{Evaluating code blocks}. | 15507 | block evaluation syntax, @pxref{Evaluating code blocks}. |
| 15478 | 15508 | ||
| 15479 | @kindex C-c C-v i | 15509 | @kindex C-c C-v i |
| 15480 | For any user to add code to the library, first save the code in regular | 15510 | For any user to add code to the library, first save the code in regular |
| @@ -15511,6 +15541,7 @@ Org supports the following languages for the @samp{src} code blocks: | |||
| 15511 | @item Scheme @tab scheme @tab GNU Screen @tab screen | 15541 | @item Scheme @tab scheme @tab GNU Screen @tab screen |
| 15512 | @item Sed @tab sed @tab shell @tab sh | 15542 | @item Sed @tab sed @tab shell @tab sh |
| 15513 | @item SQL @tab sql @tab SQLite @tab sqlite | 15543 | @item SQL @tab sql @tab SQLite @tab sqlite |
| 15544 | @item Vala @tab vala | ||
| 15514 | @end multitable | 15545 | @end multitable |
| 15515 | 15546 | ||
| 15516 | Additional documentation for some languages are at | 15547 | Additional documentation for some languages are at |
| @@ -17201,12 +17232,9 @@ The sample script shows batch processing of multiple files using | |||
| 17201 | emacs -Q --batch --eval " | 17232 | emacs -Q --batch --eval " |
| 17202 | (progn | 17233 | (progn |
| 17203 | (require 'ob-tangle) | 17234 | (require 'ob-tangle) |
| 17204 | (mapc (lambda (file) | 17235 | (dolist (file command-line-args-left) |
| 17205 | (save-current-buffer | 17236 | (with-current-buffer (find-file-noselect file) |
| 17206 | (find-file file) | 17237 | (org-babel-tangle)))) |
| 17207 | (org-babel-tangle) | ||
| 17208 | (kill-buffer))) | ||
| 17209 | command-line-args-left)) | ||
| 17210 | " "$@@" | 17238 | " "$@@" |
| 17211 | @end example | 17239 | @end example |
| 17212 | 17240 | ||
| @@ -17316,6 +17344,7 @@ Org comes with these pre-defined easy templates: | |||
| 17316 | @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE} | 17344 | @item @kbd{q} @tab @code{#+BEGIN_QUOTE ... #+END_QUOTE} |
| 17317 | @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE} | 17345 | @item @kbd{v} @tab @code{#+BEGIN_VERSE ... #+END_VERSE} |
| 17318 | @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER} | 17346 | @item @kbd{c} @tab @code{#+BEGIN_CENTER ... #+END_CENTER} |
| 17347 | @item @kbd{C} @tab @code{#+BEGIN_COMMENT ... #+END_COMMENT} | ||
| 17319 | @item @kbd{l} @tab @code{#+BEGIN_EXPORT latex ... #+END_EXPORT} | 17348 | @item @kbd{l} @tab @code{#+BEGIN_EXPORT latex ... #+END_EXPORT} |
| 17320 | @item @kbd{L} @tab @code{#+LATEX:} | 17349 | @item @kbd{L} @tab @code{#+LATEX:} |
| 17321 | @item @kbd{h} @tab @code{#+BEGIN_EXPORT html ... #+END_EXPORT} | 17350 | @item @kbd{h} @tab @code{#+BEGIN_EXPORT html ... #+END_EXPORT} |
| @@ -17477,14 +17506,16 @@ have a lower ASCII number than the lowest priority. | |||
| 17477 | This line sets a default inheritance value for entries in the current | 17506 | This line sets a default inheritance value for entries in the current |
| 17478 | buffer, most useful for specifying the allowed values of a property. | 17507 | buffer, most useful for specifying the allowed values of a property. |
| 17479 | @cindex #+SETUPFILE | 17508 | @cindex #+SETUPFILE |
| 17480 | @item #+SETUPFILE: file | 17509 | @item #+SETUPFILE: file or URL |
| 17481 | The setup file is for additional in-buffer settings. Org loads this file and | 17510 | The setup file or a URL pointing to such file is for additional in-buffer |
| 17482 | parses it for any settings in it only when Org opens the main file. @kbd{C-c | 17511 | settings. Org loads this file and parses it for any settings in it only when |
| 17483 | C-c} on the settings line will also parse and load. Org also parses and | 17512 | Org opens the main file. If URL is specified, the contents are downloaded |
| 17484 | loads the file during normal exporting process. Org parses the contents of | 17513 | and stored in a temporary file cache. @kbd{C-c C-c} on the settings line |
| 17485 | this file as if it was included in the buffer. It can be another Org file. | 17514 | will parse and load the file, and also reset the temporary file cache. Org |
| 17486 | To visit the file, @kbd{C-c '} while the cursor is on the line with the file | 17515 | also parses and loads the document during normal exporting process. Org |
| 17487 | name. | 17516 | parses the contents of this document as if it was included in the buffer. It |
| 17517 | can be another Org file. To visit the file (not a URL), @kbd{C-c '} while | ||
| 17518 | the cursor is on the line with the file name. | ||
| 17488 | @item #+STARTUP: | 17519 | @item #+STARTUP: |
| 17489 | @cindex #+STARTUP | 17520 | @cindex #+STARTUP |
| 17490 | Startup options Org uses when first visiting a file. | 17521 | Startup options Org uses when first visiting a file. |
| @@ -17725,7 +17756,9 @@ If any highlights shown in the buffer from the creation of a sparse tree, or | |||
| 17725 | from clock display, remove such highlights. | 17756 | from clock display, remove such highlights. |
| 17726 | @item | 17757 | @item |
| 17727 | If the cursor is in one of the special @code{#+KEYWORD} lines, scan the | 17758 | If the cursor is in one of the special @code{#+KEYWORD} lines, scan the |
| 17728 | buffer for these lines and update the information. | 17759 | buffer for these lines and update the information. Also reset the Org file |
| 17760 | cache used to temporary store the contents of URLs used as values for | ||
| 17761 | keywords like @code{#+SETUPFILE}. | ||
| 17729 | @item | 17762 | @item |
| 17730 | If the cursor is inside a table, realign the table. The table realigns even | 17763 | If the cursor is inside a table, realign the table. The table realigns even |
| 17731 | if automatic table editor is turned off. | 17764 | if automatic table editor is turned off. |
| @@ -17941,7 +17974,7 @@ Org can use names for constants in formulas in tables. Org can also use | |||
| 17941 | calculation suffixes for units, such as @samp{M} for @samp{Mega}. For a | 17974 | calculation suffixes for units, such as @samp{M} for @samp{Mega}. For a |
| 17942 | standard collection of such constants, install the @file{constants} package. | 17975 | standard collection of such constants, install the @file{constants} package. |
| 17943 | Install version 2.0 of this package, available at | 17976 | Install version 2.0 of this package, available at |
| 17944 | @url{http://www.astro.uva.nl/~dominik/Tools}. Org checks if the function | 17977 | @url{https://staff.fnwi.uva.nl/c.dominik/Tools/}. Org checks if the function |
| 17945 | @code{constants-get} has been autoloaded. Installation instructions are in | 17978 | @code{constants-get} has been autoloaded. Installation instructions are in |
| 17946 | the file, @file{constants.el}. | 17979 | the file, @file{constants.el}. |
| 17947 | @item @file{cdlatex.el} by Carsten Dominik | 17980 | @item @file{cdlatex.el} by Carsten Dominik |