diff options
| author | Michael Albinus <michael.albinus@gmx.de> | 2018-02-24 20:40:39 +0100 |
|---|---|---|
| committer | Kyle Meyer <kyle@kyleam.com> | 2018-02-26 21:36:41 -0500 |
| commit | bb2195a1c0dd040e7109ef5992f17953679ec140 (patch) | |
| tree | 1545a26e5ab07dc9997dc9752de36db9c705c536 | |
| parent | a0104599dc2fd030df60b9a056fb912ac9284bc1 (diff) | |
| download | org-mode-bb2195a1c0dd040e7109ef5992f17953679ec140.tar.gz | |
Backport commit e415309fe from Emacs
* doc/org.texi: Fix @cindex entries. Use consistently
@code{} for keywords.
Fix @cindex entries in org.texi
e415309fef4077fe7e4dfe1a898d749c1136ca2c
Michael Albinus
Sat Feb 24 20:40:39 2018 +0100
| -rw-r--r-- | doc/org.texi | 657 |
1 files changed, 328 insertions, 329 deletions
diff --git a/doc/org.texi b/doc/org.texi index dcb1694..66026e1 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -1341,9 +1341,9 @@ following lines anywhere in the buffer: #+STARTUP: showeverything @end example -@cindex property, VISIBILITY +@cindex property, @code{VISIBILITY} @noindent -Furthermore, any entries with a @samp{VISIBILITY} property (@pxref{Properties +Furthermore, any entries with a @code{VISIBILITY} property (@pxref{Properties and columns}) will get their visibility adapted accordingly. Allowed values for this property are @code{folded}, @code{children}, @code{content}, and @code{all}. @@ -1351,7 +1351,7 @@ for this property are @code{folded}, @code{children}, @code{content}, and @table @asis @orgcmd{C-u C-u @key{TAB},org-set-startup-visibility} Switch back to the startup visibility of the buffer, i.e., whatever is -requested by startup options and @samp{VISIBILITY} properties in individual +requested by startup options and @code{VISIBILITY} properties in individual entries. @end table @@ -1818,7 +1818,7 @@ or by a custom function. @cindex drawers @cindex visibility cycling, drawers -@cindex org-insert-drawer +@cindex @code{org-insert-drawer} @kindex C-c C-x d Sometimes you want to keep information associated with an entry, but you normally don't want to see it. For this, Org mode has @emph{drawers}. They @@ -2555,7 +2555,7 @@ rows/columns. @cindex references, named @cindex name, of column or field @cindex constants, in calculations -@cindex #+CONSTANTS +@cindex @code{#+CONSTANTS} @vindex org-table-formula-constants @samp{$name} is interpreted as the name of a column, parameter or @@ -2592,7 +2592,7 @@ numbers. @cindex references, to a different table @cindex name, of column or field @cindex constants, in calculations -@cindex #+NAME, for table +@cindex @code{#+NAME}, for table You may also reference constants, fields and ranges from a different table, either in the current file or even in a different file. The syntax is @@ -2814,8 +2814,8 @@ preceded by @samp{:=}, for example @samp{:=vsum(@@II..III)}. When you press the formula will be stored as the formula for this field, evaluated, and the current field will be replaced with the result. -@cindex #+TBLFM -Formulas are stored in a special line starting with @samp{#+TBLFM:} directly +@cindex @code{#+TBLFM} +Formulas are stored in a special line starting with @code{#+TBLFM:} directly below the table. If you type the equation in the 4th field of the 3rd data line in the table, the formula will look like @samp{@@3$4=$1+$2}. When inserting/deleting/swapping columns and rows with the appropriate commands, @@ -2833,7 +2833,7 @@ command @table @kbd @orgcmd{C-u C-c =,org-table-eval-formula} Install a new formula for the current field. The command prompts for a -formula with default taken from the @samp{#+TBLFM:} line, applies +formula with default taken from the @code{#+TBLFM:} line, applies it to the current field, and stores it. @end table @@ -2880,7 +2880,7 @@ the formula will be stored as the formula for the current column, evaluated and the current field replaced with the result. If the field contains only @samp{=}, the previously stored formula for this column is used. For each column, Org will only remember the most recently used formula. In the -@samp{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The +@code{#+TBLFM:} line, column formulas will look like @samp{$4=$1+$2}. The left-hand side of a column formula cannot be the name of column, it must be the numeric column reference or @code{$>}. @@ -2891,7 +2891,7 @@ following command: @orgcmd{C-c =,org-table-eval-formula} Install a new formula for the current column and replace current field with the result of the formula. The command prompts for a formula, with default -taken from the @samp{#+TBLFM} line, applies it to the current field and +taken from the @code{#+TBLFM} line, applies it to the current field and stores it. With a numeric prefix argument(e.g., @kbd{C-5 C-c =}) the command will apply it to that many consecutive fields in the current column. @end table @@ -3027,25 +3027,25 @@ Turn the coordinate grid in the table on and off. @end table Making a table field blank does not remove the formula associated with -the field, because that is stored in a different line (the @samp{#+TBLFM} +the field, because that is stored in a different line (the @code{#+TBLFM} line)---during the next recalculation the field will be filled again. To remove a formula from a field, you have to give an empty reply when -prompted for the formula, or to edit the @samp{#+TBLFM} line. +prompted for the formula, or to edit the @code{#+TBLFM} line. @kindex C-c C-c -You may edit the @samp{#+TBLFM} directly and re-apply the changed +You may edit the @code{#+TBLFM} directly and re-apply the changed equations with @kbd{C-c C-c} in that line or with the normal recalculation commands in the table. @anchor{Using multiple #+TBLFM lines} -@subsubheading Using multiple #+TBLFM lines -@cindex #+TBLFM line, multiple -@cindex #+TBLFM -@cindex #+TBLFM, switching +@subsubheading Using multiple @code{#+TBLFM} lines +@cindex @code{#+TBLFM} line, multiple +@cindex @code{#+TBLFM} +@cindex @code{#+TBLFM}, switching @kindex C-c C-c You may apply the formula temporarily. This is useful when you -switch the formula. Place multiple @samp{#+TBLFM} lines right +switch the formula. Place multiple @code{#+TBLFM} lines right after the table, and then press @kbd{C-c C-c} on the formula to apply. Here is an example: @@ -3072,7 +3072,7 @@ Pressing @kbd{C-c C-c} in the line of @samp{#+TBLFM: $2=$1*2} yields: @noindent Note: If you recalculate this table (with @kbd{C-u C-c *}, for example), you -will get the following result of applying only the first @samp{#+TBLFM} line. +will get the following result of applying only the first @code{#+TBLFM} line. @example | x | y | @@ -3239,7 +3239,7 @@ functions. @section Org-Plot @cindex graph, in tables @cindex plot tables using Gnuplot -@cindex #+PLOT +@cindex @code{#+PLOT} Org-Plot can produce graphs of information stored in org tables, either graphically or in ASCII-art. @@ -3422,7 +3422,7 @@ internal structure of all links, use the menu entry @cindex links, internal @cindex targets, for links -@cindex property, CUSTOM_ID +@cindex property, @code{CUSTOM_ID} If the link does not look like a URL, it is considered to be internal in the current file. The most important case is a link like @samp{[[#my-custom-id]]} which will link to the entry with the @@ -3438,7 +3438,7 @@ point to the corresponding headline. The preferred match for a text link is a @i{dedicated target}: the same string in double angular brackets, like @samp{<<My Target>>}. -@cindex #+NAME +@cindex @code{#+NAME} If no dedicated target exists, the link will then try to match the exact name of an element within the buffer. Naming is done with the @code{#+NAME} keyword, which has to be put in the line before the element it refers to, as @@ -3630,8 +3630,8 @@ removed from the link and result in a wrong link---you should avoid putting timestamp in the headline.}. @vindex org-id-link-to-org-use-id -@cindex property, CUSTOM_ID -@cindex property, ID +@cindex property, @code{CUSTOM_ID} +@cindex property, @code{ID} If the headline has a @code{CUSTOM_ID} property, a link to this custom ID will be stored. In addition or alternatively (depending on the value of @code{org-id-link-to-org-use-id}), a globally unique @code{ID} property will @@ -3873,7 +3873,7 @@ what the Org author is doing besides Emacs hacking with If you need special abbreviations just for a single Org buffer, you can define them in the file with -@cindex #+LINK +@cindex @code{#+LINK} @example #+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id= #+LINK: google http://www.google.com/search?q=%s @@ -4231,9 +4231,9 @@ unique keys across both sets of keywords.} @subsection Setting up keywords for individual files @cindex keyword options @cindex per-file keywords -@cindex #+TODO -@cindex #+TYP_TODO -@cindex #+SEQ_TODO +@cindex @code{#+TODO} +@cindex @code{#+TYP_TODO} +@cindex @code{#+SEQ_TODO} It can be very useful to use different aspects of the TODO mechanism in different files. For file-local settings, you need to add special lines to @@ -4308,7 +4308,7 @@ foreground or a background color. @cindex TODO dependencies, NOBLOCKING @vindex org-enforce-todo-dependencies -@cindex property, ORDERED +@cindex property, @code{ORDERED} The structure of Org files (hierarchy and lists) makes it easy to define TODO dependencies. Usually, a parent TODO task should not be marked DONE until all subtasks (defined as children tasks) are marked as DONE@. And sometimes @@ -4347,7 +4347,7 @@ property: @table @kbd @orgcmd{C-c C-x o,org-toggle-ordered-property} @vindex org-track-ordered-property-with-tag -@cindex property, ORDERED +@cindex property, @code{ORDERED} Toggle the @code{ORDERED} property of the current entry. A property is used for this behavior because this should be local to the current entry, not inherited like a tag. However, if you would like to @i{track} the value of @@ -4429,7 +4429,7 @@ the entry with a @samp{Closing Note} heading. @vindex org-log-states-order-reversed @vindex org-log-into-drawer -@cindex property, LOG_INTO_DRAWER +@cindex property, @code{LOG_INTO_DRAWER} When TODO keywords are used as workflow states (@pxref{Workflow states}), you might want to keep track of when a state change occurred and maybe take a note about this change. You can either record just a timestamp, or a @@ -4483,12 +4483,12 @@ to a buffer: #+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@) @end example -@cindex property, LOGGING -In order to define logging settings that are local to a subtree or a -single item, define a LOGGING property in this entry. Any non-empty -LOGGING property resets all logging settings to @code{nil}. You may then turn -on logging for this specific tree using STARTUP keywords like -@code{lognotedone} or @code{logrepeat}, as well as adding state specific +@cindex property, @code{LOGGING} +In order to define logging settings that are local to a subtree or a single +item, define a @code{LOGGING} property in this entry. Any non-empty +@code{LOGGING} property resets all logging settings to @code{nil}. You may +then turn on logging for this specific tree using @code{#+STARTUP} keywords +like @code{lognotedone} or @code{logrepeat}, as well as adding state specific settings like @code{TODO(!)}. For example @example @@ -4659,7 +4659,7 @@ these values (highest, lowest, default) like this (please make sure that the highest priority is earlier in the alphabet than the lowest priority): -@cindex #+PRIORITIES +@cindex @code{#+PRIORITIES} @example #+PRIORITIES: A C B @end example @@ -4688,7 +4688,7 @@ be updated each time the TODO status of a child changes, or when pressing ** DONE Talk to neighbor @end example -@cindex property, COOKIE_DATA +@cindex property, @code{COOKIE_DATA} If a heading has both checkboxes and TODO children below it, the meaning of the statistics cookie become ambiguous. Set the property @code{COOKIE_DATA} to either @samp{checkbox} or @samp{todo} to resolve @@ -4760,7 +4760,7 @@ checked. @cindex statistics, for checkboxes @cindex checkbox statistics -@cindex property, COOKIE_DATA +@cindex property, @code{COOKIE_DATA} @vindex org-checkbox-hierarchical-statistics The @samp{[2/4]} and @samp{[1/3]} in the first and second line are cookies indicating how many checkboxes present in this entry have been checked off, @@ -4782,7 +4782,7 @@ to either @samp{checkbox} or @samp{todo} to resolve this issue. @cindex blocking, of checkboxes @cindex checkbox blocking -@cindex property, ORDERED +@cindex property, @code{ORDERED} If the current outline node has an @code{ORDERED} property, checkboxes must be checked off in sequence, and an error will be thrown if you try to check off a box while there are unchecked boxes above it. @@ -4819,7 +4819,7 @@ Insert a new item with a checkbox. This works only if the cursor is already in a plain list item (@pxref{Plain lists}). @orgcmd{C-c C-x o,org-toggle-ordered-property} @vindex org-track-ordered-property-with-tag -@cindex property, ORDERED +@cindex property, @code{ORDERED} Toggle the @code{ORDERED} property of the entry, to toggle if checkboxes must be checked off in sequence. A property is used for this behavior because this should be local to the current entry, not inherited like a tag. @@ -4887,7 +4887,7 @@ a hypothetical level zero that surrounds the entire file. Use a line like this@footnote{As with all these in-buffer settings, pressing @kbd{C-c C-c} activates any changes in the line.}: -@cindex #+FILETAGS +@cindex @code{#+FILETAGS} @example #+FILETAGS: :Peter:Boss:Secret: @end example @@ -4949,7 +4949,7 @@ currently used in the buffer. You may also globally specify a hard list of tags with the variable @code{org-tag-alist}. Finally you can set the default tags for a given file with lines like -@cindex #+TAGS +@cindex @code{#+TAGS} @example #+TAGS: @@work @@home @@tennisclub #+TAGS: laptop car pc sailboat @@ -4968,7 +4968,7 @@ If you have a preferred set of tags that you would like to use in every file, in addition to those defined on a per-file basis by TAGS option lines, then you may specify a list of tags with the variable @code{org-tag-persistent-alist}. You may turn this off on a per-file basis -by adding a STARTUP option line to that file: +by adding a @code{#+STARTUP} option line to that file: @example #+STARTUP: noptag @@ -5318,8 +5318,8 @@ publishers and the number of disks in a box like this: If you want to set properties that can be inherited by any entry in a file, use a line like -@cindex property, _ALL -@cindex #+PROPERTY +@cindex property, @code{_ALL} +@cindex @code{#+PROPERTY} @example #+PROPERTY: NDisks_ALL 1 2 3 4 @end example @@ -5330,7 +5330,7 @@ buffer with @kbd{C-c C-c} to activate this change. If you want to add to the value of an existing property, append a @code{+} to the property name. The following results in the property @code{var} having the value ``foo=1 bar=2''. -@cindex property, + +@cindex property, @code{+} @example #+PROPERTY: var foo=1 #+PROPERTY: var+ bar=2 @@ -5339,7 +5339,7 @@ the value ``foo=1 bar=2''. It is also possible to add to the values of inherited properties. The following results in the @code{genres} property having the value ``Classic Baroque'' under the @code{Goldberg Variations} subtree. -@cindex property, + +@cindex property, @code{+} @example * CD collection ** Classic @@ -5374,7 +5374,7 @@ in the current file will be offered as possible completions. Set a property. This prompts for a property name and a value. If necessary, the property drawer is created as well. @item C-u M-x org-insert-drawer RET -@cindex org-insert-drawer +@cindex @code{org-insert-drawer} Insert a property drawer into the current entry. The drawer will be inserted early in the entry, but after the lines with planning information like deadlines. @@ -5405,20 +5405,20 @@ a column view (@pxref{Column view}), or to use them in queries. The following property names are special and should not be used as keys in the properties drawer: -@cindex property, special, ALLTAGS -@cindex property, special, BLOCKED -@cindex property, special, CLOCKSUM -@cindex property, special, CLOCKSUM_T -@cindex property, special, CLOSED -@cindex property, special, DEADLINE -@cindex property, special, FILE -@cindex property, special, ITEM -@cindex property, special, PRIORITY -@cindex property, special, SCHEDULED -@cindex property, special, TAGS -@cindex property, special, TIMESTAMP -@cindex property, special, TIMESTAMP_IA -@cindex property, special, TODO +@cindex property, special, @code{ALLTAGS} +@cindex property, special, @code{BLOCKED} +@cindex property, special, @code{CLOCKSUM} +@cindex property, special, @code{CLOCKSUM_T} +@cindex property, special, @code{CLOSED} +@cindex property, special, @code{DEADLINE} +@cindex property, special, @code{FILE} +@cindex property, special, @code{ITEM} +@cindex property, special, @code{PRIORITY} +@cindex property, special, @code{SCHEDULED} +@cindex property, special, @code{TAGS} +@cindex property, special, @code{TIMESTAMP} +@cindex property, special, @code{TIMESTAMP_IA} +@cindex property, special, @code{TODO} @example ALLTAGS @r{All tags, including inherited ones.} BLOCKED @r{"t" if task is currently blocked by children or siblings.} @@ -5498,7 +5498,7 @@ search will stop at this value and return @code{nil}. Org mode has a few properties for which inheritance is hard-coded, at least for the special applications for which they are used: -@cindex property, COLUMNS +@cindex property, @code{COLUMNS} @table @code @item COLUMNS The @code{:COLUMNS:} property defines the format of column view @@ -5507,16 +5507,16 @@ where a @code{:COLUMNS:} property is defined is used as the starting point for a column view table, independently of the location in the subtree from where columns view is turned on. @item CATEGORY -@cindex property, CATEGORY +@cindex property, @code{CATEGORY} For agenda view, a category set through a @code{:CATEGORY:} property applies to the entire subtree. @item ARCHIVE -@cindex property, ARCHIVE +@cindex property, @code{ARCHIVE} For archiving, the @code{:ARCHIVE:} property may define the archive location for the entire subtree (@pxref{Moving subtrees}). @item LOGGING -@cindex property, LOGGING -The LOGGING property may define logging settings for an entry or a +@cindex property, @code{LOGGING} +The @code{LOGGING} property may define logging settings for an entry or a subtree (@pxref{Tracking TODO state changes}). @end table @@ -5561,7 +5561,7 @@ done by defining a column format line. To define a column format for an entire file, use a line like -@cindex #+COLUMNS +@cindex @code{#+COLUMNS} @example #+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO @end example @@ -5756,7 +5756,7 @@ exported or printed directly. If you want to capture a column view, use a @code{columnview} dynamic block (@pxref{Dynamic blocks}). The frame of this block looks like this: -@cindex #+BEGIN, columnview +@cindex @code{#+BEGIN}, columnview @example * The column view #+BEGIN: columnview :hlines 1 :id "label" @@ -5772,7 +5772,7 @@ This is the most important parameter. Column view is a feature that is often localized to a certain (sub)tree, and the capture block might be at a different location in the file. To identify the tree whose view to capture, you can use 4 values: -@cindex property, ID +@cindex property, @code{ID} @example local @r{use the tree in which the capture block is located} global @r{make a global view, including all headings in the file} @@ -5780,7 +5780,7 @@ global @r{make a global view, including all headings in the file} @r{run column view at the top of this file} "@var{ID}" @r{call column view in the tree that has an @code{:ID:}} @r{property with the value @i{label}. You can use} - @r{@kbd{M-x org-id-copy RET} to create a globally unique ID for} + @r{@kbd{M-x org-id-copy RET} to create a globally unique @code{ID} for} @r{the current entry and copy it to the kill-ring.} @end example @item :hlines @@ -5804,7 +5804,7 @@ The following commands insert or update the dynamic block: @table @kbd @orgcmd{C-c C-x i,org-insert-columns-dblock} Insert a dynamic block capturing a column view. You will be prompted -for the scope or ID of the view. +for the scope or @code{ID} of the view. @orgcmdkkc{C-c C-c,C-c C-x C-u,org-dblock-update} Update dynamic block at point. @orgcmd{C-u C-c C-x C-u,org-update-all-dblocks} @@ -6212,7 +6212,7 @@ they refer to. @table @var @item DEADLINE -@cindex DEADLINE keyword +@cindex @code{DEADLINE} keyword Meaning: the task (most likely a TODO item, though not necessarily) is supposed to be finished on that date. @@ -6238,7 +6238,7 @@ deactivated if the task gets scheduled and you set @code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}. @item SCHEDULED -@cindex SCHEDULED keyword +@cindex @code{SCHEDULED} keyword Meaning: you are planning to start working on that task on the given date. @@ -6303,7 +6303,7 @@ an item: @table @kbd @c @orgcmd{C-c C-d,org-deadline} -Insert @samp{DEADLINE} keyword along with a stamp. Any CLOSED timestamp will +Insert @code{DEADLINE} keyword along with a stamp. Any CLOSED timestamp will be removed. When called with a prefix arg, an existing deadline will be removed from the entry. Depending on the variable @code{org-log-redeadline}@footnote{with corresponding @code{#+STARTUP} @@ -6312,7 +6312,7 @@ keywords @code{logredeadline}, @code{lognoteredeadline}, and deadline. @orgcmd{C-c C-s,org-schedule} -Insert @samp{SCHEDULED} keyword along with a stamp. Any CLOSED timestamp +Insert @code{SCHEDULED} keyword along with a stamp. Any CLOSED timestamp will be removed. When called with a prefix argument, remove the scheduling date from the entry. Depending on the variable @code{org-log-reschedule}@footnote{with corresponding @code{#+STARTUP} @@ -6346,8 +6346,8 @@ to the previous week before any current timestamp. @cindex tasks, repeated @cindex repeated tasks -Some tasks need to be repeated again and again. Org mode helps to -organize such tasks using a so-called repeater in a DEADLINE, SCHEDULED, +Some tasks need to be repeated again and again. Org mode helps to organize +such tasks using a so-called repeater in a @code{DEADLINE}, @code{SCHEDULED}, or plain timestamp. In the following example @example ** TODO Pay the rent @@ -6364,18 +6364,18 @@ first and the warning period last: @code{DEADLINE: <2005-10-01 Sat +1m -3d>}. @vindex org-todo-repeat-to-state Deadlines and scheduled items produce entries in the agenda when they are over-due, so it is important to be able to mark such an entry as completed -once you have done so. When you mark a DEADLINE or a SCHEDULE with the TODO -keyword DONE, it will no longer produce entries in the agenda. The problem -with this is, however, that then also the @emph{next} instance of the -repeated entry will not be active. Org mode deals with this in the following -way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), it will -shift the base date of the repeating timestamp by the repeater interval, and -immediately set the entry state back to TODO@footnote{In fact, the target -state is taken from, in this sequence, the @code{REPEAT_TO_STATE} property or -the variable @code{org-todo-repeat-to-state}. If neither of these is -specified, the target state defaults to the first state of the TODO state -sequence.}. In the example above, setting the state to DONE would actually -switch the date like this: +once you have done so. When you mark a @code{DEADLINE} or a @code{SCHEDULED} +with the TODO keyword DONE, it will no longer produce entries in the agenda. +The problem with this is, however, that then also the @emph{next} instance of +the repeated entry will not be active. Org mode deals with this in the +following way: When you try to mark such an entry DONE (using @kbd{C-c C-t}), +it will shift the base date of the repeating timestamp by the repeater +interval, and immediately set the entry state back to TODO@footnote{In fact, +the target state is taken from, in this sequence, the @code{REPEAT_TO_STATE} +property or the variable @code{org-todo-repeat-to-state}. If neither of +these is specified, the target state defaults to the first state of the TODO +state sequence.}. In the example above, setting the state to DONE would +actually switch the date like this: @example ** TODO Pay the rent @@ -6481,22 +6481,21 @@ what to do with it. @orgcmd{C-c C-x C-i,org-clock-in} @vindex org-clock-into-drawer @vindex org-clock-continuously -@cindex property, LOG_INTO_DRAWER -Start the clock on the current item (clock-in). This inserts the CLOCK -keyword together with a timestamp. If this is not the first clocking of -this item, the multiple CLOCK lines will be wrapped into a -@code{:LOGBOOK:} drawer (see also the variable -@code{org-clock-into-drawer}). You can also overrule -the setting of this variable for a subtree by setting a -@code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property. -When called with a @kbd{C-u} prefix argument, -select the task from a list of recently clocked tasks. With two @kbd{C-u -C-u} prefixes, clock into the task at point and mark it as the default task; -the default task will then always be available with letter @kbd{d} when -selecting a clocking task. With three @kbd{C-u C-u C-u} prefixes, force -continuous clocking by starting the clock when the last clock stopped.@* -@cindex property: CLOCK_MODELINE_TOTAL -@cindex property: LAST_REPEAT +@cindex property, @code{LOG_INTO_DRAWER} +!Start the clock on the current item (clock-in). This inserts the +@code{CLOCK} keyword together with a timestamp. If this is not the first +clocking of this item, the multiple @code{CLOCK} lines will be wrapped into a +@code{:LOGBOOK:} drawer (see also the variable @code{org-clock-into-drawer}). +You can also overrule the setting of this variable for a subtree by setting a +@code{CLOCK_INTO_DRAWER} or @code{LOG_INTO_DRAWER} property. When called +with a @kbd{C-u} prefix argument, select the task from a list of recently +clocked tasks. With two @kbd{C-u C-u} prefixes, clock into the task at point +and mark it as the default task; the default task will then always be +available with letter @kbd{d} when selecting a clocking task. With three +@kbd{C-u C-u C-u} prefixes, force continuous clocking by starting the clock +when the last clock stopped.@* +@cindex property, @code{CLOCK_MODELINE_TOTAL} +@cindex property, @code{LAST_REPEAT} @vindex org-clock-modeline-total While the clock is running, the current clocking time is shown in the mode line, along with the title of the task. The clock time shown will be all @@ -6605,7 +6604,7 @@ needs to be in the @code{#+BEGIN: clocktable} line for this command. If Here is an example of the frame for a clock table as it is inserted into the buffer with the @kbd{C-c C-x C-r} command: -@cindex #+BEGIN, clocktable +@cindex @code{#+BEGIN}, clocktable @example #+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file #+END: clocktable @@ -6681,8 +6680,8 @@ but you can specify your own function using the @code{:formatter} parameter. @r{E.g., @code{:sort (1 . ?a)} sorts the first column alphabetically.} :compact @r{Abbreviation for @code{:level nil :indent t :narrow 40! :tcolumns 1}} @r{All are overwritten except if there is an explicit @code{:narrow}} -:timestamp @r{A timestamp for the entry, when available. Look for SCHEDULED,} - @r{DEADLINE, TIMESTAMP and TIMESTAMP_IA, in this order.} +:timestamp @r{A timestamp for the entry, when available. Look for @code{SCHEDULED},} + @r{@code{DEADLINE}, @code{TIMESTAMP} and @code{TIMESTAMP_IA}, in this order.} :properties @r{List of properties that should be shown in the table. Each} @r{property will get its own column.} :inherit-props @r{When this flag is @code{t}, the values for @code{:properties} will be inherited.} @@ -6813,7 +6812,7 @@ with @code{org-clock-in} and two @kbd{C-u C-u} with @code{org-clock-in-last}. @section Effort estimates @cindex effort estimates -@cindex property, Effort +@cindex property, @code{EFFORT} If you want to plan your work in a very detailed way, or if you need to produce offers with quotations of the estimated work effort, you may want to assign effort estimates to entries. If you are also clocking your work, you @@ -7031,7 +7030,7 @@ Visit the last stored capture item in its buffer. @end table @vindex org-capture-bookmark -@cindex org-capture-last-stored +@cindex @code{org-capture-last-stored} You can also jump to the bookmark @code{org-capture-last-stored}, which will automatically be created unless you set @code{org-capture-bookmark} to @code{nil}. @@ -7453,12 +7452,12 @@ Delete all of a task's attachments. A safer way is to open the directory in @command{dired} and delete from there. @orgcmdtkc{s,C-c C-a s,org-attach-set-directory} -@cindex property, ATTACH_DIR +@cindex property, @code{ATTACH_DIR} Set a specific directory as the entry's attachment directory. This works by putting the directory path into the @code{ATTACH_DIR} property. @orgcmdtkc{i,C-c C-a i,org-attach-set-inherit} -@cindex property, ATTACH_DIR_INHERIT +@cindex property, @code{ATTACH_DIR_INHERIT} Set the @code{ATTACH_DIR_INHERIT} property, so that children will use the same directory for attachments as the parent does. @end table @@ -7632,14 +7631,14 @@ javascript:location.href='org-protocol://open-source?&url='+ encodeURIComponent(location.href) @end example -@cindex protocol, open-source, :base-url property -@cindex :base-url property in open-source protocol -@cindex protocol, open-source, :working-directory property -@cindex :working-directory property in open-source protocol -@cindex protocol, open-source, :online-suffix property -@cindex :online-suffix property in open-source protocol -@cindex protocol, open-source, :working-suffix property -@cindex :working-suffix property in open-source protocol +@cindex protocol, open-source, @code{:base-url} property +@cindex @code{:base-url} property in open-source protocol +@cindex protocol, open-source, @code{:working-directory} property +@cindex @code{:working-directory} property in open-source protocol +@cindex protocol, open-source, @code{:online-suffix} property +@cindex @code{:online-suffix} property in open-source protocol +@cindex protocol, open-source, @code{:working-suffix} property +@cindex @code{:working-suffix} property in open-source protocol @vindex org-protocol-project-alist The variable @code{org-protocol-project-alist} maps URLs to local file names, by stripping URL parameters from the end and replacing the @code{:base-url} @@ -7676,8 +7675,8 @@ to something like @code{open-source} handler probably cannot find a file named @file{/home/user/example/print/posters.html.php} and fails. -@cindex protocol, open-source, :rewrites property -@cindex :rewrites property in open-source protocol +@cindex protocol, open-source, @code{:rewrites} property +@cindex @code{:rewrites property} in open-source protocol Such an entry in @code{org-protocol-project-alist} may hold an additional property @code{:rewrites}. This property is a list of cons cells, each of which maps a regular expression to a path relative to the @@ -7828,12 +7827,12 @@ see the documentation string of the variable There is also an in-buffer option for setting this variable, for example: -@cindex #+ARCHIVE +@cindex @code{#+ARCHIVE} @example #+ARCHIVE: %s_done:: @end example -@cindex property, ARCHIVE +@cindex property, @code{ARCHIVE} @noindent If you would like to have a special ARCHIVE location for a single entry or a (sub)tree, give the entry an @code{:ARCHIVE:} property with the @@ -8141,7 +8140,7 @@ The purpose of the weekly/daily @emph{agenda} is to act like a page of a paper agenda, showing all the tasks for the current week or day. @table @kbd -@cindex org-agenda, command +@cindex @code{org-agenda}, command @orgcmd{C-c a a,org-agenda-list} Compile an agenda for the current week from a list of Org files. The agenda shows the entries for each day. With a numeric prefix@footnote{For backward @@ -8628,7 +8627,7 @@ associated with the item. @subsection Categories @cindex category -@cindex #+CATEGORY +@cindex @code{#+CATEGORY} The category is a broad label assigned to each agenda item. By default, the category is simply derived from the file name, but you can also specify it with a special line in the buffer, like this: @@ -8638,8 +8637,8 @@ with a special line in the buffer, like this: @end example @noindent -@cindex property, CATEGORY -If you would like to have a special CATEGORY for a single entry or a +@cindex property, @code{CATEGORY} +If you would like to have a special @code{CATEGORY} for a single entry or a (sub)tree, give the entry a @code{:CATEGORY:} property with the special category you want to apply as the value. @@ -9851,7 +9850,7 @@ does not have a specific format---defined in a property, or in its file---it uses @code{org-columns-default-format}. @item -@cindex property, special, CLOCKSUM +@cindex property, special, @code{CLOCKSUM} If any of the columns has a summary type defined (@pxref{Column attributes}), turning on column view in the agenda will visit all relevant agenda files and make sure that the computations of this property are up to date. This is @@ -9875,7 +9874,7 @@ clocked time in the displayed period use clock table mode (press @kbd{R} in the agenda). @item -@cindex property, special, CLOCKSUM_T +@cindex property, special, @code{CLOCKSUM_T} When the column view in the agenda shows the @code{CLOCKSUM_T}, that is always today's clocked time for this item. So even in the weekly agenda, the clocksum listed in column view only originates from today. This lets you @@ -9915,7 +9914,7 @@ To preserve the line breaks, indentation and blank lines in a region, but otherwise use normal formatting, you can use this construct, which can also be used to format poetry. -@cindex #+BEGIN_VERSE +@cindex @code{#+BEGIN_VERSE} @cindex verse blocks @example #+BEGIN_VERSE @@ -9931,7 +9930,7 @@ When quoting a passage from another document, it is customary to format this as a paragraph that is indented on both the left and the right margin. You can include quotations in Org mode documents like this: -@cindex #+BEGIN_QUOTE +@cindex @code{#+BEGIN_QUOTE} @cindex quote blocks @example #+BEGIN_QUOTE @@ -9941,7 +9940,7 @@ but not any simpler -- Albert Einstein @end example If you would like to center some text, do it like this: -@cindex #+BEGIN_CENTER +@cindex @code{#+BEGIN_CENTER} @cindex center blocks @example #+BEGIN_CENTER @@ -9985,8 +9984,8 @@ a horizontal line. @section Images and Tables @cindex tables, markup rules -@cindex #+CAPTION -@cindex #+NAME +@cindex @code{#+CAPTION} +@cindex @code{#+NAME} Both the native Org mode tables (@pxref{Tables}) and tables formatted with the @file{table.el} package will be exported properly. For Org mode tables, the lines before the first horizontal separator line will become table header @@ -10037,7 +10036,7 @@ or may not be handled. You can include literal examples that should not be subjected to markup. Such examples will be typeset in monospace, so this is well suited for source code and similar examples. -@cindex #+BEGIN_EXAMPLE +@cindex @code{#+BEGIN_EXAMPLE} @example #+BEGIN_EXAMPLE @@ -10076,7 +10075,7 @@ example@footnote{Code in @samp{src} blocks may also be evaluated either interactively or on export. @xref{Working with source code}, for more information on evaluating code blocks.}, see @ref{Easy templates} for shortcuts to easily insert code blocks. -@cindex #+BEGIN_SRC +@cindex @code{#+BEGIN_SRC} @example #+BEGIN_SRC emacs-lisp @@ -10591,7 +10590,7 @@ Org document by adjusting outline visibility settings. @section Export settings @cindex Export, settings -@cindex #+OPTIONS +@cindex @code{#+OPTIONS} Export options can be set: globally with variables; for an individual file by making variables buffer-local with in-buffer settings (@pxref{In-buffer settings}), by setting individual keywords, or by specifying them in a @@ -10599,7 +10598,7 @@ compact form with the @code{#+OPTIONS} keyword; or for a tree by setting properties (@pxref{Properties and columns}). Options set at a specific level override options set at a more general level. -@cindex #+SETUPFILE +@cindex @code{#+SETUPFILE} In-buffer settings may appear anywhere in the file, either directly or indirectly through a file included using @samp{#+SETUPFILE: filename or URL} syntax. Option keyword sets tailored to a particular back-end can be @@ -10615,29 +10614,29 @@ variables, include: @table @samp @item AUTHOR -@cindex #+AUTHOR +@cindex @code{#+AUTHOR} @vindex user-full-name The document author (@code{user-full-name}). @item CREATOR -@cindex #+CREATOR +@cindex @code{#+CREATOR} @vindex org-export-creator-string Entity responsible for output generation (@code{org-export-creator-string}). @item DATE -@cindex #+DATE +@cindex @code{#+DATE} @vindex org-export-date-timestamp-format A date or a time-stamp@footnote{The variable @code{org-export-date-timestamp-format} defines how this time-stamp will be exported.}. @item EMAIL -@cindex #+EMAIL +@cindex @code{#+EMAIL} @vindex user-mail-address The email address (@code{user-mail-address}). @item LANGUAGE -@cindex #+LANGUAGE +@cindex @code{#+LANGUAGE} @vindex org-export-default-language Language to use for translating certain strings (@code{org-export-default-language}). With @samp{#+LANGUAGE: fr}, for @@ -10645,7 +10644,7 @@ example, Org translates @emph{Table of contents} to the French @emph{Table des matières}. @item SELECT_TAGS -@cindex #+SELECT_TAGS +@cindex @code{#+SELECT_TAGS} @vindex org-export-select-tags The default value is @code{:export:}. When a tree is tagged with @code{:export:} (@code{org-export-select-tags}), Org selects that tree and @@ -10654,7 +10653,7 @@ see below. When selectively exporting files with @code{:export:} tags set, Org does not export any text that appears before the first headline. @item EXCLUDE_TAGS -@cindex #+EXCLUDE_TAGS +@cindex @code{#+EXCLUDE_TAGS} @vindex org-export-exclude-tags The default value is @code{:noexport:}. When a tree is tagged with @code{:noexport:} (@code{org-export-exclude-tags}), Org excludes that tree @@ -10664,12 +10663,12 @@ unconditionally excluded from the export, even if they have an code blocks contained in them. @item TITLE -@cindex #+TITLE +@cindex @code{#+TITLE} @cindex document title Org displays this title. For long titles, use multiple @code{#+TITLE} lines. @item EXPORT_FILE_NAME -@cindex #+EXPORT_FILE_NAME +@cindex @code{#+EXPORT_FILE_NAME} The name of the output file to be generated. Otherwise, Org generates the file name based on the buffer name and the extension based on the back-end format. @@ -10775,7 +10774,7 @@ Toggle inclusion of inlinetasks (@code{org-export-with-inlinetasks}). @item num: @vindex org-export-with-section-numbers -@cindex property, UNNUMBERED +@cindex property, @code{UNNUMBERED} Toggle section-numbers (@code{org-export-with-section-numbers}). When set to number @samp{n}, Org numbers only those headlines at level @samp{n} or above. Setting @code{UNNUMBERED} property to non-@code{nil} disables numbering of @@ -10851,7 +10850,7 @@ respectively, @samp{EXPORT_DATE} and @samp{EXPORT_FILE_NAME}. Except for @samp{SETUPFILE}, all other keywords listed above have an @samp{EXPORT_} equivalent. -@cindex #+BIND +@cindex @code{#+BIND} @vindex org-export-allow-bind-keywords If @code{org-export-allow-bind-keywords} is non-@code{nil}, Emacs variables can become buffer-local during export by using the BIND keyword. Its syntax @@ -10864,7 +10863,7 @@ settings that cannot be changed using keywords. @cindex list of tables @cindex list of listings -@cindex #+TOC +@cindex @code{#+TOC} @vindex org-export-with-toc Org normally inserts the table of contents directly before the first headline of the file. Org sets the TOC depth the same as the headline levels in the @@ -10910,7 +10909,7 @@ with captions. #+TOC: tables @r{build a list of tables} @end example -@cindex property, ALT_TITLE +@cindex property, @code{ALT_TITLE} Normally Org uses the headline for its entry in the table of contents. But with @code{ALT_TITLE} property, a different entry can be specified for the table of contents. @@ -10920,7 +10919,7 @@ table of contents. @cindex include files, during export Include other files during export. For example, to include your @file{.emacs} file, you could use: -@cindex #+INCLUDE +@cindex @code{#+INCLUDE} @example #+INCLUDE: "~/.emacs" src emacs-lisp @@ -10992,7 +10991,7 @@ Visit the include file at point. @node Macro replacement @section Macro replacement @cindex macro replacement, during export -@cindex #+MACRO +@cindex @code{#+MACRO} @vindex org-export-global-macros Macros replace text snippets during export. Macros are defined globally in @@ -11084,9 +11083,9 @@ Lines starting with zero or more whitespace characters followed by one @samp{#} and a whitespace are treated as comments and, as such, are not exported. -@cindex #+BEGIN_COMMENT -Likewise, regions surrounded by @samp{#+BEGIN_COMMENT} -... @samp{#+END_COMMENT} are not exported. +@cindex @code{#+BEGIN_COMMENT} +Likewise, regions surrounded by @code{#+BEGIN_COMMENT} +... @code{#+END_COMMENT} are not exported. @cindex comment trees Finally, a @samp{COMMENT} keyword at the beginning of an entry, but after any @@ -11142,7 +11141,7 @@ settings}). @table @samp @item SUBTITLE -@cindex #+SUBTITLE (ASCII) +@cindex @code{#+SUBTITLE} (ASCII) The document subtitle. For long subtitles, use multiple @code{#+SUBTITLE} lines in the Org file. Org prints them on one continuous line, wrapping into multiple lines if necessary. @@ -11159,8 +11158,8 @@ where levels become lists, @pxref{Export settings}. To insert text within the Org file by the ASCII back-end, use one the following constructs, inline, keyword, or export block: -@cindex #+ASCII -@cindex #+BEGIN_EXPORT ascii +@cindex @code{#+ASCII} +@cindex @code{#+BEGIN_EXPORT ascii} @example Inline text @@@@ascii:and additional text@@@@ within a paragraph. @@ -11172,7 +11171,7 @@ Org exports text in this block only when using ASCII back-end. @end example @subheading ASCII specific attributes -@cindex #+ATTR_ASCII +@cindex @code{#+ATTR_ASCII} @cindex horizontal rules, in ASCII export ASCII back-end recognizes only one attribute, @code{:width}, which specifies @@ -11186,8 +11185,8 @@ syntax for specifying widths is: @subheading ASCII special blocks @cindex special blocks, in ASCII export -@cindex #+BEGIN_JUSTIFYLEFT -@cindex #+BEGIN_JUSTIFYRIGHT +@cindex @code{#+BEGIN_JUSTIFYLEFT} +@cindex @code{#+BEGIN_JUSTIFYRIGHT} Besides @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), ASCII back-end has these two left and right justification blocks: @@ -11245,7 +11244,7 @@ output. These keywords work similar to the general options settings @table @samp @item BEAMER_THEME -@cindex #+BEAMER_THEME +@cindex @code{#+BEAMER_THEME} @vindex org-beamer-theme The Beamer layout theme (@code{org-beamer-theme}). Use square brackets for options. For example: @@ -11254,24 +11253,24 @@ options. For example: @end smallexample @item BEAMER_FONT_THEME -@cindex #+BEAMER_FONT_THEME +@cindex @code{#+BEAMER_FONT_THEME} The Beamer font theme. @item BEAMER_INNER_THEME -@cindex #+BEAMER_INNER_THEME +@cindex @code{#+BEAMER_INNER_THEME} The Beamer inner theme. @item BEAMER_OUTER_THEME -@cindex #+BEAMER_OUTER_THEME +@cindex @code{#+BEAMER_OUTER_THEME} The Beamer outer theme. @item BEAMER_HEADER -@cindex #+BEAMER_HEADER +@cindex @code{#+BEAMER_HEADER} Arbitrary lines inserted in the preamble, just before the @samp{hyperref} settings. @item DESCRIPTION -@cindex #+DESCRIPTION (Beamer) +@cindex @code{#+DESCRIPTION} (Beamer) The document description. For long descriptions, use multiple @code{#+DESCRIPTION} keywords. By default, @samp{hyperref} inserts @code{#+DESCRIPTION} as metadata. Use @code{org-latex-hyperref-template} to @@ -11279,7 +11278,7 @@ configure document metadata. Use @code{org-latex-title-command} to configure typesetting of description as part of front matter. @item KEYWORDS -@cindex #+KEYWORDS (Beamer) +@cindex @code{#+KEYWORDS} (Beamer) The keywords for defining the contents of the document. Use multiple @code{#+KEYWORDS} lines if necessary. By default, @samp{hyperref} inserts @code{#+KEYWORDS} as metadata. Use @code{org-latex-hyperref-template} to @@ -11287,7 +11286,7 @@ configure document metadata. Use @code{org-latex-title-command} to configure typesetting of keywords as part of front matter. @item SUBTITLE -@cindex #+SUBTITLE (Beamer) +@cindex @code{#+SUBTITLE} (Beamer) @vindex org-beamer-subtitle-format Document's subtitle. For typesetting, use @code{org-beamer-subtitle-format} string. Use @code{org-latex-hyperref-template} to configure document @@ -11309,7 +11308,7 @@ Org headlines become Beamer frames when the heading level in Org is equal to @code{org-beamer-frame-level} or @code{H} value in an @code{OPTIONS} line (@pxref{Export settings}). -@cindex property, BEAMER_ENV +@cindex property, @code{BEAMER_ENV} Org overrides headlines to frames conversion for the current tree of an Org file if it encounters the @code{BEAMER_ENV} property set to @code{frame} or @code{fullframe}. Org ignores whatever @code{org-beamer-frame-level} happens @@ -11328,7 +11327,7 @@ aid and has no semantic relevance.}. For valid values see @code{org-beamer-environments-extra}. @item -@cindex property, BEAMER_REF +@cindex property, @code{BEAMER_REF} If @code{BEAMER_ENV} is set to @code{appendix}, Org exports the entry as an appendix. When set to @code{note}, Org exports the entry as a note within the frame or between frames, depending on the entry's heading level. When @@ -11342,8 +11341,8 @@ not its content. This is useful for inserting content between frames. It is also useful for properly closing a @code{column} environment. @end itemize -@cindex property, BEAMER_ACT -@cindex property, BEAMER_OPT +@cindex property, @code{BEAMER_ACT} +@cindex property, @code{BEAMER_OPT} When @code{BEAMER_ACT} is set for a headline, Org export translates that headline as an overlay or action specification. When enclosed in square brackets, Org export makes the overlay specification a default. Use @@ -11352,7 +11351,7 @@ or block. The Beamer export back-end wraps with appropriate angular or square brackets. It also adds the @code{fragile} option for any code that may require a verbatim block. -@cindex property, BEAMER_COL +@cindex property, @code{BEAMER_COL} To create a column on the Beamer slide, use the @code{BEAMER_COL} property for its headline in the Org file. Set the value of @code{BEAMER_COL} to a decimal number representing the fraction of the total text width. Beamer @@ -11367,8 +11366,8 @@ needs, use the @code{BEAMER_ENV} property. @node Beamer specific syntax @subsection Beamer specific syntax Since Org's Beamer export back-end is an extension of the @LaTeX{} back-end, -it recognizes other @LaTeX{} specific syntax---for example, @samp{#+LATEX:} -or @samp{#+ATTR_LATEX:}. @xref{@LaTeX{} export}, for details. +it recognizes other @LaTeX{} specific syntax---for example, @code{#+LATEX:} +or @code{#+ATTR_LATEX:}. @xref{@LaTeX{} export}, for details. Beamer export wraps the table of contents generated with @code{toc:t} @code{OPTION} keyword in a @code{frame} environment. Beamer export does not @@ -11381,8 +11380,8 @@ contents}). Use square brackets for specifying options. Insert Beamer-specific code using the following constructs: -@cindex #+BEAMER -@cindex #+BEGIN_EXPORT beamer +@cindex @code{#+BEAMER} +@cindex @code{#+BEGIN_EXPORT beamer} @example #+BEAMER: \pause @@ -11403,7 +11402,7 @@ this example: A *@@@@beamer:<2->@@@@useful* feature @end example -@cindex #+ATTR_BEAMER +@cindex @code{#+ATTR_BEAMER} Beamer export recognizes the @code{ATTR_BEAMER} keyword with the following attributes from Beamer configurations: @code{:environment} for changing local Beamer environment, @code{:overlay} for specifying Beamer overlays in angular @@ -11527,66 +11526,66 @@ described in @ref{Export settings}. @table @samp @item DESCRIPTION -@cindex #+DESCRIPTION (HTML) +@cindex @code{#+DESCRIPTION} (HTML) This is the document's description, which the HTML exporter inserts it as a HTML meta tag in the HTML file. For long descriptions, use multiple @code{#+DESCRIPTION} lines. The exporter takes care of wrapping the lines properly. @item HTML_DOCTYPE -@cindex #+HTML_DOCTYPE +@cindex @code{#+HTML_DOCTYPE} @vindex org-html-doctype Specify the document type, for example: HTML5 (@code{org-html-doctype}). @item HTML_CONTAINER -@cindex #+HTML_CONTAINER +@cindex @code{#+HTML_CONTAINER} @vindex org-html-container-element Specify the HTML container, such as @samp{div}, for wrapping sections and elements (@code{org-html-container-element}). @item HTML_LINK_HOME -@cindex #+HTML_LINK_HOME +@cindex @code{#+HTML_LINK_HOME} @vindex org-html-link-home The URL for home link (@code{org-html-link-home}). @item HTML_LINK_UP -@cindex #+HTML_LINK_UP +@cindex @code{#+HTML_LINK_UP} @vindex org-html-link-up The URL for the up link of exported HTML pages (@code{org-html-link-up}). @item HTML_MATHJAX -@cindex #+HTML_MATHJAX +@cindex @code{#+HTML_MATHJAX} @vindex org-html-mathjax-options Options for MathJax (@code{org-html-mathjax-options}). MathJax is used to typeset @LaTeX{} math in HTML documents. @xref{Math formatting in HTML export}, for an example. @item HTML_HEAD -@cindex #+HTML_HEAD +@cindex @code{#+HTML_HEAD} @vindex org-html-head Arbitrary lines for appending to the HTML document's head (@code{org-html-head}). @item HTML_HEAD_EXTRA -@cindex #+HTML_HEAD_EXTRA +@cindex @code{#+HTML_HEAD_EXTRA} @vindex org-html-head-extra More arbitrary lines for appending to the HTML document's head (@code{org-html-head-extra}). @item KEYWORDS -@cindex #+KEYWORDS (HTML) +@cindex @code{#+KEYWORDS} (HTML) Keywords to describe the document's content. HTML exporter inserts these keywords as HTML meta tags. For long keywords, use multiple @code{#+KEYWORDS} lines. @item LATEX_HEADER -@cindex #+LATEX_HEADER (HTML) +@cindex @code{#+LATEX_HEADER} (HTML) Arbitrary lines for appending to the preamble; HTML exporter appends when transcoding @LaTeX{} fragments to images (@pxref{Math formatting in HTML export}). @item SUBTITLE -@cindex #+SUBTITLE (HTML) +@cindex @code{#+SUBTITLE} (HTML) The document's subtitle. HTML exporter formats subtitle if document type is @samp{HTML5} and the CSS has a @samp{subtitle} class. @end table @@ -11720,14 +11719,13 @@ back-end can insert that HTML code in the output, use this inline syntax: text@@@@html:</b>@@@@}. For larger raw HTML code blocks, use these HTML export code blocks: -@cindex #+HTML -@cindex #+BEGIN_EXPORT html +@cindex @code{#+HTML} @example #+HTML: Literal HTML code for export @end example @noindent or -@cindex #+BEGIN_EXPORT html +@cindex @code{#+BEGIN_EXPORT html} @example #+BEGIN_EXPORT html @@ -11764,7 +11762,7 @@ example, by using @code{#+ATTR_HTML} lines to specify new format attributes to @code{<a>} or @code{<img>} tags. This example shows changing the link's @code{title} and @code{style}: -@cindex #+ATTR_HTML +@cindex @code{#+ATTR_HTML} @example #+ATTR_HTML: :title The Org mode homepage :style color:red; [[https://orgmode.org]] @@ -11780,8 +11778,8 @@ exporting Org tables to HTML. By default, the exporter does not draw frames and cell borders. To change for this for a table, use the following lines before the table in the Org file: -@cindex #+CAPTION -@cindex #+ATTR_HTML +@cindex @code{#+CAPTION} +@cindex @code{#+ATTR_HTML} @example #+CAPTION: This is a table with lines around and between cells #+ATTR_HTML: :border 2 :rules all :frame border @@ -11854,8 +11852,8 @@ Org file. This example shows realignment to right, and adds @code{alt} and @code{title} attributes in support of text viewers and modern web accessibility standards. -@cindex #+CAPTION -@cindex #+ATTR_HTML +@cindex @code{#+CAPTION} +@cindex @code{#+ATTR_HTML} @example #+CAPTION: A black cat stalking a spider #+ATTR_HTML: :alt cat/spider image :title Action! :align right @@ -11964,7 +11962,7 @@ p.creator @r{creator info, about org mode version} .done @r{the DONE keywords, all states that count as done} .WAITING @r{each TODO keyword also uses a class named after itself} .timestamp @r{timestamp} -.timestamp-kwd @r{keyword associated with a timestamp, like SCHEDULED} +.timestamp-kwd @r{keyword associated with a timestamp, like @code{SCHEDULED}} .timestamp-wrapper @r{span around keyword plus timestamp} .tag @r{tag in a headline} ._HOME @r{each tag uses itself as a class, "@@" replaced by "_"} @@ -11992,14 +11990,14 @@ p.footnote @r{footnote definition paragraph, containing a footnote} @vindex org-html-head-include-default-style @vindex org-html-head @vindex org-html-head-extra -@cindex #+HTML_INCLUDE_STYLE +@cindex @code{#+HTML_INCLUDE_STYLE} The HTML export back-end includes a compact default style in each exported HTML file. To override the default style with another style, use these keywords in the Org file. They will replace the global defaults the HTML exporter uses. -@cindex #+HTML_HEAD -@cindex #+HTML_HEAD_EXTRA +@cindex @code{#+HTML_HEAD} +@cindex @code{#+HTML_HEAD_EXTRA} @example #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="style1.css" /> #+HTML_HEAD_EXTRA: <link rel="alternate stylesheet" type="text/css" href="style2.css" /> @@ -12049,7 +12047,7 @@ it on your own web server. To use this program, just add this line to the Org file: -@cindex #+INFOJS_OPT +@cindex @code{#+INFOJS_OPT} @example #+INFOJS_OPT: view:info toc:nil @end example @@ -12170,7 +12168,7 @@ The @LaTeX{} export back-end has several additional keywords for customizing @table @samp @item DESCRIPTION -@cindex #+DESCRIPTION (@LaTeX{}) +@cindex @code{#+DESCRIPTION} (@LaTeX{}) The document's description. The description along with author name, keywords, and related file metadata are inserted in the output file by the @samp{hyperref} package. See @code{org-latex-hyperref-template} for @@ -12179,7 +12177,7 @@ typesetting description into the document's front matter. Use multiple @code{#+DESCRIPTION} lines for long descriptions. @item LATEX_CLASS -@cindex #+LATEX_CLASS +@cindex @code{#+LATEX_CLASS} @vindex org-latex-default-class @vindex org-latex-classes This is @LaTeX{} document class, such as @code{article}, @code{report}, @@ -12190,32 +12188,32 @@ default class name from the @code{org-latex-default-class} variable. Org has element of @code{org-latex-classes}. @item LATEX_CLASS_OPTIONS -@cindex #+LATEX_CLASS_OPTIONS +@cindex @code{#+LATEX_CLASS_OPTIONS} Options the @LaTeX{} export back-end uses when calling the @LaTeX{} document class. @item LATEX_COMPILER -@cindex #+LATEX_COMPILER +@cindex @code{#+LATEX_COMPILER} @vindex org-latex-compiler The compiler, such as @samp{pdflatex}, @samp{xelatex}, @samp{lualatex}, for producing the PDF (@code{org-latex-compiler}). @item LATEX_HEADER -@cindex #+LATEX_HEADER +@cindex @code{#+LATEX_HEADER} @vindex org-latex-classes Arbitrary lines to add to the document's preamble, before the @samp{hyperref} settings. See @code{org-latex-classes} for adjusting the structure and order of the @LaTeX{} headers. @item LATEX_HEADER_EXTRA -@cindex #+LATEX_HEADER_EXTRA +@cindex @code{#+LATEX_HEADER_EXTRA} @vindex org-latex-classes Arbitrary lines to add to the document's preamble, before the @samp{hyperref} settings. See @code{org-latex-classes} for adjusting the structure and order of the @LaTeX{} headers. @item KEYWORDS -@cindex #+KEYWORDS (@LaTeX{}) +@cindex @code{#+KEYWORDS} (@LaTeX{}) The keywords for the document. The description along with author name, keywords, and related file metadata are inserted in the output file by the @samp{hyperref} package. See @code{org-latex-hyperref-template} for @@ -12224,7 +12222,7 @@ typesetting description into the document's front matter. Use multiple @code{#+KEYWORDS} lines if necessary. @item SUBTITLE -@cindex #+SUBTITLE (@LaTeX{}) +@cindex @code{#+SUBTITLE} (@LaTeX{}) @vindex org-latex-subtitle-separate @vindex org-latex-subtitle-format The document's subtitle. It is typeset as per @@ -12266,10 +12264,10 @@ exporter splices the values of @code{org-latex-default-packages-alist} and @code{org-latex-packages-alist}. Use the same three variables to define custom sectioning or custom classes. -@cindex #+LATEX_CLASS -@cindex #+LATEX_CLASS_OPTIONS -@cindex property, EXPORT_LATEX_CLASS -@cindex property, EXPORT_LATEX_CLASS_OPTIONS +@cindex @code{#+LATEX_CLASS} +@cindex @code{#+LATEX_CLASS_OPTIONS} +@cindex property, @code{EXPORT_LATEX_CLASS} +@cindex property, @code{EXPORT_LATEX_CLASS_OPTIONS} The @LaTeX{} export back-end sends the @code{LATEX_CLASS_OPTIONS} keyword and @code{EXPORT_LATEX_CLASS_OPTIONS} property as options to the @LaTeX{} @code{\documentclass} macro. The options and the syntax for specifying them, @@ -12279,8 +12277,8 @@ including enclosing them in square brackets, follow @LaTeX{} conventions. #+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn] @end example -@cindex #+LATEX_HEADER -@cindex #+LATEX_HEADER_EXTRA +@cindex @code{#+LATEX_HEADER} +@cindex @code{#+LATEX_HEADER_EXTRA} The @LaTeX{} export back-end appends values from @code{LATEX_HEADER} and @code{LATEX_HEADER_EXTRA} keywords to the @LaTeX{} header. The docstring for @code{org-latex-classes} explains in more detail. Also note that @LaTeX{} @@ -12314,14 +12312,14 @@ Code embedded in-line @@@@latex:any arbitrary LaTeX code@@@@ in a paragraph. @end example Inserting as one or more keyword lines in the Org file: -@cindex #+LATEX +@cindex @code{#+LATEX} @example #+LATEX: any arbitrary LaTeX code @end example Inserting as an export block in the Org file, where the back-end exports any code between begin and end markers: -@cindex #+BEGIN_EXPORT latex +@cindex @code{#+BEGIN_EXPORT latex} @example #+BEGIN_EXPORT latex any arbitrary LaTeX code @@ -12331,7 +12329,7 @@ any arbitrary LaTeX code @node Tables in @LaTeX{} export @subsection Tables in @LaTeX{} export @cindex tables, in @LaTeX{} export -@cindex #+ATTR_LATEX, in tables +@cindex @code{#+ATTR_LATEX}, in tables The @LaTeX{} export back-end can pass several @LaTeX{} attributes for table contents and layout. Besides specifying label and caption (@pxref{Images and @@ -12435,7 +12433,7 @@ Set the caption with the @LaTeX{} command @subsection Images in @LaTeX{} export @cindex images, inline in @LaTeX{} @cindex inlining images in @LaTeX{} -@cindex #+ATTR_LATEX, in images +@cindex @code{#+ATTR_LATEX}, in images The @LaTeX{} export back-end processes image links in Org files that do not have descriptions, such as these links @samp{[[file:img.jpg]]} or @@ -12505,7 +12503,7 @@ Set the @code{:comment-include} attribute to non-@code{nil} value for the @node Plain lists in @LaTeX{} export @subsection Plain lists in @LaTeX{} export @cindex plain lists, in @LaTeX{} export -@cindex #+ATTR_LATEX, in plain lists +@cindex @code{#+ATTR_LATEX}, in plain lists The @LaTeX{} export back-end accepts the @code{:environment} and @code{:options} attributes for plain lists. Both attributes work together @@ -12539,7 +12537,7 @@ four: @node Source blocks in @LaTeX{} export @subsection Source blocks in @LaTeX{} export @cindex source blocks, in @LaTeX{} export -@cindex #+ATTR_LATEX, in source blocks +@cindex @code{#+ATTR_LATEX}, in source blocks The @LaTeX{} export back-end can make source code blocks into floating objects through the attributes @code{:float} and @code{:options}. For @@ -12586,7 +12584,7 @@ variables. @subsection Example blocks in @LaTeX{} export @cindex example blocks, in @LaTeX{} export @cindex verbatim blocks, in @LaTeX{} export -@cindex #+ATTR_LATEX, in example blocks +@cindex @code{#+ATTR_LATEX}, in example blocks The @LaTeX{} export back-end wraps the contents of example blocks in a @samp{verbatim} environment. To change this behavior to use another @@ -12606,7 +12604,7 @@ This sentence is false. @cindex special blocks, in @LaTeX{} export @cindex abstract, in @LaTeX{} export @cindex proof, in @LaTeX{} export -@cindex #+ATTR_LATEX, in special blocks +@cindex @code{#+ATTR_LATEX}, in special blocks For other special blocks in the Org file, the @LaTeX{} export back-end makes @@ -12654,7 +12652,7 @@ example: @node Horizontal rules in @LaTeX{} export @subsection Horizontal rules in @LaTeX{} export @cindex horizontal rules, in @LaTeX{} export -@cindex #+ATTR_LATEX, in horizontal rules +@cindex @code{#+ATTR_LATEX}, in horizontal rules The @LaTeX{} export back-end converts horizontal rules by the specified @code{:width} and @code{:thickness} attributes. For example: @@ -12738,10 +12736,10 @@ executable. Without @file{zip}, export cannot finish. @anchor{x-export-to-odt} @cindex region, active @cindex active region -@cindex transient-mark-mode +@cindex @code{transient-mark-mode} @table @kbd @orgcmd{C-c C-e o o,org-odt-export-to-odt} -@cindex property EXPORT_FILE_NAME +@cindex property, @code{EXPORT_FILE_NAME} Export as OpenDocument Text file. @@ -12778,13 +12776,13 @@ output. Setting these keywords works similar to the general options @table @samp @item DESCRIPTION -@cindex #+DESCRIPTION (ODT) +@cindex @code{#+DESCRIPTION} (ODT) This is the document's description, which the ODT export back-end inserts as document metadata. For long descriptions, use multiple @code{#+DESCRIPTION} lines. @item KEYWORDS -@cindex #+KEYWORDS (ODT) +@cindex @code{#+KEYWORDS} (ODT) The keywords for the document. The ODT export back-end inserts the description along with author name, keywords, and related file metadata as metadata in the output file. Use multiple @code{#+KEYWORDS} lines if @@ -12873,7 +12871,7 @@ Open one, modify, and save as either OpenDocument Text (@file{.odt}) or OpenDocument Template (@file{.ott}) file. @item -@cindex #+ODT_STYLES_FILE +@cindex @code{#+ODT_STYLES_FILE} @vindex org-odt-styles-file Customize the variable @code{org-odt-styles-file} and point it to the newly created file. For additional configuration options @@ -12932,7 +12930,7 @@ back-end honors any table alignments and relative widths for columns Note that the ODT export back-end interprets column widths as weighted ratios, the default weight being 1. -@cindex #+ATTR_ODT +@cindex @code{#+ATTR_ODT} Specifying @code{:rel-width} property on an @code{#+ATTR_ODT} line controls the width of the table. For example: @@ -12989,7 +12987,7 @@ when clicked jumps to @uref{https://orgmode.org} website, do the following @subsubheading Sizing and scaling of embedded images -@cindex #+ATTR_ODT +@cindex @code{#+ATTR_ODT} Control the size and scale of the embedded images with the @code{#+ATTR_ODT} attribute. @@ -13045,7 +13043,7 @@ height:width ratio, do the following @subsubheading Anchoring of images -@cindex #+ATTR_ODT +@cindex @code{#+ATTR_ODT} The ODT export back-end can anchor images to @samp{"as-char"}, @samp{"paragraph"}, or @samp{"page"}. Set the preferred anchor using the @code{:anchor} property of the @code{#+ATTR_ODT} line. @@ -13443,7 +13441,7 @@ This paragraph is specially formatted and uses bold text. @subsubheading Customizing tables in ODT export @cindex tables, in ODT export -@cindex #+ATTR_ODT +@cindex @code{#+ATTR_ODT} Override the default table format by specifying a custom table style with the @code{#+ATTR_ODT} line. For a discussion on default formatting of tables @pxref{Tables in ODT export}. @@ -13687,52 +13685,52 @@ Texinfo output. Setting these keywords works similar to the general options @table @samp @item SUBTITLE -@cindex #+SUBTITLE (Texinfo) +@cindex @code{#+SUBTITLE} (Texinfo) The document subtitle. @item SUBAUTHOR -@cindex #+SUBAUTHOR +@cindex @code{#+SUBAUTHOR} The document subauthor. @item TEXINFO_FILENAME -@cindex #+TEXINFO_FILENAME +@cindex @code{#+TEXINFO_FILENAME} The Texinfo filename. @item TEXINFO_CLASS -@cindex #+TEXINFO_CLASS +@cindex @code{#+TEXINFO_CLASS} @vindex org-texinfo-default-class The default document class (@code{org-texinfo-default-class}), which must be a member of @code{org-texinfo-classes}. @item TEXINFO_HEADER -@cindex #+TEXINFO_HEADER +@cindex @code{#+TEXINFO_HEADER} Arbitrary lines inserted at the end of the header. @item TEXINFO_POST_HEADER -@cindex #+TEXINFO_POST_HEADER +@cindex @code{#+TEXINFO_POST_HEADER} Arbitrary lines inserted after the end of the header. @item TEXINFO_DIR_CATEGORY -@cindex #+TEXINFO_DIR_CATEGORY +@cindex @code{#+TEXINFO_DIR_CATEGORY} The directory category of the document. @item TEXINFO_DIR_TITLE -@cindex #+TEXINFO_DIR_TITLE +@cindex @code{#+TEXINFO_DIR_TITLE} The directory title of the document. @item TEXINFO_DIR_DESC -@cindex #+TEXINFO_DIR_DESC +@cindex @code{#+TEXINFO_DIR_DESC} The directory description of the document. @item TEXINFO_PRINTED_TITLE -@cindex #+TEXINFO_PRINTED_TITLE +@cindex @code{#+TEXINFO_PRINTED_TITLE} The printed title of the document. @end table @node Texinfo file header @subsection Texinfo file header -@cindex #+TEXINFO_FILENAME +@cindex @code{#+TEXINFO_FILENAME} After creating the header for a Texinfo file, the Texinfo back-end automatically generates a name and destination path for the Info file. To override this default with a more sensible path and name, specify the @@ -13740,8 +13738,8 @@ override this default with a more sensible path and name, specify the @vindex org-texinfo-coding-system @vindex org-texinfo-classes -@cindex #+TEXINFO_HEADER -@cindex #+TEXINFO_CLASS +@cindex @code{#+TEXINFO_HEADER} +@cindex @code{#+TEXINFO_CLASS} Along with the output's file name, the Texinfo header also contains language details (@pxref{Export settings}) and encoding system as set in the @code{org-texinfo-coding-system} variable. Insert @code{#+TEXINFO_HEADER} @@ -13755,14 +13753,14 @@ setting the @code{#+TEXINFO_CLASS} keyword to that class. @node Texinfo title and copyright page @subsection Texinfo title and copyright page -@cindex #+TEXINFO_PRINTED_TITLE +@cindex @code{#+TEXINFO_PRINTED_TITLE} The default template for hard copy output has a title page with @code{#+TITLE} and @code{#+AUTHOR} (@pxref{Export settings}). To replace the regular @code{#+TITLE} with something different for the printed version, use the @code{#+TEXINFO_PRINTED_TITLE} and @code{#+SUBTITLE} keywords. Both expect raw Texinfo code for setting their values. -@cindex #+SUBAUTHOR +@cindex @code{#+SUBAUTHOR} If one @code{#+AUTHOR} is not sufficient, add multiple @code{#+SUBAUTHOR} keywords. They have to be set in raw Texinfo code. @@ -13772,7 +13770,7 @@ keywords. They have to be set in raw Texinfo code. #+TEXINFO_PRINTED_TITLE: This Long Title@@inlinefmt@{tex,@@*@} Is Broken in @@TeX@{@} @end example -@cindex property, COPYING +@cindex property, @code{COPYING} Copying material is defined in a dedicated headline with a non-@code{nil} @code{:COPYING:} property. The back-end inserts the contents within a @code{@@copying} command at the beginning of the document. The heading @@ -13800,9 +13798,9 @@ Copyright information is printed on the back of the title page. @cindex @code{install-info} parameters, in Texinfo export @cindex Texinfo export, @code{install-info} parameters -@cindex #+TEXINFO_DIR_CATEGORY -@cindex #+TEXINFO_DIR_TITLE -@cindex #+TEXINFO_DIR_DESC +@cindex @code{#+TEXINFO_DIR_CATEGORY} +@cindex @code{#+TEXINFO_DIR_TITLE} +@cindex @code{#+TEXINFO_DIR_DESC} The end result of the Texinfo export process is the creation of an Info file. This Info file's metadata has variables for category, title, and description: @code{#+TEXINFO_DIR_CATEGORY}, @code{#+TEXINFO_DIR_TITLE}, and @@ -13822,7 +13820,7 @@ Here is an example that writes to the Info directory file: @vindex org-texinfo-classes @vindex org-texinfo-default-class -@cindex #+TEXINFO_CLASS +@cindex @code{#+TEXINFO_CLASS} The Texinfo export back-end uses a pre-defined scheme to convert Org headlines to an equivalent Texinfo structuring commands. A scheme like this maps top-level headlines to numbered chapters tagged as @code{@@chapter} and @@ -13837,12 +13835,12 @@ If an Org headline's level has no associated Texinfo structuring command, or is below a certain threshold (@pxref{Export settings}), then the Texinfo export back-end makes it into a list item. -@cindex property, APPENDIX +@cindex property, @code{APPENDIX} The Texinfo export back-end makes any headline with a non-@code{nil} @code{:APPENDIX:} property into an appendix. This happens independent of the Org headline level or the @code{#+TEXINFO_CLASS}. -@cindex property, DESCRIPTION +@cindex property, @code{DESCRIPTION} The Texinfo export back-end creates a menu entry after the Org headline for each regular sectioning structure. To override this with a shorter menu entry, use the @code{:ALT_TITLE:} property (@pxref{Table of contents}). @@ -13868,22 +13866,22 @@ Top Node,,texinfo}, for more information. @node Indices @subsection Indices -@cindex #+CINDEX +@cindex @code{#+CINDEX} @cindex concept index, in Texinfo export @cindex Texinfo export, index, concept -@cindex #+FINDEX +@cindex @code{#+FINDEX} @cindex function index, in Texinfo export @cindex Texinfo export, index, function -@cindex #+KINDEX +@cindex @code{#+KINDEX} @cindex keystroke index, in Texinfo export @cindex Texinfo export, keystroke index -@cindex #+PINDEX +@cindex @code{#+PINDEX} @cindex program index, in Texinfo export @cindex Texinfo export, program index -@cindex #+TINDEX +@cindex @code{#+TINDEX} @cindex data type index, in Texinfo export @cindex Texinfo export, data type index -@cindex #+VINDEX +@cindex @code{#+VINDEX} @cindex variable index, in Texinfo export @cindex Texinfo export, variable index The Texinfo export back-end recognizes these indexing keywords if used in the @@ -13896,7 +13894,7 @@ escaped with @samp{@@} if they not belong to a Texinfo command. #+CINDEX: Defining indexing entries @end example -@cindex property, INDEX +@cindex property, @code{INDEX} For the back-end to generate an index entry for a headline, set the @code{:INDEX:} property to @samp{cp} or @samp{vr}. These abbreviations come from Texinfo that stand for concept index and variable index. The Texinfo @@ -13916,8 +13914,8 @@ inserts the index after its contents. Use any of the following three methods to insert or escape raw Texinfo code: -@cindex #+TEXINFO -@cindex #+BEGIN_EXPORT texinfo +@cindex @code{#+TEXINFO} +@cindex @code{#+BEGIN_EXPORT texinfo} @example Richard @@@@texinfo:@@sc@{@@@@Stallman@@@@texinfo:@}@@@@ commence' GNU. @@ -13932,10 +13930,10 @@ This paragraph is preceded by... @node Plain lists in Texinfo export @subsection Plain lists in Texinfo export -@cindex #+ATTR_TEXINFO, in plain lists +@cindex @code{#+ATTR_TEXINFO}, in plain lists @cindex Two-column tables, in Texinfo export -@cindex :table-type attribute, in Texinfo export +@cindex @code{:table-type} attribute, in Texinfo export The Texinfo export back-end by default converts description lists in the Org file using the default command @code{@@table}, which results in a table with two columns. To change this behavior, specify @code{:table-type} with @@ -13943,14 +13941,14 @@ two columns. To change this behavior, specify @code{:table-type} with @inforef{Two-column Tables,,texinfo}. @vindex org-texinfo-table-default-markup -@cindex :indic attribute, in Texinfo export +@cindex @code{:indic} attribute, in Texinfo export The Texinfo export back-end by default also applies a text highlight based on the defaults stored in @code{org-texinfo-table-default-markup}. To override the default highlight command, specify another one with the @code{:indic} attribute. @cindex Multiple entries in two-column tables, in Texinfo export -@cindex :sep attribute, in Texinfo export +@cindex @code{:sep} attribute, in Texinfo export Org syntax is limited to one entry per list item. Nevertheless, the Texinfo export back-end can split that entry according to any text provided through the @code{:sep} attribute. Each part then becomes a new entry in the first @@ -13976,7 +13974,7 @@ This is the common text for variables foo and bar. @node Tables in Texinfo export @subsection Tables in Texinfo export -@cindex #+ATTR_TEXINFO, in tables +@cindex @code{#+ATTR_TEXINFO}, in tables When exporting tables, the Texinfo export back-end uses the widest cell width in each column. To override this and instead specify as fractions of line @@ -13989,7 +13987,7 @@ length, use the @code{:columns} attribute. See example below. @node Images in Texinfo export @subsection Images in Texinfo export -@cindex #+ATTR_TEXINFO, in images +@cindex @code{#+ATTR_TEXINFO}, in images Insert a file link to the image in the Org file, and the Texinfo export back-end inserts the image. These links must have the usual supported image @@ -14004,7 +14002,7 @@ the text using Texinfo code, as shown in the example: @node Special blocks in Texinfo export @subsection Special blocks -@cindex #+ATTR_TEXINFO, in special blocks +@cindex @code{#+ATTR_TEXINFO}, in special blocks The Texinfo export back-end converts special blocks to commands with the same name. It also adds any @code{:options} attributes to the end of the command, @@ -14127,7 +14125,7 @@ configure the variable @code{org-icalendar-categories}. To assign clock alarms based on time, configure the @code{org-icalendar-alarm-time} variable. @vindex org-icalendar-store-UID -@cindex property, ID +@cindex property, @code{ID} The iCalendar format standard requires globally unique identifier---UID---for each entry. The iCalendar export back-end creates UIDs during export. To save a copy of the UID in the Org file set the variable @@ -14156,26 +14154,27 @@ and write it to @code{org-icalendar-combined-agenda-file} file name. @vindex org-use-property-inheritance @vindex org-icalendar-include-body -@cindex property, SUMMARY -@cindex property, DESCRIPTION -@cindex property, LOCATION -@cindex property, TIMEZONE -The iCalendar export back-end includes SUMMARY, DESCRIPTION, LOCATION and -TIMEZONE properties from the Org entries when exporting. To force the -back-end to inherit the LOCATION and TIMEZONE properties, configure the -@code{org-use-property-inheritance} variable. - -When Org entries do not have SUMMARY, DESCRIPTION and LOCATION properties, -the iCalendar export back-end derives the summary from the headline, and -derives the description from the body of the Org item. The -@code{org-icalendar-include-body} variable limits the maximum number of +@cindex property, @code{SUMMARY} +@cindex property, @code{DESCRIPTION} +@cindex property, @code{LOCATION} +@cindex property, @code{TIMEZONE} +The iCalendar export back-end includes @code{SUMMARY}, @code{DESCRIPTION}, +@code{LOCATION} and @code{TIMEZONE} properties from the Org entries when +exporting. To force the back-end to inherit the @code{LOCATION} and +@code{TIMEZONE} properties, configure the @code{org-use-property-inheritance} +variable. + +When Org entries do not have @code{SUMMARY}, @code{DESCRIPTION} and +@code{LOCATION} properties, the iCalendar export back-end derives the summary +from the headline, and derives the description from the body of the Org item. +The @code{org-icalendar-include-body} variable limits the maximum number of characters of the content are turned into its description. -The TIMEZONE property can be used to specify a per-entry time zone, and will -be applied to any entry with timestamp information. Time zones should be -specified as per the IANA time zone database format, e.g.@: ``Asia/Almaty''. -Alternately, the property value can be ``UTC'', to force UTC time for this -entry only. +The @code{TIMEZONE} property can be used to specify a per-entry time zone, +and will be applied to any entry with timestamp information. Time zones +should be specified as per the IANA time zone database format, e.g.@: +``Asia/Almaty''. Alternately, the property value can be ``UTC'', to force +UTC time for this entry only. Exporting to iCalendar format depends in large part on the capabilities of the destination application. Some are more lenient than others. Consult the @@ -14464,7 +14463,7 @@ and many other properties of a project. @node Project alist @subsection The variable @code{org-publish-project-alist} -@cindex org-publish-project-alist +@cindex @code{org-publish-project-alist} @cindex projects, for publishing @vindex org-publish-project-alist @@ -14920,7 +14919,7 @@ The file will be created when first publishing a project with the "theindex.inc"}. You can then build around this include statement by adding a title, style information, etc. -@cindex #+INDEX +@cindex @code{#+INDEX} Index entries are specified with @code{#+INDEX} keyword. An entry that contains an exclamation mark will create a sub item. @@ -15091,8 +15090,8 @@ such as not inside comments and fixed width areas. Here's a sample #+END_SRC @end example -Org can take the code in the block between the @samp{#+BEGIN_SRC} and -@samp{#+END_SRC} tags, and format, compile, execute, and show the results. +Org can take the code in the block between the @code{#+BEGIN_SRC} and +@code{#+END_SRC} tags, and format, compile, execute, and show the results. Org can simplify many housekeeping tasks essential to modern code maintenance. That's why these blocks in Org mode literature are sometimes referred to as @samp{live code} blocks (as compared to the static text and @@ -15101,7 +15100,7 @@ block by tweaking the headers for compiling, execution, extraction. Org's @samp{src} code block type is one of many block types, such as quote, export, verse, latex, example, and verbatim. This section pertains to -@samp{src} code blocks between @samp{#+BEGIN_SRC} and @samp{#+END_SRC} +@code{src} code blocks between @code{#+BEGIN_SRC} and @code{#+END_SRC} For editing @samp{src} code blocks, Org provides native Emacs major-modes. That leverages the latest Emacs features for that source code language mode. @@ -15163,8 +15162,8 @@ Details of Org's facilities for working with source code are shown next. @section Structure of code blocks @cindex code block, structure @cindex source code, block structure -@cindex #+NAME -@cindex #+BEGIN_SRC +@cindex @code{#+NAME} +@cindex @code{#+BEGIN_SRC} Org offers two ways to structure source code in Org documents: in a @samp{src} block, and directly inline. Both specifications are shown below. @@ -15206,7 +15205,7 @@ results. Code from other blocks, other files, and from table formulas (@pxref{The spreadsheet}) can use the name to reference a @samp{src} block. This naming serves the same purpose as naming Org tables. Org mode requires unique names. For duplicate names, Org mode's behavior is undefined. -@cindex #+NAME +@cindex @code{#+NAME} @item #+BEGIN_SRC @item #+END_SRC Mandatory. They mark the start and end of a block that Org requires. The @@ -15417,7 +15416,7 @@ block header arguments: One, set @code{padline} (@pxref{padline}) to true @section Evaluating code blocks @cindex code block, evaluating @cindex source code, evaluating -@cindex #+RESULTS +@cindex @code{#+RESULTS} A note about security: With code evaluation comes the risk of harm. Org safeguards by prompting for user's permission before executing any code in @@ -15440,7 +15439,7 @@ evaluation from the @kbd{C-c C-c} key binding.} calls the @code{org-babel-execute-src-block} function, which executes the code in the block, collects the results, and inserts them in the buffer. -@cindex #+CALL +@cindex @code{#+CALL} By calling a named code block@footnote{Actually, the constructs call_<name>() and src_<lang>@{@} are not evaluated when they appear in a keyword line (i.e. lines starting with @code{#+KEYWORD:}, @pxref{In-buffer settings}).} @@ -15723,7 +15722,7 @@ each line. Note that Org currently accepts the plural spelling of @code{#+HEADER:} only as a convenience for backward-compatibility. It may be removed at some point. -@cindex #+HEADER: +@cindex @code{#+HEADER:} Multi-line header arguments on an unnamed @samp{src} code block: @@ -17243,7 +17242,7 @@ emacs -Q --batch --eval " * Speed keys:: Electric commands at the beginning of a headline * Code evaluation security:: Org mode files evaluate inline code * Customization:: Adapting Org to changing tastes -* In-buffer settings:: Overview of the #+KEYWORDS +* In-buffer settings:: Overview of the @code{#+KEYWORDS} * The very busy C-c C-c key:: When in doubt, press C-c C-c * Clean view:: Getting rid of leading stars in the outline * TTY keys:: Using Org on a tty @@ -17291,7 +17290,7 @@ can be used in search links like @samp{[[*find this headline]]}. @item After @samp{:} in a headline, complete tags. The list of tags is taken from the variable @code{org-tag-alist} (possibly set through the -@samp{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created +@code{#+TAGS} in-buffer option, @pxref{Setting tags}), or it is created dynamically from all tags used in the current buffer. @item After @samp{:} and not in a headline, complete property keys. The list @@ -17304,7 +17303,7 @@ After @samp{#+}, complete the special keywords like @samp{TYP_TODO} or file-specific @samp{OPTIONS}. After option keyword is complete, pressing @kbd{M-@key{TAB}} again will insert example settings for that option. @item -After @samp{#+STARTUP: }, complete startup keywords. +After @code{#+STARTUP:}, complete startup keywords. @item When the point is anywhere else, complete dictionary words using Ispell. @end itemize @@ -17468,13 +17467,13 @@ reopening the Org file in Emacs also activates the changes. @table @kbd @item #+ARCHIVE: %s_done:: Sets the archive location of the agenda file. This location applies to the -lines until the next @samp{#+ARCHIVE} line, if any, in the Org file. The +lines until the next @code{#+ARCHIVE} line, if any, in the Org file. The first archive location in the Org file also applies to any entries before it. The corresponding variable is @code{org-archive-location}. @item #+CATEGORY: Sets the category of the agenda file, which applies to the entire document. @item #+COLUMNS: %25ITEM ... -@cindex property, COLUMNS +@cindex property, @code{COLUMNS} Sets the default format for columns view. Org uses this format for column views where there is no @code{COLUMNS} property. @item #+CONSTANTS: name1=value1 ... @@ -17501,7 +17500,7 @@ have a lower ASCII number than the lowest priority. @item #+PROPERTY: Property_Name Value This line sets a default inheritance value for entries in the current buffer, most useful for specifying the allowed values of a property. -@cindex #+SETUPFILE +@cindex @code{#+SETUPFILE} @item #+SETUPFILE: file or URL The setup file or a URL pointing to such file is for additional in-buffer settings. Org loads this file and parses it for any settings in it only when @@ -17513,7 +17512,7 @@ parses the contents of this document as if it was included in the buffer. It can be another Org file. To visit the file (not a URL), @kbd{C-c '} while the cursor is on the line with the file name. @item #+STARTUP: -@cindex #+STARTUP +@cindex @code{#+STARTUP} Startup options Org uses when first visiting a file. The first set of options deals with the initial visibility of the outline @@ -17694,7 +17693,7 @@ fnadjust @r{automatically renumber and sort footnotes} nofnadjust @r{do not renumber and sort automatically} @end example -@cindex org-hide-block-startup +@cindex @code{org-hide-block-startup} To hide blocks on startup, use these keywords. The corresponding variable is @code{org-hide-block-startup}. @cindex @code{hideblocks}, STARTUP keyword @@ -17704,7 +17703,7 @@ hideblocks @r{Hide all begin/end blocks on startup} nohideblocks @r{Do not hide blocks on startup} @end example -@cindex org-pretty-entities +@cindex @code{org-pretty-entities} The display of entities as UTF-8 characters is governed by the variable @code{org-pretty-entities} and the keywords @cindex @code{entitiespretty}, STARTUP keyword @@ -17719,11 +17718,11 @@ entitiesplain @r{Leave entities plain} These lines specify valid tags for this file. Org accepts multiple tags lines. Tags could correspond to the @emph{fast tag selection} keys. The corresponding variable is @code{org-tag-alist}. -@cindex #+TBLFM +@cindex @code{#+TBLFM} @item #+TBLFM: This line is for formulas for the table directly above. A table can have -multiple @samp{#+TBLFM:} lines. On table recalculation, Org applies only the -first @samp{#+TBLFM:} line. For details see @ref{Using multiple #+TBLFM +multiple @code{#+TBLFM:} lines. On table recalculation, Org applies only the +first @code{#+TBLFM:} line. For details see @ref{Using multiple #+TBLFM lines} in @ref{Editing and debugging formulas}. @item #+TITLE:, #+AUTHOR:, #+EMAIL:, #+LANGUAGE:, #+DATE:, @itemx #+OPTIONS:, #+BIND:, @@ -17739,7 +17738,7 @@ The corresponding variable is @code{org-todo-keywords}. @node The very busy C-c C-c key @section The very busy C-c C-c key @kindex C-c C-c -@cindex C-c C-c, overview +@cindex @kbd{C-c C-c}, overview The @kbd{C-c C-c} key in Org serves many purposes depending on the context. It is probably the most over-worked, multi-purpose key combination in Org. @@ -18418,7 +18417,7 @@ the mode is C, then: At the location of source, Org needs a special line to direct Orgtbl to translate and to find the target for inserting the translated table. For example: -@cindex #+ORGTBL +@cindex @code{#+ORGTBL} @example #+ORGTBL: SEND table_name translation_function arguments... @end example @@ -18472,7 +18471,7 @@ install templates for other export formats.} with the command @kbd{M-x orgtbl-insert-radio-table RET}, which prompts for a table name. For example, if @samp{salesfigures} is the name, the template inserts: -@cindex #+ORGTBL, SEND +@cindex @code{#+ORGTBL}, @samp{SEND} @example % BEGIN RECEIVE ORGTBL salesfigures % END RECEIVE ORGTBL salesfigures @@ -18488,7 +18487,7 @@ The line @code{#+ORGTBL: SEND} tells Orgtbl mode to use the function @code{orgtbl-to-latex} to convert the table to @LaTeX{} format, then insert the table at the target (receive) location named @code{salesfigures}. Now the table is ready for data entry. It can even use spreadsheet -features@footnote{If the @samp{#+TBLFM} line contains an odd number of dollar +features@footnote{If the @code{#+TBLFM} line contains an odd number of dollar characters, this may cause problems with font-lock in @LaTeX{} mode. As shown in the example you can fix this by adding an extra line inside the @code{comment} environment that is used to balance the dollar expressions. @@ -18619,14 +18618,14 @@ translator functions by posting them to the Org users mailing list, @node Radio lists @subsection Radio lists @cindex radio lists -@cindex org-list-insert-radio-list +@cindex @code{org-list-insert-radio-list} Call the @code{org-list-insert-radio-list} function to insert a radio list template in HTML, @LaTeX{}, and Texinfo mode documents. Sending and receiving radio lists works is the same as for radio tables (@pxref{Radio tables}) except for these differences: -@cindex #+ORGLST +@cindex @code{#+ORGLST} @itemize @minus @item Orgstruct mode must be active. @@ -18670,7 +18669,7 @@ time}). Dynamic blocks can have names and function parameters. The syntax is similar to @samp{src} code block specifications: -@cindex #+BEGIN:dynamic block +@cindex @code{#+BEGIN}, dynamic block @example #+BEGIN: myblock :parameter1 value1 :parameter2 value2 ... @@ -18932,7 +18931,7 @@ priority-n @r{The computed numerical priority} @noindent If the selection of the agenda item was based on a timestamp, including those -items with @samp{DEADLINE} and @samp{SCHEDULED} keywords, then Org includes +items with @code{DEADLINE} and @code{SCHEDULED} keywords, then Org includes date and time in the output. If the selection of the agenda item was based on a timestamp (or |