diff options
| author | Michael Albinus | 2018-02-24 20:40:39 +0100 |
|---|---|---|
| committer | Michael Albinus | 2018-02-24 20:40:39 +0100 |
| commit | e415309fef4077fe7e4dfe1a898d749c1136ca2c (patch) | |
| tree | 25d3f0f65727e7860a624b500d046484c58e985d | |
| parent | 105d085e7e970c182f01d4ef7a949629ae4b9709 (diff) | |
| download | emacs-e415309fef4077fe7e4dfe1a898d749c1136ca2c.tar.gz emacs-e415309fef4077fe7e4dfe1a898d749c1136ca2c.zip | |
Fix @cindex entries in org.texi
* doc/misc/org.texi: Fix @cindex entries. Use consistently
@code{} for keywords.
| -rw-r--r-- | doc/misc/org.texi | 657 |
1 files changed, 328 insertions, 329 deletions
diff --git a/doc/misc/org.texi b/doc/misc/org.texi index b187bfcdbc6..19c83f65a68 100644 --- a/doc/misc/org.texi +++ b/doc/misc/org.texi | |||
| @@ -1342,9 +1342,9 @@ following lines anywhere in the buffer: | |||
| 1342 | #+STARTUP: showeverything | 1342 | #+STARTUP: showeverything |
| 1343 | @end example | 1343 | @end example |
| 1344 | 1344 | ||
| 1345 | @cindex property, VISIBILITY | 1345 | @cindex property, @code{VISIBILITY} |
| 1346 | @noindent | 1346 | @noindent |
| 1347 | Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties | 1347 | Furthermore, any entries with a @code{VISIBILITY} property (@pxref{Properties |
| 1348 | and columns}) will get their visibility adapted accordingly. Allowed values | 1348 | and columns}) will get their visibility adapted accordingly. Allowed values |
| 1349 | for this property are @code{folded}, @code{children}, @code{content}, and | 1349 | for this property are @code{folded}, @code{children}, @code{content}, and |
| 1350 | @code{all}. | 1350 | @code{all}. |
| @@ -1352,7 +1352,7 @@ for this property are @code{folded}, @code{children}, @code{content}, and | |||
| 1352 | @table @asis | 1352 | @table @asis |
| 1353 | @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} | 1353 | @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} |
| 1354 | Switch back to the startup visibility of the buffer, i.e., whatever is | 1354 | Switch back to the startup visibility of the buffer, i.e., whatever is |
| 1355 | requested by startup options and @samp{VISIBILITY} properties in individual | 1355 | requested by startup options and @code{VISIBILITY} properties in individual |
| 1356 | entries. | 1356 | entries. |
| 1357 | @end table | 1357 | @end table |
| 1358 | 1358 | ||
| @@ -1819,7 +1819,7 @@ or by a custom function. | |||
| 1819 | @cindex drawers | 1819 | @cindex drawers |
| 1820 | @cindex visibility cycling, drawers | 1820 | @cindex visibility cycling, drawers |
| 1821 | 1821 | ||
| 1822 | @cindex org-insert-drawer | 1822 | @cindex @code{org-insert-drawer} |
| 1823 | @kindex C-c C-x d | 1823 | @kindex C-c C-x d |
| 1824 | Sometimes you want to keep information associated with an entry, but you | 1824 | Sometimes you want to keep information associated with an entry, but you |
| 1825 | normally don't want to see it. For this, Org mode has @emph{drawers}. They | 1825 | normally don't want to see it. For this, Org mode has @emph{drawers}. They |
| @@ -2567,7 +2567,7 @@ rows/columns. | |||
| 2567 | @cindex references, named | 2567 | @cindex references, named |
| 2568 | @cindex name, of column or field | 2568 | @cindex name, of column or field |
| 2569 | @cindex constants, in calculations | 2569 | @cindex constants, in calculations |
| 2570 | @cindex #+CONSTANTS | 2570 | @cindex @code{#+CONSTANTS} |
| 2571 | 2571 | ||
| 2572 | @vindex org-table-formula-constants | 2572 | @vindex org-table-formula-constants |
| 2573 | @samp{$name} is interpreted as the name of a column, parameter or | 2573 | @samp{$name} is interpreted as the name of a column, parameter or |
| @@ -2604,7 +2604,7 @@ numbers. | |||
| 2604 | @cindex references, to a different table | 2604 | @cindex references, to a different table |
| 2605 | @cindex name, of column or field | 2605 | @cindex name, of column or field |
| 2606 | @cindex constants, in calculations | 2606 | @cindex constants, in calculations |
| 2607 | @cindex #+NAME, for table | 2607 | @cindex @code{#+NAME}, for table |
| 2608 | 2608 | ||
| 2609 | You may also reference constants, fields and ranges from a different table, | 2609 | You may also reference constants, fields and ranges from a different table, |
| 2610 | either in the current file or even in a different file. The syntax is | 2610 | either in the current file or even in a different file. The syntax is |
| @@ -2826,8 +2826,8 @@ preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press | |||
| 2826 | the formula will be stored as the formula for this field, evaluated, and the | 2826 | the formula will be stored as the formula for this field, evaluated, and the |
| 2827 | current field will be replaced with the result. | 2827 | current field will be replaced with the result. |
| 2828 | 2828 | ||
| 2829 | @cindex #+TBLFM | 2829 | @cindex @code{#+TBLFM} |
| 2830 | Formulas are stored in a special line starting with @samp{#+TBLFM:} directly | 2830 | Formulas are stored in a special line starting with @code{#+TBLFM:} directly |
| 2831 | below the table. If you type the equation in the 4th field of the 3rd data | 2831 | below the table. If you type the equation in the 4th field of the 3rd data |
| 2832 | line in the table, the formula will look like @samp{@@3$4=$1+$2}. When | 2832 | line in the table, the formula will look like @samp{@@3$4=$1+$2}. When |
| 2833 | inserting/deleting/swapping columns and rows with the appropriate commands, | 2833 | inserting/deleting/swapping columns and rows with the appropriate commands, |
| @@ -2845,7 +2845,7 @@ command | |||
| 2845 | @table @kbd | 2845 | @table @kbd |
| 2846 | @orgcmd{C-u C-c =,org-table-eval-formula} | 2846 | @orgcmd{C-u C-c =,org-table-eval-formula} |
| 2847 | Install a new formula for the current field. The command prompts for a | 2847 | Install a new formula for the current field. The command prompts for a |
| 2848 | formula with default taken from the @samp{#+TBLFM:} line, applies | 2848 | formula with default taken from the @code{#+TBLFM:} line, applies |
| 2849 | it to the current field, and stores it. | 2849 | it to the current field, and stores it. |
| 2850 | @end table | 2850 | @end table |
| 2851 | 2851 | ||
| @@ -2892,7 +2892,7 @@ the formula will be stored as the formula for the current column, evaluated | |||
| 2892 | and the current field replaced with the result. If the field contains only | 2892 | and the current field replaced with the result. If the field contains only |
| 2893 | @samp{=}, the previously stored formula for this column is used. For each | 2893 | @samp{=}, the previously stored formula for this column is used. For each |
| 2894 | column, Org will only remember the most recently used formula. In the | 2894 | column, Org will only remember the most recently used formula. In the |
| 2895 | @samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The | 2895 | @code{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The |
| 2896 | left-hand side of a column formula cannot be the name of column, it must be | 2896 | left-hand side of a column formula cannot be the name of column, it must be |
| 2897 | the numeric column reference or @code{$>}. | 2897 | the numeric column reference or @code{$>}. |
| 2898 | 2898 | ||
| @@ -2903,7 +2903,7 @@ following command: | |||
| 2903 | @orgcmd{C-c =,org-table-eval-formula} | 2903 | @orgcmd{C-c =,org-table-eval-formula} |
| 2904 | Install a new formula for the current column and replace current field with | 2904 | Install a new formula for the current column and replace current field with |
| 2905 | the result of the formula. The command prompts for a formula, with default | 2905 | the result of the formula. The command prompts for a formula, with default |
| 2906 | taken from the @samp{#+TBLFM} line, applies it to the current field and | 2906 | taken from the @code{#+TBLFM} line, applies it to the current field and |
| 2907 | stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command | 2907 | stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command |
| 2908 | will apply it to that many consecutive fields in the current column. | 2908 | will apply it to that many consecutive fields in the current column. |
| 2909 | @end table | 2909 | @end table |
| @@ -3039,25 +3039,25 @@ Turn the coordinate grid in the table on and off. | |||
| 3039 | @end table | 3039 | @end table |
| 3040 | 3040 | ||
| 3041 | Making a table field blank does not remove the formula associated with | 3041 | Making a table field blank does not remove the formula associated with |
| 3042 | the field, because that is stored in a different line (the @samp{#+TBLFM} | 3042 | the field, because that is stored in a different line (the @code{#+TBLFM} |
| 3043 | line)---during the next recalculation the field will be filled again. | 3043 | line)---during the next recalculation the field will be filled again. |
| 3044 | To remove a formula from a field, you have to give an empty reply when | 3044 | To remove a formula from a field, you have to give an empty reply when |
| 3045 | prompted for the formula, or to edit the @samp{#+TBLFM} line. | 3045 | prompted for the formula, or to edit the @code{#+TBLFM} line. |
| 3046 | 3046 | ||
| 3047 | @kindex C-c C-c | 3047 | @kindex C-c C-c |
| 3048 | You may edit the @samp{#+TBLFM} directly and re-apply the changed | 3048 | You may edit the @code{#+TBLFM} directly and re-apply the changed |
| 3049 | equations with @kbd{C-c C-c} in that line or with the normal | 3049 | equations with @kbd{C-c C-c} in that line or with the normal |
| 3050 | recalculation commands in the table. | 3050 | recalculation commands in the table. |
| 3051 | 3051 | ||
| 3052 | @anchor{Using multiple #+TBLFM lines} | 3052 | @anchor{Using multiple #+TBLFM lines} |
| 3053 | @subsubheading Using multiple #+TBLFM lines | 3053 | @subsubheading Using multiple @code{#+TBLFM} lines |
| 3054 | @cindex #+TBLFM line, multiple | 3054 | @cindex @code{#+TBLFM} line, multiple |
| 3055 | @cindex #+TBLFM | 3055 | @cindex @code{#+TBLFM} |
| 3056 | @cindex #+TBLFM, switching | 3056 | @cindex @code{#+TBLFM}, switching |
| 3057 | @kindex C-c C-c | 3057 | @kindex C-c C-c |
| 3058 | 3058 | ||
| 3059 | You may apply the formula temporarily. This is useful when you | 3059 | You may apply the formula temporarily. This is useful when you |
| 3060 | switch the formula. Place multiple @samp{#+TBLFM} lines right | 3060 | switch the formula. Place multiple @code{#+TBLFM} lines right |
| 3061 | after the table, and then press @kbd{C-c C-c} on the formula to | 3061 | after the table, and then press @kbd{C-c C-c} on the formula to |
| 3062 | apply. Here is an example: | 3062 | apply. Here is an example: |
| 3063 | 3063 | ||
| @@ -3084,7 +3084,7 @@ Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields: | |||
| 3084 | 3084 | ||
| 3085 | @noindent | 3085 | @noindent |
| 3086 | Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you | 3086 | Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you |
| 3087 | will get the following result of applying only the first @samp{#+TBLFM} line. | 3087 | will get the following result of applying only the first @code{#+TBLFM} line. |
| 3088 | 3088 | ||
| 3089 | @example | 3089 | @example |
| 3090 | | x | y | | 3090 | | x | y | |
| @@ -3251,7 +3251,7 @@ functions. | |||
| 3251 | @section Org-Plot | 3251 | @section Org-Plot |
| 3252 | @cindex graph, in tables | 3252 | @cindex graph, in tables |
| 3253 | @cindex plot tables using Gnuplot | 3253 | @cindex plot tables using Gnuplot |
| 3254 | @cindex #+PLOT | 3254 | @cindex @code{#+PLOT} |
| 3255 | 3255 | ||
| 3256 | Org-Plot can produce graphs of information stored in org tables, either | 3256 | Org-Plot can produce graphs of information stored in org tables, either |
| 3257 | graphically or in ASCII-art. | 3257 | graphically or in ASCII-art. |
| @@ -3434,7 +3434,7 @@ internal structure of all links, use the menu entry | |||
| 3434 | @cindex links, internal | 3434 | @cindex links, internal |
| 3435 | @cindex targets, for links | 3435 | @cindex targets, for links |
| 3436 | 3436 | ||
| 3437 | @cindex property, CUSTOM_ID | 3437 | @cindex property, @code{CUSTOM_ID} |
| 3438 | If the link does not look like a URL, it is considered to be internal in the | 3438 | If the link does not look like a URL, it is considered to be internal in the |
| 3439 | current file. The most important case is a link like | 3439 | current file. The most important case is a link like |
| 3440 | @samp{[[#my-custom-id]]} which will link to the entry with the | 3440 | @samp{[[#my-custom-id]]} which will link to the entry with the |
| @@ -3450,7 +3450,7 @@ point to the corresponding headline. The preferred match for a text link is | |||
| 3450 | a @i{dedicated target}: the same string in double angular brackets, like | 3450 | a @i{dedicated target}: the same string in double angular brackets, like |
| 3451 | @samp{<<My Target>>}. | 3451 | @samp{<<My Target>>}. |
| 3452 | 3452 | ||
| 3453 | @cindex #+NAME | 3453 | @cindex @code{#+NAME} |
| 3454 | If no dedicated target exists, the link will then try to match the exact name | 3454 | If no dedicated target exists, the link will then try to match the exact name |
| 3455 | of an element within the buffer. Naming is done with the @code{#+NAME} | 3455 | of an element within the buffer. Naming is done with the @code{#+NAME} |
| 3456 | keyword, which has to be put in the line before the element it refers to, as | 3456 | keyword, which has to be put in the line before the element it refers to, as |
| @@ -3642,8 +3642,8 @@ removed from the link and result in a wrong link---you should avoid putting | |||
| 3642 | timestamp in the headline.}. | 3642 | timestamp in the headline.}. |
| 3643 | 3643 | ||
| 3644 | @vindex org-id-link-to-org-use-id | 3644 | @vindex org-id-link-to-org-use-id |
| 3645 | @cindex property, CUSTOM_ID | 3645 | @cindex property, @code{CUSTOM_ID} |
| 3646 | @cindex property, ID | 3646 | @cindex property, @code{ID} |
| 3647 | If the headline has a @code{CUSTOM_ID} property, a link to this custom ID | 3647 | If the headline has a @code{CUSTOM_ID} property, a link to this custom ID |
| 3648 | will be stored. In addition or alternatively (depending on the value of | 3648 | will be stored. In addition or alternatively (depending on the value of |
| 3649 | @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will | 3649 | @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will |
| @@ -3885,7 +3885,7 @@ what the Org author is doing besides Emacs hacking with | |||
| 3885 | If you need special abbreviations just for a single Org buffer, you | 3885 | If you need special abbreviations just for a single Org buffer, you |
| 3886 | can define them in the file with | 3886 | can define them in the file with |
| 3887 | 3887 | ||
| 3888 | @cindex #+LINK | 3888 | @cindex @code{#+LINK} |
| 3889 | @example | 3889 | @example |
| 3890 | #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= | 3890 | #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= |
| 3891 | #+LINK: google http://www.google.com/search?q=%s | 3891 | #+LINK: google http://www.google.com/search?q=%s |
| @@ -4243,9 +4243,9 @@ unique keys across both sets of keywords.} | |||
| 4243 | @subsection Setting up keywords for individual files | 4243 | @subsection Setting up keywords for individual files |
| 4244 | @cindex keyword options | 4244 | @cindex keyword options |
| 4245 | @cindex per-file keywords | 4245 | @cindex per-file keywords |
| 4246 | @cindex #+TODO | 4246 | @cindex @code{#+TODO} |
| 4247 | @cindex #+TYP_TODO | 4247 | @cindex @code{#+TYP_TODO} |
| 4248 | @cindex #+SEQ_TODO | 4248 | @cindex @code{#+SEQ_TODO} |
| 4249 | 4249 | ||
| 4250 | It can be very useful to use different aspects of the TODO mechanism in | 4250 | It can be very useful to use different aspects of the TODO mechanism in |
| 4251 | different files. For file-local settings, you need to add special lines to | 4251 | different files. For file-local settings, you need to add special lines to |
| @@ -4320,7 +4320,7 @@ foreground or a background color. | |||
| 4320 | @cindex TODO dependencies, NOBLOCKING | 4320 | @cindex TODO dependencies, NOBLOCKING |
| 4321 | 4321 | ||
| 4322 | @vindex org-enforce-todo-dependencies | 4322 | @vindex org-enforce-todo-dependencies |
| 4323 | @cindex property, ORDERED | 4323 | @cindex property, @code{ORDERED} |
| 4324 | The structure of Org files (hierarchy and lists) makes it easy to define TODO | 4324 | The structure of Org files (hierarchy and lists) makes it easy to define TODO |
| 4325 | dependencies. Usually, a parent TODO task should not be marked DONE until | 4325 | dependencies. Usually, a parent TODO task should not be marked DONE until |
| 4326 | all subtasks (defined as children tasks) are marked as DONE@. And sometimes | 4326 | all subtasks (defined as children tasks) are marked as DONE@. And sometimes |
| @@ -4359,7 +4359,7 @@ property: | |||
| 4359 | @table @kbd | 4359 | @table @kbd |
| 4360 | @orgcmd{C-c C-x o,org-toggle-ordered-property} | 4360 | @orgcmd{C-c C-x o,org-toggle-ordered-property} |
| 4361 | @vindex org-track-ordered-property-with-tag | 4361 | @vindex org-track-ordered-property-with-tag |
| 4362 | @cindex property, ORDERED | 4362 | @cindex property, @code{ORDERED} |
| 4363 | Toggle the @code{ORDERED} property of the current entry. A property is used | 4363 | Toggle the @code{ORDERED} property of the current entry. A property is used |
| 4364 | for this behavior because this should be local to the current entry, not | 4364 | for this behavior because this should be local to the current entry, not |
| 4365 | inherited like a tag. However, if you would like to @i{track} the value of | 4365 | inherited like a tag. However, if you would like to @i{track} the value of |
| @@ -4441,7 +4441,7 @@ the entry with a @samp{Closing Note} heading. | |||
| 4441 | 4441 | ||
| 4442 | @vindex org-log-states-order-reversed | 4442 | @vindex org-log-states-order-reversed |
| 4443 | @vindex org-log-into-drawer | 4443 | @vindex org-log-into-drawer |
| 4444 | @cindex property, LOG_INTO_DRAWER | 4444 | @cindex property, @code{LOG_INTO_DRAWER} |
| 4445 | When TODO keywords are used as workflow states (@pxref{Workflow states}), you | 4445 | When TODO keywords are used as workflow states (@pxref{Workflow states}), you |
| 4446 | might want to keep track of when a state change occurred and maybe take a | 4446 | might want to keep track of when a state change occurred and maybe take a |
| 4447 | note about this change. You can either record just a timestamp, or a | 4447 | note about this change. You can either record just a timestamp, or a |
| @@ -4495,12 +4495,12 @@ to a buffer: | |||
| 4495 | #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) | 4495 | #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) |
| 4496 | @end example | 4496 | @end example |
| 4497 | 4497 | ||
| 4498 | @cindex property, LOGGING | 4498 | @cindex property, @code{LOGGING} |
| 4499 | In order to define logging settings that are local to a subtree or a | 4499 | In order to define logging settings that are local to a subtree or a single |
| 4500 | single item, define a LOGGING property in this entry. Any non-empty | 4500 | item, define a @code{LOGGING} property in this entry. Any non-empty |
| 4501 | LOGGING property resets all logging settings to @code{nil}. You may then turn | 4501 | @code{LOGGING} property resets all logging settings to @code{nil}. You may |
| 4502 | on logging for this specific tree using STARTUP keywords like | 4502 | then turn on logging for this specific tree using @code{#+STARTUP} keywords |
| 4503 | @code{lognotedone} or @code{logrepeat}, as well as adding state specific | 4503 | like @code{lognotedone} or @code{logrepeat}, as well as adding state specific |
| 4504 | settings like @code{TODO(!)}. For example | 4504 | settings like @code{TODO(!)}. For example |
| 4505 | 4505 | ||
| 4506 | @example | 4506 | @example |
| @@ -4671,7 +4671,7 @@ these values (highest, lowest, default) like this (please make sure that | |||
| 4671 | the highest priority is earlier in the alphabet than the lowest | 4671 | the highest priority is earlier in the alphabet than the lowest |
| 4672 | priority): | 4672 | priority): |
| 4673 | 4673 | ||
| 4674 | @cindex #+PRIORITIES | 4674 | @cindex @code{#+PRIORITIES} |
| 4675 | @example | 4675 | @example |
| 4676 | #+PRIORITIES: A C B | 4676 | #+PRIORITIES: A C B |
| 4677 | @end example | 4677 | @end example |
| @@ -4700,7 +4700,7 @@ be updated each time the TODO status of a child changes, or when pressing | |||
| 4700 | ** DONE Talk to neighbor | 4700 | ** DONE Talk to neighbor |
| 4701 | @end example | 4701 | @end example |
| 4702 | 4702 | ||
| 4703 | @cindex property, COOKIE_DATA | 4703 | @cindex property, @code{COOKIE_DATA} |
| 4704 | If a heading has both checkboxes and TODO children below it, the meaning of | 4704 | If a heading has both checkboxes and TODO children below it, the meaning of |
| 4705 | the statistics cookie become ambiguous. Set the property | 4705 | the statistics cookie become ambiguous. Set the property |
| 4706 | @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve | 4706 | @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve |
| @@ -4772,7 +4772,7 @@ checked. | |||
| 4772 | 4772 | ||
| 4773 | @cindex statistics, for checkboxes | 4773 | @cindex statistics, for checkboxes |
| 4774 | @cindex checkbox statistics | 4774 | @cindex checkbox statistics |
| 4775 | @cindex property, COOKIE_DATA | 4775 | @cindex property, @code{COOKIE_DATA} |
| 4776 | @vindex org-checkbox-hierarchical-statistics | 4776 | @vindex org-checkbox-hierarchical-statistics |
| 4777 | The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies | 4777 | The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies |
| 4778 | indicating how many checkboxes present in this entry have been checked off, | 4778 | indicating how many checkboxes present in this entry have been checked off, |
| @@ -4794,7 +4794,7 @@ to either @samp{checkbox} or @samp{todo} to resolve this issue. | |||
| 4794 | 4794 | ||
| 4795 | @cindex blocking, of checkboxes | 4795 | @cindex blocking, of checkboxes |
| 4796 | @cindex checkbox blocking | 4796 | @cindex checkbox blocking |
| 4797 | @cindex property, ORDERED | 4797 | @cindex property, @code{ORDERED} |
| 4798 | If the current outline node has an @code{ORDERED} property, checkboxes must | 4798 | If the current outline node has an @code{ORDERED} property, checkboxes must |
| 4799 | be checked off in sequence, and an error will be thrown if you try to check | 4799 | be checked off in sequence, and an error will be thrown if you try to check |
| 4800 | off a box while there are unchecked boxes above it. | 4800 | off a box while there are unchecked boxes above it. |
| @@ -4831,7 +4831,7 @@ Insert a new item with a checkbox. This works only if the cursor is already | |||
| 4831 | in a plain list item (@pxref{Plain lists}). | 4831 | in a plain list item (@pxref{Plain lists}). |
| 4832 | @orgcmd{C-c C-x o,org-toggle-ordered-property} | 4832 | @orgcmd{C-c C-x o,org-toggle-ordered-property} |
| 4833 | @vindex org-track-ordered-property-with-tag | 4833 | @vindex org-track-ordered-property-with-tag |
| 4834 | @cindex property, ORDERED | 4834 | @cindex property, @code{ORDERED} |
| 4835 | Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must | 4835 | Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must |
| 4836 | be checked off in sequence. A property is used for this behavior because | 4836 | be checked off in sequence. A property is used for this behavior because |
| 4837 | this should be local to the current entry, not inherited like a tag. | 4837 | this should be local to the current entry, not inherited like a tag. |
| @@ -4899,7 +4899,7 @@ a hypothetical level zero that surrounds the entire file. Use a line like | |||
| 4899 | this@footnote{As with all these in-buffer settings, pressing @kbd{C-c C-c} | 4899 | this@footnote{As with all these in-buffer settings, pressing @kbd{C-c C-c} |
| 4900 | activates any changes in the line.}: | 4900 | activates any changes in the line.}: |
| 4901 | 4901 | ||
| 4902 | @cindex #+FILETAGS | 4902 | @cindex @code{#+FILETAGS} |
| 4903 | @example | 4903 | @example |
| 4904 | #+FILETAGS: :Peter:Boss:Secret: | 4904 | #+FILETAGS: :Peter:Boss:Secret: |
| 4905 | @end example | 4905 | @end example |
| @@ -4961,7 +4961,7 @@ currently used in the buffer. You may also globally specify a hard list | |||
| 4961 | of tags with the variable @code{org-tag-alist}. Finally you can set | 4961 | of tags with the variable @code{org-tag-alist}. Finally you can set |
| 4962 | the default tags for a given file with lines like | 4962 | the default tags for a given file with lines like |
| 4963 | 4963 | ||
| 4964 | @cindex #+TAGS | 4964 | @cindex @code{#+TAGS} |
| 4965 | @example | 4965 | @example |
| 4966 | #+TAGS: @@work @@home @@tennisclub | 4966 | #+TAGS: @@work @@home @@tennisclub |
| 4967 | #+TAGS: laptop car pc sailboat | 4967 | #+TAGS: laptop car pc sailboat |
| @@ -4980,7 +4980,7 @@ If you have a preferred set of tags that you would like to use in every file, | |||
| 4980 | in addition to those defined on a per-file basis by TAGS option lines, then | 4980 | in addition to those defined on a per-file basis by TAGS option lines, then |
| 4981 | you may specify a list of tags with the variable | 4981 | you may specify a list of tags with the variable |
| 4982 | @code{org-tag-persistent-alist}. You may turn this off on a per-file basis | 4982 | @code{org-tag-persistent-alist}. You may turn this off on a per-file basis |
| 4983 | by adding a STARTUP option line to that file: | 4983 | by adding a @code{#+STARTUP} option line to that file: |
| 4984 | 4984 | ||
| 4985 | @example | 4985 | @example |
| 4986 | #+STARTUP: noptag | 4986 | #+STARTUP: noptag |
| @@ -5330,8 +5330,8 @@ publishers and the number of disks in a box like this: | |||
| 5330 | 5330 | ||
| 5331 | If you want to set properties that can be inherited by any entry in a | 5331 | If you want to set properties that can be inherited by any entry in a |
| 5332 | file, use a line like | 5332 | file, use a line like |
| 5333 | @cindex property, _ALL | 5333 | @cindex property, @code{_ALL} |
| 5334 | @cindex #+PROPERTY | 5334 | @cindex @code{#+PROPERTY} |
| 5335 | @example | 5335 | @example |
| 5336 | #+PROPERTY: NDisks_ALL 1 2 3 4 | 5336 | #+PROPERTY: NDisks_ALL 1 2 3 4 |
| 5337 | @end example | 5337 | @end example |
| @@ -5342,7 +5342,7 @@ buffer with @kbd{C-c C-c} to activate this change. | |||
| 5342 | If you want to add to the value of an existing property, append a @code{+} to | 5342 | If you want to add to the value of an existing property, append a @code{+} to |
| 5343 | the property name. The following results in the property @code{var} having | 5343 | the property name. The following results in the property @code{var} having |
| 5344 | the value ``foo=1 bar=2''. | 5344 | the value ``foo=1 bar=2''. |
| 5345 | @cindex property, + | 5345 | @cindex property, @code{+} |
| 5346 | @example | 5346 | @example |
| 5347 | #+PROPERTY: var foo=1 | 5347 | #+PROPERTY: var foo=1 |
| 5348 | #+PROPERTY: var+ bar=2 | 5348 | #+PROPERTY: var+ bar=2 |
| @@ -5351,7 +5351,7 @@ the value ``foo=1 bar=2''. | |||
| 5351 | It is also possible to add to the values of inherited properties. The | 5351 | It is also possible to add to the values of inherited properties. The |
| 5352 | following results in the @code{genres} property having the value ``Classic | 5352 | following results in the @code{genres} property having the value ``Classic |
| 5353 | Baroque'' under the @code{Goldberg Variations} subtree. | 5353 | Baroque'' under the @code{Goldberg Variations} subtree. |
| 5354 | @cindex property, + | 5354 | @cindex property, @code{+} |
| 5355 | @example | 5355 | @example |
| 5356 | * CD collection | 5356 | * CD collection |
| 5357 | ** Classic | 5357 | ** Classic |
| @@ -5386,7 +5386,7 @@ in the current file will be offered as possible completions. | |||
| 5386 | Set a property. This prompts for a property name and a value. If | 5386 | Set a property. This prompts for a property name and a value. If |
| 5387 | necessary, the property drawer is created as well. | 5387 | necessary, the property drawer is created as well. |
| 5388 | @item C-u M-x org-insert-drawer RET | 5388 | @item C-u M-x org-insert-drawer RET |
| 5389 | @cindex org-insert-drawer | 5389 | @cindex @code{org-insert-drawer} |
| 5390 | Insert a property drawer into the current entry. The drawer will be | 5390 | Insert a property drawer into the current entry. The drawer will be |
| 5391 | inserted early in the entry, but after the lines with planning | 5391 | inserted early in the entry, but after the lines with planning |
| 5392 | information like deadlines. | 5392 | information like deadlines. |
| @@ -5417,20 +5417,20 @@ a column view (@pxref{Column view}), or to use them in queries. The | |||
| 5417 | following property names are special and should not be used as keys in the | 5417 | following property names are special and should not be used as keys in the |
| 5418 | properties drawer: | 5418 | properties drawer: |
| 5419 | 5419 | ||
| 5420 | @cindex property, special, ALLTAGS | 5420 | @cindex property, special, @code{ALLTAGS} |
| 5421 | @cindex property, special, BLOCKED | 5421 | @cindex property, special, @code{BLOCKED} |
| 5422 | @cindex property, special, CLOCKSUM | 5422 | @cindex property, special, @code{CLOCKSUM} |
| 5423 | @cindex property, special, CLOCKSUM_T | 5423 | @cindex property, special, @code{CLOCKSUM_T} |
| 5424 | @cindex property, special, CLOSED | 5424 | @cindex property, special, @code{CLOSED} |
| 5425 | @cindex property, special, DEADLINE | 5425 | @cindex property, special, @code{DEADLINE} |
| 5426 | @cindex property, special, FILE | 5426 | @cindex property, special, @code{FILE} |
| 5427 | @cindex property, special, ITEM | 5427 | @cindex property, special, @code{ITEM} |
| 5428 | @cindex property, special, PRIORITY | 5428 | @cindex property, special, @code{PRIORITY} |
| 5429 | @cindex property, special, SCHEDULED | 5429 | @cindex property, special, @code{SCHEDULED} |
| 5430 | @cindex property, special, TAGS | 5430 | @cindex property, special, @code{TAGS} |
| 5431 | @cindex property, special, TIMESTAMP | 5431 | @cindex property, special, @code{TIMESTAMP} |
| 5432 | @cindex property, special, TIMESTAMP_IA | 5432 | @cindex property, special, @code{TIMESTAMP_IA} |
| 5433 | @cindex property, special, TODO | 5433 | @cindex property, special, @code{TODO} |
| 5434 | @example | 5434 | @example |
| 5435 | ALLTAGS @r{All tags, including inherited ones.} | 5435 | ALLTAGS @r{All tags, including inherited ones.} |
| 5436 | BLOCKED @r{"t" if task is currently blocked by children or siblings.} | 5436 | BLOCKED @r{"t" if task is currently blocked by children or siblings.} |
| @@ -5510,7 +5510,7 @@ search will stop at this value and return @code{nil}. | |||
| 5510 | Org mode has a few properties for which inheritance is hard-coded, at | 5510 | Org mode has a few properties for which inheritance is hard-coded, at |
| 5511 | least for the special applications for which they are used: | 5511 | least for the special applications for which they are used: |
| 5512 | 5512 | ||
| 5513 | @cindex property, COLUMNS | 5513 | @cindex property, @code{COLUMNS} |
| 5514 | @table @code | 5514 | @table @code |
| 5515 | @item COLUMNS | 5515 | @item COLUMNS |
| 5516 | The @code{:COLUMNS:} property defines the format of column view | 5516 | The @code{:COLUMNS:} property defines the format of column view |
| @@ -5519,16 +5519,16 @@ where a @code{:COLUMNS:} property is defined is used as the starting | |||
| 5519 | point for a column view table, independently of the location in the | 5519 | point for a column view table, independently of the location in the |
| 5520 | subtree from where columns view is turned on. | 5520 | subtree from where columns view is turned on. |
| 5521 | @item CATEGORY | 5521 | @item CATEGORY |
| 5522 | @cindex property, CATEGORY | 5522 | @cindex property, @code{CATEGORY} |
| 5523 | For agenda view, a category set through a @code{:CATEGORY:} property | 5523 | For agenda view, a category set through a @code{:CATEGORY:} property |
| 5524 | applies to the entire subtree. | 5524 | applies to the entire subtree. |
| 5525 | @item ARCHIVE | 5525 | @item ARCHIVE |
| 5526 | @cindex property, ARCHIVE | 5526 | @cindex property, @code{ARCHIVE} |
| 5527 | For archiving, the @code{:ARCHIVE:} property may define the archive | 5527 | For archiving, the @code{:ARCHIVE:} property may define the archive |
| 5528 | location for the entire subtree (@pxref{Moving subtrees}). | 5528 | location for the entire subtree (@pxref{Moving subtrees}). |
| 5529 | @item LOGGING | 5529 | @item LOGGING |
| 5530 | @cindex property, LOGGING | 5530 | @cindex property, @code{LOGGING} |
| 5531 | The LOGGING property may define logging settings for an entry or a | 5531 | The @code{LOGGING} property may define logging settings for an entry or a |
| 5532 | subtree (@pxref{Tracking TODO state changes}). | 5532 | subtree (@pxref{Tracking TODO state changes}). |
| 5533 | @end table | 5533 | @end table |
| 5534 | 5534 | ||
| @@ -5573,7 +5573,7 @@ done by defining a column format line. | |||
| 5573 | 5573 | ||
| 5574 | To define a column format for an entire file, use a line like | 5574 | To define a column format for an entire file, use a line like |
| 5575 | 5575 | ||
| 5576 | @cindex #+COLUMNS | 5576 | @cindex @code{#+COLUMNS} |
| 5577 | @example | 5577 | @example |
| 5578 | #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO | 5578 | #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO |
| 5579 | @end example | 5579 | @end example |
| @@ -5768,7 +5768,7 @@ exported or printed directly. If you want to capture a column view, use | |||
| 5768 | a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame | 5768 | a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame |
| 5769 | of this block looks like this: | 5769 | of this block looks like this: |
| 5770 | 5770 | ||
| 5771 | @cindex #+BEGIN, columnview | 5771 | @cindex @code{#+BEGIN}, columnview |
| 5772 | @example | 5772 | @example |
| 5773 | * The column view | 5773 | * The column view |
| 5774 | #+BEGIN: columnview :hlines 1 :id "label" | 5774 | #+BEGIN: columnview :hlines 1 :id "label" |
| @@ -5784,7 +5784,7 @@ This is the most important parameter. Column view is a feature that is | |||
| 5784 | often localized to a certain (sub)tree, and the capture block might be | 5784 | often localized to a certain (sub)tree, and the capture block might be |
| 5785 | at a different location in the file. To identify the tree whose view to | 5785 | at a different location in the file. To identify the tree whose view to |
| 5786 | capture, you can use 4 values: | 5786 | capture, you can use 4 values: |
| 5787 | @cindex property, ID | 5787 | @cindex property, @code{ID} |
| 5788 | @example | 5788 | @example |
| 5789 | local @r{use the tree in which the capture block is located} | 5789 | local @r{use the tree in which the capture block is located} |
| 5790 | global @r{make a global view, including all headings in the file} | 5790 | global @r{make a global view, including all headings in the file} |
| @@ -5792,7 +5792,7 @@ global @r{make a global view, including all headings in the file} | |||
| 5792 | @r{run column view at the top of this file} | 5792 | @r{run column view at the top of this file} |
| 5793 | "@var{ID}" @r{call column view in the tree that has an @code{:ID:}} | 5793 | "@var{ID}" @r{call column view in the tree that has an @code{:ID:}} |
| 5794 | @r{property with the value @i{label}. You can use} | 5794 | @r{property with the value @i{label}. You can use} |
| 5795 | @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for} | 5795 | @r{@kbd{M-x org-id-copy RET} to create a globally unique @code{ID} for} |
| 5796 | @r{the current entry and copy it to the kill-ring.} | 5796 | @r{the current entry and copy it to the kill-ring.} |
| 5797 | @end example | 5797 | @end example |
| 5798 | @item :hlines | 5798 | @item :hlines |
| @@ -5816,7 +5816,7 @@ The following commands insert or update the dynamic block: | |||
| 5816 | @table @kbd | 5816 | @table @kbd |
| 5817 | @orgcmd{C-c C-x i,org-insert-columns-dblock} | 5817 | @orgcmd{C-c C-x i,org-insert-columns-dblock} |
| 5818 | Insert a dynamic block capturing a column view. You will be prompted | 5818 | Insert a dynamic block capturing a column view. You will be prompted |
| 5819 | for the scope or ID of the view. | 5819 | for the scope or @code{ID} of the view. |
| 5820 | @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} | 5820 | @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} |
| 5821 | Update dynamic block at point. | 5821 | Update dynamic block at point. |
| 5822 | @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks} | 5822 | @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks} |
| @@ -6224,7 +6224,7 @@ they refer to. | |||
| 6224 | 6224 | ||
| 6225 | @table @var | 6225 | @table @var |
| 6226 | @item DEADLINE | 6226 | @item DEADLINE |
| 6227 | @cindex DEADLINE keyword | 6227 | @cindex @code{DEADLINE} keyword |
| 6228 | 6228 | ||
| 6229 | Meaning: the task (most likely a TODO item, though not necessarily) is supposed | 6229 | Meaning: the task (most likely a TODO item, though not necessarily) is supposed |
| 6230 | to be finished on that date. | 6230 | to be finished on that date. |
| @@ -6250,7 +6250,7 @@ deactivated if the task gets scheduled and you set | |||
| 6250 | @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}. | 6250 | @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}. |
| 6251 | 6251 | ||
| 6252 | @item SCHEDULED | 6252 | @item SCHEDULED |
| 6253 | @cindex SCHEDULED keyword | 6253 | @cindex @code{SCHEDULED} keyword |
| 6254 | 6254 | ||
| 6255 | Meaning: you are planning to start working on that task on the given | 6255 | Meaning: you are planning to start working on that task on the given |
| 6256 | date. | 6256 | date. |
| @@ -6315,7 +6315,7 @@ an item: | |||
| 6315 | @table @kbd | 6315 | @table @kbd |
| 6316 | @c | 6316 | @c |
| 6317 | @orgcmd{C-c C-d,org-deadline} | 6317 | @orgcmd{C-c C-d,org-deadline} |
| 6318 | Insert @samp{DEADLINE} keyword along with a stamp. Any CLOSED timestamp will | 6318 | Insert @code{DEADLINE} keyword along with a stamp. Any CLOSED timestamp will |
| 6319 | be removed. When called with a prefix arg, an existing deadline will be | 6319 | be removed. When called with a prefix arg, an existing deadline will be |
| 6320 | removed from the entry. Depending on the variable | 6320 | removed from the entry. Depending on the variable |
| 6321 | @code{org-log-redeadline}@footnote{with corresponding @code{#+STARTUP} | 6321 | @code{org-log-redeadline}@footnote{with corresponding @code{#+STARTUP} |
| @@ -6324,7 +6324,7 @@ keywords @code{logredeadline}, @code{lognoteredeadline}, and | |||
| 6324 | deadline. | 6324 | deadline. |
| 6325 | 6325 | ||
| 6326 | @orgcmd{C-c C-s,org-schedule} | 6326 | @orgcmd{C-c C-s,org-schedule} |
| 6327 | Insert @samp{SCHEDULED} keyword along with a stamp. Any CLOSED timestamp | 6327 | Insert @code{SCHEDULED} keyword along with a stamp. Any CLOSED timestamp |
| 6328 | will be removed. When called with a prefix argument, remove the scheduling | 6328 | will be removed. When called with a prefix argument, remove the scheduling |
| 6329 | date from the entry. Depending on the variable | 6329 | date from the entry. Depending on the variable |
| 6330 | @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP} | 6330 | @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP} |
| @@ -6358,8 +6358,8 @@ to the previous week before any current timestamp. | |||
| 6358 | @cindex tasks, repeated | 6358 | @cindex tasks, repeated |
| 6359 | @cindex repeated tasks | 6359 | @cindex repeated tasks |
| 6360 | 6360 | ||
| 6361 | Some tasks need to be repeated again and again. Org mode helps to | 6361 | Some tasks need to be repeated again and again. Org mode helps to organize |
| 6362 | organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, | 6362 | such tasks using a so-called repeater in a @code{DEADLINE}, @code{SCHEDULED}, |
| 6363 | or plain timestamp. In the following example | 6363 | or plain timestamp. In the following example |
| 6364 | @example | 6364 | @example |
| 6365 | ** TODO Pay the rent | 6365 | ** TODO Pay the rent |
| @@ -6376,18 +6376,18 @@ first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. | |||
| 6376 | @vindex org-todo-repeat-to-state | 6376 | @vindex org-todo-repeat-to-state |
| 6377 | Deadlines and scheduled items produce entries in the agenda when they are | 6377 | Deadlines and scheduled items produce entries in the agenda when they are |
| 6378 | over-due, so it is important to be able to mark such an entry as completed | 6378 | over-due, so it is important to be able to mark such an entry as completed |
| 6379 | once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO | 6379 | once you have done so. When you mark a @code{DEADLINE} or a @code{SCHEDULED} |
| 6380 | keyword DONE, it will no longer produce entries in the agenda. The problem | 6380 | with the TODO keyword DONE, it will no longer produce entries in the agenda. |
| 6381 | with this is, however, that then also the @emph{next} instance of the | 6381 | The problem with this is, however, that then also the @emph{next} instance of |
| 6382 | repeated entry will not be active. Org mode deals with this in the following | 6382 | the repeated entry will not be active. Org mode deals with this in the |
| 6383 | way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will | 6383 | following way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), |
| 6384 | shift the base date of the repeating timestamp by the repeater interval, and | 6384 | it will shift the base date of the repeating timestamp by the repeater |
| 6385 | immediately set the entry state back to TODO@footnote{In fact, the target | 6385 | interval, and immediately set the entry state back to TODO@footnote{In fact, |
| 6386 | state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or | 6386 | the target state is taken from, in this sequence, the @code{REPEAT_TO_STATE} |
| 6387 | the variable @code{org-todo-repeat-to-state}. If neither of these is | 6387 | property or the variable @code{org-todo-repeat-to-state}. If neither of |
| 6388 | specified, the target state defaults to the first state of the TODO state | 6388 | these is specified, the target state defaults to the first state of the TODO |
| 6389 | sequence.}. In the example above, setting the state to DONE would actually | 6389 | state sequence.}. In the example above, setting the state to DONE would |
| 6390 | switch the date like this: | 6390 | actually switch the date like this: |
| 6391 | 6391 | ||
| 6392 | @example | 6392 | @example |
| 6393 | ** TODO Pay the rent | 6393 | ** TODO Pay the rent |
| @@ -6493,22 +6493,21 @@ what to do with it. | |||
| 6493 | @orgcmd{C-c C-x C-i,org-clock-in} | 6493 | @orgcmd{C-c C-x C-i,org-clock-in} |
| 6494 | @vindex org-clock-into-drawer | 6494 | @vindex org-clock-into-drawer |
| 6495 | @vindex org-clock-continuously | 6495 | @vindex org-clock-continuously |
| 6496 | @cindex property, LOG_INTO_DRAWER | 6496 | @cindex property, @code{LOG_INTO_DRAWER} |
| 6497 | Start the clock on the current item (clock-in). This inserts the CLOCK | 6497 | !Start the clock on the current item (clock-in). This inserts the |
| 6498 | keyword together with a timestamp. If this is not the first clocking of | 6498 | @code{CLOCK} keyword together with a timestamp. If this is not the first |
| 6499 | this item, the multiple CLOCK lines will be wrapped into a | 6499 | clocking of this item, the multiple @code{CLOCK} lines will be wrapped into a |
| 6500 | @code{:LOGBOOK:} drawer (see also the variable | 6500 | @code{:LOGBOOK:} drawer (see also the variable @code{org-clock-into-drawer}). |
| 6501 | @code{org-clock-into-drawer}). You can also overrule | 6501 | You can also overrule the setting of this variable for a subtree by setting a |
| 6502 | the setting of this variable for a subtree by setting a | 6502 | @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property. When called |
| 6503 | @code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property. | 6503 | with a @kbd{C-u} prefix argument, select the task from a list of recently |
| 6504 | When called with a @kbd{C-u} prefix argument, | 6504 | clocked tasks. With two @kbd{C-u C-u} prefixes, clock into the task at point |
| 6505 | select the task from a list of recently clocked tasks. With two @kbd{C-u | 6505 | and mark it as the default task; the default task will then always be |
| 6506 | C-u} prefixes, clock into the task at point and mark it as the default task; | 6506 | available with letter @kbd{d} when selecting a clocking task. With three |
| 6507 | the default task will then always be available with letter @kbd{d} when | 6507 | @kbd{C-u C-u C-u} prefixes, force continuous clocking by starting the clock |
| 6508 | selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force | 6508 | when the last clock stopped.@* |
| 6509 | continuous clocking by starting the clock when the last clock stopped.@* | 6509 | @cindex property, @code{CLOCK_MODELINE_TOTAL} |
| 6510 | @cindex property: CLOCK_MODELINE_TOTAL | 6510 | @cindex property, @code{LAST_REPEAT} |
| 6511 | @cindex property: LAST_REPEAT | ||
| 6512 | @vindex org-clock-modeline-total | 6511 | @vindex org-clock-modeline-total |
| 6513 | While the clock is running, the current clocking time is shown in the mode | 6512 | While the clock is running, the current clocking time is shown in the mode |
| 6514 | line, along with the title of the task. The clock time shown will be all | 6513 | line, along with the title of the task. The clock time shown will be all |
| @@ -6617,7 +6616,7 @@ needs to be in the @code{#+BEGIN: clocktable} line for this command. If | |||
| 6617 | Here is an example of the frame for a clock table as it is inserted into the | 6616 | Here is an example of the frame for a clock table as it is inserted into the |
| 6618 | buffer with the @kbd{C-c C-x C-r} command: | 6617 | buffer with the @kbd{C-c C-x C-r} command: |
| 6619 | 6618 | ||
| 6620 | @cindex #+BEGIN, clocktable | 6619 | @cindex @code{#+BEGIN}, clocktable |
| 6621 | @example | 6620 | @example |
| 6622 | #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file | 6621 | #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file |
| 6623 | #+END: clocktable | 6622 | #+END: clocktable |
| @@ -6693,8 +6692,8 @@ but you can specify your own function using the @code{:formatter} parameter. | |||
| 6693 | @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.} | 6692 | @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.} |
| 6694 | :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}} | 6693 | :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}} |
| 6695 | @r{All are overwritten except if there is an explicit @code{:narrow}} | 6694 | @r{All are overwritten except if there is an explicit @code{:narrow}} |
| 6696 | :timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} | 6695 | :timestamp @r{A timestamp for the entry, when available. Look for @code{SCHEDULED},} |
| 6697 | @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} | 6696 | @r{@code{DEADLINE}, @code{TIMESTAMP} and @code{TIMESTAMP_IA}, in this order.} |
| 6698 | :properties @r{List of properties that should be shown in the table. Each} | 6697 | :properties @r{List of properties that should be shown in the table. Each} |
| 6699 | @r{property will get its own column.} | 6698 | @r{property will get its own column.} |
| 6700 | :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.} | 6699 | :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.} |
| @@ -6825,7 +6824,7 @@ with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}. | |||
| 6825 | @section Effort estimates | 6824 | @section Effort estimates |
| 6826 | @cindex effort estimates | 6825 | @cindex effort estimates |
| 6827 | 6826 | ||
| 6828 | @cindex property, Effort | 6827 | @cindex property, @code{EFFORT} |
| 6829 | If you want to plan your work in a very detailed way, or if you need to | 6828 | If you want to plan your work in a very detailed way, or if you need to |
| 6830 | produce offers with quotations of the estimated work effort, you may want to | 6829 | produce offers with quotations of the estimated work effort, you may want to |
| 6831 | assign effort estimates to entries. If you are also clocking your work, you | 6830 | assign effort estimates to entries. If you are also clocking your work, you |
| @@ -7043,7 +7042,7 @@ Visit the last stored capture item in its buffer. | |||
| 7043 | @end table | 7042 | @end table |
| 7044 | 7043 | ||
| 7045 | @vindex org-capture-bookmark | 7044 | @vindex org-capture-bookmark |
| 7046 | @cindex org-capture-last-stored | 7045 | @cindex @code{org-capture-last-stored} |
| 7047 | You can also jump to the bookmark @code{org-capture-last-stored}, which will | 7046 | You can also jump to the bookmark @code{org-capture-last-stored}, which will |
| 7048 | automatically be created unless you set @code{org-capture-bookmark} to | 7047 | automatically be created unless you set @code{org-capture-bookmark} to |
| 7049 | @code{nil}. | 7048 | @code{nil}. |
| @@ -7464,12 +7463,12 @@ Delete all of a task's attachments. A safer way is to open the directory in | |||
| 7464 | @command{dired} and delete from there. | 7463 | @command{dired} and delete from there. |
| 7465 | 7464 | ||
| 7466 | @orgcmdtkc{s,C-c C-a s,org-attach-set-directory} | 7465 | @orgcmdtkc{s,C-c C-a s,org-attach-set-directory} |
| 7467 | @cindex property, ATTACH_DIR | 7466 | @cindex property, @code{ATTACH_DIR} |
| 7468 | Set a specific directory as the entry's attachment directory. This works by | 7467 | Set a specific directory as the entry's attachment directory. This works by |
| 7469 | putting the directory path into the @code{ATTACH_DIR} property. | 7468 | putting the directory path into the @code{ATTACH_DIR} property. |
| 7470 | 7469 | ||
| 7471 | @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit} | 7470 | @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit} |
| 7472 | @cindex property, ATTACH_DIR_INHERIT | 7471 | @cindex property, @code{ATTACH_DIR_INHERIT} |
| 7473 | Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the | 7472 | Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the |
| 7474 | same directory for attachments as the parent does. | 7473 | same directory for attachments as the parent does. |
| 7475 | @end table | 7474 | @end table |
| @@ -7643,14 +7642,14 @@ javascript:location.href='org-protocol://open-source?&url='+ | |||
| 7643 | encodeURIComponent(location.href) | 7642 | encodeURIComponent(location.href) |
| 7644 | @end example | 7643 | @end example |
| 7645 | 7644 | ||
| 7646 | @cindex protocol, open-source, :base-url property | 7645 | @cindex protocol, open-source, @code{:base-url} property |
| 7647 | @cindex :base-url property in open-source protocol | 7646 | @cindex @code{:base-url} property in open-source protocol |
| 7648 | @cindex protocol, open-source, :working-directory property | 7647 | @cindex protocol, open-source, @code{:working-directory} property |
| 7649 | @cindex :working-directory property in open-source protocol | 7648 | @cindex @code{:working-directory} property in open-source protocol |
| 7650 | @cindex protocol, open-source, :online-suffix property | 7649 | @cindex protocol, open-source, @code{:online-suffix} property |
| 7651 | @cindex :online-suffix property in open-source protocol | 7650 | @cindex @code{:online-suffix} property in open-source protocol |
| 7652 | @cindex protocol, open-source, :working-suffix property | 7651 | @cindex protocol, open-source, @code{:working-suffix} property |
| 7653 | @cindex :working-suffix property in open-source protocol | 7652 | @cindex @code{:working-suffix} property in open-source protocol |
| 7654 | @vindex org-protocol-project-alist | 7653 | @vindex org-protocol-project-alist |
| 7655 | The variable @code{org-protocol-project-alist} maps URLs to local file names, | 7654 | The variable @code{org-protocol-project-alist} maps URLs to local file names, |
| 7656 | by stripping URL parameters from the end and replacing the @code{:base-url} | 7655 | by stripping URL parameters from the end and replacing the @code{:base-url} |
| @@ -7687,8 +7686,8 @@ to something like | |||
| 7687 | @code{open-source} handler probably cannot find a file named | 7686 | @code{open-source} handler probably cannot find a file named |
| 7688 | @file{/home/user/example/print/posters.html.php} and fails. | 7687 | @file{/home/user/example/print/posters.html.php} and fails. |
| 7689 | 7688 | ||
| 7690 | @cindex protocol, open-source, :rewrites property | 7689 | @cindex protocol, open-source, @code{:rewrites} property |
| 7691 | @cindex :rewrites property in open-source protocol | 7690 | @cindex @code{:rewrites property} in open-source protocol |
| 7692 | Such an entry in @code{org-protocol-project-alist} may hold an additional | 7691 | Such an entry in @code{org-protocol-project-alist} may hold an additional |
| 7693 | property @code{:rewrites}. This property is a list of cons cells, each of | 7692 | property @code{:rewrites}. This property is a list of cons cells, each of |
| 7694 | which maps a regular expression to a path relative to the | 7693 | which maps a regular expression to a path relative to the |
| @@ -7839,12 +7838,12 @@ see the documentation string of the variable | |||
| 7839 | 7838 | ||
| 7840 | There is also an in-buffer option for setting this variable, for example: | 7839 | There is also an in-buffer option for setting this variable, for example: |
| 7841 | 7840 | ||
| 7842 | @cindex #+ARCHIVE | 7841 | @cindex @code{#+ARCHIVE} |
| 7843 | @example | 7842 | @example |
| 7844 | #+ARCHIVE: %s_done:: | 7843 | #+ARCHIVE: %s_done:: |
| 7845 | @end example | 7844 | @end example |
| 7846 | 7845 | ||
| 7847 | @cindex property, ARCHIVE | 7846 | @cindex property, @code{ARCHIVE} |
| 7848 | @noindent | 7847 | @noindent |
| 7849 | If you would like to have a special ARCHIVE location for a single entry | 7848 | If you would like to have a special ARCHIVE location for a single entry |
| 7850 | or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the | 7849 | or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the |
| @@ -8152,7 +8151,7 @@ The purpose of the weekly/daily @emph{agenda} is to act like a page of a | |||
| 8152 | paper agenda, showing all the tasks for the current week or day. | 8151 | paper agenda, showing all the tasks for the current week or day. |
| 8153 | 8152 | ||
| 8154 | @table @kbd | 8153 | @table @kbd |
| 8155 | @cindex org-agenda, command | 8154 | @cindex @code{org-agenda}, command |
| 8156 | @orgcmd{C-c a a,org-agenda-list} | 8155 | @orgcmd{C-c a a,org-agenda-list} |
| 8157 | Compile an agenda for the current week from a list of Org files. The agenda | 8156 | Compile an agenda for the current week from a list of Org files. The agenda |
| 8158 | shows the entries for each day. With a numeric prefix@footnote{For backward | 8157 | shows the entries for each day. With a numeric prefix@footnote{For backward |
| @@ -8639,7 +8638,7 @@ associated with the item. | |||
| 8639 | @subsection Categories | 8638 | @subsection Categories |
| 8640 | 8639 | ||
| 8641 | @cindex category | 8640 | @cindex category |
| 8642 | @cindex #+CATEGORY | 8641 | @cindex @code{#+CATEGORY} |
| 8643 | The category is a broad label assigned to each agenda item. By default, the | 8642 | The category is a broad label assigned to each agenda item. By default, the |
| 8644 | category is simply derived from the file name, but you can also specify it | 8643 | category is simply derived from the file name, but you can also specify it |
| 8645 | with a special line in the buffer, like this: | 8644 | with a special line in the buffer, like this: |
| @@ -8649,8 +8648,8 @@ with a special line in the buffer, like this: | |||
| 8649 | @end example | 8648 | @end example |
| 8650 | 8649 | ||
| 8651 | @noindent | 8650 | @noindent |
| 8652 | @cindex property, CATEGORY | 8651 | @cindex property, @code{CATEGORY} |
| 8653 | If you would like to have a special CATEGORY for a single entry or a | 8652 | If you would like to have a special @code{CATEGORY} for a single entry or a |
| 8654 | (sub)tree, give the entry a @code{:CATEGORY:} property with the | 8653 | (sub)tree, give the entry a @code{:CATEGORY:} property with the |
| 8655 | special category you want to apply as the value. | 8654 | special category you want to apply as the value. |
| 8656 | 8655 | ||
| @@ -9862,7 +9861,7 @@ does not have a specific format---defined in a property, or in its file---it | |||
| 9862 | uses @code{org-columns-default-format}. | 9861 | uses @code{org-columns-default-format}. |
| 9863 | 9862 | ||
| 9864 | @item | 9863 | @item |
| 9865 | @cindex property, special, CLOCKSUM | 9864 | @cindex property, special, @code{CLOCKSUM} |
| 9866 | If any of the columns has a summary type defined (@pxref{Column attributes}), | 9865 | If any of the columns has a summary type defined (@pxref{Column attributes}), |
| 9867 | turning on column view in the agenda will visit all relevant agenda files and | 9866 | turning on column view in the agenda will visit all relevant agenda files and |
| 9868 | make sure that the computations of this property are up to date. This is | 9867 | make sure that the computations of this property are up to date. This is |
| @@ -9886,7 +9885,7 @@ clocked time in the displayed period use clock table mode (press @kbd{R} in | |||
| 9886 | the agenda). | 9885 | the agenda). |
| 9887 | 9886 | ||
| 9888 | @item | 9887 | @item |
| 9889 | @cindex property, special, CLOCKSUM_T | 9888 | @cindex property, special, @code{CLOCKSUM_T} |
| 9890 | When the column view in the agenda shows the @code{CLOCKSUM_T}, that is | 9889 | When the column view in the agenda shows the @code{CLOCKSUM_T}, that is |
| 9891 | always today's clocked time for this item. So even in the weekly agenda, the | 9890 | always today's clocked time for this item. So even in the weekly agenda, the |
| 9892 | clocksum listed in column view only originates from today. This lets you | 9891 | clocksum listed in column view only originates from today. This lets you |
| @@ -9926,7 +9925,7 @@ To preserve the line breaks, indentation and blank lines in a region, but | |||
| 9926 | otherwise use normal formatting, you can use this construct, which can also | 9925 | otherwise use normal formatting, you can use this construct, which can also |
| 9927 | be used to format poetry. | 9926 | be used to format poetry. |
| 9928 | 9927 | ||
| 9929 | @cindex #+BEGIN_VERSE | 9928 | @cindex @code{#+BEGIN_VERSE} |
| 9930 | @cindex verse blocks | 9929 | @cindex verse blocks |
| 9931 | @example | 9930 | @example |
| 9932 | #+BEGIN_VERSE | 9931 | #+BEGIN_VERSE |
| @@ -9942,7 +9941,7 @@ When quoting a passage from another document, it is customary to format this | |||
| 9942 | as a paragraph that is indented on both the left and the right margin. You | 9941 | as a paragraph that is indented on both the left and the right margin. You |
| 9943 | can include quotations in Org mode documents like this: | 9942 | can include quotations in Org mode documents like this: |
| 9944 | 9943 | ||
| 9945 | @cindex #+BEGIN_QUOTE | 9944 | @cindex @code{#+BEGIN_QUOTE} |
| 9946 | @cindex quote blocks | 9945 | @cindex quote blocks |
| 9947 | @example | 9946 | @example |
| 9948 | #+BEGIN_QUOTE | 9947 | #+BEGIN_QUOTE |
| @@ -9952,7 +9951,7 @@ but not any simpler -- Albert Einstein | |||
| 9952 | @end example | 9951 | @end example |
| 9953 | 9952 | ||
| 9954 | If you would like to center some text, do it like this: | 9953 | If you would like to center some text, do it like this: |
| 9955 | @cindex #+BEGIN_CENTER | 9954 | @cindex @code{#+BEGIN_CENTER} |
| 9956 | @cindex center blocks | 9955 | @cindex center blocks |
| 9957 | @example | 9956 | @example |
| 9958 | #+BEGIN_CENTER | 9957 | #+BEGIN_CENTER |
| @@ -9996,8 +9995,8 @@ a horizontal line. | |||
| 9996 | @section Images and Tables | 9995 | @section Images and Tables |
| 9997 | 9996 | ||
| 9998 | @cindex tables, markup rules | 9997 | @cindex tables, markup rules |
| 9999 | @cindex #+CAPTION | 9998 | @cindex @code{#+CAPTION} |
| 10000 | @cindex #+NAME | 9999 | @cindex @code{#+NAME} |
| 10001 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with | 10000 | Both the native Org mode tables (@pxref{Tables}) and tables formatted with |
| 10002 | the @file{table.el} package will be exported properly. For Org mode tables, | 10001 | the @file{table.el} package will be exported properly. For Org mode tables, |
| 10003 | the lines before the first horizontal separator line will become table header | 10002 | the lines before the first horizontal separator line will become table header |
| @@ -10048,7 +10047,7 @@ or may not be handled. | |||
| 10048 | You can include literal examples that should not be subjected to | 10047 | You can include literal examples that should not be subjected to |
| 10049 | markup. Such examples will be typeset in monospace, so this is well suited | 10048 | markup. Such examples will be typeset in monospace, so this is well suited |
| 10050 | for source code and similar examples. | 10049 | for source code and similar examples. |
| 10051 | @cindex #+BEGIN_EXAMPLE | 10050 | @cindex @code{#+BEGIN_EXAMPLE} |
| 10052 | 10051 | ||
| 10053 | @example | 10052 | @example |
| 10054 | #+BEGIN_EXAMPLE | 10053 | #+BEGIN_EXAMPLE |
| @@ -10087,7 +10086,7 @@ example@footnote{Code in @samp{src} blocks may also be evaluated either | |||
| 10087 | interactively or on export. @xref{Working with source code}, for more | 10086 | interactively or on export. @xref{Working with source code}, for more |
| 10088 | information on evaluating code blocks.}, see @ref{Easy templates} for | 10087 | information on evaluating code blocks.}, see @ref{Easy templates} for |
| 10089 | shortcuts to easily insert code blocks. | 10088 | shortcuts to easily insert code blocks. |
| 10090 | @cindex #+BEGIN_SRC | 10089 | @cindex @code{#+BEGIN_SRC} |
| 10091 | 10090 | ||
| 10092 | @example | 10091 | @example |
| 10093 | #+BEGIN_SRC emacs-lisp | 10092 | #+BEGIN_SRC emacs-lisp |
| @@ -10602,7 +10601,7 @@ Org document by adjusting outline visibility settings. | |||
| 10602 | @section Export settings | 10601 | @section Export settings |
| 10603 | @cindex Export, settings | 10602 | @cindex Export, settings |
| 10604 | 10603 | ||
| 10605 | @cindex #+OPTIONS | 10604 | @cindex @code{#+OPTIONS} |
| 10606 | Export options can be set: globally with variables; for an individual file by | 10605 | Export options can be set: globally with variables; for an individual file by |
| 10607 | making variables buffer-local with in-buffer settings (@pxref{In-buffer | 10606 | making variables buffer-local with in-buffer settings (@pxref{In-buffer |
| 10608 | settings}), by setting individual keywords, or by specifying them in a | 10607 | settings}), by setting individual keywords, or by specifying them in a |
| @@ -10610,7 +10609,7 @@ compact form with the @code{#+OPTIONS} keyword; or for a tree by setting | |||
| 10610 | properties (@pxref{Properties and columns}). Options set at a specific level | 10609 | properties (@pxref{Properties and columns}). Options set at a specific level |
| 10611 | override options set at a more general level. | 10610 | override options set at a more general level. |
| 10612 | 10611 | ||
| 10613 | @cindex #+SETUPFILE | 10612 | @cindex @code{#+SETUPFILE} |
| 10614 | In-buffer settings may appear anywhere in the file, either directly or | 10613 | In-buffer settings may appear anywhere in the file, either directly or |
| 10615 | indirectly through a file included using @samp{#+SETUPFILE: filename or URL} | 10614 | indirectly through a file included using @samp{#+SETUPFILE: filename or URL} |
| 10616 | syntax. Option keyword sets tailored to a particular back-end can be | 10615 | syntax. Option keyword sets tailored to a particular back-end can be |
| @@ -10626,29 +10625,29 @@ variables, include: | |||
| 10626 | 10625 | ||
| 10627 | @table @samp | 10626 | @table @samp |
| 10628 | @item AUTHOR | 10627 | @item AUTHOR |
| 10629 | @cindex #+AUTHOR | 10628 | @cindex @code{#+AUTHOR} |
| 10630 | @vindex user-full-name | 10629 | @vindex user-full-name |
| 10631 | The document author (@code{user-full-name}). | 10630 | The document author (@code{user-full-name}). |
| 10632 | 10631 | ||
| 10633 | @item CREATOR | 10632 | @item CREATOR |
| 10634 | @cindex #+CREATOR | 10633 | @cindex @code{#+CREATOR} |
| 10635 | @vindex org-export-creator-string | 10634 | @vindex org-export-creator-string |
| 10636 | Entity responsible for output generation (@code{org-export-creator-string}). | 10635 | Entity responsible for output generation (@code{org-export-creator-string}). |
| 10637 | 10636 | ||
| 10638 | @item DATE | 10637 | @item DATE |
| 10639 | @cindex #+DATE | 10638 | @cindex @code{#+DATE} |
| 10640 | @vindex org-export-date-timestamp-format | 10639 | @vindex org-export-date-timestamp-format |
| 10641 | A date or a time-stamp@footnote{The variable | 10640 | A date or a time-stamp@footnote{The variable |
| 10642 | @code{org-export-date-timestamp-format} defines how this time-stamp will be | 10641 | @code{org-export-date-timestamp-format} defines how this time-stamp will be |
| 10643 | exported.}. | 10642 | exported.}. |
| 10644 | 10643 | ||
| 10645 | @item EMAIL | 10644 | @item EMAIL |
| 10646 | @cindex #+EMAIL | 10645 | @cindex @code{#+EMAIL} |
| 10647 | @vindex user-mail-address | 10646 | @vindex user-mail-address |
| 10648 | The email address (@code{user-mail-address}). | 10647 | The email address (@code{user-mail-address}). |
| 10649 | 10648 | ||
| 10650 | @item LANGUAGE | 10649 | @item LANGUAGE |
| 10651 | @cindex #+LANGUAGE | 10650 | @cindex @code{#+LANGUAGE} |
| 10652 | @vindex org-export-default-language | 10651 | @vindex org-export-default-language |
| 10653 | Language to use for translating certain strings | 10652 | Language to use for translating certain strings |
| 10654 | (@code{org-export-default-language}). With @samp{#+LANGUAGE: fr}, for | 10653 | (@code{org-export-default-language}). With @samp{#+LANGUAGE: fr}, for |
| @@ -10656,7 +10655,7 @@ example, Org translates @emph{Table of contents} to the French @emph{Table | |||
| 10656 | des matières}. | 10655 | des matières}. |
| 10657 | 10656 | ||
| 10658 | @item SELECT_TAGS | 10657 | @item SELECT_TAGS |
| 10659 | @cindex #+SELECT_TAGS | 10658 | @cindex @code{#+SELECT_TAGS} |
| 10660 | @vindex org-export-select-tags | 10659 | @vindex org-export-select-tags |
| 10661 | The default value is @code{:export:}. When a tree is tagged with | 10660 | The default value is @code{:export:}. When a tree is tagged with |
| 10662 | @code{:export:} (@code{org-export-select-tags}), Org selects that tree and | 10661 | @code{:export:} (@code{org-export-select-tags}), Org selects that tree and |
| @@ -10665,7 +10664,7 @@ see below. When selectively exporting files with @code{:export:} tags set, | |||
| 10665 | Org does not export any text that appears before the first headline. | 10664 | Org does not export any text that appears before the first headline. |
| 10666 | 10665 | ||
| 10667 | @item EXCLUDE_TAGS | 10666 | @item EXCLUDE_TAGS |
| 10668 | @cindex #+EXCLUDE_TAGS | 10667 | @cindex @code{#+EXCLUDE_TAGS} |
| 10669 | @vindex org-export-exclude-tags | 10668 | @vindex org-export-exclude-tags |
| 10670 | The default value is @code{:noexport:}. When a tree is tagged with | 10669 | The default value is @code{:noexport:}. When a tree is tagged with |
| 10671 | @code{:noexport:} (@code{org-export-exclude-tags}), Org excludes that tree | 10670 | @code{:noexport:} (@code{org-export-exclude-tags}), Org excludes that tree |
| @@ -10675,12 +10674,12 @@ unconditionally excluded from the export, even if they have an | |||
| 10675 | code blocks contained in them. | 10674 | code blocks contained in them. |
| 10676 | 10675 | ||
| 10677 | @item TITLE | 10676 | @item TITLE |
| 10678 | @cindex #+TITLE | 10677 | @cindex @code{#+TITLE} |
| 10679 | @cindex document title | 10678 | @cindex document title |
| 10680 | Org displays this title. For long titles, use multiple @code{#+TITLE} lines. | 10679 | Org displays this title. For long titles, use multiple @code{#+TITLE} lines. |
| 10681 | 10680 | ||
| 10682 | @item EXPORT_FILE_NAME | 10681 | @item EXPORT_FILE_NAME |
| 10683 | @cindex #+EXPORT_FILE_NAME | 10682 | @cindex @code{#+EXPORT_FILE_NAME} |
| 10684 | The name of the output file to be generated. Otherwise, Org generates the | 10683 | The name of the output file to be generated. Otherwise, Org generates the |
| 10685 | file name based on the buffer name and the extension based on the back-end | 10684 | file name based on the buffer name and the extension based on the back-end |
| 10686 | format. | 10685 | format. |
| @@ -10786,7 +10785,7 @@ Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}). | |||
| 10786 | 10785 | ||
| 10787 | @item num: | 10786 | @item num: |
| 10788 | @vindex org-export-with-section-numbers | 10787 | @vindex org-export-with-section-numbers |
| 10789 | @cindex property, UNNUMBERED | 10788 | @cindex property, @code{UNNUMBERED} |
| 10790 | Toggle section-numbers (@code{org-export-with-section-numbers}). When set to | 10789 | Toggle section-numbers (@code{org-export-with-section-numbers}). When set to |
| 10791 | number @samp{n}, Org numbers only those headlines at level @samp{n} or above. | 10790 | number @samp{n}, Org numbers only those headlines at level @samp{n} or above. |
| 10792 | Setting @code{UNNUMBERED} property to non-@code{nil} disables numbering of | 10791 | Setting @code{UNNUMBERED} property to non-@code{nil} disables numbering of |
| @@ -10862,7 +10861,7 @@ respectively, @samp{EXPORT_DATE} and @samp{EXPORT_FILE_NAME}. Except for | |||
| 10862 | @samp{SETUPFILE}, all other keywords listed above have an @samp{EXPORT_} | 10861 | @samp{SETUPFILE}, all other keywords listed above have an @samp{EXPORT_} |
| 10863 | equivalent. | 10862 | equivalent. |
| 10864 | 10863 | ||
| 10865 | @cindex #+BIND | 10864 | @cindex @code{#+BIND} |
| 10866 | @vindex org-export-allow-bind-keywords | 10865 | @vindex org-export-allow-bind-keywords |
| 10867 | If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables | 10866 | If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables |
| 10868 | can become buffer-local during export by using the BIND keyword. Its syntax | 10867 | can become buffer-local during export by using the BIND keyword. Its syntax |
| @@ -10875,7 +10874,7 @@ settings that cannot be changed using keywords. | |||
| 10875 | @cindex list of tables | 10874 | @cindex list of tables |
| 10876 | @cindex list of listings | 10875 | @cindex list of listings |
| 10877 | 10876 | ||
| 10878 | @cindex #+TOC | 10877 | @cindex @code{#+TOC} |
| 10879 | @vindex org-export-with-toc | 10878 | @vindex org-export-with-toc |
| 10880 | Org normally inserts the table of contents directly before the first headline | 10879 | Org normally inserts the table of contents directly before the first headline |
| 10881 | of the file. Org sets the TOC depth the same as the headline levels in the | 10880 | of the file. Org sets the TOC depth the same as the headline levels in the |
| @@ -10921,7 +10920,7 @@ with captions. | |||
| 10921 | #+TOC: tables @r{build a list of tables} | 10920 | #+TOC: tables @r{build a list of tables} |
| 10922 | @end example | 10921 | @end example |
| 10923 | 10922 | ||
| 10924 | @cindex property, ALT_TITLE | 10923 | @cindex property, @code{ALT_TITLE} |
| 10925 | Normally Org uses the headline for its entry in the table of contents. But | 10924 | Normally Org uses the headline for its entry in the table of contents. But |
| 10926 | with @code{ALT_TITLE} property, a different entry can be specified for the | 10925 | with @code{ALT_TITLE} property, a different entry can be specified for the |
| 10927 | table of contents. | 10926 | table of contents. |
| @@ -10931,7 +10930,7 @@ table of contents. | |||
| 10931 | @cindex include files, during export | 10930 | @cindex include files, during export |
| 10932 | Include other files during export. For example, to include your @file{.emacs} | 10931 | Include other files during export. For example, to include your @file{.emacs} |
| 10933 | file, you could use: | 10932 | file, you could use: |
| 10934 | @cindex #+INCLUDE | 10933 | @cindex @code{#+INCLUDE} |
| 10935 | 10934 | ||
| 10936 | @example | 10935 | @example |
| 10937 | #+INCLUDE: "~/.emacs" src emacs-lisp | 10936 | #+INCLUDE: "~/.emacs" src emacs-lisp |
| @@ -11003,7 +11002,7 @@ Visit the include file at point. | |||
| 11003 | @node Macro replacement | 11002 | @node Macro replacement |
| 11004 | @section Macro replacement | 11003 | @section Macro replacement |
| 11005 | @cindex macro replacement, during export | 11004 | @cindex macro replacement, during export |
| 11006 | @cindex #+MACRO | 11005 | @cindex @code{#+MACRO} |
| 11007 | 11006 | ||
| 11008 | @vindex org-export-global-macros | 11007 | @vindex org-export-global-macros |
| 11009 | Macros replace text snippets during export. Macros are defined globally in | 11008 | Macros replace text snippets during export. Macros are defined globally in |
| @@ -11095,9 +11094,9 @@ Lines starting with zero or more whitespace characters followed by one | |||
| 11095 | @samp{#} and a whitespace are treated as comments and, as such, are not | 11094 | @samp{#} and a whitespace are treated as comments and, as such, are not |
| 11096 | exported. | 11095 | exported. |
| 11097 | 11096 | ||
| 11098 | @cindex #+BEGIN_COMMENT | 11097 | @cindex @code{#+BEGIN_COMMENT} |
| 11099 | Likewise, regions surrounded by @samp{#+BEGIN_COMMENT} | 11098 | Likewise, regions surrounded by @code{#+BEGIN_COMMENT} |
| 11100 | ... @samp{#+END_COMMENT} are not exported. | 11099 | ... @code{#+END_COMMENT} are not exported. |
| 11101 | 11100 | ||
| 11102 | @cindex comment trees | 11101 | @cindex comment trees |
| 11103 | Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any | 11102 | Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any |
| @@ -11153,7 +11152,7 @@ settings}). | |||
| 11153 | 11152 | ||
| 11154 | @table @samp | 11153 | @table @samp |
| 11155 | @item SUBTITLE | 11154 | @item SUBTITLE |
| 11156 | @cindex #+SUBTITLE (ASCII) | 11155 | @cindex @code{#+SUBTITLE} (ASCII) |
| 11157 | The document subtitle. For long subtitles, use multiple @code{#+SUBTITLE} | 11156 | The document subtitle. For long subtitles, use multiple @code{#+SUBTITLE} |
| 11158 | lines in the Org file. Org prints them on one continuous line, wrapping into | 11157 | lines in the Org file. Org prints them on one continuous line, wrapping into |
| 11159 | multiple lines if necessary. | 11158 | multiple lines if necessary. |
| @@ -11170,8 +11169,8 @@ where levels become lists, @pxref{Export settings}. | |||
| 11170 | To insert text within the Org file by the ASCII back-end, use one the | 11169 | To insert text within the Org file by the ASCII back-end, use one the |
| 11171 | following constructs, inline, keyword, or export block: | 11170 | following constructs, inline, keyword, or export block: |
| 11172 | 11171 | ||
| 11173 | @cindex #+ASCII | 11172 | @cindex @code{#+ASCII} |
| 11174 | @cindex #+BEGIN_EXPORT ascii | 11173 | @cindex @code{#+BEGIN_EXPORT ascii} |
| 11175 | @example | 11174 | @example |
| 11176 | Inline text @@@@ascii:and additional text@@@@ within a paragraph. | 11175 | Inline text @@@@ascii:and additional text@@@@ within a paragraph. |
| 11177 | 11176 | ||
| @@ -11183,7 +11182,7 @@ Org exports text in this block only when using ASCII back-end. | |||
| 11183 | @end example | 11182 | @end example |
| 11184 | 11183 | ||
| 11185 | @subheading ASCII specific attributes | 11184 | @subheading ASCII specific attributes |
| 11186 | @cindex #+ATTR_ASCII | 11185 | @cindex @code{#+ATTR_ASCII} |
| 11187 | @cindex horizontal rules, in ASCII export | 11186 | @cindex horizontal rules, in ASCII export |
| 11188 | 11187 | ||
| 11189 | ASCII back-end recognizes only one attribute, @code{:width}, which specifies | 11188 | ASCII back-end recognizes only one attribute, @code{:width}, which specifies |
| @@ -11197,8 +11196,8 @@ syntax for specifying widths is: | |||
| 11197 | 11196 | ||
| 11198 | @subheading ASCII special blocks | 11197 | @subheading ASCII special blocks |
| 11199 | @cindex special blocks, in ASCII export | 11198 | @cindex special blocks, in ASCII export |
| 11200 | @cindex #+BEGIN_JUSTIFYLEFT | 11199 | @cindex @code{#+BEGIN_JUSTIFYLEFT} |
| 11201 | @cindex #+BEGIN_JUSTIFYRIGHT | 11200 | @cindex @code{#+BEGIN_JUSTIFYRIGHT} |
| 11202 | 11201 | ||
| 11203 | Besides @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), ASCII back-end has | 11202 | Besides @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), ASCII back-end has |
| 11204 | these two left and right justification blocks: | 11203 | these two left and right justification blocks: |
| @@ -11256,7 +11255,7 @@ output. These keywords work similar to the general options settings | |||
| 11256 | 11255 | ||
| 11257 | @table @samp | 11256 | @table @samp |
| 11258 | @item BEAMER_THEME | 11257 | @item BEAMER_THEME |
| 11259 | @cindex #+BEAMER_THEME | 11258 | @cindex @code{#+BEAMER_THEME} |
| 11260 | @vindex org-beamer-theme | 11259 | @vindex org-beamer-theme |
| 11261 | The Beamer layout theme (@code{org-beamer-theme}). Use square brackets for | 11260 | The Beamer layout theme (@code{org-beamer-theme}). Use square brackets for |
| 11262 | options. For example: | 11261 | options. For example: |
| @@ -11265,24 +11264,24 @@ options. For example: | |||
| 11265 | @end smallexample | 11264 | @end smallexample |
| 11266 | 11265 | ||
| 11267 | @item BEAMER_FONT_THEME | 11266 | @item BEAMER_FONT_THEME |
| 11268 | @cindex #+BEAMER_FONT_THEME | 11267 | @cindex @code{#+BEAMER_FONT_THEME} |
| 11269 | The Beamer font theme. | 11268 | The Beamer font theme. |
| 11270 | 11269 | ||
| 11271 | @item BEAMER_INNER_THEME | 11270 | @item BEAMER_INNER_THEME |
| 11272 | @cindex #+BEAMER_INNER_THEME | 11271 | @cindex @code{#+BEAMER_INNER_THEME} |
| 11273 | The Beamer inner theme. | 11272 | The Beamer inner theme. |
| 11274 | 11273 | ||
| 11275 | @item BEAMER_OUTER_THEME | 11274 | @item BEAMER_OUTER_THEME |
| 11276 | @cindex #+BEAMER_OUTER_THEME | 11275 | @cindex @code{#+BEAMER_OUTER_THEME} |
| 11277 | The Beamer outer theme. | 11276 | The Beamer outer theme. |
| 11278 | 11277 | ||
| 11279 | @item BEAMER_HEADER | 11278 | @item BEAMER_HEADER |
| 11280 | @cindex #+BEAMER_HEADER | 11279 | @cindex @code{#+BEAMER_HEADER} |
| 11281 | Arbitrary lines inserted in the preamble, just before the @samp{hyperref} | 11280 | Arbitrary lines inserted in the preamble, just before the @samp{hyperref} |
| 11282 | settings. | 11281 | settings. |
| 11283 | 11282 | ||
| 11284 | @item DESCRIPTION | 11283 | @item DESCRIPTION |
| 11285 | @cindex #+DESCRIPTION (Beamer) | 11284 | @cindex @code{#+DESCRIPTION} (Beamer) |
| 11286 | The document description. For long descriptions, use multiple | 11285 | The document description. For long descriptions, use multiple |
| 11287 | @code{#+DESCRIPTION} keywords. By default, @samp{hyperref} inserts | 11286 | @code{#+DESCRIPTION} keywords. By default, @samp{hyperref} inserts |
| 11288 | @code{#+DESCRIPTION} as metadata. Use @code{org-latex-hyperref-template} to | 11287 | @code{#+DESCRIPTION} as metadata. Use @code{org-latex-hyperref-template} to |
| @@ -11290,7 +11289,7 @@ configure document metadata. Use @code{org-latex-title-command} to configure | |||
| 11290 | typesetting of description as part of front matter. | 11289 | typesetting of description as part of front matter. |
| 11291 | 11290 | ||
| 11292 | @item KEYWORDS | 11291 | @item KEYWORDS |
| 11293 | @cindex #+KEYWORDS (Beamer) | 11292 | @cindex @code{#+KEYWORDS} (Beamer) |
| 11294 | The keywords for defining the contents of the document. Use multiple | 11293 | The keywords for defining the contents of the document. Use multiple |
| 11295 | @code{#+KEYWORDS} lines if necessary. By default, @samp{hyperref} inserts | 11294 | @code{#+KEYWORDS} lines if necessary. By default, @samp{hyperref} inserts |
| 11296 | @code{#+KEYWORDS} as metadata. Use @code{org-latex-hyperref-template} to | 11295 | @code{#+KEYWORDS} as metadata. Use @code{org-latex-hyperref-template} to |
| @@ -11298,7 +11297,7 @@ configure document metadata. Use @code{org-latex-title-command} to configure | |||
| 11298 | typesetting of keywords as part of front matter. | 11297 | typesetting of keywords as part of front matter. |
| 11299 | 11298 | ||
| 11300 | @item SUBTITLE | 11299 | @item SUBTITLE |
| 11301 | @cindex #+SUBTITLE (Beamer) | 11300 | @cindex @code{#+SUBTITLE} (Beamer) |
| 11302 | @vindex org-beamer-subtitle-format | 11301 | @vindex org-beamer-subtitle-format |
| 11303 | Document's subtitle. For typesetting, use @code{org-beamer-subtitle-format} | 11302 | Document's subtitle. For typesetting, use @code{org-beamer-subtitle-format} |
| 11304 | string. Use @code{org-latex-hyperref-template} to configure document | 11303 | string. Use @code{org-latex-hyperref-template} to configure document |
| @@ -11320,7 +11319,7 @@ Org headlines become Beamer frames when the heading level in Org is equal to | |||
| 11320 | @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line | 11319 | @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line |
| 11321 | (@pxref{Export settings}). | 11320 | (@pxref{Export settings}). |
| 11322 | 11321 | ||
| 11323 | @cindex property, BEAMER_ENV | 11322 | @cindex property, @code{BEAMER_ENV} |
| 11324 | Org overrides headlines to frames conversion for the current tree of an Org | 11323 | Org overrides headlines to frames conversion for the current tree of an Org |
| 11325 | file if it encounters the @code{BEAMER_ENV} property set to @code{frame} or | 11324 | file if it encounters the @code{BEAMER_ENV} property set to @code{frame} or |
| 11326 | @code{fullframe}. Org ignores whatever @code{org-beamer-frame-level} happens | 11325 | @code{fullframe}. Org ignores whatever @code{org-beamer-frame-level} happens |
| @@ -11339,7 +11338,7 @@ aid and has no semantic relevance.}. For valid values see | |||
| 11339 | @code{org-beamer-environments-extra}. | 11338 | @code{org-beamer-environments-extra}. |
| 11340 | 11339 | ||
| 11341 | @item | 11340 | @item |
| 11342 | @cindex property, BEAMER_REF | 11341 | @cindex property, @code{BEAMER_REF} |
| 11343 | If @code{BEAMER_ENV} is set to @code{appendix}, Org exports the entry as an | 11342 | If @code{BEAMER_ENV} is set to @code{appendix}, Org exports the entry as an |
| 11344 | appendix. When set to @code{note}, Org exports the entry as a note within | 11343 | appendix. When set to @code{note}, Org exports the entry as a note within |
| 11345 | the frame or between frames, depending on the entry's heading level. When | 11344 | the frame or between frames, depending on the entry's heading level. When |
| @@ -11353,8 +11352,8 @@ not its content. This is useful for inserting content between frames. It is | |||
| 11353 | also useful for properly closing a @code{column} environment. | 11352 | also useful for properly closing a @code{column} environment. |
| 11354 | @end itemize | 11353 | @end itemize |
| 11355 | 11354 | ||
| 11356 | @cindex property, BEAMER_ACT | 11355 | @cindex property, @code{BEAMER_ACT} |
| 11357 | @cindex property, BEAMER_OPT | 11356 | @cindex property, @code{BEAMER_OPT} |
| 11358 | When @code{BEAMER_ACT} is set for a headline, Org export translates that | 11357 | When @code{BEAMER_ACT} is set for a headline, Org export translates that |
| 11359 | headline as an overlay or action specification. When enclosed in square | 11358 | headline as an overlay or action specification. When enclosed in square |
| 11360 | brackets, Org export makes the overlay specification a default. Use | 11359 | brackets, Org export makes the overlay specification a default. Use |
| @@ -11363,7 +11362,7 @@ or block. The Beamer export back-end wraps with appropriate angular or | |||
| 11363 | square brackets. It also adds the @code{fragile} option for any code that may | 11362 | square brackets. It also adds the @code{fragile} option for any code that may |
| 11364 | require a verbatim block. | 11363 | require a verbatim block. |
| 11365 | 11364 | ||
| 11366 | @cindex property, BEAMER_COL | 11365 | @cindex property, @code{BEAMER_COL} |
| 11367 | To create a column on the Beamer slide, use the @code{BEAMER_COL} property | 11366 | To create a column on the Beamer slide, use the @code{BEAMER_COL} property |
| 11368 | for its headline in the Org file. Set the value of @code{BEAMER_COL} to a | 11367 | for its headline in the Org file. Set the value of @code{BEAMER_COL} to a |
| 11369 | decimal number representing the fraction of the total text width. Beamer | 11368 | decimal number representing the fraction of the total text width. Beamer |
| @@ -11378,8 +11377,8 @@ needs, use the @code{BEAMER_ENV} property. | |||
| 11378 | @node Beamer specific syntax | 11377 | @node Beamer specific syntax |
| 11379 | @subsection Beamer specific syntax | 11378 | @subsection Beamer specific syntax |
| 11380 | Since Org's Beamer export back-end is an extension of the @LaTeX{} back-end, | 11379 | Since Org's Beamer export back-end is an extension of the @LaTeX{} back-end, |
| 11381 | it recognizes other @LaTeX{} specific syntax---for example, @samp{#+LATEX:} | 11380 | it recognizes other @LaTeX{} specific syntax---for example, @code{#+LATEX:} |
| 11382 | or @samp{#+ATTR_LATEX:}. @xref{@LaTeX{} export}, for details. | 11381 | or @code{#+ATTR_LATEX:}. @xref{@LaTeX{} export}, for details. |
| 11383 | 11382 | ||
| 11384 | Beamer export wraps the table of contents generated with @code{toc:t} | 11383 | Beamer export wraps the table of contents generated with @code{toc:t} |
| 11385 | @code{OPTION} keyword in a @code{frame} environment. Beamer export does not | 11384 | @code{OPTION} keyword in a @code{frame} environment. Beamer export does not |
| @@ -11392,8 +11391,8 @@ contents}). Use square brackets for specifying options. | |||
| 11392 | 11391 | ||
| 11393 | Insert Beamer-specific code using the following constructs: | 11392 | Insert Beamer-specific code using the following constructs: |
| 11394 | 11393 | ||
| 11395 | @cindex #+BEAMER | 11394 | @cindex @code{#+BEAMER} |
| 11396 | @cindex #+BEGIN_EXPORT beamer | 11395 | @cindex @code{#+BEGIN_EXPORT beamer} |
| 11397 | @example | 11396 | @example |
| 11398 | #+BEAMER: \pause | 11397 | #+BEAMER: \pause |
| 11399 | 11398 | ||
| @@ -11414,7 +11413,7 @@ this example: | |||
| 11414 | A *@@@@beamer:<2->@@@@useful* feature | 11413 | A *@@@@beamer:<2->@@@@useful* feature |
| 11415 | @end example | 11414 | @end example |
| 11416 | 11415 | ||
| 11417 | @cindex #+ATTR_BEAMER | 11416 | @cindex @code{#+ATTR_BEAMER} |
| 11418 | Beamer export recognizes the @code{ATTR_BEAMER} keyword with the following | 11417 | Beamer export recognizes the @code{ATTR_BEAMER} keyword with the following |
| 11419 | attributes from Beamer configurations: @code{:environment} for changing local | 11418 | attributes from Beamer configurations: @code{:environment} for changing local |
| 11420 | Beamer environment, @code{:overlay} for specifying Beamer overlays in angular | 11419 | Beamer environment, @code{:overlay} for specifying Beamer overlays in angular |
| @@ -11538,66 +11537,66 @@ described in @ref{Export settings}. | |||
| 11538 | 11537 | ||
| 11539 | @table @samp | 11538 | @table @samp |
| 11540 | @item DESCRIPTION | 11539 | @item DESCRIPTION |
| 11541 | @cindex #+DESCRIPTION (HTML) | 11540 | @cindex @code{#+DESCRIPTION} (HTML) |
| 11542 | This is the document's description, which the HTML exporter inserts it as a | 11541 | This is the document's description, which the HTML exporter inserts it as a |
| 11543 | HTML meta tag in the HTML file. For long descriptions, use multiple | 11542 | HTML meta tag in the HTML file. For long descriptions, use multiple |
| 11544 | @code{#+DESCRIPTION} lines. The exporter takes care of wrapping the lines | 11543 | @code{#+DESCRIPTION} lines. The exporter takes care of wrapping the lines |
| 11545 | properly. | 11544 | properly. |
| 11546 | 11545 | ||
| 11547 | @item HTML_DOCTYPE | 11546 | @item HTML_DOCTYPE |
| 11548 | @cindex #+HTML_DOCTYPE | 11547 | @cindex @code{#+HTML_DOCTYPE} |
| 11549 | @vindex org-html-doctype | 11548 | @vindex org-html-doctype |
| 11550 | Specify the document type, for example: HTML5 (@code{org-html-doctype}). | 11549 | Specify the document type, for example: HTML5 (@code{org-html-doctype}). |
| 11551 | 11550 | ||
| 11552 | @item HTML_CONTAINER | 11551 | @item HTML_CONTAINER |
| 11553 | @cindex #+HTML_CONTAINER | 11552 | @cindex @code{#+HTML_CONTAINER} |
| 11554 | @vindex org-html-container-element | 11553 | @vindex org-html-container-element |
| 11555 | Specify the HTML container, such as @samp{div}, for wrapping sections and | 11554 | Specify the HTML container, such as @samp{div}, for wrapping sections and |
| 11556 | elements (@code{org-html-container-element}). | 11555 | elements (@code{org-html-container-element}). |
| 11557 | 11556 | ||
| 11558 | @item HTML_LINK_HOME | 11557 | @item HTML_LINK_HOME |
| 11559 | @cindex #+HTML_LINK_HOME | 11558 | @cindex @code{#+HTML_LINK_HOME} |
| 11560 | @vindex org-html-link-home | 11559 | @vindex org-html-link-home |
| 11561 | The URL for home link (@code{org-html-link-home}). | 11560 | The URL for home link (@code{org-html-link-home}). |
| 11562 | 11561 | ||
| 11563 | @item HTML_LINK_UP | 11562 | @item HTML_LINK_UP |
| 11564 | @cindex #+HTML_LINK_UP | 11563 | @cindex @code{#+HTML_LINK_UP} |
| 11565 | @vindex org-html-link-up | 11564 | @vindex org-html-link-up |
| 11566 | The URL for the up link of exported HTML pages (@code{org-html-link-up}). | 11565 | The URL for the up link of exported HTML pages (@code{org-html-link-up}). |
| 11567 | 11566 | ||
| 11568 | @item HTML_MATHJAX | 11567 | @item HTML_MATHJAX |
| 11569 | @cindex #+HTML_MATHJAX | 11568 | @cindex @code{#+HTML_MATHJAX} |
| 11570 | @vindex org-html-mathjax-options | 11569 | @vindex org-html-mathjax-options |
| 11571 | Options for MathJax (@code{org-html-mathjax-options}). MathJax is used to | 11570 | Options for MathJax (@code{org-html-mathjax-options}). MathJax is used to |
| 11572 | typeset @LaTeX{} math in HTML documents. @xref{Math formatting in HTML | 11571 | typeset @LaTeX{} math in HTML documents. @xref{Math formatting in HTML |
| 11573 | export}, for an example. | 11572 | export}, for an example. |
| 11574 | 11573 | ||
| 11575 | @item HTML_HEAD | 11574 | @item HTML_HEAD |
| 11576 | @cindex #+HTML_HEAD | 11575 | @cindex @code{#+HTML_HEAD} |
| 11577 | @vindex org-html-head | 11576 | @vindex org-html-head |
| 11578 | Arbitrary lines for appending to the HTML document's head | 11577 | Arbitrary lines for appending to the HTML document's head |
| 11579 | (@code{org-html-head}). | 11578 | (@code{org-html-head}). |
| 11580 | 11579 | ||
| 11581 | @item HTML_HEAD_EXTRA | 11580 | @item HTML_HEAD_EXTRA |
| 11582 | @cindex #+HTML_HEAD_EXTRA | 11581 | @cindex @code{#+HTML_HEAD_EXTRA} |
| 11583 | @vindex org-html-head-extra | 11582 | @vindex org-html-head-extra |
| 11584 | More arbitrary lines for appending to the HTML document's head | 11583 | More arbitrary lines for appending to the HTML document's head |
| 11585 | (@code{org-html-head-extra}). | 11584 | (@code{org-html-head-extra}). |
| 11586 | 11585 | ||
| 11587 | @item KEYWORDS | 11586 | @item KEYWORDS |
| 11588 | @cindex #+KEYWORDS (HTML) | 11587 | @cindex @code{#+KEYWORDS} (HTML) |
| 11589 | Keywords to describe the document's content. HTML exporter inserts these | 11588 | Keywords to describe the document's content. HTML exporter inserts these |
| 11590 | keywords as HTML meta tags. For long keywords, use multiple | 11589 | keywords as HTML meta tags. For long keywords, use multiple |
| 11591 | @code{#+KEYWORDS} lines. | 11590 | @code{#+KEYWORDS} lines. |
| 11592 | 11591 | ||
| 11593 | @item LATEX_HEADER | 11592 | @item LATEX_HEADER |
| 11594 | @cindex #+LATEX_HEADER (HTML) | 11593 | @cindex @code{#+LATEX_HEADER} (HTML) |
| 11595 | Arbitrary lines for appending to the preamble; HTML exporter appends when | 11594 | Arbitrary lines for appending to the preamble; HTML exporter appends when |
| 11596 | transcoding @LaTeX{} fragments to images (@pxref{Math formatting in HTML | 11595 | transcoding @LaTeX{} fragments to images (@pxref{Math formatting in HTML |
| 11597 | export}). | 11596 | export}). |
| 11598 | 11597 | ||
| 11599 | @item SUBTITLE | 11598 | @item SUBTITLE |
| 11600 | @cindex #+SUBTITLE (HTML) | 11599 | @cindex @code{#+SUBTITLE} (HTML) |
| 11601 | The document's subtitle. HTML exporter formats subtitle if document type is | 11600 | The document's subtitle. HTML exporter formats subtitle if document type is |
| 11602 | @samp{HTML5} and the CSS has a @samp{subtitle} class. | 11601 | @samp{HTML5} and the CSS has a @samp{subtitle} class. |
| 11603 | @end table | 11602 | @end table |
| @@ -11731,14 +11730,13 @@ back-end can insert that HTML code in the output, use this inline syntax: | |||
| 11731 | text@@@@html:</b>@@@@}. For larger raw HTML code blocks, use these HTML | 11730 | text@@@@html:</b>@@@@}. For larger raw HTML code blocks, use these HTML |
| 11732 | export code blocks: | 11731 | export code blocks: |
| 11733 | 11732 | ||
| 11734 | @cindex #+HTML | 11733 | @cindex @code{#+HTML} |
| 11735 | @cindex #+BEGIN_EXPORT html | ||
| 11736 | @example | 11734 | @example |
| 11737 | #+HTML: Literal HTML code for export | 11735 | #+HTML: Literal HTML code for export |
| 11738 | @end example | 11736 | @end example |
| 11739 | 11737 | ||
| 11740 | @noindent or | 11738 | @noindent or |
| 11741 | @cindex #+BEGIN_EXPORT html | 11739 | @cindex @code{#+BEGIN_EXPORT html} |
| 11742 | 11740 | ||
| 11743 | @example | 11741 | @example |
| 11744 | #+BEGIN_EXPORT html | 11742 | #+BEGIN_EXPORT html |
| @@ -11775,7 +11773,7 @@ example, by using @code{#+ATTR_HTML} lines to specify new format attributes | |||
| 11775 | to @code{<a>} or @code{<img>} tags. This example shows changing the link's | 11773 | to @code{<a>} or @code{<img>} tags. This example shows changing the link's |
| 11776 | @code{title} and @code{style}: | 11774 | @code{title} and @code{style}: |
| 11777 | 11775 | ||
| 11778 | @cindex #+ATTR_HTML | 11776 | @cindex @code{#+ATTR_HTML} |
| 11779 | @example | 11777 | @example |
| 11780 | #+ATTR_HTML: :title The Org mode homepage :style color:red; | 11778 | #+ATTR_HTML: :title The Org mode homepage :style color:red; |
| 11781 | [[http://orgmode.org]] | 11779 | [[http://orgmode.org]] |
| @@ -11791,8 +11789,8 @@ exporting Org tables to HTML. By default, the exporter does not draw frames | |||
| 11791 | and cell borders. To change for this for a table, use the following lines | 11789 | and cell borders. To change for this for a table, use the following lines |
| 11792 | before the table in the Org file: | 11790 | before the table in the Org file: |
| 11793 | 11791 | ||
| 11794 | @cindex #+CAPTION | 11792 | @cindex @code{#+CAPTION} |
| 11795 | @cindex #+ATTR_HTML | 11793 | @cindex @code{#+ATTR_HTML} |
| 11796 | @example | 11794 | @example |
| 11797 | #+CAPTION: This is a table with lines around and between cells | 11795 | #+CAPTION: This is a table with lines around and between cells |
| 11798 | #+ATTR_HTML: :border 2 :rules all :frame border | 11796 | #+ATTR_HTML: :border 2 :rules all :frame border |
| @@ -11865,8 +11863,8 @@ Org file. This example shows realignment to right, and adds @code{alt} and | |||
| 11865 | @code{title} attributes in support of text viewers and modern web accessibility | 11863 | @code{title} attributes in support of text viewers and modern web accessibility |
| 11866 | standards. | 11864 | standards. |
| 11867 | 11865 | ||
| 11868 | @cindex #+CAPTION | 11866 | @cindex @code{#+CAPTION} |
| 11869 | @cindex #+ATTR_HTML | 11867 | @cindex @code{#+ATTR_HTML} |
| 11870 | @example | 11868 | @example |
| 11871 | #+CAPTION: A black cat stalking a spider | 11869 | #+CAPTION: A black cat stalking a spider |
| 11872 | #+ATTR_HTML: :alt cat/spider image :title Action! :align right | 11870 | #+ATTR_HTML: :alt cat/spider image :title Action! :align right |
| @@ -11975,7 +11973,7 @@ p.creator @r{creator info, about org mode version} | |||
| 11975 | .done @r{the DONE keywords, all states that count as done} | 11973 | .done @r{the DONE keywords, all states that count as done} |
| 11976 | .WAITING @r{each TODO keyword also uses a class named after itself} | 11974 | .WAITING @r{each TODO keyword also uses a class named after itself} |
| 11977 | .timestamp @r{timestamp} | 11975 | .timestamp @r{timestamp} |
| 11978 | .timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} | 11976 | .timestamp-kwd @r{keyword associated with a timestamp, like @code{SCHEDULED}} |
| 11979 | .timestamp-wrapper @r{span around keyword plus timestamp} | 11977 | .timestamp-wrapper @r{span around keyword plus timestamp} |
| 11980 | .tag @r{tag in a headline} | 11978 | .tag @r{tag in a headline} |
| 11981 | ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"} | 11979 | ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"} |
| @@ -12003,14 +12001,14 @@ p.footnote @r{footnote definition paragraph, containing a footnote} | |||
| 12003 | @vindex org-html-head-include-default-style | 12001 | @vindex org-html-head-include-default-style |
| 12004 | @vindex org-html-head | 12002 | @vindex org-html-head |
| 12005 | @vindex org-html-head-extra | 12003 | @vindex org-html-head-extra |
| 12006 | @cindex #+HTML_INCLUDE_STYLE | 12004 | @cindex @code{#+HTML_INCLUDE_STYLE} |
| 12007 | The HTML export back-end includes a compact default style in each exported | 12005 | The HTML export back-end includes a compact default style in each exported |
| 12008 | HTML file. To override the default style with another style, use these | 12006 | HTML file. To override the default style with another style, use these |
| 12009 | keywords in the Org file. They will replace the global defaults the HTML | 12007 | keywords in the Org file. They will replace the global defaults the HTML |
| 12010 | exporter uses. | 12008 | exporter uses. |
| 12011 | 12009 | ||
| 12012 | @cindex #+HTML_HEAD | 12010 | @cindex @code{#+HTML_HEAD} |
| 12013 | @cindex #+HTML_HEAD_EXTRA | 12011 | @cindex @code{#+HTML_HEAD_EXTRA} |
| 12014 | @example | 12012 | @example |
| 12015 | #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" /> | 12013 | #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" /> |
| 12016 | #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" /> | 12014 | #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" /> |
| @@ -12060,7 +12058,7 @@ it on your own web server. | |||
| 12060 | 12058 | ||
| 12061 | To use this program, just add this line to the Org file: | 12059 | To use this program, just add this line to the Org file: |
| 12062 | 12060 | ||
| 12063 | @cindex #+INFOJS_OPT | 12061 | @cindex @code{#+INFOJS_OPT} |
| 12064 | @example | 12062 | @example |
| 12065 | #+INFOJS_OPT: view:info toc:nil | 12063 | #+INFOJS_OPT: view:info toc:nil |
| 12066 | @end example | 12064 | @end example |
| @@ -12181,7 +12179,7 @@ The @LaTeX{} export back-end has several additional keywords for customizing | |||
| 12181 | 12179 | ||
| 12182 | @table @samp | 12180 | @table @samp |
| 12183 | @item DESCRIPTION | 12181 | @item DESCRIPTION |
| 12184 | @cindex #+DESCRIPTION (@LaTeX{}) | 12182 | @cindex @code{#+DESCRIPTION} (@LaTeX{}) |
| 12185 | The document's description. The description along with author name, | 12183 | The document's description. The description along with author name, |
| 12186 | keywords, and related file metadata are inserted in the output file by the | 12184 | keywords, and related file metadata are inserted in the output file by the |
| 12187 | @samp{hyperref} package. See @code{org-latex-hyperref-template} for | 12185 | @samp{hyperref} package. See @code{org-latex-hyperref-template} for |
| @@ -12190,7 +12188,7 @@ typesetting description into the document's front matter. Use multiple | |||
| 12190 | @code{#+DESCRIPTION} lines for long descriptions. | 12188 | @code{#+DESCRIPTION} lines for long descriptions. |
| 12191 | 12189 | ||
| 12192 | @item LATEX_CLASS | 12190 | @item LATEX_CLASS |
| 12193 | @cindex #+LATEX_CLASS | 12191 | @cindex @code{#+LATEX_CLASS} |
| 12194 | @vindex org-latex-default-class | 12192 | @vindex org-latex-default-class |
| 12195 | @vindex org-latex-classes | 12193 | @vindex org-latex-classes |
| 12196 | This is @LaTeX{} document class, such as @code{article}, @code{report}, | 12194 | This is @LaTeX{} document class, such as @code{article}, @code{report}, |
| @@ -12201,32 +12199,32 @@ default class name from the @code{org-latex-default-class} variable. Org has | |||
| 12201 | element of @code{org-latex-classes}. | 12199 | element of @code{org-latex-classes}. |
| 12202 | 12200 | ||
| 12203 | @item LATEX_CLASS_OPTIONS | 12201 | @item LATEX_CLASS_OPTIONS |
| 12204 | @cindex #+LATEX_CLASS_OPTIONS | 12202 | @cindex @code{#+LATEX_CLASS_OPTIONS} |
| 12205 | Options the @LaTeX{} export back-end uses when calling the @LaTeX{} document | 12203 | Options the @LaTeX{} export back-end uses when calling the @LaTeX{} document |
| 12206 | class. | 12204 | class. |
| 12207 | 12205 | ||
| 12208 | @item LATEX_COMPILER | 12206 | @item LATEX_COMPILER |
| 12209 | @cindex #+LATEX_COMPILER | 12207 | @cindex @code{#+LATEX_COMPILER} |
| 12210 | @vindex org-latex-compiler | 12208 | @vindex org-latex-compiler |
| 12211 | The compiler, such as @samp{pdflatex}, @samp{xelatex}, @samp{lualatex}, for | 12209 | The compiler, such as @samp{pdflatex}, @samp{xelatex}, @samp{lualatex}, for |
| 12212 | producing the PDF (@code{org-latex-compiler}). | 12210 | producing the PDF (@code{org-latex-compiler}). |
| 12213 | 12211 | ||
| 12214 | @item LATEX_HEADER | 12212 | @item LATEX_HEADER |
| 12215 | @cindex #+LATEX_HEADER | 12213 | @cindex @code{#+LATEX_HEADER} |
| 12216 | @vindex org-latex-classes | 12214 | @vindex org-latex-classes |
| 12217 | Arbitrary lines to add to the document's preamble, before the @samp{hyperref} | 12215 | Arbitrary lines to add to the document's preamble, before the @samp{hyperref} |
| 12218 | settings. See @code{org-latex-classes} for adjusting the structure and order | 12216 | settings. See @code{org-latex-classes} for adjusting the structure and order |
| 12219 | of the @LaTeX{} headers. | 12217 | of the @LaTeX{} headers. |
| 12220 | 12218 | ||
| 12221 | @item LATEX_HEADER_EXTRA | 12219 | @item LATEX_HEADER_EXTRA |
| 12222 | @cindex #+LATEX_HEADER_EXTRA | 12220 | @cindex @code{#+LATEX_HEADER_EXTRA} |
| 12223 | @vindex org-latex-classes | 12221 | @vindex org-latex-classes |
| 12224 | Arbitrary lines to add to the document's preamble, before the @samp{hyperref} | 12222 | Arbitrary lines to add to the document's preamble, before the @samp{hyperref} |
| 12225 | settings. See @code{org-latex-classes} for adjusting the structure and order | 12223 | settings. See @code{org-latex-classes} for adjusting the structure and order |
| 12226 | of the @LaTeX{} headers. | 12224 | of the @LaTeX{} headers. |
| 12227 | 12225 | ||
| 12228 | @item KEYWORDS | 12226 | @item KEYWORDS |
| 12229 | @cindex #+KEYWORDS (@LaTeX{}) | 12227 | @cindex @code{#+KEYWORDS} (@LaTeX{}) |
| 12230 | The keywords for the document. The description along with author name, | 12228 | The keywords for the document. The description along with author name, |
| 12231 | keywords, and related file metadata are inserted in the output file by the | 12229 | keywords, and related file metadata are inserted in the output file by the |
| 12232 | @samp{hyperref} package. See @code{org-latex-hyperref-template} for | 12230 | @samp{hyperref} package. See @code{org-latex-hyperref-template} for |
| @@ -12235,7 +12233,7 @@ typesetting description into the document's front matter. Use multiple | |||
| 12235 | @code{#+KEYWORDS} lines if necessary. | 12233 | @code{#+KEYWORDS} lines if necessary. |
| 12236 | 12234 | ||
| 12237 | @item SUBTITLE | 12235 | @item SUBTITLE |
| 12238 | @cindex #+SUBTITLE (@LaTeX{}) | 12236 | @cindex @code{#+SUBTITLE} (@LaTeX{}) |
| 12239 | @vindex org-latex-subtitle-separate | 12237 | @vindex org-latex-subtitle-separate |
| 12240 | @vindex org-latex-subtitle-format | 12238 | @vindex org-latex-subtitle-format |
| 12241 | The document's subtitle. It is typeset as per | 12239 | The document's subtitle. It is typeset as per |
| @@ -12277,10 +12275,10 @@ exporter splices the values of @code{org-latex-default-packages-alist} and | |||
| 12277 | @code{org-latex-packages-alist}. Use the same three variables to define | 12275 | @code{org-latex-packages-alist}. Use the same three variables to define |
| 12278 | custom sectioning or custom classes. | 12276 | custom sectioning or custom classes. |
| 12279 | 12277 | ||
| 12280 | @cindex #+LATEX_CLASS | 12278 | @cindex @code{#+LATEX_CLASS} |
| 12281 | @cindex #+LATEX_CLASS_OPTIONS | 12279 | @cindex @code{#+LATEX_CLASS_OPTIONS} |
| 12282 | @cindex property, EXPORT_LATEX_CLASS | 12280 | @cindex property, @code{EXPORT_LATEX_CLASS} |
| 12283 | @cindex property, EXPORT_LATEX_CLASS_OPTIONS | 12281 | @cindex property, @code{EXPORT_LATEX_CLASS_OPTIONS} |
| 12284 | The @LaTeX{} export back-end sends the @code{LATEX_CLASS_OPTIONS} keyword and | 12282 | The @LaTeX{} export back-end sends the @code{LATEX_CLASS_OPTIONS} keyword and |
| 12285 | @code{EXPORT_LATEX_CLASS_OPTIONS} property as options to the @LaTeX{} | 12283 | @code{EXPORT_LATEX_CLASS_OPTIONS} property as options to the @LaTeX{} |
| 12286 | @code{\documentclass} macro. The options and the syntax for specifying them, | 12284 | @code{\documentclass} macro. The options and the syntax for specifying them, |
| @@ -12290,8 +12288,8 @@ including enclosing them in square brackets, follow @LaTeX{} conventions. | |||
| 12290 | #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn] | 12288 | #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn] |
| 12291 | @end example | 12289 | @end example |
| 12292 | 12290 | ||
| 12293 | @cindex #+LATEX_HEADER | 12291 | @cindex @code{#+LATEX_HEADER} |
| 12294 | @cindex #+LATEX_HEADER_EXTRA | 12292 | @cindex @code{#+LATEX_HEADER_EXTRA} |
| 12295 | The @LaTeX{} export back-end appends values from @code{LATEX_HEADER} and | 12293 | The @LaTeX{} export back-end appends values from @code{LATEX_HEADER} and |
| 12296 | @code{LATEX_HEADER_EXTRA} keywords to the @LaTeX{} header. The docstring for | 12294 | @code{LATEX_HEADER_EXTRA} keywords to the @LaTeX{} header. The docstring for |
| 12297 | @code{org-latex-classes} explains in more detail. Also note that @LaTeX{} | 12295 | @code{org-latex-classes} explains in more detail. Also note that @LaTeX{} |
| @@ -12325,14 +12323,14 @@ Code embedded in-line @@@@latex:any arbitrary LaTeX code@@@@ in a paragraph. | |||
| 12325 | @end example | 12323 | @end example |
| 12326 | 12324 | ||
| 12327 | Inserting as one or more keyword lines in the Org file: | 12325 | Inserting as one or more keyword lines in the Org file: |
| 12328 | @cindex #+LATEX | 12326 | @cindex @code{#+LATEX} |
| 12329 | @example | 12327 | @example |
| 12330 | #+LATEX: any arbitrary LaTeX code | 12328 | #+LATEX: any arbitrary LaTeX code |
| 12331 | @end example | 12329 | @end example |
| 12332 | 12330 | ||
| 12333 | Inserting as an export block in the Org file, where the back-end exports any | 12331 | Inserting as an export block in the Org file, where the back-end exports any |
| 12334 | code between begin and end markers: | 12332 | code between begin and end markers: |
| 12335 | @cindex #+BEGIN_EXPORT latex | 12333 | @cindex @code{#+BEGIN_EXPORT latex} |
| 12336 | @example | 12334 | @example |
| 12337 | #+BEGIN_EXPORT latex | 12335 | #+BEGIN_EXPORT latex |
| 12338 | any arbitrary LaTeX code | 12336 | any arbitrary LaTeX code |
| @@ -12342,7 +12340,7 @@ any arbitrary LaTeX code | |||
| 12342 | @node Tables in @LaTeX{} export | 12340 | @node Tables in @LaTeX{} export |
| 12343 | @subsection Tables in @LaTeX{} export | 12341 | @subsection Tables in @LaTeX{} export |
| 12344 | @cindex tables, in @LaTeX{} export | 12342 | @cindex tables, in @LaTeX{} export |
| 12345 | @cindex #+ATTR_LATEX, in tables | 12343 | @cindex @code{#+ATTR_LATEX}, in tables |
| 12346 | 12344 | ||
| 12347 | The @LaTeX{} export back-end can pass several @LaTeX{} attributes for table | 12345 | The @LaTeX{} export back-end can pass several @LaTeX{} attributes for table |
| 12348 | contents and layout. Besides specifying label and caption (@pxref{Images and | 12346 | contents and layout. Besides specifying label and caption (@pxref{Images and |
| @@ -12446,7 +12444,7 @@ Set the caption with the @LaTeX{} command | |||
| 12446 | @subsection Images in @LaTeX{} export | 12444 | @subsection Images in @LaTeX{} export |
| 12447 | @cindex images, inline in @LaTeX{} | 12445 | @cindex images, inline in @LaTeX{} |
| 12448 | @cindex inlining images in @LaTeX{} | 12446 | @cindex inlining images in @LaTeX{} |
| 12449 | @cindex #+ATTR_LATEX, in images | 12447 | @cindex @code{#+ATTR_LATEX}, in images |
| 12450 | 12448 | ||
| 12451 | The @LaTeX{} export back-end processes image links in Org files that do not | 12449 | The @LaTeX{} export back-end processes image links in Org files that do not |
| 12452 | have descriptions, such as these links @samp{[[file:img.jpg]]} or | 12450 | have descriptions, such as these links @samp{[[file:img.jpg]]} or |
| @@ -12516,7 +12514,7 @@ Set the @code{:comment-include} attribute to non-@code{nil} value for the | |||
| 12516 | @node Plain lists in @LaTeX{} export | 12514 | @node Plain lists in @LaTeX{} export |
| 12517 | @subsection Plain lists in @LaTeX{} export | 12515 | @subsection Plain lists in @LaTeX{} export |
| 12518 | @cindex plain lists, in @LaTeX{} export | 12516 | @cindex plain lists, in @LaTeX{} export |
| 12519 | @cindex #+ATTR_LATEX, in plain lists | 12517 | @cindex @code{#+ATTR_LATEX}, in plain lists |
| 12520 | 12518 | ||
| 12521 | The @LaTeX{} export back-end accepts the @code{:environment} and | 12519 | The @LaTeX{} export back-end accepts the @code{:environment} and |
| 12522 | @code{:options} attributes for plain lists. Both attributes work together | 12520 | @code{:options} attributes for plain lists. Both attributes work together |
| @@ -12550,7 +12548,7 @@ four: | |||
| 12550 | @node Source blocks in @LaTeX{} export | 12548 | @node Source blocks in @LaTeX{} export |
| 12551 | @subsection Source blocks in @LaTeX{} export | 12549 | @subsection Source blocks in @LaTeX{} export |
| 12552 | @cindex source blocks, in @LaTeX{} export | 12550 | @cindex source blocks, in @LaTeX{} export |
| 12553 | @cindex #+ATTR_LATEX, in source blocks | 12551 | @cindex @code{#+ATTR_LATEX}, in source blocks |
| 12554 | 12552 | ||
| 12555 | The @LaTeX{} export back-end can make source code blocks into floating | 12553 | The @LaTeX{} export back-end can make source code blocks into floating |
| 12556 | objects through the attributes @code{:float} and @code{:options}. For | 12554 | objects through the attributes @code{:float} and @code{:options}. For |
| @@ -12597,7 +12595,7 @@ variables. | |||
| 12597 | @subsection Example blocks in @LaTeX{} export | 12595 | @subsection Example blocks in @LaTeX{} export |
| 12598 | @cindex example blocks, in @LaTeX{} export | 12596 | @cindex example blocks, in @LaTeX{} export |
| 12599 | @cindex verbatim blocks, in @LaTeX{} export | 12597 | @cindex verbatim blocks, in @LaTeX{} export |
| 12600 | @cindex #+ATTR_LATEX, in example blocks | 12598 | @cindex @code{#+ATTR_LATEX}, in example blocks |
| 12601 | 12599 | ||
| 12602 | The @LaTeX{} export back-end wraps the contents of example blocks in a | 12600 | The @LaTeX{} export back-end wraps the contents of example blocks in a |
| 12603 | @samp{verbatim} environment. To change this behavior to use another | 12601 | @samp{verbatim} environment. To change this behavior to use another |
| @@ -12617,7 +12615,7 @@ This sentence is false. | |||
| 12617 | @cindex special blocks, in @LaTeX{} export | 12615 | @cindex special blocks, in @LaTeX{} export |
| 12618 | @cindex abstract, in @LaTeX{} export | 12616 | @cindex abstract, in @LaTeX{} export |
| 12619 | @cindex proof, in @LaTeX{} export | 12617 | @cindex proof, in @LaTeX{} export |
| 12620 | @cindex #+ATTR_LATEX, in special blocks | 12618 | @cindex @code{#+ATTR_LATEX}, in special blocks |
| 12621 | 12619 | ||
| 12622 | 12620 | ||
| 12623 | For other special blocks in the Org file, the @LaTeX{} export back-end makes | 12621 | For other special blocks in the Org file, the @LaTeX{} export back-end makes |
| @@ -12665,7 +12663,7 @@ example: | |||
| 12665 | @node Horizontal rules in @LaTeX{} export | 12663 | @node Horizontal rules in @LaTeX{} export |
| 12666 | @subsection Horizontal rules in @LaTeX{} export | 12664 | @subsection Horizontal rules in @LaTeX{} export |
| 12667 | @cindex horizontal rules, in @LaTeX{} export | 12665 | @cindex horizontal rules, in @LaTeX{} export |
| 12668 | @cindex #+ATTR_LATEX, in horizontal rules | 12666 | @cindex @code{#+ATTR_LATEX}, in horizontal rules |
| 12669 | 12667 | ||
| 12670 | The @LaTeX{} export back-end converts horizontal rules by the specified | 12668 | The @LaTeX{} export back-end converts horizontal rules by the specified |
| 12671 | @code{:width} and @code{:thickness} attributes. For example: | 12669 | @code{:width} and @code{:thickness} attributes. For example: |
| @@ -12749,10 +12747,10 @@ executable. Without @file{zip}, export cannot finish. | |||
| 12749 | @anchor{x-export-to-odt} | 12747 | @anchor{x-export-to-odt} |
| 12750 | @cindex region, active | 12748 | @cindex region, active |
| 12751 | @cindex active region | 12749 | @cindex active region |
| 12752 | @cindex transient-mark-mode | 12750 | @cindex @code{transient-mark-mode} |
| 12753 | @table @kbd | 12751 | @table @kbd |
| 12754 | @orgcmd{C-c C-e o o,org-odt-export-to-odt} | 12752 | @orgcmd{C-c C-e o o,org-odt-export-to-odt} |
| 12755 | @cindex property EXPORT_FILE_NAME | 12753 | @cindex property, @code{EXPORT_FILE_NAME} |
| 12756 | 12754 | ||
| 12757 | Export as OpenDocument Text file. | 12755 | Export as OpenDocument Text file. |
| 12758 | 12756 | ||
| @@ -12789,13 +12787,13 @@ output. Setting these keywords works similar to the general options | |||
| 12789 | 12787 | ||
| 12790 | @table @samp | 12788 | @table @samp |
| 12791 | @item DESCRIPTION | 12789 | @item DESCRIPTION |
| 12792 | @cindex #+DESCRIPTION (ODT) | 12790 | @cindex @code{#+DESCRIPTION} (ODT) |
| 12793 | This is the document's description, which the ODT export back-end inserts as | 12791 | This is the document's description, which the ODT export back-end inserts as |
| 12794 | document metadata. For long descriptions, use multiple @code{#+DESCRIPTION} | 12792 | document metadata. For long descriptions, use multiple @code{#+DESCRIPTION} |
| 12795 | lines. | 12793 | lines. |
| 12796 | 12794 | ||
| 12797 | @item KEYWORDS | 12795 | @item KEYWORDS |
| 12798 | @cindex #+KEYWORDS (ODT) | 12796 | @cindex @code{#+KEYWORDS} (ODT) |
| 12799 | The keywords for the document. The ODT export back-end inserts the | 12797 | The keywords for the document. The ODT export back-end inserts the |
| 12800 | description along with author name, keywords, and related file metadata as | 12798 | description along with author name, keywords, and related file metadata as |
| 12801 | metadata in the output file. Use multiple @code{#+KEYWORDS} lines if | 12799 | metadata in the output file. Use multiple @code{#+KEYWORDS} lines if |
| @@ -12884,7 +12882,7 @@ Open one, modify, and save as either OpenDocument Text (@file{.odt}) or | |||
| 12884 | OpenDocument Template (@file{.ott}) file. | 12882 | OpenDocument Template (@file{.ott}) file. |
| 12885 | 12883 | ||
| 12886 | @item | 12884 | @item |
| 12887 | @cindex #+ODT_STYLES_FILE | 12885 | @cindex @code{#+ODT_STYLES_FILE} |
| 12888 | @vindex org-odt-styles-file | 12886 | @vindex org-odt-styles-file |
| 12889 | Customize the variable @code{org-odt-styles-file} and point it to the | 12887 | Customize the variable @code{org-odt-styles-file} and point it to the |
| 12890 | newly created file. For additional configuration options | 12888 | newly created file. For additional configuration options |
| @@ -12943,7 +12941,7 @@ back-end honors any table alignments and relative widths for columns | |||
| 12943 | Note that the ODT export back-end interprets column widths as weighted | 12941 | Note that the ODT export back-end interprets column widths as weighted |
| 12944 | ratios, the default weight being 1. | 12942 | ratios, the default weight being 1. |
| 12945 | 12943 | ||
| 12946 | @cindex #+ATTR_ODT | 12944 | @cindex @code{#+ATTR_ODT} |
| 12947 | 12945 | ||
| 12948 | Specifying @code{:rel-width} property on an @code{#+ATTR_ODT} line controls | 12946 | Specifying @code{:rel-width} property on an @code{#+ATTR_ODT} line controls |
| 12949 | the width of the table. For example: | 12947 | the width of the table. For example: |
| @@ -13000,7 +12998,7 @@ when clicked jumps to @uref{http://Orgmode.org} website, do the following | |||
| 13000 | 12998 | ||
| 13001 | @subsubheading Sizing and scaling of embedded images | 12999 | @subsubheading Sizing and scaling of embedded images |
| 13002 | 13000 | ||
| 13003 | @cindex #+ATTR_ODT | 13001 | @cindex @code{#+ATTR_ODT} |
| 13004 | Control the size and scale of the embedded images with the @code{#+ATTR_ODT} | 13002 | Control the size and scale of the embedded images with the @code{#+ATTR_ODT} |
| 13005 | attribute. | 13003 | attribute. |
| 13006 | 13004 | ||
| @@ -13056,7 +13054,7 @@ height:width ratio, do the following | |||
| 13056 | 13054 | ||
| 13057 | @subsubheading Anchoring of images | 13055 | @subsubheading Anchoring of images |
| 13058 | 13056 | ||
| 13059 | @cindex #+ATTR_ODT | 13057 | @cindex @code{#+ATTR_ODT} |
| 13060 | The ODT export back-end can anchor images to @samp{"as-char"}, | 13058 | The ODT export back-end can anchor images to @samp{"as-char"}, |
| 13061 | @samp{"paragraph"}, or @samp{"page"}. Set the preferred anchor using the | 13059 | @samp{"paragraph"}, or @samp{"page"}. Set the preferred anchor using the |
| 13062 | @code{:anchor} property of the @code{#+ATTR_ODT} line. | 13060 | @code{:anchor} property of the @code{#+ATTR_ODT} line. |
| @@ -13454,7 +13452,7 @@ This paragraph is specially formatted and uses bold text. | |||
| 13454 | @subsubheading Customizing tables in ODT export | 13452 | @subsubheading Customizing tables in ODT export |
| 13455 | @cindex tables, in ODT export | 13453 | @cindex tables, in ODT export |
| 13456 | 13454 | ||
| 13457 | @cindex #+ATTR_ODT | 13455 | @cindex @code{#+ATTR_ODT} |
| 13458 | Override the default table format by specifying a custom table style with the | 13456 | Override the default table format by specifying a custom table style with the |
| 13459 | @code{#+ATTR_ODT} line. For a discussion on default formatting of tables | 13457 | @code{#+ATTR_ODT} line. For a discussion on default formatting of tables |
| 13460 | @pxref{Tables in ODT export}. | 13458 | @pxref{Tables in ODT export}. |
| @@ -13698,52 +13696,52 @@ Texinfo output. Setting these keywords works similar to the general options | |||
| 13698 | @table @samp | 13696 | @table @samp |
| 13699 | 13697 | ||
| 13700 | @item SUBTITLE | 13698 | @item SUBTITLE |
| 13701 | @cindex #+SUBTITLE (Texinfo) | 13699 | @cindex @code{#+SUBTITLE} (Texinfo) |
| 13702 | The document subtitle. | 13700 | The document subtitle. |
| 13703 | 13701 | ||
| 13704 | @item SUBAUTHOR | 13702 | @item SUBAUTHOR |
| 13705 | @cindex #+SUBAUTHOR | 13703 | @cindex @code{#+SUBAUTHOR} |
| 13706 | The document subauthor. | 13704 | The document subauthor. |
| 13707 | 13705 | ||
| 13708 | @item TEXINFO_FILENAME | 13706 | @item TEXINFO_FILENAME |
| 13709 | @cindex #+TEXINFO_FILENAME | 13707 | @cindex @code{#+TEXINFO_FILENAME} |
| 13710 | The Texinfo filename. | 13708 | The Texinfo filename. |
| 13711 | 13709 | ||
| 13712 | @item TEXINFO_CLASS | 13710 | @item TEXINFO_CLASS |
| 13713 | @cindex #+TEXINFO_CLASS | 13711 | @cindex @code{#+TEXINFO_CLASS} |
| 13714 | @vindex org-texinfo-default-class | 13712 | @vindex org-texinfo-default-class |
| 13715 | The default document class (@code{org-texinfo-default-class}), which must be | 13713 | The default document class (@code{org-texinfo-default-class}), which must be |
| 13716 | a member of @code{org-texinfo-classes}. | 13714 | a member of @code{org-texinfo-classes}. |
| 13717 | 13715 | ||
| 13718 | @item TEXINFO_HEADER | 13716 | @item TEXINFO_HEADER |
| 13719 | @cindex #+TEXINFO_HEADER | 13717 | @cindex @code{#+TEXINFO_HEADER} |
| 13720 | Arbitrary lines inserted at the end of the header. | 13718 | Arbitrary lines inserted at the end of the header. |
| 13721 | 13719 | ||
| 13722 | @item TEXINFO_POST_HEADER | 13720 | @item TEXINFO_POST_HEADER |
| 13723 | @cindex #+TEXINFO_POST_HEADER | 13721 | @cindex @code{#+TEXINFO_POST_HEADER} |
| 13724 | Arbitrary lines inserted after the end of the header. | 13722 | Arbitrary lines inserted after the end of the header. |
| 13725 | 13723 | ||
| 13726 | @item TEXINFO_DIR_CATEGORY | 13724 | @item TEXINFO_DIR_CATEGORY |
| 13727 | @cindex #+TEXINFO_DIR_CATEGORY | 13725 | @cindex @code{#+TEXINFO_DIR_CATEGORY} |
| 13728 | The directory category of the document. | 13726 | The directory category of the document. |
| 13729 | 13727 | ||
| 13730 | @item TEXINFO_DIR_TITLE | 13728 | @item TEXINFO_DIR_TITLE |
| 13731 | @cindex #+TEXINFO_DIR_TITLE | 13729 | @cindex @code{#+TEXINFO_DIR_TITLE} |
| 13732 | The directory title of the document. | 13730 | The directory title of the document. |
| 13733 | 13731 | ||
| 13734 | @item TEXINFO_DIR_DESC | 13732 | @item TEXINFO_DIR_DESC |
| 13735 | @cindex #+TEXINFO_DIR_DESC | 13733 | @cindex @code{#+TEXINFO_DIR_DESC} |
| 13736 | The directory description of the document. | 13734 | The directory description of the document. |
| 13737 | 13735 | ||
| 13738 | @item TEXINFO_PRINTED_TITLE | 13736 | @item TEXINFO_PRINTED_TITLE |
| 13739 | @cindex #+TEXINFO_PRINTED_TITLE | 13737 | @cindex @code{#+TEXINFO_PRINTED_TITLE} |
| 13740 | The printed title of the document. | 13738 | The printed title of the document. |
| 13741 | @end table | 13739 | @end table |
| 13742 | 13740 | ||
| 13743 | @node Texinfo file header | 13741 | @node Texinfo file header |
| 13744 | @subsection Texinfo file header | 13742 | @subsection Texinfo file header |
| 13745 | 13743 | ||
| 13746 | @cindex #+TEXINFO_FILENAME | 13744 | @cindex @code{#+TEXINFO_FILENAME} |
| 13747 | After creating the header for a Texinfo file, the Texinfo back-end | 13745 | After creating the header for a Texinfo file, the Texinfo back-end |
| 13748 | automatically generates a name and destination path for the Info file. To | 13746 | automatically generates a name and destination path for the Info file. To |
| 13749 | override this default with a more sensible path and name, specify the | 13747 | override this default with a more sensible path and name, specify the |
| @@ -13751,8 +13749,8 @@ override this default with a more sensible path and name, specify the | |||
| 13751 | 13749 | ||
| 13752 | @vindex org-texinfo-coding-system | 13750 | @vindex org-texinfo-coding-system |
| 13753 | @vindex org-texinfo-classes | 13751 | @vindex org-texinfo-classes |
| 13754 | @cindex #+TEXINFO_HEADER | 13752 | @cindex @code{#+TEXINFO_HEADER} |
| 13755 | @cindex #+TEXINFO_CLASS | 13753 | @cindex @code{#+TEXINFO_CLASS} |
| 13756 | Along with the output's file name, the Texinfo header also contains language | 13754 | Along with the output's file name, the Texinfo header also contains language |
| 13757 | details (@pxref{Export settings}) and encoding system as set in the | 13755 | details (@pxref{Export settings}) and encoding system as set in the |
| 13758 | @code{org-texinfo-coding-system} variable. Insert @code{#+TEXINFO_HEADER} | 13756 | @code{org-texinfo-coding-system} variable. Insert @code{#+TEXINFO_HEADER} |
| @@ -13766,14 +13764,14 @@ setting the @code{#+TEXINFO_CLASS} keyword to that class. | |||
| 13766 | @node Texinfo title and copyright page | 13764 | @node Texinfo title and copyright page |
| 13767 | @subsection Texinfo title and copyright page | 13765 | @subsection Texinfo title and copyright page |
| 13768 | 13766 | ||
| 13769 | @cindex #+TEXINFO_PRINTED_TITLE | 13767 | @cindex @code{#+TEXINFO_PRINTED_TITLE} |
| 13770 | The default template for hard copy output has a title page with | 13768 | The default template for hard copy output has a title page with |
| 13771 | @code{#+TITLE} and @code{#+AUTHOR} (@pxref{Export settings}). To replace the | 13769 | @code{#+TITLE} and @code{#+AUTHOR} (@pxref{Export settings}). To replace the |
| 13772 | regular @code{#+TITLE} with something different for the printed version, use | 13770 | regular @code{#+TITLE} with something different for the printed version, use |
| 13773 | the @code{#+TEXINFO_PRINTED_TITLE} and @code{#+SUBTITLE} keywords. Both | 13771 | the @code{#+TEXINFO_PRINTED_TITLE} and @code{#+SUBTITLE} keywords. Both |
| 13774 | expect raw Texinfo code for setting their values. | 13772 | expect raw Texinfo code for setting their values. |
| 13775 | 13773 | ||
| 13776 | @cindex #+SUBAUTHOR | 13774 | @cindex @code{#+SUBAUTHOR} |
| 13777 | If one @code{#+AUTHOR} is not sufficient, add multiple @code{#+SUBAUTHOR} | 13775 | If one @code{#+AUTHOR} is not sufficient, add multiple @code{#+SUBAUTHOR} |
| 13778 | keywords. They have to be set in raw Texinfo code. | 13776 | keywords. They have to be set in raw Texinfo code. |
| 13779 | 13777 | ||
| @@ -13783,7 +13781,7 @@ keywords. They have to be set in raw Texinfo code. | |||
| 13783 | #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@} | 13781 | #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@} |
| 13784 | @end example | 13782 | @end example |
| 13785 | 13783 | ||
| 13786 | @cindex property, COPYING | 13784 | @cindex property, @code{COPYING} |
| 13787 | Copying material is defined in a dedicated headline with a non-@code{nil} | 13785 | Copying material is defined in a dedicated headline with a non-@code{nil} |
| 13788 | @code{:COPYING:} property. The back-end inserts the contents within a | 13786 | @code{:COPYING:} property. The back-end inserts the contents within a |
| 13789 | @code{@@copying} command at the beginning of the document. The heading | 13787 | @code{@@copying} command at the beginning of the document. The heading |
| @@ -13811,9 +13809,9 @@ Copyright information is printed on the back of the title page. | |||
| 13811 | @cindex @code{install-info} parameters, in Texinfo export | 13809 | @cindex @code{install-info} parameters, in Texinfo export |
| 13812 | @cindex Texinfo export, @code{install-info} parameters | 13810 | @cindex Texinfo export, @code{install-info} parameters |
| 13813 | 13811 | ||
| 13814 | @cindex #+TEXINFO_DIR_CATEGORY | 13812 | @cindex @code{#+TEXINFO_DIR_CATEGORY} |
| 13815 | @cindex #+TEXINFO_DIR_TITLE | 13813 | @cindex @code{#+TEXINFO_DIR_TITLE} |
| 13816 | @cindex #+TEXINFO_DIR_DESC | 13814 | @cindex @code{#+TEXINFO_DIR_DESC} |
| 13817 | The end result of the Texinfo export process is the creation of an Info file. | 13815 | The end result of the Texinfo export process is the creation of an Info file. |
| 13818 | This Info file's metadata has variables for category, title, and description: | 13816 | This Info file's metadata has variables for category, title, and description: |
| 13819 | @code{#+TEXINFO_DIR_CATEGORY}, @code{#+TEXINFO_DIR_TITLE}, and | 13817 | @code{#+TEXINFO_DIR_CATEGORY}, @code{#+TEXINFO_DIR_TITLE}, and |
| @@ -13833,7 +13831,7 @@ Here is an example that writes to the Info directory file: | |||
| 13833 | 13831 | ||
| 13834 | @vindex org-texinfo-classes | 13832 | @vindex org-texinfo-classes |
| 13835 | @vindex org-texinfo-default-class | 13833 | @vindex org-texinfo-default-class |
| 13836 | @cindex #+TEXINFO_CLASS | 13834 | @cindex @code{#+TEXINFO_CLASS} |
| 13837 | The Texinfo export back-end uses a pre-defined scheme to convert Org | 13835 | The Texinfo export back-end uses a pre-defined scheme to convert Org |
| 13838 | headlines to an equivalent Texinfo structuring commands. A scheme like this | 13836 | headlines to an equivalent Texinfo structuring commands. A scheme like this |
| 13839 | maps top-level headlines to numbered chapters tagged as @code{@@chapter} and | 13837 | maps top-level headlines to numbered chapters tagged as @code{@@chapter} and |
| @@ -13848,12 +13846,12 @@ If an Org headline's level has no associated Texinfo structuring command, or | |||
| 13848 | is below a certain threshold (@pxref{Export settings}), then the Texinfo | 13846 | is below a certain threshold (@pxref{Export settings}), then the Texinfo |
| 13849 | export back-end makes it into a list item. | 13847 | export back-end makes it into a list item. |
| 13850 | 13848 | ||
| 13851 | @cindex property, APPENDIX | 13849 | @cindex property, @code{APPENDIX} |
| 13852 | The Texinfo export back-end makes any headline with a non-@code{nil} | 13850 | The Texinfo export back-end makes any headline with a non-@code{nil} |
| 13853 | @code{:APPENDIX:} property into an appendix. This happens independent of the | 13851 | @code{:APPENDIX:} property into an appendix. This happens independent of the |
| 13854 | Org headline level or the @code{#+TEXINFO_CLASS}. | 13852 | Org headline level or the @code{#+TEXINFO_CLASS}. |
| 13855 | 13853 | ||
| 13856 | @cindex property, DESCRIPTION | 13854 | @cindex property, @code{DESCRIPTION} |
| 13857 | The Texinfo export back-end creates a menu entry after the Org headline for | 13855 | The Texinfo export back-end creates a menu entry after the Org headline for |
| 13858 | each regular sectioning structure. To override this with a shorter menu | 13856 | each regular sectioning structure. To override this with a shorter menu |
| 13859 | entry, use the @code{:ALT_TITLE:} property (@pxref{Table of contents}). | 13857 | entry, use the @code{:ALT_TITLE:} property (@pxref{Table of contents}). |
| @@ -13879,22 +13877,22 @@ Top Node,,texinfo}, for more information. | |||
| 13879 | @node Indices | 13877 | @node Indices |
| 13880 | @subsection Indices | 13878 | @subsection Indices |
| 13881 | 13879 | ||
| 13882 | @cindex #+CINDEX | 13880 | @cindex @code{#+CINDEX} |
| 13883 | @cindex concept index, in Texinfo export | 13881 | @cindex concept index, in Texinfo export |
| 13884 | @cindex Texinfo export, index, concept | 13882 | @cindex Texinfo export, index, concept |
| 13885 | @cindex #+FINDEX | 13883 | @cindex @code{#+FINDEX} |
| 13886 | @cindex function index, in Texinfo export | 13884 | @cindex function index, in Texinfo export |
| 13887 | @cindex Texinfo export, index, function | 13885 | @cindex Texinfo export, index, function |
| 13888 | @cindex #+KINDEX | 13886 | @cindex @code{#+KINDEX} |
| 13889 | @cindex keystroke index, in Texinfo export | 13887 | @cindex keystroke index, in Texinfo export |
| 13890 | @cindex Texinfo export, keystroke index | 13888 | @cindex Texinfo export, keystroke index |
| 13891 | @cindex #+PINDEX | 13889 | @cindex @code{#+PINDEX} |
| 13892 | @cindex program index, in Texinfo export | 13890 | @cindex program index, in Texinfo export |
| 13893 | @cindex Texinfo export, program index | 13891 | @cindex Texinfo export, program index |
| 13894 | @cindex #+TINDEX | 13892 | @cindex @code{#+TINDEX} |
| 13895 | @cindex data type index, in Texinfo export | 13893 | @cindex data type index, in Texinfo export |
| 13896 | @cindex Texinfo export, data type index | 13894 | @cindex Texinfo export, data type index |
| 13897 | @cindex #+VINDEX | 13895 | @cindex @code{#+VINDEX} |
| 13898 | @cindex variable index, in Texinfo export | 13896 | @cindex variable index, in Texinfo export |
| 13899 | @cindex Texinfo export, variable index | 13897 | @cindex Texinfo export, variable index |
| 13900 | The Texinfo export back-end recognizes these indexing keywords if used in the | 13898 | The Texinfo export back-end recognizes these indexing keywords if used in the |
| @@ -13907,7 +13905,7 @@ escaped with @samp{@@} if they not belong to a Texinfo command. | |||
| 13907 | #+CINDEX: Defining indexing entries | 13905 | #+CINDEX: Defining indexing entries |
| 13908 | @end example | 13906 | @end example |
| 13909 | 13907 | ||
| 13910 | @cindex property, INDEX | 13908 | @cindex property, @code{INDEX} |
| 13911 | For the back-end to generate an index entry for a headline, set the | 13909 | For the back-end to generate an index entry for a headline, set the |
| 13912 | @code{:INDEX:} property to @samp{cp} or @samp{vr}. These abbreviations come | 13910 | @code{:INDEX:} property to @samp{cp} or @samp{vr}. These abbreviations come |
| 13913 | from Texinfo that stand for concept index and variable index. The Texinfo | 13911 | from Texinfo that stand for concept index and variable index. The Texinfo |
| @@ -13927,8 +13925,8 @@ inserts the index after its contents. | |||
| 13927 | 13925 | ||
| 13928 | Use any of the following three methods to insert or escape raw Texinfo code: | 13926 | Use any of the following three methods to insert or escape raw Texinfo code: |
| 13929 | 13927 | ||
| 13930 | @cindex #+TEXINFO | 13928 | @cindex @code{#+TEXINFO} |
| 13931 | @cindex #+BEGIN_EXPORT texinfo | 13929 | @cindex @code{#+BEGIN_EXPORT texinfo} |
| 13932 | @example | 13930 | @example |
| 13933 | Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU. | 13931 | Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU. |
| 13934 | 13932 | ||
| @@ -13943,10 +13941,10 @@ This paragraph is preceded by... | |||
| 13943 | 13941 | ||
| 13944 | @node Plain lists in Texinfo export | 13942 | @node Plain lists in Texinfo export |
| 13945 | @subsection Plain lists in Texinfo export | 13943 | @subsection Plain lists in Texinfo export |
| 13946 | @cindex #+ATTR_TEXINFO, in plain lists | 13944 | @cindex @code{#+ATTR_TEXINFO}, in plain lists |
| 13947 | @cindex Two-column tables, in Texinfo export | 13945 | @cindex Two-column tables, in Texinfo export |
| 13948 | 13946 | ||
| 13949 | @cindex :table-type attribute, in Texinfo export | 13947 | @cindex @code{:table-type} attribute, in Texinfo export |
| 13950 | The Texinfo export back-end by default converts description lists in the Org | 13948 | The Texinfo export back-end by default converts description lists in the Org |
| 13951 | file using the default command @code{@@table}, which results in a table with | 13949 | file using the default command @code{@@table}, which results in a table with |
| 13952 | two columns. To change this behavior, specify @code{:table-type} with | 13950 | two columns. To change this behavior, specify @code{:table-type} with |
| @@ -13954,14 +13952,14 @@ two columns. To change this behavior, specify @code{:table-type} with | |||
| 13954 | @inforef{Two-column Tables,,texinfo}. | 13952 | @inforef{Two-column Tables,,texinfo}. |
| 13955 | 13953 | ||
| 13956 | @vindex org-texinfo-table-default-markup | 13954 | @vindex org-texinfo-table-default-markup |
| 13957 | @cindex :indic attribute, in Texinfo export | 13955 | @cindex @code{:indic} attribute, in Texinfo export |
| 13958 | The Texinfo export back-end by default also applies a text highlight based on | 13956 | The Texinfo export back-end by default also applies a text highlight based on |
| 13959 | the defaults stored in @code{org-texinfo-table-default-markup}. To override | 13957 | the defaults stored in @code{org-texinfo-table-default-markup}. To override |
| 13960 | the default highlight command, specify another one with the @code{:indic} | 13958 | the default highlight command, specify another one with the @code{:indic} |
| 13961 | attribute. | 13959 | attribute. |
| 13962 | 13960 | ||
| 13963 | @cindex Multiple entries in two-column tables, in Texinfo export | 13961 | @cindex Multiple entries in two-column tables, in Texinfo export |
| 13964 | @cindex :sep attribute, in Texinfo export | 13962 | @cindex @code{:sep} attribute, in Texinfo export |
| 13965 | Org syntax is limited to one entry per list item. Nevertheless, the Texinfo | 13963 | Org syntax is limited to one entry per list item. Nevertheless, the Texinfo |
| 13966 | export back-end can split that entry according to any text provided through | 13964 | export back-end can split that entry according to any text provided through |
| 13967 | the @code{:sep} attribute. Each part then becomes a new entry in the first | 13965 | the @code{:sep} attribute. Each part then becomes a new entry in the first |
| @@ -13987,7 +13985,7 @@ This is the common text for variables foo and bar. | |||
| 13987 | 13985 | ||
| 13988 | @node Tables in Texinfo export | 13986 | @node Tables in Texinfo export |
| 13989 | @subsection Tables in Texinfo export | 13987 | @subsection Tables in Texinfo export |
| 13990 | @cindex #+ATTR_TEXINFO, in tables | 13988 | @cindex @code{#+ATTR_TEXINFO}, in tables |
| 13991 | 13989 | ||
| 13992 | When exporting tables, the Texinfo export back-end uses the widest cell width | 13990 | When exporting tables, the Texinfo export back-end uses the widest cell width |
| 13993 | in each column. To override this and instead specify as fractions of line | 13991 | in each column. To override this and instead specify as fractions of line |
| @@ -14000,7 +13998,7 @@ length, use the @code{:columns} attribute. See example below. | |||
| 14000 | 13998 | ||
| 14001 | @node Images in Texinfo export | 13999 | @node Images in Texinfo export |
| 14002 | @subsection Images in Texinfo export | 14000 | @subsection Images in Texinfo export |
| 14003 | @cindex #+ATTR_TEXINFO, in images | 14001 | @cindex @code{#+ATTR_TEXINFO}, in images |
| 14004 | 14002 | ||
| 14005 | Insert a file link to the image in the Org file, and the Texinfo export | 14003 | Insert a file link to the image in the Org file, and the Texinfo export |
| 14006 | back-end inserts the image. These links must have the usual supported image | 14004 | back-end inserts the image. These links must have the usual supported image |
| @@ -14015,7 +14013,7 @@ the text using Texinfo code, as shown in the example: | |||
| 14015 | 14013 | ||
| 14016 | @node Special blocks in Texinfo export | 14014 | @node Special blocks in Texinfo export |
| 14017 | @subsection Special blocks | 14015 | @subsection Special blocks |
| 14018 | @cindex #+ATTR_TEXINFO, in special blocks | 14016 | @cindex @code{#+ATTR_TEXINFO}, in special blocks |
| 14019 | 14017 | ||
| 14020 | The Texinfo export back-end converts special blocks to commands with the same | 14018 | The Texinfo export back-end converts special blocks to commands with the same |
| 14021 | name. It also adds any @code{:options} attributes to the end of the command, | 14019 | name. It also adds any @code{:options} attributes to the end of the command, |
| @@ -14138,7 +14136,7 @@ configure the variable @code{org-icalendar-categories}. To assign clock | |||
| 14138 | alarms based on time, configure the @code{org-icalendar-alarm-time} variable. | 14136 | alarms based on time, configure the @code{org-icalendar-alarm-time} variable. |
| 14139 | 14137 | ||
| 14140 | @vindex org-icalendar-store-UID | 14138 | @vindex org-icalendar-store-UID |
| 14141 | @cindex property, ID | 14139 | @cindex property, @code{ID} |
| 14142 | The iCalendar format standard requires globally unique identifier---UID---for | 14140 | The iCalendar format standard requires globally unique identifier---UID---for |
| 14143 | each entry. The iCalendar export back-end creates UIDs during export. To | 14141 | each entry. The iCalendar export back-end creates UIDs during export. To |
| 14144 | save a copy of the UID in the Org file set the variable | 14142 | save a copy of the UID in the Org file set the variable |
| @@ -14167,26 +14165,27 @@ and write it to @code{org-icalendar-combined-agenda-file} file name. | |||
| 14167 | 14165 | ||
| 14168 | @vindex org-use-property-inheritance | 14166 | @vindex org-use-property-inheritance |
| 14169 | @vindex org-icalendar-include-body | 14167 | @vindex org-icalendar-include-body |
| 14170 | @cindex property, SUMMARY | 14168 | @cindex property, @code{SUMMARY} |
| 14171 | @cindex property, DESCRIPTION | 14169 | @cindex property, @code{DESCRIPTION} |
| 14172 | @cindex property, LOCATION | 14170 | @cindex property, @code{LOCATION} |
| 14173 | @cindex property, TIMEZONE | 14171 | @cindex property, @code{TIMEZONE} |
| 14174 | The iCalendar export back-end includes SUMMARY, DESCRIPTION, LOCATION and | 14172 | The iCalendar export back-end includes @code{SUMMARY}, @code{DESCRIPTION}, |
| 14175 | TIMEZONE properties from the Org entries when exporting. To force the | 14173 | @code{LOCATION} and @code{TIMEZONE} properties from the Org entries when |
| 14176 | back-end to inherit the LOCATION and TIMEZONE properties, configure the | 14174 | exporting. To force the back-end to inherit the @code{LOCATION} and |
| 14177 | @code{org-use-property-inheritance} variable. | 14175 | @code{TIMEZONE} properties, configure the @code{org-use-property-inheritance} |
| 14178 | 14176 | variable. | |
| 14179 | When Org entries do not have SUMMARY, DESCRIPTION and LOCATION properties, | 14177 | |
| 14180 | the iCalendar export back-end derives the summary from the headline, and | 14178 | When Org entries do not have @code{SUMMARY}, @code{DESCRIPTION} and |
| 14181 | derives the description from the body of the Org item. The | 14179 | @code{LOCATION} properties, the iCalendar export back-end derives the summary |
| 14182 | @code{org-icalendar-include-body} variable limits the maximum number of | 14180 | from the headline, and derives the description from the body of the Org item. |
| 14181 | The @code{org-icalendar-include-body} variable limits the maximum number of | ||
| 14183 | characters of the content are turned into its description. | 14182 | characters of the content are turned into its description. |
| 14184 | 14183 | ||
| 14185 | The TIMEZONE property can be used to specify a per-entry time zone, and will | 14184 | The @code{TIMEZONE} property can be used to specify a per-entry time zone, |
| 14186 | be applied to any entry with timestamp information. Time zones should be | 14185 | and will be applied to any entry with timestamp information. Time zones |
| 14187 | specified as per the IANA time zone database format, e.g.@: ``Asia/Almaty''. | 14186 | should be specified as per the IANA time zone database format, e.g.@: |
| 14188 | Alternately, the property value can be ``UTC'', to force UTC time for this | 14187 | ``Asia/Almaty''. Alternately, the property value can be ``UTC'', to force |
| 14189 | entry only. | 14188 | UTC time for this entry only. |
| 14190 | 14189 | ||
| 14191 | Exporting to iCalendar format depends in large part on the capabilities of | 14190 | Exporting to iCalendar format depends in large part on the capabilities of |
| 14192 | the destination application. Some are more lenient than others. Consult the | 14191 | the destination application. Some are more lenient than others. Consult the |
| @@ -14475,7 +14474,7 @@ and many other properties of a project. | |||
| 14475 | 14474 | ||
| 14476 | @node Project alist | 14475 | @node Project alist |
| 14477 | @subsection The variable @code{org-publish-project-alist} | 14476 | @subsection The variable @code{org-publish-project-alist} |
| 14478 | @cindex org-publish-project-alist | 14477 | @cindex @code{org-publish-project-alist} |
| 14479 | @cindex projects, for publishing | 14478 | @cindex projects, for publishing |
| 14480 | 14479 | ||
| 14481 | @vindex org-publish-project-alist | 14480 | @vindex org-publish-project-alist |
| @@ -14931,7 +14930,7 @@ The file will be created when first publishing a project with the | |||
| 14931 | "theindex.inc"}. You can then build around this include statement by adding | 14930 | "theindex.inc"}. You can then build around this include statement by adding |
| 14932 | a title, style information, etc. | 14931 | a title, style information, etc. |
| 14933 | 14932 | ||
| 14934 | @cindex #+INDEX | 14933 | @cindex @code{#+INDEX} |
| 14935 | Index entries are specified with @code{#+INDEX} keyword. An entry that | 14934 | Index entries are specified with @code{#+INDEX} keyword. An entry that |
| 14936 | contains an exclamation mark will create a sub item. | 14935 | contains an exclamation mark will create a sub item. |
| 14937 | 14936 | ||
| @@ -15102,8 +15101,8 @@ such as not inside comments and fixed width areas. Here's a sample | |||
| 15102 | #+END_SRC | 15101 | #+END_SRC |
| 15103 | @end example | 15102 | @end example |
| 15104 | 15103 | ||
| 15105 | Org can take the code in the block between the @samp{#+BEGIN_SRC} and | 15104 | Org can take the code in the block between the @code{#+BEGIN_SRC} and |
| 15106 | @samp{#+END_SRC} tags, and format, compile, execute, and show the results. | 15105 | @code{#+END_SRC} tags, and format, compile, execute, and show the results. |
| 15107 | Org can simplify many housekeeping tasks essential to modern code | 15106 | Org can simplify many housekeeping tasks essential to modern code |
| 15108 | maintenance. That's why these blocks in Org mode literature are sometimes | 15107 | maintenance. That's why these blocks in Org mode literature are sometimes |
| 15109 | referred to as @samp{live code} blocks (as compared to the static text and | 15108 | referred to as @samp{live code} blocks (as compared to the static text and |
| @@ -15112,7 +15111,7 @@ block by tweaking the headers for compiling, execution, extraction. | |||
| 15112 | 15111 | ||
| 15113 | Org's @samp{src} code block type is one of many block types, such as quote, | 15112 | Org's @samp{src} code block type is one of many block types, such as quote, |
| 15114 | export, verse, latex, example, and verbatim. This section pertains to | 15113 | export, verse, latex, example, and verbatim. This section pertains to |
| 15115 | @samp{src} code blocks between @samp{#+BEGIN_SRC} and @samp{#+END_SRC} | 15114 | @code{src} code blocks between @code{#+BEGIN_SRC} and @code{#+END_SRC} |
| 15116 | 15115 | ||
| 15117 | For editing @samp{src} code blocks, Org provides native Emacs major-modes. | 15116 | For editing @samp{src} code blocks, Org provides native Emacs major-modes. |
| 15118 | That leverages the latest Emacs features for that source code language mode. | 15117 | That leverages the latest Emacs features for that source code language mode. |
| @@ -15174,8 +15173,8 @@ Details of Org's facilities for working with source code are shown next. | |||
| 15174 | @section Structure of code blocks | 15173 | @section Structure of code blocks |
| 15175 | @cindex code block, structure | 15174 | @cindex code block, structure |
| 15176 | @cindex source code, block structure | 15175 | @cindex source code, block structure |
| 15177 | @cindex #+NAME | 15176 | @cindex @code{#+NAME} |
| 15178 | @cindex #+BEGIN_SRC | 15177 | @cindex @code{#+BEGIN_SRC} |
| 15179 | 15178 | ||
| 15180 | Org offers two ways to structure source code in Org documents: in a | 15179 | Org offers two ways to structure source code in Org documents: in a |
| 15181 | @samp{src} block, and directly inline. Both specifications are shown below. | 15180 | @samp{src} block, and directly inline. Both specifications are shown below. |
| @@ -15217,7 +15216,7 @@ results. Code from other blocks, other files, and from table formulas | |||
| 15217 | (@pxref{The spreadsheet}) can use the name to reference a @samp{src} block. | 15216 | (@pxref{The spreadsheet}) can use the name to reference a @samp{src} block. |
| 15218 | This naming serves the same purpose as naming Org tables. Org mode requires | 15217 | This naming serves the same purpose as naming Org tables. Org mode requires |
| 15219 | unique names. For duplicate names, Org mode's behavior is undefined. | 15218 | unique names. For duplicate names, Org mode's behavior is undefined. |
| 15220 | @cindex #+NAME | 15219 | @cindex @code{#+NAME} |
| 15221 | @item #+BEGIN_SRC | 15220 | @item #+BEGIN_SRC |
| 15222 | @item #+END_SRC | 15221 | @item #+END_SRC |
| 15223 | Mandatory. They mark the start and end of a block that Org requires. The | 15222 | Mandatory. They mark the start and end of a block that Org requires. The |
| @@ -15428,7 +15427,7 @@ block header arguments: One, set @code{padline} (@pxref{padline}) to true | |||
| 15428 | @section Evaluating code blocks | 15427 | @section Evaluating code blocks |
| 15429 | @cindex code block, evaluating | 15428 | @cindex code block, evaluating |
| 15430 | @cindex source code, evaluating | 15429 | @cindex source code, evaluating |
| 15431 | @cindex #+RESULTS | 15430 | @cindex @code{#+RESULTS} |
| 15432 | 15431 | ||
| 15433 | A note about security: With code evaluation comes the risk of harm. Org | 15432 | A note about security: With code evaluation comes the risk of harm. Org |
| 15434 | safeguards by prompting for user's permission before executing any code in | 15433 | safeguards by prompting for user's permission before executing any code in |
| @@ -15451,7 +15450,7 @@ evaluation from the @kbd{C-c C-c} key binding.} calls the | |||
| 15451 | @code{org-babel-execute-src-block} function, which executes the code in the | 15450 | @code{org-babel-execute-src-block} function, which executes the code in the |
| 15452 | block, collects the results, and inserts them in the buffer. | 15451 | block, collects the results, and inserts them in the buffer. |
| 15453 | 15452 | ||
| 15454 | @cindex #+CALL | 15453 | @cindex @code{#+CALL} |
| 15455 | By calling a named code block@footnote{Actually, the constructs call_<name>() | 15454 | By calling a named code block@footnote{Actually, the constructs call_<name>() |
| 15456 | and src_<lang>@{@} are not evaluated when they appear in a keyword line | 15455 | and src_<lang>@{@} are not evaluated when they appear in a keyword line |
| 15457 | (i.e. lines starting with @code{#+KEYWORD:}, @pxref{In-buffer settings}).} | 15456 | (i.e. lines starting with @code{#+KEYWORD:}, @pxref{In-buffer settings}).} |
| @@ -15734,7 +15733,7 @@ each line. Note that Org currently accepts the plural spelling of | |||
| 15734 | @code{#+HEADER:} only as a convenience for backward-compatibility. It may be | 15733 | @code{#+HEADER:} only as a convenience for backward-compatibility. It may be |
| 15735 | removed at some point. | 15734 | removed at some point. |
| 15736 | 15735 | ||
| 15737 | @cindex #+HEADER: | 15736 | @cindex @code{#+HEADER:} |
| 15738 | 15737 | ||
| 15739 | Multi-line header arguments on an unnamed @samp{src} code block: | 15738 | Multi-line header arguments on an unnamed @samp{src} code block: |
| 15740 | 15739 | ||
| @@ -17254,7 +17253,7 @@ emacs -Q --batch --eval " | |||
| 17254 | * Speed keys:: Electric commands at the beginning of a headline | 17253 | * Speed keys:: Electric commands at the beginning of a headline |
| 17255 | * Code evaluation security:: Org mode files evaluate inline code | 17254 | * Code evaluation security:: Org mode files evaluate inline code |
| 17256 | * Customization:: Adapting Org to changing tastes | 17255 | * Customization:: Adapting Org to changing tastes |
| 17257 | * In-buffer settings:: Overview of the #+KEYWORDS | 17256 | * In-buffer settings:: Overview of the @code{#+KEYWORDS} |
| 17258 | * The very busy C-c C-c key:: When in doubt, press C-c C-c | 17257 | * The very busy C-c C-c key:: When in doubt, press C-c C-c |
| 17259 | * Clean view:: Getting rid of leading stars in the outline | 17258 | * Clean view:: Getting rid of leading stars in the outline |
| 17260 | * TTY keys:: Using Org on a tty | 17259 | * TTY keys:: Using Org on a tty |
| @@ -17302,7 +17301,7 @@ can be used in search links like @samp{[[*find this headline]]}. | |||
| 17302 | @item | 17301 | @item |
| 17303 | After @samp{:} in a headline, complete tags. The list of tags is taken | 17302 | After @samp{:} in a headline, complete tags. The list of tags is taken |
| 17304 | from the variable @code{org-tag-alist} (possibly set through the | 17303 | from the variable @code{org-tag-alist} (possibly set through the |
| 17305 | @samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created | 17304 | @code{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created |
| 17306 | dynamically from all tags used in the current buffer. | 17305 | dynamically from all tags used in the current buffer. |
| 17307 | @item | 17306 | @item |
| 17308 | After @samp{:} and not in a headline, complete property keys. The list | 17307 | After @samp{:} and not in a headline, complete property keys. The list |
| @@ -17315,7 +17314,7 @@ After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or | |||
| 17315 | file-specific @samp{OPTIONS}. After option keyword is complete, pressing | 17314 | file-specific @samp{OPTIONS}. After option keyword is complete, pressing |
| 17316 | @kbd{M-@key{TAB}} again will insert example settings for that option. | 17315 | @kbd{M-@key{TAB}} again will insert example settings for that option. |
| 17317 | @item | 17316 | @item |
| 17318 | After @samp{#+STARTUP: }, complete startup keywords. | 17317 | After @code{#+STARTUP:}, complete startup keywords. |
| 17319 | @item | 17318 | @item |
| 17320 | When the point is anywhere else, complete dictionary words using Ispell. | 17319 | When the point is anywhere else, complete dictionary words using Ispell. |
| 17321 | @end itemize | 17320 | @end itemize |
| @@ -17479,13 +17478,13 @@ reopening the Org file in Emacs also activates the changes. | |||
| 17479 | @table @kbd | 17478 | @table @kbd |
| 17480 | @item #+ARCHIVE: %s_done:: | 17479 | @item #+ARCHIVE: %s_done:: |
| 17481 | Sets the archive location of the agenda file. This location applies to the | 17480 | Sets the archive location of the agenda file. This location applies to the |
| 17482 | lines until the next @samp{#+ARCHIVE} line, if any, in the Org file. The | 17481 | lines until the next @code{#+ARCHIVE} line, if any, in the Org file. The |
| 17483 | first archive location in the Org file also applies to any entries before it. | 17482 | first archive location in the Org file also applies to any entries before it. |
| 17484 | The corresponding variable is @code{org-archive-location}. | 17483 | The corresponding variable is @code{org-archive-location}. |
| 17485 | @item #+CATEGORY: | 17484 | @item #+CATEGORY: |
| 17486 | Sets the category of the agenda file, which applies to the entire document. | 17485 | Sets the category of the agenda file, which applies to the entire document. |
| 17487 | @item #+COLUMNS: %25ITEM ... | 17486 | @item #+COLUMNS: %25ITEM ... |
| 17488 | @cindex property, COLUMNS | 17487 | @cindex property, @code{COLUMNS} |
| 17489 | Sets the default format for columns view. Org uses this format for column | 17488 | Sets the default format for columns view. Org uses this format for column |
| 17490 | views where there is no @code{COLUMNS} property. | 17489 | views where there is no @code{COLUMNS} property. |
| 17491 | @item #+CONSTANTS: name1=value1 ... | 17490 | @item #+CONSTANTS: name1=value1 ... |
| @@ -17512,7 +17511,7 @@ have a lower ASCII number than the lowest priority. | |||
| 17512 | @item #+PROPERTY: Property_Name Value | 17511 | @item #+PROPERTY: Property_Name Value |
| 17513 | This line sets a default inheritance value for entries in the current | 17512 | This line sets a default inheritance value for entries in the current |
| 17514 | buffer, most useful for specifying the allowed values of a property. | 17513 | buffer, most useful for specifying the allowed values of a property. |
| 17515 | @cindex #+SETUPFILE | 17514 | @cindex @code{#+SETUPFILE} |
| 17516 | @item #+SETUPFILE: file or URL | 17515 | @item #+SETUPFILE: file or URL |
| 17517 | The setup file or a URL pointing to such file is for additional in-buffer | 17516 | The setup file or a URL pointing to such file is for additional in-buffer |
| 17518 | settings. Org loads this file and parses it for any settings in it only when | 17517 | settings. Org loads this file and parses it for any settings in it only when |
| @@ -17524,7 +17523,7 @@ parses the contents of this document as if it was included in the buffer. It | |||
| 17524 | can be another Org file. To visit the file (not a URL), @kbd{C-c '} while | 17523 | can be another Org file. To visit the file (not a URL), @kbd{C-c '} while |
| 17525 | the cursor is on the line with the file name. | 17524 | the cursor is on the line with the file name. |
| 17526 | @item #+STARTUP: | 17525 | @item #+STARTUP: |
| 17527 | @cindex #+STARTUP | 17526 | @cindex @code{#+STARTUP} |
| 17528 | Startup options Org uses when first visiting a file. | 17527 | Startup options Org uses when first visiting a file. |
| 17529 | 17528 | ||
| 17530 | The first set of options deals with the initial visibility of the outline | 17529 | The first set of options deals with the initial visibility of the outline |
| @@ -17705,7 +17704,7 @@ fnadjust @r{automatically renumber and sort footnotes} | |||
| 17705 | nofnadjust @r{do not renumber and sort automatically} | 17704 | nofnadjust @r{do not renumber and sort automatically} |
| 17706 | @end example | 17705 | @end example |
| 17707 | 17706 | ||
| 17708 | @cindex org-hide-block-startup | 17707 | @cindex @code{org-hide-block-startup} |
| 17709 | To hide blocks on startup, use these keywords. The corresponding variable is | 17708 | To hide blocks on startup, use these keywords. The corresponding variable is |
| 17710 | @code{org-hide-block-startup}. | 17709 | @code{org-hide-block-startup}. |
| 17711 | @cindex @code{hideblocks}, STARTUP keyword | 17710 | @cindex @code{hideblocks}, STARTUP keyword |
| @@ -17715,7 +17714,7 @@ hideblocks @r{Hide all begin/end blocks on startup} | |||
| 17715 | nohideblocks @r{Do not hide blocks on startup} | 17714 | nohideblocks @r{Do not hide blocks on startup} |
| 17716 | @end example | 17715 | @end example |
| 17717 | 17716 | ||
| 17718 | @cindex org-pretty-entities | 17717 | @cindex @code{org-pretty-entities} |
| 17719 | The display of entities as UTF-8 characters is governed by the variable | 17718 | The display of entities as UTF-8 characters is governed by the variable |
| 17720 | @code{org-pretty-entities} and the keywords | 17719 | @code{org-pretty-entities} and the keywords |
| 17721 | @cindex @code{entitiespretty}, STARTUP keyword | 17720 | @cindex @code{entitiespretty}, STARTUP keyword |
| @@ -17730,11 +17729,11 @@ entitiesplain @r{Leave entities plain} | |||
| 17730 | These lines specify valid tags for this file. Org accepts multiple tags | 17729 | These lines specify valid tags for this file. Org accepts multiple tags |
| 17731 | lines. Tags could correspond to the @emph{fast tag selection} keys. The | 17730 | lines. Tags could correspond to the @emph{fast tag selection} keys. The |
| 17732 | corresponding variable is @code{org-tag-alist}. | 17731 | corresponding variable is @code{org-tag-alist}. |
| 17733 | @cindex #+TBLFM | 17732 | @cindex @code{#+TBLFM} |
| 17734 | @item #+TBLFM: | 17733 | @item #+TBLFM: |
| 17735 | This line is for formulas for the table directly above. A table can have | 17734 | This line is for formulas for the table directly above. A table can have |
| 17736 | multiple @samp{#+TBLFM:} lines. On table recalculation, Org applies only the | 17735 | multiple @code{#+TBLFM:} lines. On table recalculation, Org applies only the |
| 17737 | first @samp{#+TBLFM:} line. For details see @ref{Using multiple #+TBLFM | 17736 | first @code{#+TBLFM:} line. For details see @ref{Using multiple #+TBLFM |
| 17738 | lines} in @ref{Editing and debugging formulas}. | 17737 | lines} in @ref{Editing and debugging formulas}. |
| 17739 | @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:, | 17738 | @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:, |
| 17740 | @itemx #+OPTIONS:, #+BIND:, | 17739 | @itemx #+OPTIONS:, #+BIND:, |
| @@ -17750,7 +17749,7 @@ The corresponding variable is @code{org-todo-keywords}. | |||
| 17750 | @node The very busy C-c C-c key | 17749 | @node The very busy C-c C-c key |
| 17751 | @section The very busy C-c C-c key | 17750 | @section The very busy C-c C-c key |
| 17752 | @kindex C-c C-c | 17751 | @kindex C-c C-c |
| 17753 | @cindex C-c C-c, overview | 17752 | @cindex @kbd{C-c C-c}, overview |
| 17754 | 17753 | ||
| 17755 | The @kbd{C-c C-c} key in Org serves many purposes depending on the context. | 17754 | The @kbd{C-c C-c} key in Org serves many purposes depending on the context. |
| 17756 | It is probably the most over-worked, multi-purpose key combination in Org. | 17755 | It is probably the most over-worked, multi-purpose key combination in Org. |
| @@ -18429,7 +18428,7 @@ the mode is C, then: | |||
| 18429 | At the location of source, Org needs a special line to direct Orgtbl to | 18428 | At the location of source, Org needs a special line to direct Orgtbl to |
| 18430 | translate and to find the target for inserting the translated table. For | 18429 | translate and to find the target for inserting the translated table. For |
| 18431 | example: | 18430 | example: |
| 18432 | @cindex #+ORGTBL | 18431 | @cindex @code{#+ORGTBL} |
| 18433 | @example | 18432 | @example |
| 18434 | #+ORGTBL: SEND table_name translation_function arguments... | 18433 | #+ORGTBL: SEND table_name translation_function arguments... |
| 18435 | @end example | 18434 | @end example |
| @@ -18483,7 +18482,7 @@ install templates for other export formats.} with the command @kbd{M-x | |||
| 18483 | orgtbl-insert-radio-table RET}, which prompts for a table name. For example, | 18482 | orgtbl-insert-radio-table RET}, which prompts for a table name. For example, |
| 18484 | if @samp{salesfigures} is the name, the template inserts: | 18483 | if @samp{salesfigures} is the name, the template inserts: |
| 18485 | 18484 | ||
| 18486 | @cindex #+ORGTBL, SEND | 18485 | @cindex @code{#+ORGTBL}, @samp{SEND} |
| 18487 | @example | 18486 | @example |
| 18488 | % BEGIN RECEIVE ORGTBL salesfigures | 18487 | % BEGIN RECEIVE ORGTBL salesfigures |
| 18489 | % END RECEIVE ORGTBL salesfigures | 18488 | % END RECEIVE ORGTBL salesfigures |
| @@ -18499,7 +18498,7 @@ The line @code{#+ORGTBL: SEND} tells Orgtbl mode to use the function | |||
| 18499 | @code{orgtbl-to-latex} to convert the table to @LaTeX{} format, then insert | 18498 | @code{orgtbl-to-latex} to convert the table to @LaTeX{} format, then insert |
| 18500 | the table at the target (receive) location named @code{salesfigures}. Now | 18499 | the table at the target (receive) location named @code{salesfigures}. Now |
| 18501 | the table is ready for data entry. It can even use spreadsheet | 18500 | the table is ready for data entry. It can even use spreadsheet |
| 18502 | features@footnote{If the @samp{#+TBLFM} line contains an odd number of dollar | 18501 | features@footnote{If the @code{#+TBLFM} line contains an odd number of dollar |
| 18503 | characters, this may cause problems with font-lock in @LaTeX{} mode. As | 18502 | characters, this may cause problems with font-lock in @LaTeX{} mode. As |
| 18504 | shown in the example you can fix this by adding an extra line inside the | 18503 | shown in the example you can fix this by adding an extra line inside the |
| 18505 | @code{comment} environment that is used to balance the dollar expressions. | 18504 | @code{comment} environment that is used to balance the dollar expressions. |
| @@ -18630,14 +18629,14 @@ translator functions by posting them to the Org users mailing list, | |||
| 18630 | @node Radio lists | 18629 | @node Radio lists |
| 18631 | @subsection Radio lists | 18630 | @subsection Radio lists |
| 18632 | @cindex radio lists | 18631 | @cindex radio lists |
| 18633 | @cindex org-list-insert-radio-list | 18632 | @cindex @code{org-list-insert-radio-list} |
| 18634 | 18633 | ||
| 18635 | Call the @code{org-list-insert-radio-list} function to insert a radio list | 18634 | Call the @code{org-list-insert-radio-list} function to insert a radio list |
| 18636 | template in HTML, @LaTeX{}, and Texinfo mode documents. Sending and | 18635 | template in HTML, @LaTeX{}, and Texinfo mode documents. Sending and |
| 18637 | receiving radio lists works is the same as for radio tables (@pxref{Radio | 18636 | receiving radio lists works is the same as for radio tables (@pxref{Radio |
| 18638 | tables}) except for these differences: | 18637 | tables}) except for these differences: |
| 18639 | 18638 | ||
| 18640 | @cindex #+ORGLST | 18639 | @cindex @code{#+ORGLST} |
| 18641 | @itemize @minus | 18640 | @itemize @minus |
| 18642 | @item | 18641 | @item |
| 18643 | Orgstruct mode must be active. | 18642 | Orgstruct mode must be active. |
| @@ -18681,7 +18680,7 @@ time}). | |||
| 18681 | Dynamic blocks can have names and function parameters. The syntax is similar | 18680 | Dynamic blocks can have names and function parameters. The syntax is similar |
| 18682 | to @samp{src} code block specifications: | 18681 | to @samp{src} code block specifications: |
| 18683 | 18682 | ||
| 18684 | @cindex #+BEGIN:dynamic block | 18683 | @cindex @code{#+BEGIN}, dynamic block |
| 18685 | @example | 18684 | @example |
| 18686 | #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... | 18685 | #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... |
| 18687 | 18686 | ||
| @@ -18943,7 +18942,7 @@ priority-n @r{The computed numerical priority} | |||
| 18943 | 18942 | ||
| 18944 | @noindent | 18943 | @noindent |
| 18945 | If the selection of the agenda item was based on a timestamp, including those | 18944 | If the selection of the agenda item was based on a timestamp, including those |
| 18946 | items with @samp{DEADLINE} and @samp{SCHEDULED} keywords, then Org includes | 18945 | items with @code{DEADLINE} and @code{SCHEDULED} keywords, then Org includes |
| 18947 | date and time in the output. | 18946 | date and time in the output. |
| 18948 | 18947 | ||
| 18949 | If the selection of the agenda item was based on a timestamp (or | 18948 | If the selection of the agenda item was based on a timestamp (or |