[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] emacs-26 e415309 2/4: Fix @cindex entries in org.texi
|
From: |
Michael Albinus |
|
Subject: |
[Emacs-diffs] emacs-26 e415309 2/4: Fix @cindex entries in org.texi |
|
Date: |
Sat, 24 Feb 2018 14:52:35 -0500 (EST) |
branch: emacs-26
commit e415309fef4077fe7e4dfe1a898d749c1136ca2c
Author: Michael Albinus <address@hidden>
Commit: Michael Albinus <address@hidden>
Fix @cindex entries in org.texi
* doc/misc/org.texi: Fix @cindex entries. Use consistently
@code{} for keywords.
---
doc/misc/org.texi | 657 +++++++++++++++++++++++++++---------------------------
1 file changed, 328 insertions(+), 329 deletions(-)
diff --git a/doc/misc/org.texi b/doc/misc/org.texi
index b187bfc..19c83f6 100644
--- a/doc/misc/org.texi
+++ b/doc/misc/org.texi
@@ -1342,9 +1342,9 @@ following lines anywhere in the buffer:
#+STARTUP: showeverything
@end example
address@hidden property, VISIBILITY
address@hidden 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}.
@@ -1352,7 +1352,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
@@ -1819,7 +1819,7 @@ or by a custom function.
@cindex drawers
@cindex visibility cycling, drawers
address@hidden org-insert-drawer
address@hidden @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
@@ -2567,7 +2567,7 @@ rows/columns.
@cindex references, named
@cindex name, of column or field
@cindex constants, in calculations
address@hidden #+CONSTANTS
address@hidden @code{#+CONSTANTS}
@vindex org-table-formula-constants
@samp{$name} is interpreted as the name of a column, parameter or
@@ -2604,7 +2604,7 @@ numbers.
@cindex references, to a different table
@cindex name, of column or field
@cindex constants, in calculations
address@hidden #+NAME, for table
address@hidden @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
@@ -2826,8 +2826,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.
address@hidden #+TBLFM
-Formulas are stored in a special line starting with @samp{#+TBLFM:} directly
address@hidden @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,
@@ -2845,7 +2845,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
@@ -2892,7 +2892,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
address@hidden:} line, column formulas will look like @samp{$4=$1+$2}. The
address@hidden:} 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{$>}.
@@ -2903,7 +2903,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
@@ -3039,25 +3039,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}
address@hidden Using multiple #+TBLFM lines
address@hidden #+TBLFM line, multiple
address@hidden #+TBLFM
address@hidden #+TBLFM, switching
address@hidden Using multiple @code{#+TBLFM} lines
address@hidden @code{#+TBLFM} line, multiple
address@hidden @code{#+TBLFM}
address@hidden @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:
@@ -3084,7 +3084,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 |
@@ -3251,7 +3251,7 @@ functions.
@section Org-Plot
@cindex graph, in tables
@cindex plot tables using Gnuplot
address@hidden #+PLOT
address@hidden @code{#+PLOT}
Org-Plot can produce graphs of information stored in org tables, either
graphically or in ASCII-art.
@@ -3434,7 +3434,7 @@ internal structure of all links, use the menu entry
@cindex links, internal
@cindex targets, for links
address@hidden property, CUSTOM_ID
address@hidden 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
@@ -3450,7 +3450,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>>}.
address@hidden #+NAME
address@hidden @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
@@ -3642,8 +3642,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
address@hidden property, CUSTOM_ID
address@hidden property, ID
address@hidden property, @code{CUSTOM_ID}
address@hidden 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
@@ -3885,7 +3885,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
address@hidden #+LINK
address@hidden @code{#+LINK}
@example
#+LINK: bugzilla http://10.1.2.9/bugzilla/show_bug.cgi?id=
#+LINK: google http://www.google.com/search?q=%s
@@ -4243,9 +4243,9 @@ unique keys across both sets of keywords.}
@subsection Setting up keywords for individual files
@cindex keyword options
@cindex per-file keywords
address@hidden #+TODO
address@hidden #+TYP_TODO
address@hidden #+SEQ_TODO
address@hidden @code{#+TODO}
address@hidden @code{#+TYP_TODO}
address@hidden @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
@@ -4320,7 +4320,7 @@ foreground or a background color.
@cindex TODO dependencies, NOBLOCKING
@vindex org-enforce-todo-dependencies
address@hidden property, ORDERED
address@hidden 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 address@hidden And
sometimes
@@ -4359,7 +4359,7 @@ property:
@table @kbd
@orgcmd{C-c C-x o,org-toggle-ordered-property}
@vindex org-track-ordered-property-with-tag
address@hidden property, ORDERED
address@hidden 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
@@ -4441,7 +4441,7 @@ the entry with a @samp{Closing Note} heading.
@vindex org-log-states-order-reversed
@vindex org-log-into-drawer
address@hidden property, LOG_INTO_DRAWER
address@hidden 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
@@ -4495,12 +4495,12 @@ to a buffer:
#+TODO: TODO(t) WAIT(w@@/!) | DONE(d!) CANCELED(c@@)
@end example
address@hidden 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
address@hidden or @code{logrepeat}, as well as adding state specific
address@hidden 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
address@hidden 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
@@ -4671,7 +4671,7 @@ these values (highest, lowest, default) like this (please
make sure that
the highest priority is earlier in the alphabet than the lowest
priority):
address@hidden #+PRIORITIES
address@hidden @code{#+PRIORITIES}
@example
#+PRIORITIES: A C B
@end example
@@ -4700,7 +4700,7 @@ be updated each time the TODO status of a child changes,
or when pressing
** DONE Talk to neighbor
@end example
address@hidden property, COOKIE_DATA
address@hidden 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
@@ -4772,7 +4772,7 @@ checked.
@cindex statistics, for checkboxes
@cindex checkbox statistics
address@hidden property, COOKIE_DATA
address@hidden 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,
@@ -4794,7 +4794,7 @@ to either @samp{checkbox} or @samp{todo} to resolve this
issue.
@cindex blocking, of checkboxes
@cindex checkbox blocking
address@hidden property, ORDERED
address@hidden 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.
@@ -4831,7 +4831,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
address@hidden property, ORDERED
address@hidden 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.
@@ -4899,7 +4899,7 @@ a hypothetical level zero that surrounds the entire file.
Use a line like
address@hidden with all these in-buffer settings, pressing @kbd{C-c C-c}
activates any changes in the line.}:
address@hidden #+FILETAGS
address@hidden @code{#+FILETAGS}
@example
#+FILETAGS: :Peter:Boss:Secret:
@end example
@@ -4961,7 +4961,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
address@hidden #+TAGS
address@hidden @code{#+TAGS}
@example
#+TAGS: @@work @@home @@tennisclub
#+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,
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
@@ -5330,8 +5330,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
address@hidden property, _ALL
address@hidden #+PROPERTY
address@hidden property, @code{_ALL}
address@hidden @code{#+PROPERTY}
@example
#+PROPERTY: NDisks_ALL 1 2 3 4
@end example
@@ -5342,7 +5342,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''.
address@hidden property, +
address@hidden property, @code{+}
@example
#+PROPERTY: var foo=1
#+PROPERTY: var+ bar=2
@@ -5351,7 +5351,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.
address@hidden property, +
address@hidden property, @code{+}
@example
* CD collection
** Classic
@@ -5386,7 +5386,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
address@hidden org-insert-drawer
address@hidden @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.
@@ -5417,20 +5417,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:
address@hidden property, special, ALLTAGS
address@hidden property, special, BLOCKED
address@hidden property, special, CLOCKSUM
address@hidden property, special, CLOCKSUM_T
address@hidden property, special, CLOSED
address@hidden property, special, DEADLINE
address@hidden property, special, FILE
address@hidden property, special, ITEM
address@hidden property, special, PRIORITY
address@hidden property, special, SCHEDULED
address@hidden property, special, TAGS
address@hidden property, special, TIMESTAMP
address@hidden property, special, TIMESTAMP_IA
address@hidden property, special, TODO
address@hidden property, special, @code{ALLTAGS}
address@hidden property, special, @code{BLOCKED}
address@hidden property, special, @code{CLOCKSUM}
address@hidden property, special, @code{CLOCKSUM_T}
address@hidden property, special, @code{CLOSED}
address@hidden property, special, @code{DEADLINE}
address@hidden property, special, @code{FILE}
address@hidden property, special, @code{ITEM}
address@hidden property, special, @code{PRIORITY}
address@hidden property, special, @code{SCHEDULED}
address@hidden property, special, @code{TAGS}
address@hidden property, special, @code{TIMESTAMP}
address@hidden property, special, @code{TIMESTAMP_IA}
address@hidden property, special, @code{TODO}
@example
ALLTAGS @r{All tags, including inherited ones.}
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}.
Org mode has a few properties for which inheritance is hard-coded, at
least for the special applications for which they are used:
address@hidden property, COLUMNS
address@hidden property, @code{COLUMNS}
@table @code
@item COLUMNS
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
point for a column view table, independently of the location in the
subtree from where columns view is turned on.
@item CATEGORY
address@hidden property, CATEGORY
address@hidden property, @code{CATEGORY}
For agenda view, a category set through a @code{:CATEGORY:} property
applies to the entire subtree.
@item ARCHIVE
address@hidden property, ARCHIVE
address@hidden property, @code{ARCHIVE}
For archiving, the @code{:ARCHIVE:} property may define the archive
location for the entire subtree (@pxref{Moving subtrees}).
@item LOGGING
address@hidden property, LOGGING
-The LOGGING property may define logging settings for an entry or a
address@hidden property, @code{LOGGING}
+The @code{LOGGING} property may define logging settings for an entry or a
subtree (@pxref{Tracking TODO state changes}).
@end table
@@ -5573,7 +5573,7 @@ done by defining a column format line.
To define a column format for an entire file, use a line like
address@hidden #+COLUMNS
address@hidden @code{#+COLUMNS}
@example
#+COLUMNS: %25ITEM %TAGS %PRIORITY %TODO
@end example
@@ -5768,7 +5768,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:
address@hidden #+BEGIN, columnview
address@hidden @code{#+BEGIN}, columnview
@example
* The column view
#+BEGIN: columnview :hlines 1 :id "label"
@@ -5784,7 +5784,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:
address@hidden property, ID
address@hidden 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}
@@ -5792,7 +5792,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}
- @address@hidden org-id-copy RET} to create a globally unique ID for}
+ @address@hidden 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
@@ -5816,7 +5816,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}
@@ -6224,7 +6224,7 @@ they refer to.
@table @var
@item DEADLINE
address@hidden DEADLINE keyword
address@hidden @code{DEADLINE} keyword
Meaning: the task (most likely a TODO item, though not necessarily) is supposed
to be finished on that date.
@@ -6250,7 +6250,7 @@ deactivated if the task gets scheduled and you set
@code{org-agenda-skip-deadline-prewarning-if-scheduled} to @code{t}.
@item SCHEDULED
address@hidden SCHEDULED keyword
address@hidden @code{SCHEDULED} keyword
Meaning: you are planning to start working on that task on the given
date.
@@ -6315,7 +6315,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
@address@hidden corresponding @code{#+STARTUP}
@@ -6324,7 +6324,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
@address@hidden corresponding @code{#+STARTUP}
@@ -6358,8 +6358,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
@@ -6376,18 +6376,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 address@hidden 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 address@hidden 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
@@ -6493,22 +6493,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
address@hidden 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
address@hidden:LOGBOOK:} drawer (see also the variable
address@hidden). You can also overrule
-the setting of this variable for a subtree by setting a
address@hidden 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 address@hidden
address@hidden property: CLOCK_MODELINE_TOTAL
address@hidden property: LAST_REPEAT
address@hidden property, @code{LOG_INTO_DRAWER}
+!Start the clock on the current item (clock-in). This inserts the
address@hidden 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
address@hidden: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
address@hidden 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
address@hidden C-u C-u} prefixes, force continuous clocking by starting the
clock
+when the last clock address@hidden
address@hidden property, @code{CLOCK_MODELINE_TOTAL}
address@hidden 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
@@ -6617,7 +6616,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:
address@hidden #+BEGIN, clocktable
address@hidden @code{#+BEGIN}, clocktable
@example
#+BEGIN: clocktable :maxlevel 2 :emphasize nil :scope file
#+END: clocktable
@@ -6693,8 +6692,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},}
+ @address@hidden, @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.}
@@ -6825,7 +6824,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
address@hidden property, Effort
address@hidden 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
@@ -7043,7 +7042,7 @@ Visit the last stored capture item in its buffer.
@end table
@vindex org-capture-bookmark
address@hidden org-capture-last-stored
address@hidden @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}.
@@ -7464,12 +7463,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}
address@hidden property, ATTACH_DIR
address@hidden 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}
address@hidden property, ATTACH_DIR_INHERIT
address@hidden 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
@@ -7643,14 +7642,14 @@
javascript:location.href='org-protocol://open-source?&url='+
encodeURIComponent(location.href)
@end example
address@hidden protocol, open-source, :base-url property
address@hidden :base-url property in open-source protocol
address@hidden protocol, open-source, :working-directory property
address@hidden :working-directory property in open-source protocol
address@hidden protocol, open-source, :online-suffix property
address@hidden :online-suffix property in open-source protocol
address@hidden protocol, open-source, :working-suffix property
address@hidden :working-suffix property in open-source protocol
address@hidden protocol, open-source, @code{:base-url} property
address@hidden @code{:base-url} property in open-source protocol
address@hidden protocol, open-source, @code{:working-directory} property
address@hidden @code{:working-directory} property in open-source protocol
address@hidden protocol, open-source, @code{:online-suffix} property
address@hidden @code{:online-suffix} property in open-source protocol
address@hidden protocol, open-source, @code{:working-suffix} property
address@hidden @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}
@@ -7687,8 +7686,8 @@ to something like
@code{open-source} handler probably cannot find a file named
@file{/home/user/example/print/posters.html.php} and fails.
address@hidden protocol, open-source, :rewrites property
address@hidden :rewrites property in open-source protocol
address@hidden protocol, open-source, @code{:rewrites} property
address@hidden @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
@@ -7839,12 +7838,12 @@ see the documentation string of the variable
There is also an in-buffer option for setting this variable, for example:
address@hidden #+ARCHIVE
address@hidden @code{#+ARCHIVE}
@example
#+ARCHIVE: %s_done::
@end example
address@hidden property, ARCHIVE
address@hidden 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
@@ -8152,7 +8151,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
address@hidden org-agenda, command
address@hidden @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 address@hidden backward
@@ -8639,7 +8638,7 @@ associated with the item.
@subsection Categories
@cindex category
address@hidden #+CATEGORY
address@hidden @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:
@@ -8649,8 +8648,8 @@ with a special line in the buffer, like this:
@end example
@noindent
address@hidden property, CATEGORY
-If you would like to have a special CATEGORY for a single entry or a
address@hidden 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.
@@ -9862,7 +9861,7 @@ does not have a specific format---defined in a property,
or in its file---it
uses @code{org-columns-default-format}.
@item
address@hidden property, special, CLOCKSUM
address@hidden 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
@@ -9886,7 +9885,7 @@ clocked time in the displayed period use clock table mode
(press @kbd{R} in
the agenda).
@item
address@hidden property, special, CLOCKSUM_T
address@hidden 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
@@ -9926,7 +9925,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.
address@hidden #+BEGIN_VERSE
address@hidden @code{#+BEGIN_VERSE}
@cindex verse blocks
@example
#+BEGIN_VERSE
@@ -9942,7 +9941,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:
address@hidden #+BEGIN_QUOTE
address@hidden @code{#+BEGIN_QUOTE}
@cindex quote blocks
@example
#+BEGIN_QUOTE
@@ -9952,7 +9951,7 @@ but not any simpler -- Albert Einstein
@end example
If you would like to center some text, do it like this:
address@hidden #+BEGIN_CENTER
address@hidden @code{#+BEGIN_CENTER}
@cindex center blocks
@example
#+BEGIN_CENTER
@@ -9996,8 +9995,8 @@ a horizontal line.
@section Images and Tables
@cindex tables, markup rules
address@hidden #+CAPTION
address@hidden #+NAME
address@hidden @code{#+CAPTION}
address@hidden @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
@@ -10048,7 +10047,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.
address@hidden #+BEGIN_EXAMPLE
address@hidden @code{#+BEGIN_EXAMPLE}
@example
#+BEGIN_EXAMPLE
@@ -10087,7 +10086,7 @@ address@hidden 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.
address@hidden #+BEGIN_SRC
address@hidden @code{#+BEGIN_SRC}
@example
#+BEGIN_SRC emacs-lisp
@@ -10602,7 +10601,7 @@ Org document by adjusting outline visibility settings.
@section Export settings
@cindex Export, settings
address@hidden #+OPTIONS
address@hidden @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
@@ -10610,7 +10609,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.
address@hidden #+SETUPFILE
address@hidden @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
@@ -10626,29 +10625,29 @@ variables, include:
@table @samp
@item AUTHOR
address@hidden #+AUTHOR
address@hidden @code{#+AUTHOR}
@vindex user-full-name
The document author (@code{user-full-name}).
@item CREATOR
address@hidden #+CREATOR
address@hidden @code{#+CREATOR}
@vindex org-export-creator-string
Entity responsible for output generation (@code{org-export-creator-string}).
@item DATE
address@hidden #+DATE
address@hidden @code{#+DATE}
@vindex org-export-date-timestamp-format
A date or a address@hidden variable
@code{org-export-date-timestamp-format} defines how this time-stamp will be
exported.}.
@item EMAIL
address@hidden #+EMAIL
address@hidden @code{#+EMAIL}
@vindex user-mail-address
The email address (@code{user-mail-address}).
@item LANGUAGE
address@hidden #+LANGUAGE
address@hidden @code{#+LANGUAGE}
@vindex org-export-default-language
Language to use for translating certain strings
(@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
des matières}.
@item SELECT_TAGS
address@hidden #+SELECT_TAGS
address@hidden @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
@@ -10665,7 +10664,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
address@hidden #+EXCLUDE_TAGS
address@hidden @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
@@ -10675,12 +10674,12 @@ unconditionally excluded from the export, even if
they have an
code blocks contained in them.
@item TITLE
address@hidden #+TITLE
address@hidden @code{#+TITLE}
@cindex document title
Org displays this title. For long titles, use multiple @code{#+TITLE} lines.
@item EXPORT_FILE_NAME
address@hidden #+EXPORT_FILE_NAME
address@hidden @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.
@@ -10786,7 +10785,7 @@ Toggle inclusion of inlinetasks
(@code{org-export-with-inlinetasks}).
@item num:
@vindex org-export-with-section-numbers
address@hidden property, UNNUMBERED
address@hidden 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 address@hidden disables numbering of
@@ -10862,7 +10861,7 @@ respectively, @samp{EXPORT_DATE} and
@samp{EXPORT_FILE_NAME}. Except for
@samp{SETUPFILE}, all other keywords listed above have an @samp{EXPORT_}
equivalent.
address@hidden #+BIND
address@hidden @code{#+BIND}
@vindex org-export-allow-bind-keywords
If @code{org-export-allow-bind-keywords} is address@hidden, Emacs variables
can become buffer-local during export by using the BIND keyword. Its syntax
@@ -10875,7 +10874,7 @@ settings that cannot be changed using keywords.
@cindex list of tables
@cindex list of listings
address@hidden #+TOC
address@hidden @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
@@ -10921,7 +10920,7 @@ with captions.
#+TOC: tables @r{build a list of tables}
@end example
address@hidden property, ALT_TITLE
address@hidden 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.
@@ -10931,7 +10930,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:
address@hidden #+INCLUDE
address@hidden @code{#+INCLUDE}
@example
#+INCLUDE: "~/.emacs" src emacs-lisp
@@ -11003,7 +11002,7 @@ Visit the include file at point.
@node Macro replacement
@section Macro replacement
@cindex macro replacement, during export
address@hidden #+MACRO
address@hidden @code{#+MACRO}
@vindex org-export-global-macros
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
@samp{#} and a whitespace are treated as comments and, as such, are not
exported.
address@hidden #+BEGIN_COMMENT
-Likewise, regions surrounded by @samp{#+BEGIN_COMMENT}
-... @samp{#+END_COMMENT} are not exported.
address@hidden @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
@@ -11153,7 +11152,7 @@ settings}).
@table @samp
@item SUBTITLE
address@hidden #+SUBTITLE (ASCII)
address@hidden @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.
@@ -11170,8 +11169,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:
address@hidden #+ASCII
address@hidden #+BEGIN_EXPORT ascii
address@hidden @code{#+ASCII}
address@hidden @code{#+BEGIN_EXPORT ascii}
@example
Inline text @@@@ascii:and additional text@@@@ within a paragraph.
@@ -11183,7 +11182,7 @@ Org exports text in this block only when using ASCII
back-end.
@end example
@subheading ASCII specific attributes
address@hidden #+ATTR_ASCII
address@hidden @code{#+ATTR_ASCII}
@cindex horizontal rules, in ASCII export
ASCII back-end recognizes only one attribute, @code{:width}, which specifies
@@ -11197,8 +11196,8 @@ syntax for specifying widths is:
@subheading ASCII special blocks
@cindex special blocks, in ASCII export
address@hidden #+BEGIN_JUSTIFYLEFT
address@hidden #+BEGIN_JUSTIFYRIGHT
address@hidden @code{#+BEGIN_JUSTIFYLEFT}
address@hidden @code{#+BEGIN_JUSTIFYRIGHT}
Besides @code{#+BEGIN_CENTER} blocks (@pxref{Paragraphs}), ASCII back-end has
these two left and right justification blocks:
@@ -11256,7 +11255,7 @@ output. These keywords work similar to the general
options settings
@table @samp
@item BEAMER_THEME
address@hidden #+BEAMER_THEME
address@hidden @code{#+BEAMER_THEME}
@vindex org-beamer-theme
The Beamer layout theme (@code{org-beamer-theme}). Use square brackets for
options. For example:
@@ -11265,24 +11264,24 @@ options. For example:
@end smallexample
@item BEAMER_FONT_THEME
address@hidden #+BEAMER_FONT_THEME
address@hidden @code{#+BEAMER_FONT_THEME}
The Beamer font theme.
@item BEAMER_INNER_THEME
address@hidden #+BEAMER_INNER_THEME
address@hidden @code{#+BEAMER_INNER_THEME}
The Beamer inner theme.
@item BEAMER_OUTER_THEME
address@hidden #+BEAMER_OUTER_THEME
address@hidden @code{#+BEAMER_OUTER_THEME}
The Beamer outer theme.
@item BEAMER_HEADER
address@hidden #+BEAMER_HEADER
address@hidden @code{#+BEAMER_HEADER}
Arbitrary lines inserted in the preamble, just before the @samp{hyperref}
settings.
@item DESCRIPTION
address@hidden #+DESCRIPTION (Beamer)
address@hidden @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
@@ -11290,7 +11289,7 @@ configure document metadata. Use
@code{org-latex-title-command} to configure
typesetting of description as part of front matter.
@item KEYWORDS
address@hidden #+KEYWORDS (Beamer)
address@hidden @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
@@ -11298,7 +11297,7 @@ configure document metadata. Use
@code{org-latex-title-command} to configure
typesetting of keywords as part of front matter.
@item SUBTITLE
address@hidden #+SUBTITLE (Beamer)
address@hidden @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
@@ -11320,7 +11319,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}).
address@hidden property, BEAMER_ENV
address@hidden 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
@@ -11339,7 +11338,7 @@ aid and has no semantic relevance.}. For valid values
see
@code{org-beamer-environments-extra}.
@item
address@hidden property, BEAMER_REF
address@hidden 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
@@ -11353,8 +11352,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
address@hidden property, BEAMER_ACT
address@hidden property, BEAMER_OPT
address@hidden property, @code{BEAMER_ACT}
address@hidden 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
@@ -11363,7 +11362,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.
address@hidden property, BEAMER_COL
address@hidden 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
@@ -11378,8 +11377,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:}. @address@hidden export}, for details.
+it recognizes other @LaTeX{} specific syntax---for example, @code{#+LATEX:}
+or @code{#+ATTR_LATEX:}. @address@hidden 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
@@ -11392,8 +11391,8 @@ contents}). Use square brackets for specifying options.
Insert Beamer-specific code using the following constructs:
address@hidden #+BEAMER
address@hidden #+BEGIN_EXPORT beamer
address@hidden @code{#+BEAMER}
address@hidden @code{#+BEGIN_EXPORT beamer}
@example
#+BEAMER: \pause
@@ -11414,7 +11413,7 @@ this example:
A *@@@@beamer:<2->@@@@useful* feature
@end example
address@hidden #+ATTR_BEAMER
address@hidden @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
@@ -11538,66 +11537,66 @@ described in @ref{Export settings}.
@table @samp
@item DESCRIPTION
address@hidden #+DESCRIPTION (HTML)
address@hidden @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
address@hidden #+HTML_DOCTYPE
address@hidden @code{#+HTML_DOCTYPE}
@vindex org-html-doctype
Specify the document type, for example: HTML5 (@code{org-html-doctype}).
@item HTML_CONTAINER
address@hidden #+HTML_CONTAINER
address@hidden @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
address@hidden #+HTML_LINK_HOME
address@hidden @code{#+HTML_LINK_HOME}
@vindex org-html-link-home
The URL for home link (@code{org-html-link-home}).
@item HTML_LINK_UP
address@hidden #+HTML_LINK_UP
address@hidden @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
address@hidden #+HTML_MATHJAX
address@hidden @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
address@hidden #+HTML_HEAD
address@hidden @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
address@hidden #+HTML_HEAD_EXTRA
address@hidden @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
address@hidden #+KEYWORDS (HTML)
address@hidden @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
address@hidden #+LATEX_HEADER (HTML)
address@hidden @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
address@hidden #+SUBTITLE (HTML)
address@hidden @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
@@ -11731,14 +11730,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:
address@hidden #+HTML
address@hidden #+BEGIN_EXPORT html
address@hidden @code{#+HTML}
@example
#+HTML: Literal HTML code for export
@end example
@noindent or
address@hidden #+BEGIN_EXPORT html
address@hidden @code{#+BEGIN_EXPORT html}
@example
#+BEGIN_EXPORT html
@@ -11775,7 +11773,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}:
address@hidden #+ATTR_HTML
address@hidden @code{#+ATTR_HTML}
@example
#+ATTR_HTML: :title The Org mode homepage :style color:red;
[[http://orgmode.org]]
@@ -11791,8 +11789,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:
address@hidden #+CAPTION
address@hidden #+ATTR_HTML
address@hidden @code{#+CAPTION}
address@hidden @code{#+ATTR_HTML}
@example
#+CAPTION: This is a table with lines around and between cells
#+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
@code{title} attributes in support of text viewers and modern web accessibility
standards.
address@hidden #+CAPTION
address@hidden #+ATTR_HTML
address@hidden @code{#+CAPTION}
address@hidden @code{#+ATTR_HTML}
@example
#+CAPTION: A black cat stalking a spider
#+ATTR_HTML: :alt cat/spider image :title Action! :align right
@@ -11975,7 +11973,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 "_"}
@@ -12003,14 +12001,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
address@hidden #+HTML_INCLUDE_STYLE
address@hidden @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.
address@hidden #+HTML_HEAD
address@hidden #+HTML_HEAD_EXTRA
address@hidden @code{#+HTML_HEAD}
address@hidden @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" />
@@ -12060,7 +12058,7 @@ it on your own web server.
To use this program, just add this line to the Org file:
address@hidden #+INFOJS_OPT
address@hidden @code{#+INFOJS_OPT}
@example
#+INFOJS_OPT: view:info toc:nil
@end example
@@ -12181,7 +12179,7 @@ The @LaTeX{} export back-end has several additional
keywords for customizing
@table @samp
@item DESCRIPTION
address@hidden #+DESCRIPTION (@LaTeX{})
address@hidden @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
@@ -12190,7 +12188,7 @@ typesetting description into the document's front
matter. Use multiple
@code{#+DESCRIPTION} lines for long descriptions.
@item LATEX_CLASS
address@hidden #+LATEX_CLASS
address@hidden @code{#+LATEX_CLASS}
@vindex org-latex-default-class
@vindex org-latex-classes
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
element of @code{org-latex-classes}.
@item LATEX_CLASS_OPTIONS
address@hidden #+LATEX_CLASS_OPTIONS
address@hidden @code{#+LATEX_CLASS_OPTIONS}
Options the @LaTeX{} export back-end uses when calling the @LaTeX{} document
class.
@item LATEX_COMPILER
address@hidden #+LATEX_COMPILER
address@hidden @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
address@hidden #+LATEX_HEADER
address@hidden @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
address@hidden #+LATEX_HEADER_EXTRA
address@hidden @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
address@hidden #+KEYWORDS (@LaTeX{})
address@hidden @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
@@ -12235,7 +12233,7 @@ typesetting description into the document's front
matter. Use multiple
@code{#+KEYWORDS} lines if necessary.
@item SUBTITLE
address@hidden #+SUBTITLE (@LaTeX{})
address@hidden @code{#+SUBTITLE} (@LaTeX{})
@vindex org-latex-subtitle-separate
@vindex org-latex-subtitle-format
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
@code{org-latex-packages-alist}. Use the same three variables to define
custom sectioning or custom classes.
address@hidden #+LATEX_CLASS
address@hidden #+LATEX_CLASS_OPTIONS
address@hidden property, EXPORT_LATEX_CLASS
address@hidden property, EXPORT_LATEX_CLASS_OPTIONS
address@hidden @code{#+LATEX_CLASS}
address@hidden @code{#+LATEX_CLASS_OPTIONS}
address@hidden property, @code{EXPORT_LATEX_CLASS}
address@hidden 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,
@@ -12290,8 +12288,8 @@ including enclosing them in square brackets, follow
@LaTeX{} conventions.
#+LATEX_CLASS_OPTIONS: [a4paper,11pt,twoside,twocolumn]
@end example
address@hidden #+LATEX_HEADER
address@hidden #+LATEX_HEADER_EXTRA
address@hidden @code{#+LATEX_HEADER}
address@hidden @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{}
@@ -12325,14 +12323,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:
address@hidden #+LATEX
address@hidden @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:
address@hidden #+BEGIN_EXPORT latex
address@hidden @code{#+BEGIN_EXPORT latex}
@example
#+BEGIN_EXPORT latex
any arbitrary LaTeX code
@@ -12342,7 +12340,7 @@ any arbitrary LaTeX code
@node Tables in @LaTeX{} export
@subsection Tables in @LaTeX{} export
@cindex tables, in @LaTeX{} export
address@hidden #+ATTR_LATEX, in tables
address@hidden @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
@@ -12446,7 +12444,7 @@ Set the caption with the @LaTeX{} command
@subsection Images in @LaTeX{} export
@cindex images, inline in @LaTeX{}
@cindex inlining images in @LaTeX{}
address@hidden #+ATTR_LATEX, in images
address@hidden @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
@@ -12516,7 +12514,7 @@ Set the @code{:comment-include} attribute to
address@hidden value for the
@node Plain lists in @LaTeX{} export
@subsection Plain lists in @LaTeX{} export
@cindex plain lists, in @LaTeX{} export
address@hidden #+ATTR_LATEX, in plain lists
address@hidden @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
@@ -12550,7 +12548,7 @@ four:
@node Source blocks in @LaTeX{} export
@subsection Source blocks in @LaTeX{} export
@cindex source blocks, in @LaTeX{} export
address@hidden #+ATTR_LATEX, in source blocks
address@hidden @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
@@ -12597,7 +12595,7 @@ variables.
@subsection Example blocks in @LaTeX{} export
@cindex example blocks, in @LaTeX{} export
@cindex verbatim blocks, in @LaTeX{} export
address@hidden #+ATTR_LATEX, in example blocks
address@hidden @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
@@ -12617,7 +12615,7 @@ This sentence is false.
@cindex special blocks, in @LaTeX{} export
@cindex abstract, in @LaTeX{} export
@cindex proof, in @LaTeX{} export
address@hidden #+ATTR_LATEX, in special blocks
address@hidden @code{#+ATTR_LATEX}, in special blocks
For other special blocks in the Org file, the @LaTeX{} export back-end makes
@@ -12665,7 +12663,7 @@ example:
@node Horizontal rules in @LaTeX{} export
@subsection Horizontal rules in @LaTeX{} export
@cindex horizontal rules, in @LaTeX{} export
address@hidden #+ATTR_LATEX, in horizontal rules
address@hidden @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:
@@ -12749,10 +12747,10 @@ executable. Without @file{zip}, export cannot finish.
@anchor{x-export-to-odt}
@cindex region, active
@cindex active region
address@hidden transient-mark-mode
address@hidden @code{transient-mark-mode}
@table @kbd
@orgcmd{C-c C-e o o,org-odt-export-to-odt}
address@hidden property EXPORT_FILE_NAME
address@hidden property, @code{EXPORT_FILE_NAME}
Export as OpenDocument Text file.
@@ -12789,13 +12787,13 @@ output. Setting these keywords works similar to the
general options
@table @samp
@item DESCRIPTION
address@hidden #+DESCRIPTION (ODT)
address@hidden @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
address@hidden #+KEYWORDS (ODT)
address@hidden @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
@@ -12884,7 +12882,7 @@ Open one, modify, and save as either OpenDocument Text
(@file{.odt}) or
OpenDocument Template (@file{.ott}) file.
@item
address@hidden #+ODT_STYLES_FILE
address@hidden @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
@@ -12943,7 +12941,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.
address@hidden #+ATTR_ODT
address@hidden @code{#+ATTR_ODT}
Specifying @code{:rel-width} property on an @code{#+ATTR_ODT} line controls
the width of the table. For example:
@@ -13000,7 +12998,7 @@ when clicked jumps to @uref{http://Orgmode.org}
website, do the following
@subsubheading Sizing and scaling of embedded images
address@hidden #+ATTR_ODT
address@hidden @code{#+ATTR_ODT}
Control the size and scale of the embedded images with the @code{#+ATTR_ODT}
attribute.
@@ -13056,7 +13054,7 @@ height:width ratio, do the following
@subsubheading Anchoring of images
address@hidden #+ATTR_ODT
address@hidden @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.
@@ -13454,7 +13452,7 @@ This paragraph is specially formatted and uses bold
text.
@subsubheading Customizing tables in ODT export
@cindex tables, in ODT export
address@hidden #+ATTR_ODT
address@hidden @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}.
@@ -13698,52 +13696,52 @@ Texinfo output. Setting these keywords works similar
to the general options
@table @samp
@item SUBTITLE
address@hidden #+SUBTITLE (Texinfo)
address@hidden @code{#+SUBTITLE} (Texinfo)
The document subtitle.
@item SUBAUTHOR
address@hidden #+SUBAUTHOR
address@hidden @code{#+SUBAUTHOR}
The document subauthor.
@item TEXINFO_FILENAME
address@hidden #+TEXINFO_FILENAME
address@hidden @code{#+TEXINFO_FILENAME}
The Texinfo filename.
@item TEXINFO_CLASS
address@hidden #+TEXINFO_CLASS
address@hidden @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
address@hidden #+TEXINFO_HEADER
address@hidden @code{#+TEXINFO_HEADER}
Arbitrary lines inserted at the end of the header.
@item TEXINFO_POST_HEADER
address@hidden #+TEXINFO_POST_HEADER
address@hidden @code{#+TEXINFO_POST_HEADER}
Arbitrary lines inserted after the end of the header.
@item TEXINFO_DIR_CATEGORY
address@hidden #+TEXINFO_DIR_CATEGORY
address@hidden @code{#+TEXINFO_DIR_CATEGORY}
The directory category of the document.
@item TEXINFO_DIR_TITLE
address@hidden #+TEXINFO_DIR_TITLE
address@hidden @code{#+TEXINFO_DIR_TITLE}
The directory title of the document.
@item TEXINFO_DIR_DESC
address@hidden #+TEXINFO_DIR_DESC
address@hidden @code{#+TEXINFO_DIR_DESC}
The directory description of the document.
@item TEXINFO_PRINTED_TITLE
address@hidden #+TEXINFO_PRINTED_TITLE
address@hidden @code{#+TEXINFO_PRINTED_TITLE}
The printed title of the document.
@end table
@node Texinfo file header
@subsection Texinfo file header
address@hidden #+TEXINFO_FILENAME
address@hidden @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
@@ -13751,8 +13749,8 @@ override this default with a more sensible path and
name, specify the
@vindex org-texinfo-coding-system
@vindex org-texinfo-classes
address@hidden #+TEXINFO_HEADER
address@hidden #+TEXINFO_CLASS
address@hidden @code{#+TEXINFO_HEADER}
address@hidden @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}
@@ -13766,14 +13764,14 @@ setting the @code{#+TEXINFO_CLASS} keyword to that
class.
@node Texinfo title and copyright page
@subsection Texinfo title and copyright page
address@hidden #+TEXINFO_PRINTED_TITLE
address@hidden @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.
address@hidden #+SUBAUTHOR
address@hidden @code{#+SUBAUTHOR}
If one @code{#+AUTHOR} is not sufficient, add multiple @code{#+SUBAUTHOR}
keywords. They have to be set in raw Texinfo code.
@@ -13783,7 +13781,7 @@ keywords. They have to be set in raw Texinfo code.
#+TEXINFO_PRINTED_TITLE: This Long Title@@address@hidden,@@address@hidden Is
Broken in @@address@hidden@}
@end example
address@hidden property, COPYING
address@hidden property, @code{COPYING}
Copying material is defined in a dedicated headline with a address@hidden
@code{:COPYING:} property. The back-end inserts the contents within a
@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.
@cindex @code{install-info} parameters, in Texinfo export
@cindex Texinfo export, @code{install-info} parameters
address@hidden #+TEXINFO_DIR_CATEGORY
address@hidden #+TEXINFO_DIR_TITLE
address@hidden #+TEXINFO_DIR_DESC
address@hidden @code{#+TEXINFO_DIR_CATEGORY}
address@hidden @code{#+TEXINFO_DIR_TITLE}
address@hidden @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
@@ -13833,7 +13831,7 @@ Here is an example that writes to the Info directory
file:
@vindex org-texinfo-classes
@vindex org-texinfo-default-class
address@hidden #+TEXINFO_CLASS
address@hidden @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
@@ -13848,12 +13846,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.
address@hidden property, APPENDIX
address@hidden property, @code{APPENDIX}
The Texinfo export back-end makes any headline with a address@hidden
@code{:APPENDIX:} property into an appendix. This happens independent of the
Org headline level or the @code{#+TEXINFO_CLASS}.
address@hidden property, DESCRIPTION
address@hidden 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}).
@@ -13879,22 +13877,22 @@ Top Node,,texinfo}, for more information.
@node Indices
@subsection Indices
address@hidden #+CINDEX
address@hidden @code{#+CINDEX}
@cindex concept index, in Texinfo export
@cindex Texinfo export, index, concept
address@hidden #+FINDEX
address@hidden @code{#+FINDEX}
@cindex function index, in Texinfo export
@cindex Texinfo export, index, function
address@hidden #+KINDEX
address@hidden @code{#+KINDEX}
@cindex keystroke index, in Texinfo export
@cindex Texinfo export, keystroke index
address@hidden #+PINDEX
address@hidden @code{#+PINDEX}
@cindex program index, in Texinfo export
@cindex Texinfo export, program index
address@hidden #+TINDEX
address@hidden @code{#+TINDEX}
@cindex data type index, in Texinfo export
@cindex Texinfo export, data type index
address@hidden #+VINDEX
address@hidden @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
@@ -13907,7 +13905,7 @@ escaped with @samp{@@} if they not belong to a Texinfo
command.
#+CINDEX: Defining indexing entries
@end example
address@hidden property, INDEX
address@hidden 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
@@ -13927,8 +13925,8 @@ inserts the index after its contents.
Use any of the following three methods to insert or escape raw Texinfo code:
address@hidden #+TEXINFO
address@hidden #+BEGIN_EXPORT texinfo
address@hidden @code{#+TEXINFO}
address@hidden @code{#+BEGIN_EXPORT texinfo}
@example
Richard @@@@texinfo:@@address@hidden@@@@Stallman@@@@texinfo:@}@@@@ commence'
GNU.
@@ -13943,10 +13941,10 @@ This paragraph is preceded by...
@node Plain lists in Texinfo export
@subsection Plain lists in Texinfo export
address@hidden #+ATTR_TEXINFO, in plain lists
address@hidden @code{#+ATTR_TEXINFO}, in plain lists
@cindex Two-column tables, in Texinfo export
address@hidden :table-type attribute, in Texinfo export
address@hidden @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
@@ -13954,14 +13952,14 @@ two columns. To change this behavior, specify
@code{:table-type} with
@inforef{Two-column Tables,,texinfo}.
@vindex org-texinfo-table-default-markup
address@hidden :indic attribute, in Texinfo export
address@hidden @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
address@hidden :sep attribute, in Texinfo export
address@hidden @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
@@ -13987,7 +13985,7 @@ This is the common text for variables foo and bar.
@node Tables in Texinfo export
@subsection Tables in Texinfo export
address@hidden #+ATTR_TEXINFO, in tables
address@hidden @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
@@ -14000,7 +13998,7 @@ length, use the @code{:columns} attribute. See example
below.
@node Images in Texinfo export
@subsection Images in Texinfo export
address@hidden #+ATTR_TEXINFO, in images
address@hidden @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
@@ -14015,7 +14013,7 @@ the text using Texinfo code, as shown in the example:
@node Special blocks in Texinfo export
@subsection Special blocks
address@hidden #+ATTR_TEXINFO, in special blocks
address@hidden @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,
@@ -14138,7 +14136,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
address@hidden property, ID
address@hidden 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
@@ -14167,26 +14165,27 @@ and write it to
@code{org-icalendar-combined-agenda-file} file name.
@vindex org-use-property-inheritance
@vindex org-icalendar-include-body
address@hidden property, SUMMARY
address@hidden property, DESCRIPTION
address@hidden property, LOCATION
address@hidden 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
address@hidden 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
address@hidden variable limits the maximum number of
address@hidden property, @code{SUMMARY}
address@hidden property, @code{DESCRIPTION}
address@hidden property, @code{LOCATION}
address@hidden property, @code{TIMEZONE}
+The iCalendar export back-end includes @code{SUMMARY}, @code{DESCRIPTION},
address@hidden and @code{TIMEZONE} properties from the Org entries when
+exporting. To force the back-end to inherit the @code{LOCATION} and
address@hidden properties, configure the @code{org-use-property-inheritance}
+variable.
+
+When Org entries do not have @code{SUMMARY}, @code{DESCRIPTION} and
address@hidden 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
@@ -14475,7 +14474,7 @@ and many other properties of a project.
@node Project alist
@subsection The variable @code{org-publish-project-alist}
address@hidden org-publish-project-alist
address@hidden @code{org-publish-project-alist}
@cindex projects, for publishing
@vindex org-publish-project-alist
@@ -14931,7 +14930,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.
address@hidden #+INDEX
address@hidden @code{#+INDEX}
Index entries are specified with @code{#+INDEX} keyword. An entry that
contains an exclamation mark will create a sub item.
@@ -15102,8 +15101,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
address@hidden tags, and format, compile, execute, and show the results.
+Org can take the code in the block between the @code{#+BEGIN_SRC} and
address@hidden 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
@@ -15112,7 +15111,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
address@hidden code blocks between @samp{#+BEGIN_SRC} and @samp{#+END_SRC}
address@hidden 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.
@@ -15174,8 +15173,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
address@hidden #+NAME
address@hidden #+BEGIN_SRC
address@hidden @code{#+NAME}
address@hidden @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.
@@ -15217,7 +15216,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.
address@hidden #+NAME
address@hidden @code{#+NAME}
@item #+BEGIN_SRC
@item #+END_SRC
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
@section Evaluating code blocks
@cindex code block, evaluating
@cindex source code, evaluating
address@hidden #+RESULTS
address@hidden @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
@@ -15451,7 +15450,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.
address@hidden #+CALL
address@hidden @code{#+CALL}
By calling a named code address@hidden, the constructs call_<name>()
and src_<lang>@address@hidden are not evaluated when they appear in a keyword
line
(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
@code{#+HEADER:} only as a convenience for backward-compatibility. It may be
removed at some point.
address@hidden #+HEADER:
address@hidden @code{#+HEADER:}
Multi-line header arguments on an unnamed @samp{src} code block:
@@ -17254,7 +17253,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
@@ -17302,7 +17301,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
address@hidden in-buffer option, @pxref{Setting tags}), or it is created
address@hidden 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
@@ -17315,7 +17314,7 @@ After @samp{#+}, complete the special keywords like
@samp{TYP_TODO} or
file-specific @samp{OPTIONS}. After option keyword is complete, pressing
@address@hidden 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
@@ -17479,13 +17478,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 ...
address@hidden property, COLUMNS
address@hidden 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 ...
@@ -17512,7 +17511,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.
address@hidden #+SETUPFILE
address@hidden @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
@@ -17524,7 +17523,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:
address@hidden #+STARTUP
address@hidden @code{#+STARTUP}
Startup options Org uses when first visiting a file.
The first set of options deals with the initial visibility of the outline
@@ -17705,7 +17704,7 @@ fnadjust @r{automatically renumber and sort
footnotes}
nofnadjust @r{do not renumber and sort automatically}
@end example
address@hidden org-hide-block-startup
address@hidden @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
@@ -17715,7 +17714,7 @@ hideblocks @r{Hide all begin/end blocks on startup}
nohideblocks @r{Do not hide blocks on startup}
@end example
address@hidden org-pretty-entities
address@hidden @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
@@ -17730,11 +17729,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}.
address@hidden #+TBLFM
address@hidden @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:,
@@ -17750,7 +17749,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
address@hidden C-c C-c, overview
address@hidden @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.
@@ -18429,7 +18428,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:
address@hidden #+ORGTBL
address@hidden @code{#+ORGTBL}
@example
#+ORGTBL: SEND table_name translation_function arguments...
@end example
@@ -18483,7 +18482,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:
address@hidden #+ORGTBL, SEND
address@hidden @code{#+ORGTBL}, @samp{SEND}
@example
% BEGIN RECEIVE ORGTBL salesfigures
% END RECEIVE ORGTBL salesfigures
@@ -18499,7 +18498,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
address@hidden the @samp{#+TBLFM} line contains an odd number of dollar
address@hidden 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.
@@ -18630,14 +18629,14 @@ translator functions by posting them to the Org users
mailing list,
@node Radio lists
@subsection Radio lists
@cindex radio lists
address@hidden org-list-insert-radio-list
address@hidden @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:
address@hidden #+ORGLST
address@hidden @code{#+ORGLST}
@itemize @minus
@item
Orgstruct mode must be active.
@@ -18681,7 +18680,7 @@ time}).
Dynamic blocks can have names and function parameters. The syntax is similar
to @samp{src} code block specifications:
address@hidden #+BEGIN:dynamic block
address@hidden @code{#+BEGIN}, dynamic block
@example
#+BEGIN: myblock :parameter1 value1 :parameter2 value2 ...
@@ -18943,7 +18942,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