Documentation for Org hooks, commands and options
Definitions
This page lists all hooks, commands and options of Org 9.8.7.
- Hooks
- are options containing functions to be run before or after
a function. For example,
org-mode-hookcan contain a list of functions to be called after org-mode is turned on. - Commands
- are interactive functions that the user can run with
M-x command RET. Most commands have an associated keybinding, indicated here. Users can bind command to his preferred keybinding. - Options
- are variables that the user can set through the
customizeinterface. CallingM-x customize-variable RETthen completing over available options will open the custom interface, which makes it easy to set an option.
These are the main "internals" that the user may want to know about,
and we list them here for further reference. E.g. You can safely
create links to https://orgmode.org/worg/doc.html#org-agenda to refer
to the documentation of the org-agenda command.
On top of these symbols, there are other non-interactive functions and
variables. You can get more documentation about them with C-h f org-
TAB and C-h v org- TAB respectively.
Hooks
org-after-demote-entry-hook nil
- In file: org.el
- Find modifications in git logs
Hook run after an entry has been demoted. The cursor will be at the beginning of the entry. When a subtree is being demoted, the hook will be called for each node.
org-after-note-stored-hook (funcall #'#[nil (nil) (crm-se...
- In file: org.el
- Find modifications in git logs
Hook triggered after a note is stored. The point is at the stored note when the hook is executed.
org-after-promote-entry-hook nil
- In file: org.el
- Find modifications in git logs
Hook run after an entry has been promoted. The cursor will be at the beginning of the entry. When a subtree is being promoted, the hook will be called for each node.
org-after-refile-insert-hook nil
Hook run after `org-refile' has inserted its stuff at the new location. Note that this is still *before* the stuff will be removed from the *old* location.
org-after-sorting-entries-or-items-hook nil
- In file: org.el
- Find modifications in git logs
Hook that is run after a bunch of entries or items have been sorted. When children are sorted, the cursor is in the parent line when this hook gets called. When a region or a plain list is sorted, the cursor will be in the first entry of the sorted region/list.
org-after-todo-state-change-hook (funcall #'#[nil (nil) (crm-se...
- In file: org.el
- Find modifications in git logs
Hook which is run after the state of a TODO item was changed. The new state (a string with a TODO keyword, or nil) is available in the Lisp variable `org-state'.
org-after-todo-statistics-hook nil
- In file: org.el
- Find modifications in git logs
Hook that is called after a TODO statistics cookie has been updated.
Each function is called with two arguments: the number of not-done entries
and the number of done entries.
For example, the following function, when added to this hook, will switch
an entry to DONE when all children are done, and back to TODO when new
entries are set to a TODO status. Note that this hook is only called
when there is a statistics cookie in the headline!
(defun org-summary-todo (n-done n-not-done)
"Switch entry to DONE when all subentries are done, to TODO otherwise."
(let (org-log-done org-todo-log-states) ; turn off logging
(org-todo (if (= n-not-done 0) "DONE" "TODO"))))
org-agenda-after-show-hook nil
Normal hook run after an item has been shown from the agenda. Point is in the buffer where the item originated.
org-agenda-before-write-hook (funcall #'#[nil ('(org-agenda...
Hook run in a temporary buffer before writing the agenda to an export file. A useful function for this hook is `org-agenda-add-entry-text'.
org-agenda-bulk-custom-functions (funcall #'#[nil (nil) (origin...
Alist of characters and custom functions for bulk actions.
For example, this makes those two functions available:
(setq org-agenda-bulk-custom-functions
\='((?R set-category)
(?C bulk-cut)))
With selected entries in an agenda buffer, `B R' will call
the custom function `set-category' on the selected entries.
Note that functions in this alist don't need to be quoted.
You can also specify a function which collects arguments to be
used for each call to your bulk custom function. The argument
collecting function will be run once and should return a list of
arguments to pass to the bulk function. For example:
(setq org-agenda-bulk-custom-functions
\='((?R set-category get-category)))
Now, `B R' will call the custom `get-category' which would prompt
the user once for a category. That category is then passed as an
argument to `set-category' for each entry it's called against.
org-agenda-cleanup-fancy-diary-hook nil
Hook run when the fancy diary buffer is cleaned up.
org-agenda-entry-text-cleanup-hook nil
Hook that is run after basic cleanup of entry text to be shown in agenda. This cleanup is done in a temporary buffer, so the function may inspect and change the entire buffer. Some default stuff like drawers and scheduling/deadline dates will already have been removed when this is called, as will any matches for regular expressions listed in `org-agenda-entry-text-exclude-regexps'.
org-agenda-filter-hook (funcall #'#[nil (nil) (origin...
Hook run just after filtering with `org-agenda-filter'.
org-agenda-finalize-hook (funcall #'#[nil (nil) (origin...
Hook run just before displaying an agenda buffer. The buffer is still writable when the hook is called. You can modify some of the buffer substrings but you should be extra careful not to modify the text properties of the agenda headlines as the agenda display heavily relies on them.
org-agenda-mode-hook nil
Hook run after `org-agenda-mode' is turned on. The buffer is still writable when this hook is called.
org-archive-finalize-hook (funcall #'#[nil (nil) (t)])
Hook run after successfully archiving a subtree in final location. Hook functions are called with point on the subtree in the destination file. Compare this with `org-archive-hook', which runs in the original file. At this stage, the subtree has been added to the archive location, but not yet deleted from the original file.
org-archive-hook (funcall #'#[nil (nil) (t)])
Hook run after successfully archiving a subtree. Hook functions are called with point on the subtree in the original file. At this stage, the subtree has been added to the archive location, but not yet deleted from the original file.
org-attach-after-change-hook nil
Hook called when files have been added or removed to the attachment folder.
org-attach-open-hook nil
Hook that is invoked by `org-attach-open'. Created mostly to be compatible with org-attach-git after removing git-functionality from this file.
org-babel-after-execute-hook nil
- In file: ob-core.el
- Find modifications in git logs
Hook for functions to be called after `org-babel-execute-src-block'.
org-babel-post-tangle-hook (funcall #'#[nil (nil) (org-id...
- Since: Emacs version 24.1
- In file: ob-tangle.el
- Find modifications in git logs
Hook run in code files tangled by `org-babel-tangle'.
org-babel-pre-tangle-hook (funcall #'#[nil ('(save-buffe...
- Since: Emacs version 24.1
- In file: ob-tangle.el
- Find modifications in git logs
Hook run at the beginning of `org-babel-tangle' in the original buffer.
org-babel-tangle-body-hook (funcall #'#[nil (nil) (org-id...
- Since: Emacs version 24.1
- In file: ob-tangle.el
- Find modifications in git logs
Hook run over the contents of each code block body.
org-babel-tangle-finished-hook (funcall #'#[nil (nil) (org-id...
Hook run at the very end of `org-babel-tangle' in the original buffer. In this way, it is the counterpart to `org-babel-pre-tangle-hook'.
org-beamer-mode-hook nil
Hook run after entering or leaving `org-beamer-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-blocker-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions that are allowed to block a state change. Functions in this hook should not modify the buffer. Each function gets as its single argument a property list, see `org-trigger-hook' for more information about this list. If any of the functions in this hook returns nil, the state change is blocked.
org-capture-after-finalize-hook (funcall #'#[nil (nil) (org-re...
- Since: Emacs version 24.1
- In file: org-capture.el
- Find modifications in git logs
Hook that is run right after a capture process is finalized. Suitable for window cleanup.
org-capture-before-finalize-hook (funcall #'#[nil (nil) (org-re...
- Since: Emacs version 24.1
- In file: org-capture.el
- Find modifications in git logs
Hook that is run right before a capture process is finalized. The capture buffer is still current when this hook runs and it is widened to the entire buffer.
org-capture-mode-hook nil
Hook for the `org-capture-mode' minor mode.
org-capture-prepare-finalize-hook (funcall #'#[nil (nil) (org-re...
- Since: Emacs version 24.1
- In file: org-capture.el
- Find modifications in git logs
Hook that is run before the finalization starts. The capture buffer is current and still narrowed.
org-cdlatex-mode-hook nil
- In file: org.el
- Find modifications in git logs
Hook run after entering or leaving `org-cdlatex-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-checkbox-statistics-hook nil
Hook that is run whenever Org thinks checkbox statistics should be updated. This hook runs even if checkbox rule in `org-list-automatic-rules' does not apply, so it can be used to implement alternative ways of collecting statistics information.
org-clock-before-select-task-hook nil
Hook called in task selection just before prompting the user.
org-clock-cancel-hook nil
Hook run when canceling the current clock.
org-clock-goto-hook nil
Hook run when selecting the currently clocked-in entry.
org-clock-in-hook nil
Hook run when starting the clock.
org-clock-in-prepare-hook nil
Hook run when preparing the clock. This hook is run before anything happens to the task that you want to clock in. For example, you can use this hook to add an effort property.
org-clock-out-hook nil
Hook run when stopping the current clock. The point is at the current clock line when the hook is executed. The hook functions can access `org-clock-out-removed-last-clock' to check whether the latest CLOCK line has been cleared.
org-create-file-search-functions nil
- In file: ol.el
- Find modifications in git logs
List of functions to construct the right search string for a file link. These functions are called in turn with point at the location to which the link should point. A function in the hook should first test if it would like to handle this file type, for example by checking the `major-mode' or the file extension. If it decides not to handle this file, it should just return nil to give other functions a chance. If it does handle the file, it must return the search string to be used when following the link. The search string will be part of the file link, given after a double colon, and `org-open-at-point' will automatically search for it. If special measures must be taken to make the search successful, another function should be added to the companion hook `org-execute-file-search-functions', which see. A function in this hook may also use `org-link-store-props' and set `:description' property to provide a suggestion for the descriptive text to be used for this link when it gets inserted into an Org buffer with \[org-insert-link].
org-ctrl-c-ctrl-c-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to \`C-c C-c'. This can be used to add additional functionality to the \`C-c C-c' key which executes context-dependent commands. This hook is run after any other test, while `org-ctrl-c-ctrl-c-hook' is run before the first test. Each function will be called with no arguments. The function must check if the context is appropriate for it to act. If yes, it should do its thing and then return a non-nil value. If the context is wrong, just do nothing and return nil.
org-ctrl-c-ctrl-c-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to \`C-c C-c'. This can be used to add additional functionality to the \`C-c C-c' key which executes context-dependent commands. This hook is run before any other test, while `org-ctrl-c-ctrl-c-final-hook' is run after the last test. Each function will be called with no arguments. The function must check if the context is appropriate for it to act. If yes, it should do its thing and then return a non-nil value. If the context is wrong, just do nothing and return nil.
org-cycle-hook (funcall #'#[nil ('(org-cycle-...
Hook that is run after `org-cycle' has changed the buffer visibility. The function(s) in this hook must accept a single argument which indicates the new state that was set by the most recent `org-cycle' command. The argument is a symbol. After a global state change, it can have the values `overview', `contents', or `all'. After a local state change, it can have the values `folded', `children', or `subtree'.
org-cycle-pre-hook (funcall #'#[nil (nil) (t)])
Hook that is run before visibility cycling is happening. The function(s) in this hook must accept a single argument which indicates the new state that will be set right after running this hook. The argument is a symbol. Before a global state change, it can have the values `overview', `content', or `all'. Before a local state change, it can have the values `folded', `children', or `subtree'.
org-cycle-tab-first-hook nil
Hook for functions to attach themselves to TAB. See `org-ctrl-c-ctrl-c-hook' for more information. This hook runs as the first action when TAB is pressed, even before `org-cycle' messes around with the `outline-regexp' to cater for inline tasks and plain list item folding. If any function in this hook returns t, any other actions that would have been caused by TAB (such as table field motion or visibility cycling) will not occur.
org-execute-file-search-functions nil
- In file: ol.el
- Find modifications in git logs
List of functions to execute a file search triggered by a link.
Functions added to this hook must accept a single argument, the
search string that was part of the file link, the part after the
double colon. The function must first check if it would like to
handle this search, for example by checking the `major-mode' or
the file extension. If it decides not to handle this search, it
should just return nil to give other functions a chance. If it
does handle the search, it must return a non-nil value to keep
other functions from trying.
Each function can access the current prefix argument through the
variable `current-prefix-arg'. Note that a single prefix is used
to force opening a link in Emacs, so it may be good to only use a
numeric or double prefix to guide the search function.
In case this is needed, a function in this hook can also restore
the window configuration before `org-open-at-point' was called using:
(set-window-configuration org-window-config-before-follow-link)
org-export-before-parsing-functions nil
- In file: ox.el
- Find modifications in git logs
Abnormal hook run before parsing an export buffer. This is run after include keywords and macros have been expanded and Babel code blocks executed, on a copy of the original buffer being exported. Visibility and narrowing are preserved. Point is at the beginning of the buffer. Every function in this hook will be called with one argument: the backend currently used, as a symbol.
org-export-before-parsing-hook nil
org-export-before-processing-functions nil
- In file: ox.el
- Find modifications in git logs
Abnormal hook run at the beginning of the export process. This is run before include keywords and macros are expanded and Babel code blocks executed, on a copy of the original buffer being exported. Visibility and narrowing are preserved. Point is at the beginning of the buffer. Every function in this hook will be called with one argument: the backend currently used, as a symbol.
org-export-before-processing-hook nil
org-export-filter-babel-call-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded babel-call. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-body-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded body. Each filter is called with three arguments: a string which contains no Org syntax, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-bold-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded bold text. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-center-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded center block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-clock-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded clock. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-code-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded code text. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-diary-sexp-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded diary-sexp. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-drawer-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded drawer. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-dynamic-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded dynamic-block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-entity-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded entity. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-example-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded example-block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-export-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded export-block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-export-snippet-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded export-snippet. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-final-output-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to the transcoded string. Each filter is called with three arguments: the full transcoded string, the backend, as a symbol, and the communication channel, as a plist. It must return a string that will be used as the final export output.
org-export-filter-fixed-width-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded fixed-width. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-footnote-definition-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded footnote-definition. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-footnote-reference-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded footnote-reference. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-headline-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded headline. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-horizontal-rule-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded horizontal-rule. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-inline-babel-call-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded inline-babel-call. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-inline-src-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded inline-src-block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-inlinetask-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded inlinetask. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-italic-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded italic text. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-item-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded item. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-keyword-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded keyword. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-latex-environment-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded latex-environment. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-latex-fragment-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded latex-fragment. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-line-break-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded line-break. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-link-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded link. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-node-property-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded node-property. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-options-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to the export options. Each filter is called with two arguments: the export options, as a plist, and the backend, as a symbol. It must return a property list containing export options.
org-export-filter-paragraph-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded paragraph. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-parse-tree-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to the parsed tree. Each filter is called with three arguments: the parse tree, as returned by `org-element-parse-buffer', the backend, as a symbol, and the communication channel, as a plist. It must return the modified parse tree to transcode.
org-export-filter-plain-list-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded plain-list. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-plain-text-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to plain text. Each filter is called with three arguments: a string which contains no Org syntax, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-planning-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded planning. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-property-drawer-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded property-drawer. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-quote-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded quote block. Each filter is called with three arguments: the transcoded quote data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-radio-target-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded radio-target. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-section-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded section. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-special-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded special block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-src-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded src-block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-strike-through-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded strike-through text. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-subscript-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded subscript. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-superscript-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded superscript. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-table-cell-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded table-cell. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-table-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded table. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-table-row-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded table-row. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-target-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded target. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-timestamp-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded timestamp. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-underline-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded underline text. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-verbatim-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to transcoded verbatim text. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-filter-verse-block-functions nil
- In file: ox.el
- Find modifications in git logs
List of functions applied to a transcoded verse block. Each filter is called with three arguments: the transcoded data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.
org-export-stack-mode-hook nil
- In file: ox.el
- Find modifications in git logs
Hook run after entering `org-export-stack-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-feed-after-adding-hook (funcall #'#[nil (nil) (t)])
Hook that is run after new items have been added to a file. Depending on `org-feed-save-after-adding', the buffer will already have been saved.
org-feed-before-adding-hook (funcall #'#[nil (nil) (t)])
Hook that is run before adding new feed items to a file. You might want to commit the file in its current state to version control, for example.
org-fold-core-extend-changed-region-functions nil
Special hook run just before handling changes in buffer. This is used to account changes outside folded regions that still affect the folded region visibility. For example, removing all stars at the beginning of a folded Org mode heading should trigger the folded text to be revealed. Each function is called with two arguments: beginning and the end of the changed region.
org-fold-reveal-start-hook nil
Hook run before revealing a location.
org-follow-link-hook (funcall #'#[nil (nil) (t)])
Hook that is run after a link has been followed.
org-font-lock-hook nil
- In file: org.el
- Find modifications in git logs
Functions to be called for special font lock stuff.
org-font-lock-set-keywords-hook nil
- In file: org.el
- Find modifications in git logs
Functions that can manipulate `org-font-lock-extra-keywords'. This is called after `org-font-lock-extra-keywords' is defined, but before it is installed to be used by font lock. This can be useful if something needs to be inserted at a specific position in the font-lock sequence.
org-icalendar-after-save-hook nil
Hook run after an iCalendar file has been saved. This hook is run with the name of the file as argument. A good way to use this is to tell a desktop calendar application to re-read the iCalendar file.
org-indent-mode-hook nil
Hook run after entering or leaving `org-indent-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-indent-post-buffer-init-functions (funcall #'#[nil (nil) (org-in...
Hook run after org-indent finishes initializing a buffer. The function(s) in this hook must accept a single argument representing the initialized buffer.
org-insert-heading-hook (funcall #'#[nil (nil) (crm-se...
- In file: org.el
- Find modifications in git logs
Hook being run after inserting a new heading.
org-lint–report-mode-hook nil
Hook run after entering `org-lint--report-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-list-checkbox-radio-mode-hook nil
Hook run after entering or leaving `org-list-checkbox-radio-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-load-hook (funcall #'#[nil (nil) (crm-se...
- In file: org.el
- Find modifications in git logs
Hook that is run after org.el has been loaded.
org-log-buffer-setup-hook (funcall #'#[nil (nil) (crm-se...
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Hook that is run after an Org log buffer is created.
org-metadown-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-down'. This one runs after all other options except `org-drag-element-forward' have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metadown-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-down'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metaleft-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-left'. This one runs after all options have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metaleft-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-left'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metareturn-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-RET'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metaright-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-right'. This one runs after all options have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metaright-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-right'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metaup-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-up'. This one runs after all other options except `org-drag-element-backward' have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-metaup-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-up'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-mobile-before-process-capture-hook nil
Hook that is run after content was moved to `org-mobile-inbox-for-pull'. The inbox file is visited by the current buffer, and the buffer is narrowed to the newly captured data.
org-mobile-post-pull-hook nil
Hook run after running `org-mobile-pull', only if new items were found. If Emacs does not have direct write access to the WebDAV directory used by the mobile device, this hook should be used to copy the emptied capture file `mobileorg.org' back to the WebDAV directory, for example using `rsync' or `scp'.
org-mobile-post-push-hook nil
Hook run after running `org-mobile-push'. If Emacs does not have direct write access to the WebDAV directory used by the mobile device, this hook should be used to copy all files from the local staging directory `org-mobile-directory' to the WebDAV directory, for example using `rsync' or `scp'.
org-mobile-pre-pull-hook nil
Hook run before executing `org-mobile-pull'. If Emacs does not have direct write access to the WebDAV directory used by the mobile device, this hook should be used to copy the capture file `mobileorg.org' from the WebDAV location to the local staging directory `org-mobile-directory'.
org-mobile-pre-push-hook nil
Hook run before running `org-mobile-push'. This could be used to clean up `org-mobile-directory', for example to remove files that used to be included in the agenda but no longer are. The presence of such files would not really be a problem, but after time they may accumulate.
org-mode-hook (funcall #'#[nil (nil) (crm-se...
- In file: org.el
- Find modifications in git logs
Mode hook for Org mode, run after the mode was turned on.
org-num-mode-hook nil
- In file: org-num.el
- Find modifications in git logs
Hook run after entering or leaving `org-num-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-occur-hook (funcall #'#[nil ('(org-first-...
- In file: org.el
- Find modifications in git logs
Hook that is run after `org-occur' has constructed a sparse tree. This can be used to recenter the window to show as much of the structure as possible.
org-open-at-point-functions nil
- In file: org.el
- Find modifications in git logs
Hook that is run when following a link at point. Functions in this hook must return t if they identify and follow a link at point. If they don't find anything interesting at point, they must return nil.
org-open-link-functions nil
- In file: ol.el
- Find modifications in git logs
Hook for functions finding a plain text link. These functions must take a single argument, the link content. They will be called for links that look like [[link text][description]] when LINK TEXT does not have a protocol like "http:" and does not look like a filename (e.g. "./blue.png"). These functions will be called *before* Org attempts to resolve the link by doing text searches in the current buffer - so if you want a link "[[target]]" to still find "<<target>>", your function should handle this as a special case. When the function does handle the link, it must return a non-nil value. If it decides that it is not responsible for this link, it must return nil to indicate that Org can continue with other options like exact and fuzzy text search.
org-persist-after-read-hook nil
Abnormal hook ran after reading data. The hook must accept the same arguments as `org-persist-read'.
org-persist-before-read-hook nil
Abnormal hook ran before reading data. The hook must accept the same arguments as `org-persist-read'. The hooks will be evaluated until a hook returns non-nil. If any of the hooks return non-nil, do not read the data.
org-persist-before-write-hook nil
Abnormal hook ran before saving data. The hook must accept the same arguments as `org-persist-write'. The hooks will be evaluated until a hook returns non-nil. If any of the hooks return non-nil, do not save the data.
org-pre-cycle-hook nil
org-property-allowed-value-functions nil
- In file: org.el
- Find modifications in git logs
Hook for functions supplying allowed values for a specific property. The functions must take a single argument, the name of the property, and return a flat list of allowed values. If ":ETC" is one of the values, this means that these values are intended as defaults for completion, but that other values should be allowed too. The functions must return nil if they are not responsible for this property.
org-property-changed-functions nil
- In file: org.el
- Find modifications in git logs
Hook called when the value of a property has changed. Each hook function should accept two arguments, the name of the property and the new value.
org-publish-after-publishing-hook nil
Hook run each time a file is published. Every function in this hook will be called with two arguments: the name of the original file and the name of the file produced.
org-reveal-start-hook nil
org-shiftdown-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-down'. This one runs after all other options except shift-select have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftdown-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-down'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftleft-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-left'. This one runs after all other options except shift-select have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftleft-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-left'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetadown-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-down'. This one runs after all other options except `org-drag-line-forward' have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetadown-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-down'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetaleft-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-left'. This one runs after all other options have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetaleft-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-left'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetaright-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-right'. This one runs after all other options have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetaright-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-right'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetaup-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-up'. This one runs after all other options except `org-drag-line-backward' have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftmetaup-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `M-S-up'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftright-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-right'. This one runs after all other options except shift-select have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftright-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-right'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftup-final-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-up'. This one runs after all other options except shift-select have been excluded. See `org-ctrl-c-ctrl-c-hook' for more information.
org-shiftup-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions attaching themselves to `S-up'. See `org-ctrl-c-ctrl-c-hook' for more information.
org-speed-command-hook (funcall #'#[nil ('(org-speed-...
- Since: Emacs version 24.1
- In file: org-keys.el
- Find modifications in git logs
Hook for activating speed commands at strategic locations. Hook functions are called in sequence until a valid handler is found. Each hook takes a single argument, a user-pressed command key which is also a `self-insert-command' from the global map. Within the hook, examine the cursor position and the command key and return nil or a valid handler as appropriate. Handler could be one of an interactive command, a function, or a form. Set `org-use-speed-commands' to non-nil value to enable this hook. The default setting is `org-speed-command-activate'.
org-src-mode-hook nil
- In file: org-src.el
- Find modifications in git logs
Hook run after Org switched a source code snippet to its Emacs mode. \<org-mode-map> This hook will run: - when editing a source code snippet with `\[org-edit-special]' - when formatting a source code snippet for export with htmlize. You may want to use this hook for example to turn off `outline-minor-mode' or similar things which you want to have when editing a source code file, but which mess up the display of a snippet in Org exported files.
org-tab-after-check-for-cycling-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions to attach themselves to TAB. See `org-ctrl-c-ctrl-c-hook' for more information. This hook runs after it has been established that not table field motion and not visibility should be done because of current context. This is probably the place where a package like yasnippets can hook in.
org-tab-after-check-for-table-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions to attach themselves to TAB. See `org-ctrl-c-ctrl-c-hook' for more information. This hook runs after it has been established that the cursor is not in a table, but before checking if the cursor is in a headline or if global cycling should be done. If any function in this hook returns t, not other actions like visibility cycling will be done.
org-tab-before-tab-emulation-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions to attach themselves to TAB. See `org-ctrl-c-ctrl-c-hook' for more information. This hook runs after every other options for TAB have been exhausted, but before indentation and insertion takes place.
org-tab-first-hook nil
org-table-follow-field-mode-hook nil
Hook run after entering or leaving `org-table-follow-field-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-table-header-line-mode-hook nil
Hook run after entering or leaving `org-table-header-line-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
org-timer-continue-hook nil
Hook run after relative or countdown timer is continued.
org-timer-done-hook nil
Hook run after countdown timer reaches zero. The hook is run before the timer is actually stopped.
org-timer-pause-hook nil
Hook run before relative or countdown timer is paused.
org-timer-set-hook nil
Hook run after countdown timer is set.
org-timer-start-hook nil
Hook run after relative timer is started.
org-timer-stop-hook nil
Hook run before relative or countdown timer is stopped.
org-todo-get-default-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions that get a default item for todo. Each function takes arguments (NEW-MARK OLD-MARK) and returns either nil or a string to be used for the todo mark.
org-todo-repeat-hook (funcall #'#[nil (nil) (crm-se...
- In file: org.el
- Find modifications in git logs
Hook that is run after a task has been repeated.
org-todo-setup-filter-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions that pre-filter todo specs. Each function takes a todo spec and returns either nil or the spec transformed into canonical form.
org-todo-statistics-hook nil
- In file: org.el
- Find modifications in git logs
Hook that is run whenever Org thinks TODO statistics should be updated. This hook runs even if there is no statistics cookie present, in which case `org-after-todo-statistics-hook' would not run.
org-trigger-hook nil
- In file: org.el
- Find modifications in git logs
Hook for functions that are triggered by a state change.
Each function gets as its single argument a property list with at
least the following elements:
(:type type-of-change :position pos-at-entry-start
:from old-state :to new-state)
Depending on the type, more properties may be present.
This mechanism is currently implemented for:
TODO state changes
------------------
:type todo-state-change
:from previous state (keyword as a string), or nil, or a symbol
`todo' or `done', to indicate the general type of state.
:to new state, like in :from
orgtbl-after-send-table-hook nil
Hook for functions attaching to \`C-c C-c', if the table is sent. This can be used to add additional functionality after the table is sent to the receiver position, otherwise, if table is not sent, the functions are not run.
orgtbl-mode-hook nil
Hook run after entering or leaving `orgtbl-mode'. No problems result if this variable is not bound. `add-hook' automatically binds it. (This is true for all hook variables.)
Commands
org–backward-paragraph-once
- In file: org.el
- Find modifications in git logs
Move backward to start of paragraph or equivalent, once. See ‘org-backward-paragraph’.
org–forward-paragraph-once
- In file: org.el
- Find modifications in git logs
Move forward to end of paragraph or equivalent, once. See ‘org-forward-paragraph’.
org-add-note
- Access:
C-c C-z - In file: org.el
- Find modifications in git logs
Add a note to the current entry. This is done in the same way as adding a state change note.
org-advertized-archive-subtree (&optional find-done)
- In file: org.el
- Find modifications in git logs
Move the current subtree to the archive. The archive can be a certain top-level heading in the current file, or in a different file. The tree will be moved to that location. If ‘org-archive-mark-done’ is non-nil and the subtree has a TODO keyword, the subtree heading will be marked DONE. And the current time will be added. When called with a single prefix argument FIND-DONE, find whole trees without any open TODO items and archive them (after getting confirmation from the user). When called with a double prefix argument, find whole trees with timestamps before today and archive them (after getting confirmation from the user). If the cursor is not at a headline when these commands are called, try all level 1 trees. If the cursor is on a headline, only try the direct children of this heading.
org-agenda (&optional arg keys restriction)
Dispatch agenda commands to collect entries to the agenda buffer.
Prompts for a command to execute. Any prefix arg will be passed
on to the selected command. The default selections are:
a Call ‘org-agenda-list’ to display the agenda for current day or week.
t Call ‘org-todo-list’ to display the global todo list.
T Call ‘org-todo-list’ to display the global todo list, select only
entries with a specific TODO keyword (the user gets a prompt).
m Call ‘org-tags-view’ to display headlines with tags matching
a condition (the user is prompted for the condition).
M Like ‘m’, but select only TODO entries, no ordinary headlines.
e Export views to associated files.
s Search entries for keywords.
S Search entries for keywords, only with TODO keywords.
/ Multi occur across all agenda files and also files listed
in ‘org-agenda-text-search-extra-files’.
< Restrict agenda commands to buffer, subtree, or region.
Press several times to get the desired effect.
> Remove a previous restriction.
# List "stuck" projects.
! Configure what "stuck" means.
C Configure custom agenda commands.
More commands can be added by configuring the variable
‘org-agenda-custom-commands’. In particular, specific tags and TODO keyword
searches can be pre-defined in this way.
If the current buffer is in Org mode and visiting a file, you can also
first press ‘<’ once to indicate that the agenda should be temporarily
(until the next use of ‘M-x org-agenda’) restricted to the current file.
Pressing ‘<’ twice means to restrict to the current subtree or region
(if active).
org-agenda-Quit
Exit the agenda, killing the agenda buffer. Like ‘org-agenda-quit’, but kill the buffer even when ‘org-agenda-sticky’ is non-nil.
org-agenda-add-note (&optional _arg)
Add a time-stamped note to the entry at point.
org-agenda-append-agenda
Append another agenda view to the current one. This function allows interactive building of block agendas. Agenda views are separated by ‘org-agenda-block-separator’.
org-agenda-archive
Archive the entry or subtree belonging to the current agenda entry.
org-agenda-archive-default
Archive the entry or subtree belonging to the current agenda entry.
org-agenda-archive-default-with-confirmation
Archive the entry or subtree belonging to the current agenda entry.
org-agenda-archive-to-archive-sibling
Move the entry to the archive sibling.
org-agenda-archive-with (cmd &optional confirm)
Move the entry to the archive sibling.
org-agenda-archives-mode (&optional with-files)
Toggle inclusion of items in trees marked with :ARCHIVE:. When called with a prefix argument, include all archive files as well.
org-agenda-backward-block
Move backward by one agenda block.
org-agenda-bulk-action (&optional arg)
Execute an remote-editing action on all marked entries. The prefix arg is passed through to the command if possible.
org-agenda-bulk-mark (&optional arg)
Mark entries for future bulk action. When ARG is nil or one and region is not active then mark the entry at point. When ARG is nil or one and region is active then mark the entries in the region. When ARG is greater than one mark ARG lines.
org-agenda-bulk-mark-all
Mark all entries for future agenda bulk action.
org-agenda-bulk-mark-regexp (regexp)
Mark entries matching REGEXP for future agenda bulk action.
org-agenda-bulk-remove-overlays (&optional beg end)
Remove the mark overlays between BEG and END in the agenda buffer. BEG and END default to the buffer limits. This only removes the overlays, it does not remove the markers from the list in ‘org-agenda-bulk-marked-entries’.
org-agenda-bulk-toggle
- Access:
M-m - In file: org-agenda.el
- Find modifications in git logs
Toggle the mark at point for bulk action.
org-agenda-bulk-toggle-all
- Access:
M-* - In file: org-agenda.el
- Find modifications in git logs
Toggle all marks for bulk action.
org-agenda-bulk-unmark (&optional arg)
Unmark the entry at point for future bulk action.
org-agenda-bulk-unmark-all
Remove all marks in the agenda buffer. This will remove the markers and the overlays.
org-agenda-capture (&optional with-time)
Call ‘org-capture’ with the date at point. With a ‘C-1’ prefix, use the HH:MM value at point (if any) or the current HH:MM time.
org-agenda-clock-cancel (&optional _arg)
Cancel the currently running clock.
org-agenda-clock-goto
Jump to the currently clocked in task within the agenda. If the currently clocked in task is not listed in the agenda buffer, display it in another window.
org-agenda-clock-in (&optional arg)
Start the clock on the currently selected item.
org-agenda-clock-out
Stop the currently running clock.
org-agenda-clockreport-mode
Toggle clocktable mode in an agenda buffer.
org-agenda-columns
Turn on or update column view in the agenda.
org-agenda-convert-date
org-agenda-ctrl-c-ctrl-c
Set tags in agenda buffer.
org-agenda-cycle-show (&optional n)
Show the current entry in another window, with default settings. Default settings are taken from ‘org-fold-show-context-detail’. When use repeatedly in immediate succession, the remote entry will cycle through visibility children -> subtree -> folded When called with a numeric prefix arg, that arg will be passed through to ‘org-agenda-show-1’. For the interpretation of that argument, see the docstring of ‘org-agenda-show-1’.
org-agenda-date-earlier (arg &optional what)
Change the date of this item to ARG day(s) earlier.
org-agenda-date-earlier-hours (arg)
Change the time of this item, in hour steps.
org-agenda-date-earlier-minutes (arg)
Change the time of this item, in units of ‘org-time-stamp-rounding-minutes’.
org-agenda-date-later (arg &optional what)
Change the date of this item to ARG day(s) later.
org-agenda-date-later-hours (arg)
Change the time of this item, in hour steps.
org-agenda-date-later-minutes (arg)
Change the time of this item, in units of ‘org-time-stamp-rounding-minutes’.
org-agenda-date-prompt (arg)
Change the date of this item. Date is prompted for, with default today. The prefix ARG is passed to the ‘org-timestamp’ command and can therefore be used to request time specification in the time stamp.
org-agenda-day-view (&optional day-of-month)
Switch to daily view for agenda. With argument DAY-OF-MONTH, switch to that day of the month.
org-agenda-deadline (arg &optional time)
Schedule the item at point. ARG is passed through to ‘org-deadline’.
org-agenda-diary-entry
Make a diary entry, like the ‘i’ command from the calendar. All the standard commands work: block, weekly etc. When ‘org-agenda-diary-file’ points to a file, ‘org-agenda-diary-entry-in-org-file’ is called instead to create entries in that Org file.
org-agenda-dim-blocked-tasks (&optional _invisible)
Dim currently blocked TODOs in the agenda display. When INVISIBLE is non-nil, hide currently blocked TODO instead of dimming them.
org-agenda-do-date-earlier (arg)
org-agenda-do-date-later (arg)
org-agenda-drag-line-backward (arg)
Drag an agenda line backward by ARG lines.
org-agenda-drag-line-forward (arg &optional backward)
Drag an agenda line forward by ARG lines. When the optional argument ‘backward’ is non-nil, move backward.
org-agenda-earlier (arg)
Go backward in time by the current span in the agenda buffer. With prefix ARG, go backward that many times the current span. See also: ‘org-agenda-later’ (M-x org-agenda-later) ‘org-agenda-goto-today’ (M-x org-agenda-goto-today) ‘org-agenda-goto-date’ (M-x org-agenda-goto-date)
org-agenda-end-of-line
Go to the end of visible line.
org-agenda-entry-text-mode (&optional arg)
Toggle entry text mode in an agenda buffer.
org-agenda-entry-text-show
Add entry context for all agenda lines.
org-agenda-execute (arg)
Execute another agenda command, keeping same window. So this is just a shortcut for ‘M-x org-agenda’, available in the agenda.
org-agenda-exit
Exit the agenda, killing Org buffers loaded by the agenda. Like ‘org-agenda-Quit’, but kill any buffers that were created by the agenda. Org buffers visited directly by the user will not be touched. Also, exit the agenda even if it is in column view.
org-agenda-file-to-front (&optional to-end)
- Access:
C-c [ - In file: org.el
- Find modifications in git logs
Move/add the current file to the top of the agenda file list. If the file is not present in the list, it is added to the front. If it is present, it is moved there. With optional argument TO-END, add/move to the end of the list.
org-agenda-filter (&optional strip-or-accumulate)
Prompt for a general filter string and apply it to the agenda.
The string may contain filter elements like
+category
+tag
+<effort > and = are also allowed as effort operators
+/regexp/
Instead of ‘+’, ‘-’ is allowed to strip the agenda of matching entries.
‘+’ is optional if it is not required to separate two string parts.
Multiple filter elements can be concatenated without spaces, for example
+work-John<0:10-/plot/
selects entries with category ‘work’ and effort estimates below 10 minutes,
and deselects entries with tag ‘John’ or matching the regexp ‘plot’.
During entry of the filter, completion for tags, categories and effort
values is offered. Since the syntax for categories and tags is identical
there should be no overlap between categories and tags. If there is, tags
get priority.
A single ‘C-u’ prefix arg STRIP-OR-ACCUMULATE will negate the
entire filter, which can be useful in connection with the prompt history.
A double ‘C-u C-u’ prefix arg will add the new filter elements to the
existing ones. A shortcut for this is to add an additional ‘+’ at the
beginning of the string, like ‘+-John’.
With a triple prefix argument, execute the computed filtering defined in
the variable ‘org-agenda-auto-exclude-function’.
org-agenda-filter-by-category (strip)
Filter lines in the agenda buffer that have a specific category. The category is that of the current line. With a ‘C-u’ prefix argument, exclude the lines of that category. When there is already a category filter in place, this command removes the filter.
org-agenda-filter-by-effort (strip-or-accumulate)
Filter agenda entries by effort. With no ‘C-u’ prefix argument, keep entries matching the effort condition. With one ‘C-u’ prefix argument, filter out entries matching the condition. With two ‘C-u’ prefix arguments, add a second condition to the existing filter. This last option is in practice not very useful, but it is available for consistency with the other filter commands.
org-agenda-filter-by-regexp (strip-or-accumulate)
Filter agenda entries by a regular expressions. You will be prompted for the regular expression, and the agenda view will only show entries that are matched by that expression. With one ‘C-u’ prefix argument, hide entries matching the regexp. When there is already a regexp filter active, this command removed the filter. However, with two ‘C-u’ prefix arguments, add a new condition to an already existing regexp filter.
org-agenda-filter-by-tag (strip-or-accumulate &optional char exclude)
Keep only those lines in the agenda buffer that have a specific tag. The tag is selected with its fast selection letter, as configured. With a ‘C-u’ prefix, apply the filter negatively, stripping all matches. With a ‘C-u C-u’ prefix, add the new tag to the existing filter instead of replacing it. With a ‘C-u C-u C-u’ prefix, filter the literal tag, i.e. don’t filter on all its group members. A Lisp caller can specify CHAR. EXCLUDE means that the new tag should be used to exclude the search - the interactive user can also press ‘-’ or ‘+’ to switch between filtering and excluding.
org-agenda-filter-by-top-headline (strip)
Keep only those lines that are descendants from the same top headline. The top headline is that of the current line. With prefix arg STRIP, hide all lines of the category at point.
org-agenda-filter-remove-all
Remove all filters from the current agenda buffer.
org-agenda-follow-mode
Toggle follow mode in an agenda buffer.
org-agenda-fontify-priorities
Make highest priority lines bold, and lowest italic.
org-agenda-fortnight-view (&optional iso-week)
Switch to fortnightly view for agenda. With argument ISO-WEEK, switch to the corresponding ISO week. If ISO-WEEK has more then 2 digits, only the last two encode the week. Any digits before this encode a year. So 200712 means week 12 of year 2007. Years ranging from 70 years ago to 30 years in the future can also be written as 2-digit years.
org-agenda-forward-block (&optional backward)
Move forward by one agenda block. When optional argument BACKWARD is set, go backward.
org-agenda-goto (&optional highlight)
Go to the entry at point in the corresponding Org file.
org-agenda-goto-calendar
Open the Emacs calendar with the date at the cursor.
org-agenda-goto-date (date)
Jump to DATE in the agenda buffer. When called interactively, prompt for the date. When called from Lisp, DATE should be a date as returned by ‘org-read-date’. See also: ‘org-agenda-earlier’ (M-x org-agenda-earlier) ‘org-agenda-later’ (M-x org-agenda-later) ‘org-agenda-goto-today’ (M-x org-agenda-goto-today)
org-agenda-goto-mouse (ev)
Go to the Org file which contains the item at the mouse click.
org-agenda-goto-today
Go to today’s date in the agenda buffer. See also: ‘org-agenda-later’ (M-x org-agenda-later) ‘org-agenda-earlier’ (M-x org-agenda-earlier) ‘org-agenda-goto-date’ (M-x org-agenda-goto-date)
org-agenda-holidays
Display the holidays for the 3 months around the cursor date.
org-agenda-kill
- Access:
C-k - In file: org-agenda.el
- Find modifications in git logs
Kill the entry or subtree belonging to the current agenda entry.
org-agenda-kill-all-agenda-buffers
Kill all buffers in ‘org-agenda-mode’. This is used when toggling sticky agendas.
org-agenda-later (arg)
Go forward in time by the current span in the agenda buffer. With prefix ARG, go forward that many times the current span. See also: ‘org-agenda-earlier’ (M-x org-agenda-earlier) ‘org-agenda-goto-today’ (M-x org-agenda-goto-today) ‘org-agenda-goto-date’ (M-x org-agenda-goto-date)
org-agenda-limit-interactively (remove)
In agenda, interactively limit entries to various maximums.
org-agenda-list (&optional arg start-day span with-hour)
Produce a daily/weekly view from all files in variable ‘org-agenda-files’. The view will be for the current day or week, but from the overview buffer you will be able to go to other days/weeks. With a numeric prefix argument in an interactive call, the agenda will span ARG days. Lisp programs should instead specify SPAN to change the number of days. SPAN defaults to ‘org-agenda-span’. START-DAY defaults to TODAY, or to the most recent match for the weekday given in ‘org-agenda-start-on-weekday’. When WITH-HOUR is non-nil, only include scheduled and deadline items if they have an hour specification like [h]h:mm.
org-agenda-list-stuck-projects (&rest _ignore)
Create agenda view for projects that are stuck. Stuck projects are project that have no next actions. For the definitions of what a project is and how to check if it stuck, customize the variable ‘org-stuck-projects’.
org-agenda-log-mode (&optional special)
Toggle log mode in an agenda buffer. With argument SPECIAL, show all possible log items, not only the ones configured in ‘org-agenda-log-mode-items’. With a ‘C-u C-u’ prefix, show *only* log items, nothing else.
org-agenda-manipulate-query-add
Manipulate the query by adding a search term with positive selection. Positive selection means the term must be matched for selection of an entry.
org-agenda-manipulate-query-add-re
Manipulate the query by adding a search regexp with positive selection. Positive selection means the regexp must match for selection of an entry.
org-agenda-manipulate-query-subtract
Manipulate the query by adding a search term with negative selection. Negative selection means term must not be matched for selection of an entry.
org-agenda-manipulate-query-subtract-re
Manipulate the query by adding a search regexp with negative selection. Negative selection means regexp must not match for selection of an entry.
org-agenda-mode
Mode for time-sorted view on action items in Org files.
The following commands are available:
Key Binding
-------------------------------------------------------------------------------
TAB org-agenda-goto
C-k org-agenda-kill
RET org-agenda-switch-to
C-n org-agenda-next-line
C-p org-agenda-previous-line
C-_ org-agenda-undo
SPC org-agenda-show-and-scroll-up
! org-agenda-toggle-deadlines
# org-agenda-dim-blocked-tasks
$ org-agenda-archive
% org-agenda-bulk-mark-regexp
* org-agenda-bulk-mark-all
+ org-agenda-priority-up
, org-agenda-priority
- org-agenda-priority-down
. org-agenda-goto-today
/ org-agenda-filter
0 .. 9 digit-argument
: org-agenda-set-tags
; org-timer-set-timer
< org-agenda-filter-by-category
= org-agenda-filter-by-regexp
> org-agenda-date-prompt
? org-agenda-show-the-flagging-note
A org-agenda-append-agenda
B org-agenda-bulk-action
C org-agenda-convert-date
D org-agenda-toggle-diary
E org-agenda-entry-text-mode
F org-agenda-follow-mode
G org-agenda-toggle-time-grid
H org-agenda-holidays
I org-agenda-clock-in
J org-agenda-clock-goto
K org-habit-toggle-display-in-agenda
L org-agenda-recenter
M org-agenda-phases-of-moon
N org-agenda-next-item
O org-agenda-clock-out
P org-agenda-previous-item
Q org-agenda-Quit
R org-agenda-clockreport-mode
S org-agenda-sunrise-sunset
T org-agenda-show-tags
U org-agenda-bulk-unmark-all
X org-agenda-clock-cancel
[ org-agenda-manipulate-query-add
\ org-agenda-filter-by-tag
] org-agenda-manipulate-query-subtract
^ org-agenda-filter-by-top-headline
_ org-agenda-filter-by-effort
a org-agenda-archive-default-with-confirmation
b org-agenda-earlier
c org-agenda-goto-calendar
d org-agenda-day-view
e org-agenda-set-effort
f org-agenda-later
g org-agenda-redo-all
h org-agenda-holidays
i org-agenda-diary-entry
j org-agenda-goto-date
k org-agenda-capture
l org-agenda-log-mode
m org-agenda-bulk-mark
n org-agenda-next-line
o delete-other-windows
p org-agenda-previous-line
q org-agenda-quit
r org-agenda-redo
s org-save-all-org-buffers
t org-agenda-todo
u org-agenda-bulk-unmark
v org-agenda-view-mode-dispatch
w org-agenda-week-view
x org-agenda-exit
y org-agenda-year-view
z org-agenda-add-note
{ org-agenda-manipulate-query-add-re
| org-agenda-filter-remove-all
} org-agenda-manipulate-query-subtract-re
~ org-agenda-limit-interactively
DEL org-agenda-show-scroll-down
C-/ org-agenda-undo
C-S-<left> org-agenda-todo-previousset
C-S-<right> org-agenda-todo-nextset
M-<down> org-agenda-drag-line-forward
M-<up> org-agenda-drag-line-backward
S-<down> org-agenda-priority-down
S-<left> org-agenda-do-date-earlier
S-<right> org-agenda-do-date-later
S-<up> org-agenda-priority-up
<backspace> org-agenda-show-scroll-down
<down> org-agenda-next-line
<mouse-2> org-agenda-goto-mouse
<mouse-3> org-agenda-show-mouse
<tab> org-agenda-goto
<undo> org-agenda-undo
<up> org-agenda-previous-line
M-* org-agenda-bulk-toggle-all
M-m org-agenda-bulk-toggle
C-c C-a org-attach
C-c C-c org-agenda-ctrl-c-ctrl-c
C-c C-d org-agenda-deadline
C-c C-n org-agenda-next-date-line
C-c C-o org-agenda-open-link
C-c C-p org-agenda-previous-date-line
C-c C-q org-agenda-set-tags
C-c C-s org-agenda-schedule
C-c C-t org-agenda-todo
C-c C-w org-agenda-refile
C-c C-z org-agenda-add-note
C-c $ org-agenda-archive
C-c , org-agenda-priority
C-x C-s org-save-all-org-buffers
C-x C-w org-agenda-write
C-x u org-agenda-undo
<remap> <backward-paragraph> org-agenda-backward-block
<remap> <forward-paragraph> org-agenda-forward-block
<remap> <move-end-of-line> org-agenda-end-of-line
C-c C-x C-a org-agenda-archive-default
C-c C-x C-c org-agenda-columns
C-c C-x C-e org-clock-modify-effort-estimate
C-c C-x TAB org-agenda-clock-in
C-c C-x C-j org-clock-goto
C-c C-x C-o org-agenda-clock-out
C-c C-x C-s org-agenda-archive
C-c C-x C-x org-agenda-clock-cancel
C-c C-x ! org-reload
C-c C-x < org-agenda-set-restriction-lock-from-agenda
C-c C-x > org-agenda-remove-restriction-lock
C-c C-x A org-agenda-archive-to-archive-sibling
C-c C-x I org-info-find-node
C-c C-x _ org-timer-stop
C-c C-x a org-agenda-toggle-archive-tag
C-c C-x b org-agenda-tree-to-indirect-buffer
C-c C-x e org-agenda-set-effort
C-c C-x p org-agenda-set-property
C-c C-x <down> org-agenda-priority-down
C-c C-x <left> org-agenda-do-date-earlier
C-c C-x <right> org-agenda-do-date-later
C-c C-x <up> org-agenda-priority-up
C-c C-x RET g org-mobile-pull
C-c C-x RET p org-mobile-push
org-agenda-month-view (&optional month)
Switch to monthly view for agenda. With argument MONTH, switch to that month. If MONTH has more then 2 digits, only the last two encode the month. Any digits before this encode a year. So 200712 means December year 2007. Years ranging from 70 years ago to 30 years in the future can also be written as 2-digit years.
org-agenda-next-date-line (&optional arg)
Jump to the next line indicating a date in agenda buffer.
org-agenda-next-item (n)
Move cursor to next agenda item.
org-agenda-next-line
Move cursor to the next line, and show if follow mode is active.
org-agenda-open-link (&optional arg)
Open the link(s) in the current entry, if any. This looks for a link in the displayed line in the agenda. It also looks at the text of the entry itself.
org-agenda-phases-of-moon
Display the phases of the moon for the 3 months around the cursor date.
org-agenda-prepare-buffers (files)
- In file: org.el
- Find modifications in git logs
Create buffers for all agenda files, protect archived trees and comments.
org-agenda-previous-date-line (&optional arg)
Jump to the previous line indicating a date in agenda buffer.
org-agenda-previous-item (n)
Move cursor to next agenda item.
org-agenda-previous-line
Move cursor to the previous line, and show if follow mode is active.
org-agenda-priority (&optional force-direction)
Set the priority of line at point, also in Org file. This changes the line at point, all other lines in the agenda referring to the same tree node, and the headline of the tree node in the Org file. Called with one universal prefix arg, show the priority instead of setting it. When called programmatically, FORCE-DIRECTION can be ‘set’, ‘up’, ‘down’, or a character.
org-agenda-priority-down
Decrease the priority of line at point, also in Org file.
org-agenda-priority-up
Increase the priority of line at point, also in Org file.
org-agenda-quit
Exit the agenda. When ‘org-agenda-sticky’ is non-nil, bury the agenda buffer instead of killing it. When ‘org-agenda-restore-windows-after-quit’ is non-nil, restore the pre-agenda window configuration. When column view is active, exit column view instead of the agenda.
org-agenda-recenter (arg)
Display the Org file which contains the item at point and recenter.
org-agenda-redo (&optional all)
Rebuild possibly ALL agenda view(s) in the current buffer.
org-agenda-redo-all (&optional exhaustive)
Rebuild all agenda views in the current buffer. With a prefix argument, do so in all agenda buffers.
org-agenda-refile (&optional goto rfloc no-update)
Refile the item at point. When called with ‘C-u C-u’, go to the location of the last refiled item. When called with ‘C-u C-u C-u’ prefix or when GOTO is 0, clear the refile cache. RFLOC can be a refile location obtained in a different way. When NO-UPDATE is non-nil, don’t redo the agenda buffer.
org-agenda-remove-filter (type)
Remove filter of type TYPE from the agenda buffer.
org-agenda-remove-restriction-lock (&optional noupdate)
- Access:
C-c C-x > - In file: org-agenda.el
- Find modifications in git logs
Remove agenda restriction lock.
org-agenda-reset-view
Switch to default view for agenda.
org-agenda-schedule (arg &optional time)
Schedule the item at point. ARG is passed through to ‘org-schedule’.
org-agenda-set-effort
Set the effort property for the current headline.
org-agenda-set-property
Set a property for the current headline.
org-agenda-set-restriction-lock (&optional type)
- Access:
C-c C-x < - In file: org-agenda.el
- Find modifications in git logs
Set restriction lock for agenda to current subtree or file. When in a restricted subtree, remove it. The restriction will span over the entire file if TYPE is ‘file’, or if TYPE is (4), or if the cursor is before the first headline in the file. Otherwise, only apply the restriction to the current subtree.
org-agenda-set-restriction-lock-from-agenda (arg)
Set the restriction lock to the agenda item at point from within the agenda. When called with a ‘C-u’ prefix, restrict to the file which contains the item. Argument ARG is the prefix argument.
org-agenda-show (&optional full-entry)
Display the Org file which contains the item at point. With prefix argument FULL-ENTRY, make the entire entry visible if it was hidden in the outline.
org-agenda-show-1 (&optional more)
Display the Org file which contains the item at point. The prefix arg selects the amount of information to display: 0 hide the subtree 1 just show the entry according to defaults. 2 show the children view 3 show the subtree view 4 show the entire subtree and any drawers With prefix argument FULL-ENTRY, make the entire entry visible if it was hidden in the outline.
org-agenda-show-and-scroll-up (&optional arg)
Display the Org file which contains the item at point. When called repeatedly, scroll the window that is displaying the buffer. With a ‘C-u’ prefix argument, display the item, but fold drawers.
org-agenda-show-clocking-issues
Add overlays, showing issues with clocking. See also the user option ‘org-agenda-clock-consistency-checks’.
org-agenda-show-mouse (ev)
Display the Org file which contains the item at the mouse click.
org-agenda-show-scroll-down
Scroll down the window showing the agenda.
org-agenda-show-the-flagging-note
Display the flagging note in the other window. When called a second time in direct sequence, offer to remove the FLAGGING tag and (if present) the flagging note.
org-agenda-sunrise-sunset (arg)
Display sunrise and sunset for the cursor date. Latitude and longitude can be specified with the variables ‘calendar-latitude’ and ‘calendar-longitude’. When called with prefix argument, latitude and longitude will be prompted for.
org-agenda-switch-to (&optional delete-other-windows)
Go to the Org mode file which contains the item at point. When optional argument DELETE-OTHER-WINDOWS is non-nil, the displayed Org file fills the frame.
org-agenda-to-appt (&optional refresh filter &rest args)
Activate appointments found in ‘org-agenda-files’.
With a ‘C-u’ prefix, refresh the list of appointments.
If FILTER is t, interactively prompt the user for a regular
expression, and filter out entries that don’t match it.
If FILTER is a string, use this string as a regular expression
for filtering entries out.
If FILTER is a function, filter out entries against which
calling the function returns nil. This function takes one
argument: an entry from ‘org-agenda-get-day-entries’.
FILTER can also be an alist with the car of each cell being
either ‘headline’ or ‘category’. For example:
((headline "IMPORTANT")
(category "Work"))
will only add headlines containing IMPORTANT or headlines
belonging to the "Work" category.
ARGS are symbols indicating what kind of entries to consider.
By default ‘org-agenda-to-appt’ will use :deadline*, :scheduled*
(i.e., deadlines and scheduled items with a hh:mm specification)
and :timestamp entries. See the docstring of ‘org-diary’ for
details and examples.
If an entry has a APPT_WARNTIME property, its value will be used
to override ‘appt-message-warning-time’.
org-agenda-todo (&optional arg)
Cycle TODO state of line at point, also in Org file. This changes the line at point, all other lines in the agenda referring to the same tree node, and the headline of the tree node in the Org file.
org-agenda-todo-nextset
Switch TODO entry to next sequence.
org-agenda-todo-previousset
Switch TODO entry to previous sequence.
org-agenda-todo-yesterday (&optional arg)
Like ‘org-agenda-todo’ but the time of change will be 23:59 of yesterday.
org-agenda-toggle-archive-tag
Toggle the archive tag for the current entry.
org-agenda-toggle-deadlines
Toggle inclusion of entries with a deadline in an agenda buffer.
org-agenda-toggle-diary
Toggle diary inclusion in an agenda buffer.
org-agenda-toggle-time-grid
Toggle time grid in an agenda buffer.
org-agenda-tree-to-indirect-buffer (arg)
Show the subtree corresponding to the current entry in an indirect buffer. This calls the command ‘org-tree-to-indirect-buffer’ from the original buffer. With a numerical prefix ARG, go up to this level and then take that tree. With a negative numeric ARG, go up by this number of levels. With a ‘C-u’ prefix, make a separate frame for this tree, i.e. don’t use the dedicated frame.
org-agenda-undo
- Access:
C-/, <undo>, C-_ - In file: org-agenda.el
- Find modifications in git logs
Undo a remote editing step in the agenda. This undoes changes both in the agenda buffer and in the remote buffer that have been changed along.
org-agenda-view-mode-dispatch
Call one of the view mode commands.
org-agenda-week-view (&optional iso-week)
Switch to weekly view for agenda. With argument ISO-WEEK, switch to the corresponding ISO week. If ISO-WEEK has more then 2 digits, only the last two encode the week. Any digits before this encode a year. So 200712 means week 12 of year 2007. Years ranging from 70 years ago to 30 years in the future can also be written as 2-digit years.
org-agenda-write (file &optional open nosettings _)
Write the current buffer (an agenda view) as a file. Depending on the extension of the file name, plain text (.txt), HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced. If the extension is .ics, translate visible agenda into iCalendar format. If the extension is .org, collect all subtrees corresponding to the agenda entries and add them in an .org file. With prefix argument OPEN, open the new file immediately. If NOSETTINGS is given, do not scope the settings of ‘org-agenda-exporter-settings’ into the export commands. This is used when the settings have already been scoped and we do not wish to overrule other, higher priority settings.
org-agenda-year-view (&optional year)
Switch to yearly view for agenda. With argument YEAR, switch to that year. Years ranging from 70 years ago to 30 years in the future can also be written as 2-digit years.
org-archive-set-tag
Set the ARCHIVE tag.
org-archive-subtree (&optional find-done)
- Access:
C-c $, C-c C-x C-s - In file: org-archive.el
- Find modifications in git logs
Move the current subtree to the archive. The archive can be a certain top-level heading in the current file, or in a different file. The tree will be moved to that location. If ‘org-archive-mark-done’ is non-nil and the subtree has a TODO keyword, the subtree heading will be marked DONE. And the current time will be added. When called with a single prefix argument FIND-DONE, find whole trees without any open TODO items and archive them (after getting confirmation from the user). When called with a double prefix argument, find whole trees with timestamps before today and archive them (after getting confirmation from the user). If the cursor is not at a headline when these commands are called, try all level 1 trees. If the cursor is on a headline, only try the direct children of this heading.
org-archive-subtree-default
- Access:
C-c C-x C-a - In file: org-archive.el
- Find modifications in git logs
Archive the current subtree with the default command. This command is set with the variable ‘org-archive-default-command’.
org-archive-subtree-default-with-confirmation
Archive the current subtree with the default command. This command is set with the variable ‘org-archive-default-command’.
org-archive-to-archive-sibling
- Access:
C-c C-x A - In file: org-archive.el
- Find modifications in git logs
Archive the current heading by moving it under the archive sibling. The archive sibling is a sibling of the heading with the heading name ‘org-archive-sibling-heading’ and an ‘org-archive-tag’ tag. If this sibling does not exist, it will be created at the end of the subtree. Archiving time is retained in the ARCHIVE_TIME node property.
org-ascii-convert-region-to-ascii
Assume region has Org syntax, and convert it to plain ASCII.
org-ascii-convert-region-to-utf8
Assume region has Org syntax, and convert it to UTF-8.
org-ascii-export-as-ascii (&optional async subtreep visible-only body-only ext-plist)
Export current buffer to a text buffer. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting buffer should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, strip title and table of contents from output. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Export is done in a buffer named "*Org ASCII Export*", which will be displayed when ‘org-export-show-temporary-export-buffer’ is non-nil.
org-ascii-export-to-ascii (&optional async subtreep visible-only body-only ext-plist)
Export current buffer to a text file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, strip title and table of contents from output. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Return output file’s name.
org-attach
- Access:
C-c C-a - In file: org-attach.el
- Find modifications in git logs
The dispatcher for attachment commands. Shows a list of commands and prompts for another key to execute a command.
org-attach-attach (file &optional visit-dir method)
Move/copy/link FILE into the attachment directory of the current outline node. If VISIT-DIR is non-nil, visit the directory with ‘dired’. METHOD may be ‘cp’, ‘mv’, ‘ln’, ‘lns’ or ‘url’ default taken from ‘org-attach-method’. Return a list (LINK DESCRIPTION), representing the file stored. When ‘org-attach-store-link-p’ is non-nil, LINK and DESCRIPTION will be the same as in the link stored. When ‘org-attach-store-link-p’ is nil, LINK will be an attachment: link and DESCRIPTION be the file name.
org-attach-attach-cp
Attach a file by copying it.
org-attach-attach-ln
Attach a file by creating a hard link to it. Beware that this does not work on systems that do not support hard links. On some systems, this apparently does copy the file instead.
org-attach-attach-lns
Attach a file by creating a symbolic link to it. Beware that this does not work on systems that do not support symbolic links. On some systems, this apparently does copy the file instead.
org-attach-attach-mv
Attach a file by moving (renaming) it.
org-attach-buffer (buffer-name)
Attach BUFFER-NAME’s contents to current outline node. BUFFER-NAME is a string. Signals a ‘file-already-exists’ error if it would overwrite an existing filename.
org-attach-delete-all (&optional force)
Delete all attachments from the current outline node. This actually deletes the entire attachment directory. A safer way is to open the directory in ‘dired’ and delete from there. With prefix argument FORCE, directory will be recursively deleted with no prompts.
org-attach-delete-one (&optional attachment)
Delete a single ATTACHMENT.
org-attach-dir-get-create
Return existing or new directory associated with the current outline node. ‘org-attach-preferred-new-method’ decides how to attach new directory if neither ID nor DIR property exist. If the attachment by some reason cannot be created an error will be raised.
org-attach-dired-to-subtree (files)
Attach FILES marked or current file in ‘dired’ to subtree in other window. Takes the method given in ‘org-attach-method’ for the attach action. Precondition: Point must be in a ‘dired’ buffer. Idea taken from ‘gnus-dired-attach’.
org-attach-new (file)
Create a new attachment FILE for the current outline node. The attachment is created as an Emacs buffer.
org-attach-open (&optional in-emacs)
Open an attachment of the current outline node. If there are more than one attachment, you will be prompted for the file name. This command will open the file using the settings in ‘org-file-apps’ and in the system-specific variants of this variable. If IN-EMACS is non-nil, force opening in Emacs.
org-attach-open-in-emacs
Open attachment, force opening in Emacs. See ‘org-attach-open’.
org-attach-reveal
Show the attachment directory of the current outline node. This will attempt to use an external program to show the directory. Will create an attachment and folder if it doesn’t exist yet. Respects ‘org-attach-preferred-new-method’.
org-attach-reveal-in-emacs
Show the attachment directory of the current outline node in ‘dired’. Will create an attachment and folder if it doesn’t exist yet. Respects ‘org-attach-preferred-new-method’.
org-attach-set-directory
Set the DIR node property and ask to move files there. The property defines the directory that is used for attachments of the entry. Creates relative links if ‘org-attach-dir-relative’ is non-nil. Return the directory.
org-attach-sync
Synchronize the current outline node with its attachments. Useful after files have been added/removed externally. Option ‘org-attach-sync-delete-empty-dir’ controls the behavior for empty attachment directories.
org-attach-unset-directory
Remove DIR node property. If attachment folder is changed due to removal of DIR-property ask to move attachments to new location and ask to delete old attachment-folder. Change of attachment-folder due to unset might be if an ID property is set on the node, or if a separate inherited DIR-property exists (that is different from the unset one).
org-attach-url (url)
Attach URL.
org-babel-check-src-block
- Access:
C-c C-v c, C-c C-v C-c - In file: ob-core.el
- Find modifications in git logs
Check for misspelled header arguments in the current code block.
org-babel-demarcate-block (&optional arg)
- Access:
C-c C-v d, C-c C-v C-d, C-d - In file: ob-core.el
- Find modifications in git logs
Wrap or split the code in an active region or at point. With prefix argument ARG, also create a new heading at point. When called from inside of a code block the current block is split. When called from outside of a code block a new code block is created. In both cases if the region is demarcated and if the region is not active then the point is demarcated. When called within blank lines after a code block, create a new code block of the same language as the previous.
org-babel-describe-bindings
- Access:
C-c C-v h - In file: org-keys.el
- Find modifications in git logs
Describe all keybindings behind ‘org-babel-key-prefix’.
org-babel-detangle (&optional source-code-file)
Propagate changes from current source buffer back to the original Org file. This requires that code blocks were tangled with link comments which enable the original code blocks to be found. Optional argument SOURCE-CODE-FILE is the file path to be used instead of the current buffer.
org-babel-do-key-sequence-in-edit-buffer (key)
- Access:
C-c C-v x, C-c C-v C-x - In file: ob-core.el
- Find modifications in git logs
Read key sequence KEY and execute the command in edit buffer. Enter a key sequence to be executed in the language major-mode edit buffer. For example, TAB will alter the contents of the Org code block according to the effect of TAB in the language major mode buffer. For languages that support interactive sessions, this can be used to send code from the Org buffer to the session for evaluation using the native major mode evaluation mechanisms.
org-babel-examplify-region (beg end &optional results-switches inline)
- In file: ob-core.el
- Find modifications in git logs
Comment out region BEG..END using the inline ‘==’ or ‘: ’ org example quote. When INLINE is non-nil, use the inline verbatim markup. When INLINE is nil and RESULTS-SWITCHES is non-nil, RESULTS-SWITCHES is used as a string to be appended to #+begin_example line.
org-babel-examplize-region (beg end &optional results-switches inline)
Comment out region BEG..END using the inline ‘==’ or ‘: ’ org example quote. When INLINE is non-nil, use the inline verbatim markup. When INLINE is nil and RESULTS-SWITCHES is non-nil, RESULTS-SWITCHES is used as a string to be appended to #+begin_example line.
org-babel-execute-buffer (&optional arg)
- Access:
C-c C-v b, C-c C-v C-b, C-b - In file: ob-core.el
- Find modifications in git logs
Execute source code blocks in a buffer. Prefix argument ARG is passed to ‘org-babel-execute-src-block’. Call ‘org-babel-execute-src-block’ on every source block in the current buffer.
org-babel-execute-maybe
- Access:
C-c C-v C-e, C-c C-v e, C-e - In file: ob-core.el
- Find modifications in git logs
Execute src block or babel call at point.
org-babel-execute-src-block (&optional arg info params executor-type)
- In file: ob-core.el
- Find modifications in git logs
Execute the current source code block and return the result. Insert the results of execution into the buffer. Source code execution and the collection and formatting of results can be controlled through a variety of header arguments. With prefix argument ARG, force re-execution even if an existing result cached in the buffer would otherwise have been returned. Optionally supply a value for INFO in the form returned by ‘org-babel-get-src-block-info’. Optionally supply a value for PARAMS which will be merged with the header arguments specified at the front of the source code block. EXECUTOR-TYPE is the type of the org element responsible for the execution of the source block. If not provided then informed guess will be made.
org-babel-execute-src-block-maybe
- In file: ob-core.el
- Find modifications in git logs
Conditionally execute a source block. Detect if this is context for a Babel src-block and if so then run ‘org-babel-execute-src-block’.
org-babel-execute-subtree (&optional arg)
- Access:
C-c C-v s, C-c C-v C-s - In file: ob-core.el
- Find modifications in git logs
Execute source code blocks in a subtree. Call ‘org-babel-execute-src-block’ on every source block in the current subtree, passing over the prefix argument ARG.
org-babel-exp-process-buffer
- In file: ob-exp.el
- Find modifications in git logs
Execute all Babel blocks in current buffer.
org-babel-exp-src-block (&optional element)
- In file: ob-exp.el
- Find modifications in git logs
Process source block for export.
Depending on the ":export" header argument, replace the source
code block like this:
both ---- display the code and the results
code ---- the default, display the code inside the block but do
not process
results - just like none only the block is run on export ensuring
that its results are present in the Org mode buffer
none ---- do not display either code or results upon export
Optional argument ELEMENT must contain source block element at point.
Assume point is at block opening line.
org-babel-expand-src-block (&optional _arg info params)
- Access:
C-c C-v v, C-c C-v C-v - In file: ob-core.el
- Find modifications in git logs
Expand the current source code block or block specified by INFO. INFO is the output of ‘org-babel-get-src-block-info’. PARAMS defines inherited header arguments. Expand according to the source code block’s header arguments and pop open the results in a preview buffer.
org-babel-expand-src-block-maybe
- In file: ob-core.el
- Find modifications in git logs
Conditionally expand a source block. Detect if this is context for an org-babel src-block and if so then run ‘org-babel-expand-src-block’.
org-babel-goto-named-result (name)
- Access:
C-c C-v C-r, C-c C-v r - In file: ob-core.el
- Find modifications in git logs
Go to a result with NAME.
org-babel-goto-named-src-block (name)
- Access:
C-c C-v g - In file: ob-core.el
- Find modifications in git logs
Go to a source-code block with NAME.
org-babel-goto-src-block-head
- Access:
C-c C-v C-u, C-c C-v u, C-u - In file: ob-core.el
- Find modifications in git logs
Go to the beginning of the current code block.
org-babel-hash-at-point (&optional point)
- In file: ob-core.el
- Find modifications in git logs
Return the value of the hash at POINT. The hash is also added as the last element of the kill ring. This can be called with ‘C-c C-c’.
org-babel-haskell-export-to-lhs (&optional arg)
Export to a .lhs file with all haskell code blocks escaped. When called with a prefix argument the resulting .lhs file will be exported to a .tex file. This function will create two new files, base-name.lhs and base-name.tex where base-name is the name of the current Org file. Note that all standard Babel literate programming constructs (header arguments, no-web syntax etc...) are ignored.
org-babel-hide-result-toggle (&optional force)
- In file: ob-core.el
- Find modifications in git logs
Toggle the visibility of the current result. When FORCE is symbol ‘off’, unconditionally display the result. Otherwise, when FORCE is non-nil, unconditionally hide the result.
org-babel-hide-result-toggle-maybe
- In file: ob-core.el
- Find modifications in git logs
Toggle visibility of result at point.
org-babel-initiate-session (&optional arg info)
- In file: ob-core.el
- Find modifications in git logs
Initiate session for current code block or the block defined by INFO. If called with a prefix argument ARG, then resolve any variable references in the header arguments and assign these variables in the session. Copy the body of the code block to the kill ring.
org-babel-insert-header-arg (&optional header-arg value)
- Access:
C-c C-v j, C-c C-v C-j - In file: ob-core.el
- Find modifications in git logs
Insert a header argument and its value. HEADER-ARG and VALUE, when provided, are the header argument name and its value. When HEADER-ARG or VALUE are nil, offer interactive completion from lists of common args and values.
org-babel-lilypond-tangle
Tangle lilypond blocks, then ‘org-babel-lilypond-execute-tangled-ly’.
org-babel-lilypond-toggle-arrange-mode
Toggle whether in Arrange mode or Basic mode.
org-babel-lilypond-toggle-html-generation
Toggle whether html will be generated by compilation.
org-babel-lilypond-toggle-midi-play
Toggle whether midi will be played following a successful compilation.
org-babel-lilypond-toggle-pdf-display
Toggle whether pdf will be displayed following a successful compilation.
org-babel-lilypond-toggle-pdf-generation
Toggle whether pdf will be generated by compilation.
org-babel-lilypond-toggle-png-generation
Toggle whether png image will be generated by compilation.
org-babel-load-file (file &optional compile)
- In file: org.el
- Find modifications in git logs
Load Emacs Lisp source code blocks in the Org FILE. This function exports the source code using ‘org-babel-tangle’ and then loads the resulting file using ‘load-file’. With optional prefix argument COMPILE, the tangled Emacs Lisp file is byte-compiled before it is loaded.
org-babel-load-in-session (&optional _arg info)
- Access:
C-c C-v l, C-c C-v C-l, C-l - In file: ob-core.el
- Find modifications in git logs
Load the body of the current source-code block. When optional argument INFO is non-nil, use source block defined in INFO, as returned by ‘org-babel-get-src-block-info’. Evaluate the header arguments for the source block before entering the session. After loading the body this pops open the session.
org-babel-load-in-session-maybe
- In file: ob-core.el
- Find modifications in git logs
Conditionally load a source block in a session. Detect if this is context for an org-babel src-block and if so then run ‘org-babel-load-in-session’.
org-babel-lob-execute-maybe
- In file: ob-lob.el
- Find modifications in git logs
Execute a Library of Babel source block, if appropriate. Detect if this is context for a Library Of Babel source block and if so then run the appropriate source block from the Library.
org-babel-lob-ingest (&optional file)
- Access:
C-c C-v i - In file: ob-lob.el
- Find modifications in git logs
Add all named source blocks defined in FILE to ‘org-babel-library-of-babel’.
org-babel-mark-block
- Access:
C-c C-v C-M-h, C-M-h - In file: ob-core.el
- Find modifications in git logs
Mark current source block.
org-babel-next-src-block (&optional arg)
- Access:
C-c C-v C-n, C-c C-v n - In file: ob-core.el
- Find modifications in git logs
Jump to the next source block. With optional prefix argument ARG, jump forward ARG many source blocks.
org-babel-open-src-block-result (&optional re-run)
- Access:
C-c C-v C-o, C-c C-v o, C-o - In file: ob-core.el
- Find modifications in git logs
Open results of source block at point. If ‘point’ is on a source block then open the results of the source code block, otherwise return nil. With optional prefix argument RE-RUN the source-code block is evaluated even if results already exist.
org-babel-pop-to-session (&optional arg info)
- In file: ob-core.el
- Find modifications in git logs
Switch to the session of the current code block or block defined by INFO. Uses ‘org-babel-initiate-session’ to start the session. If called with a prefix argument ARG, then this is passed on to ‘org-babel-initiate-session’.
org-babel-pop-to-session-maybe
- In file: ob-core.el
- Find modifications in git logs
Conditionally pop to a session. Detect if this is context for an org-babel src-block and if so then run ‘org-babel-switch-to-session’.
org-babel-previous-src-block (&optional arg)
- Access:
C-c C-v C-p, C-c C-v p - In file: ob-core.el
- Find modifications in git logs
Jump to the previous source block. With optional prefix argument ARG, jump backward ARG many source blocks.
org-babel-processing-view-sketch
Show the sketch of the Processing block under point in an external viewer.
org-babel-remove-inline-result (&optional datum)
- In file: ob-core.el
- Find modifications in git logs
Remove the result of DATUM or the current inline-src-block or babel call. The result must be wrapped in a ‘results’ macro to be removed. Leading white space is trimmed.
org-babel-remove-result (&optional info keep-keyword)
- In file: ob-core.el
- Find modifications in git logs
Remove the result of the current source block. INFO argument is currently ignored. When KEEP-KEYWORD is non-nil, keep the #+RESULT keyword and just remove the rest of the result.
org-babel-remove-result-one-or-many (arg)
- Access:
C-c C-v k - In file: ob-core.el
- Find modifications in git logs
Remove the result of the current source block. If called with prefix argument ARG, remove all result blocks in the buffer.
org-babel-result-hide-all
- In file: ob-core.el
- Find modifications in git logs
Fold all results in the current buffer.
org-babel-screen-test
Test if the default setup works. The terminal should shortly flicker.
org-babel-sha1-hash (&optional info context)
- Access:
C-c C-v a, C-c C-v C-a, C-a - In file: ob-core.el
- Find modifications in git logs
Generate a sha1 hash based on the value of INFO. CONTEXT specifies the context of evaluation. It can be ‘:eval’, ‘:export’, ‘:tangle’. A nil value means ‘:eval’.
org-babel-shell-initialize
Define execution functions associated to shell names. This function has to be called whenever ‘org-babel-shell-names’ is modified outside the Customize interface.
org-babel-switch-to-session (&optional arg info)
- Access:
C-c C-v C-z, C-z - In file: ob-core.el
- Find modifications in git logs
Switch to the session of the current code block or block defined by INFO. Uses ‘org-babel-initiate-session’ to start the session. If called with a prefix argument ARG, then this is passed on to ‘org-babel-initiate-session’.
org-babel-switch-to-session-with-code (&optional arg _info)
- Access:
C-c C-v z - In file: ob-core.el
- Find modifications in git logs
Switch to code buffer and display session. Prefix argument ARG is passed to ‘org-babel-switch-to-session’.
org-babel-tangle (&optional arg target-file lang-re)
- Access:
C-c C-v t, C-c C-v C-t, C-t - In file: ob-tangle.el
- Find modifications in git logs
Write code blocks to source-specific files. Extract the bodies of all source code blocks from the current file into their own source-specific files. Return the list of files. With one universal prefix argument, only tangle the block at point. When two universal prefix arguments, only tangle blocks for the tangle file of the block at point. Optional argument TARGET-FILE can be used to specify a default export file for all source blocks. Optional argument LANG-RE can be used to limit the exported source code blocks by languages matching a regular expression.
org-babel-tangle-clean
Remove comments inserted by ‘org-babel-tangle’. Call this function inside of a source-code file generated by ‘org-babel-tangle’ to remove all comments inserted automatically by ‘org-babel-tangle’. Warning, this comment removes any lines containing constructs which resemble Org file links or noweb references.
org-babel-tangle-file (file &optional target-file lang-re)
- Access:
C-c C-v f, C-c C-v C-f, C-f - In file: ob-tangle.el
- Find modifications in git logs
Extract the bodies of source code blocks in FILE. Source code blocks are extracted with ‘org-babel-tangle’. Optional argument TARGET-FILE can be used to specify a default export file for all source blocks. Optional argument LANG-RE can be used to limit the exported source code blocks by languages matching a regular expression. Return list of the tangled file names.
org-babel-tangle-jump-to-org
Jump from a tangled code file to the related Org mode file.
org-babel-view-src-block-info
- Access:
C-c C-v I, C-c C-v TAB - In file: ob-core.el
- Find modifications in git logs
Display information on the current source block. This includes header arguments, language and name, and is largely a window into the ‘org-babel-get-src-block-info’ function.
org-backward-element
- Access:
M-{ - In file: org.el
- Find modifications in git logs
Move backward by one element. Move to the previous element at the same level, when possible.
org-backward-heading-same-level (arg &optional invisible-ok)
- In file: org.el
- Find modifications in git logs
Move backward to the ARG’th subheading at same level as this one. Stop at the first and last subheadings of a superior heading.
org-backward-paragraph (&optional arg)
- In file: org.el
- Find modifications in git logs
Move backward by a paragraph, or equivalent, unit.
With argument ARG, do it ARG times;
a negative argument ARG = -N means move forward N paragraphs.
The function moves point between two structural
elements (paragraphs, tables, lists, etc.).
It also provides the following special moves for convenience:
- on a table or a property drawer, move to its beginning;
- on comment, example, export, source and verse blocks, stop
at blank lines;
- skip consecutive clocks, diary S-exps, and keywords.
org-backward-sentence (&optional _arg)
- In file: org.el
- Find modifications in git logs
Go to beginning of sentence, or beginning of table field. This will call ‘backward-sentence’ or ‘org-table-beginning-of-field’, depending on context.
org-beamer-export-as-latex (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a Beamer buffer.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer should be accessible
through the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Export is done in a buffer named "*Org BEAMER Export*", which
will be displayed when ‘org-export-show-temporary-export-buffer’
is non-nil.
org-beamer-export-to-latex (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a Beamer presentation (tex).
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return output file’s name.
org-beamer-export-to-pdf (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a Beamer presentation (PDF).
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return PDF file’s name.
org-beamer-mode (&optional arg)
Support for editing Beamer oriented Org mode files. This is a minor mode. If called interactively, toggle the ‘Org-Beamer mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-beamer-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled. Key Binding ------------------------------------------------------------------------------- C-c C-b org-beamer-select-environment
org-beamer-select-environment
- Access:
C-c C-b - In file: ox-beamer.el
- Find modifications in git logs
Select the environment to be used by beamer for this entry. While this uses (for convenience) a tag selection interface, the result of this command will be that the BEAMER_env *property* of the entry is set. In addition to this, the command will also set a tag as a visual aid, but the tag does not have any semantic meaning.
org-beginning-of-item
Go to the beginning of the current item. Throw an error when not in a list.
org-beginning-of-item-list
Go to the beginning item of the current list or sublist. Throw an error when not in a list.
org-beginning-of-line (&optional n)
- In file: org.el
- Find modifications in git logs
Go to the beginning of the current visible line. If this is a headline, and ‘org-special-ctrl-a/e’ is not nil or symbol ‘reversed’, on the first attempt move to where the headline text starts, and only move to beginning of line when the cursor is already before the start of the text of the headline. If ‘org-special-ctrl-a/e’ is symbol ‘reversed’ then go to the start of the text on the second attempt. With argument N not nil or 1, move forward N - 1 lines first.
org-bibtex (filename)
Export each headline in the current file to a bibtex entry. Headlines are exported using ‘org-bibtex-headline’.
org-bibtex-check (&optional optional)
Check the current headline for required fields. With prefix argument OPTIONAL also prompt for optional fields.
org-bibtex-check-all (&optional optional)
Check all headlines in the current file. With prefix argument OPTIONAL also prompt for optional fields.
org-bibtex-create (&optional arg update-heading)
Create a new entry at the given level. With a prefix ARG, query for optional fields as well. If UPDATE-HEADING is non-nil, add data to the headline of the entry at point.
org-bibtex-create-in-current-entry (&optional arg)
Add bibliographical data to the current entry. With a prefix arg, query for optional fields.
org-bibtex-export-to-kill-ring
Export current headline to kill ring as bibtex entry.
org-bibtex-import-from-file (file)
Read bibtex entries from FILE and insert as Org headlines after point.
org-bibtex-read
Read a bibtex entry and save to ‘org-bibtex-entries’. This uses ‘bibtex-parse-entry’. Return the new value of ‘org-bibtex-entries’.
org-bibtex-read-buffer (buffer)
Read all bibtex entries in BUFFER and save to ‘org-bibtex-entries’. Return the number of saved entries.
org-bibtex-read-file (file)
Read FILE with ‘org-bibtex-read-buffer’.
org-bibtex-search (string)
Search for bibliographical entries in agenda files. This function relies ‘org-search-view’ to locate results.
org-bibtex-write (&optional noindent update-heading)
Insert a heading built from the first element of ‘org-bibtex-entries’. When optional argument NOINDENT is non-nil, do not indent the properties drawer. If UPDATE-HEADING is non-nil, add data to the headline of the entry at point.
org-bibtex-yank (&optional update-heading)
If kill ring holds a bibtex entry yank it as an Org headline. When called with non-nil prefix argument UPDATE-HEADING, add data to the headline of the entry at point.
org-browse-news
- In file: org.el
- Find modifications in git logs
Browse the news for the latest major release.
org-calendar-backward-day
- In file: org.el
- Find modifications in git logs
Move the cursor backward by one day.
org-calendar-backward-month
- In file: org.el
- Find modifications in git logs
Move the cursor backward by one month.
org-calendar-backward-week
- In file: org.el
- Find modifications in git logs
Move the cursor backward by one week.
org-calendar-backward-year
- In file: org.el
- Find modifications in git logs
Move the cursor backward by one year.
org-calendar-forward-day
- In file: org.el
- Find modifications in git logs
Move the cursor forward by one day.
org-calendar-forward-month
- In file: org.el
- Find modifications in git logs
Move the cursor forward by one month.
org-calendar-forward-week
- In file: org.el
- Find modifications in git logs
Move the cursor forward by one week.
org-calendar-forward-year
- In file: org.el
- Find modifications in git logs
Move the cursor forward by one year.
org-calendar-goto-agenda
Compute the Org agenda for the calendar date displayed at the cursor. This is a command that has to be installed in ‘calendar-mode-map’.
org-calendar-goto-today
- Access:
C-. - In file: org.el
- Find modifications in git logs
Reposition the calendar window so the current date is visible.
org-calendar-goto-today-or-insert-dot
- In file: org.el
- Find modifications in git logs
Go to the current date, or insert a dot. If at the beginning of the prompt, behave as ‘org-calendar-goto-today’ else insert ".".
org-calendar-scroll-month-left
- In file: org.el
- Find modifications in git logs
Scroll the displayed calendar left by one month.
org-calendar-scroll-month-right
- In file: org.el
- Find modifications in git logs
Scroll the displayed calendar right by one month.
org-calendar-scroll-three-months-left
- Access:
C-v - In file: org.el
- Find modifications in git logs
Scroll the displayed calendar left by three months.
org-calendar-scroll-three-months-right
- Access:
M-v - In file: org.el
- Find modifications in git logs
Scroll the displayed calendar right by three months.
org-calendar-select
- In file: org.el
- Find modifications in git logs
Return to ‘org-read-date’ with the date currently selected. This is used by ‘org-read-date’ in a temporary keymap for the calendar buffer.
org-calendar-select-mouse (ev)
- In file: org.el
- Find modifications in git logs
Return to ‘org-read-date’ with the date currently selected. This is used by ‘org-read-date’ in a temporary keymap for the calendar buffer.
org-calendar-view-entries
- In file: org.el
- Find modifications in git logs
Prepare and display a buffer with diary entries.
org-cancel-repeater
- In file: org.el
- Find modifications in git logs
Cancel all the repeaters in entry by setting their numeric value to zero.
org-cancel-repeaters
- In file: org.el
- Find modifications in git logs
Cancel all the repeaters in entry by setting their numeric value to zero.
org-capture (&optional goto keys)
Capture something. This will let you select a template from ‘org-capture-templates’, and then file the newly captured information. The text is immediately inserted at the target location, and an indirect buffer is shown where you can edit it. Pressing ‘C-c C-c’ brings you back to the previous state of Emacs, so that you can continue your work. When called interactively with a ‘C-u’ prefix argument GOTO, don’t capture anything, just go to the file/headline where the selected template stores its notes. With a ‘C-u C-u’ prefix argument, go to the last note stored. When called with a ‘C-0’ (zero) prefix, insert a template at point. When called with a ‘C-1’ (one) prefix, force prompting for a date when a datetree entry is made. Elisp programs can set KEYS to a string associated with a template in ‘org-capture-templates’. In this case, interactive selection will be bypassed. If ‘org-capture-use-agenda-date’ is non-nil, capturing from the agenda will use the date at point as the default date. Then, a ‘C-1’ prefix will tell the capture process to use the HH:MM time of the day at point (if any) or the current HH:MM time.
org-capture-finalize (&optional stay-with-capture)
Finalize the capture process. With prefix argument STAY-WITH-CAPTURE, jump to the location of the captured item after finalizing.
org-capture-goto-last-stored
Go to the location where the last capture note was stored.
org-capture-goto-target (&optional template-key)
Go to the target location of a capture template. If TEMPLATE-KEY is nil, the user is queried for the template.
org-capture-import-remember-templates
Set ‘org-capture-templates’ to be similar to ‘org-remember-templates’.
org-capture-kill
Abort the current capture process.
org-capture-mode (&optional arg)
Minor mode for special key bindings in a capture buffer. Turning on this mode runs the normal hook ‘org-capture-mode-hook’. This is a minor mode. If called interactively, toggle the ‘Org-Capture mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-capture-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled. Key Binding ------------------------------------------------------------------------------- C-c C-c org-capture-finalize C-c C-k org-capture-kill C-c C-w org-capture-refile
org-capture-refile
Finalize the current capture and then refile the entry. Refiling is done from the base buffer, because the indirect buffer is then already gone. Any prefix argument will be passed to the refile command.
org-capture-string (string &optional keys)
Capture STRING with the template selected by KEYS.
org-cdlatex-environment-indent (&optional environment item)
- Access:
C-c { - In file: org.el
- Find modifications in git logs
Execute ‘cdlatex-environment’ and indent the inserted environment. ENVIRONMENT and ITEM are passed to ‘cdlatex-environment’. The inserted environment is indented to current indentation unless point is at the beginning of the line, in which the environment remains unintended.
org-cdlatex-math-modify (&optional _arg)
- In file: org.el
- Find modifications in git logs
Execute ‘cdlatex-math-modify’ in LaTeX fragments. Revert to the normal definition outside of these fragments.
org-cdlatex-mode (&optional arg)
- In file: org.el
- Find modifications in git logs
Toggle the minor ‘org-cdlatex-mode’.
This mode supports entering LaTeX environment and math in LaTeX fragments
in Org mode.
Key Binding
-------------------------------------------------------------------------------
' org-cdlatex-math-modify
^ .. _ org-cdlatex-underscore-caret
` cdlatex-math-symbol
C-c { org-cdlatex-environment-indent
This is a minor mode. If called interactively, toggle the ‘Org-Cdlatex
mode’ mode. If the prefix argument is positive, enable the mode, and if
it is zero or negative, disable the mode.
If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the
mode if ARG is nil, omitted, or is a positive number. Disable the mode
if ARG is a negative number.
To check whether the minor mode is enabled in the current buffer,
evaluate the variable ‘org-cdlatex-mode’.
The mode’s hook is called both when the mode is enabled and when it is
disabled.
org-cdlatex-underscore-caret (&optional _arg)
- In file: org.el
- Find modifications in git logs
Execute ‘cdlatex-sub-superscript’ in LaTeX fragments. Revert to the normal definition outside of these fragments.
org-change-tag-in-region (beg end tag off)
- In file: org.el
- Find modifications in git logs
Add or remove TAG for each entry in the region. This works in the agenda, and also in an Org buffer.
org-check-after-date (d)
- In file: org.el
- Find modifications in git logs
Check if there are deadlines or scheduled entries after date D.
org-check-before-date (d)
- In file: org.el
- Find modifications in git logs
Check if there are deadlines or scheduled entries before date D.
org-check-dates-range (start-date end-date)
- In file: org.el
- Find modifications in git logs
Check for deadlines/scheduled entries between START-DATE and END-DATE.
org-check-deadlines (ndays)
- In file: org.el
- Find modifications in git logs
Check if there are any deadlines due or past due. A deadline is considered due if it happens within ‘org-deadline-warning-days’ days from today’s date. If the deadline appears in an entry marked DONE, it is not shown. A numeric prefix argument NDAYS can be used to test that many days. If the prefix is a raw ‘C-u’, all deadlines are shown.
org-cite-insert (arg)
- Access:
C-c C-x @ - In file: oc.el
- Find modifications in git logs
Insert a citation at point. Insertion is done according to the processor set in ‘org-cite-insert-processor’. ARG is the prefix argument received when calling interactively the function.
org-clock-cancel
- Access:
C-c C-x C-q - In file: org-clock.el
- Find modifications in git logs
Cancel the running clock by removing the start timestamp.
org-clock-display (&optional arg)
- Access:
C-c C-x C-d - In file: org-clock.el
- Find modifications in git logs
Show subtree times in the entire buffer. By default, show the total time for the range defined in ‘org-clock-display-default-range’. With ‘C-u’ prefix, show the total time for today instead. With ‘C-u C-u’ prefix, use a custom range, entered at prompt. With ‘C-u C-u C-u’ prefix, display the total time in the echo area. Use ‘M-x org-clock-remove-overlays’ to remove the subtree times.
org-clock-goto (&optional select)
- Access:
<mode-line> <mouse-2>, C-c C-x C-j - In file: org-clock.el
- Find modifications in git logs
Go to the currently clocked-in entry, or to the most recently clocked one. With prefix arg SELECT, offer recently clocked tasks for selection.
org-clock-in (&optional select start-time)
- Access:
C-c C-x TAB - In file: org-clock.el
- Find modifications in git logs
Start the clock on the current item. If necessary, clock-out of the currently active clock. With a ‘C-u’ prefix argument SELECT, offer a list of recently clocked tasks to clock into. When SELECT is ‘C-u C-u’, clock into the current task and mark it as the default task, a special task that will always be offered in the clocking selection, associated with the letter ‘d’. When SELECT is ‘C-u C-u C-u’, clock in by using the last clock-out time as the start time. See ‘org-clock-continuously’ to make this the default behavior.
org-clock-in-last (&optional arg)
- Access:
C-c C-x C-x - In file: org-clock.el
- Find modifications in git logs
Clock in the last closed clocked item. When already clocking in, send a warning. With a universal prefix argument, select the task you want to clock in from the last clocked in tasks. With two universal prefix arguments, start clocking using the last clock-out time, if any. With three universal prefix arguments, interactively prompt for a todo state to switch to, overriding the existing value ‘org-clock-in-switch-to-state’.
org-clock-mark-default-task
Mark current task as default task.
org-clock-modify-effort-estimate (&optional value)
Add to or set the effort estimate of the item currently being clocked. VALUE can be a number of minutes, or a string with format hh:mm or mm. When the string starts with a + or a - sign, the current value of the effort property will be changed by that amount. If the effort value is expressed as an unit defined in ‘org-duration-units’ (e.g. "3h"), the modified value will be converted to a hh:mm duration. This command will update the "Effort" property of the currently clocked item, and the value displayed in the mode line.
org-clock-out (&optional switch-to-state fail-quietly at-time)
- Access:
C-c C-x C-o - In file: org-clock.el
- Find modifications in git logs
Stop the currently running clock. Throw an error if there is no running clock and FAIL-QUIETLY is nil. With a universal prefix, prompt for a state to switch the clocked out task to, overriding the existing value of ‘org-clock-out-switch-to-state’.
org-clock-remove-overlays (&optional _beg _end noremove)
Remove the occur highlights from the buffer. If NOREMOVE is nil, remove this function from the ‘before-change-functions’ in the current buffer.
org-clock-report (&optional arg)
Update or create a table containing a report about clocked time. If point is inside an existing clocktable block, update it. Otherwise, insert a new one. The new table inherits its properties from the variable ‘org-clock-clocktable-default-properties’. The scope of the clocktable, when not specified in the previous variable, is ‘subtree’ of the current heading when the function is called from inside heading, and ‘file’ elsewhere (before the first heading). When called with a prefix argument, move to the first clock table in the buffer and update it.
org-clock-timestamps-down (&optional n)
Decrease CLOCK timestamps at cursor. Optional argument N tells to change by that many units.
org-clock-timestamps-up (&optional n)
Increase CLOCK timestamps at cursor. Optional argument N tells to change by that many units.
org-clock-toggle-auto-clockout
org-clock-update-time-maybe
If this is a CLOCK line, update it and return t. Otherwise, return nil.
org-clone-subtree-with-time-shift (n &optional shift)
- Access:
C-c C-x c - In file: org.el
- Find modifications in git logs
Clone the task (subtree) at point N times. The clones will be inserted as siblings. In interactive use, the user will be prompted for the number of clones to be produced. If the entry has a timestamp, the user will also be prompted for a time shift, which may be a repeater as used in time stamps, for example ‘+3d’. To disable this, you can call the function with a universal prefix argument. When a valid repeater is given and the entry contains any time stamps, the clones will become a sequence in time, with time stamps in the subtree shifted for each clone produced. If SHIFT is nil or the empty string, time stamps will be left alone. The ID property of the original subtree is removed. In each clone, all the CLOCK entries will be removed. This prevents Org from considering that the clocked times overlap. If the original subtree did contain time stamps with a repeater, the following will happen: - the repeater will be removed in each clone - an additional clone will be produced, with the current, unshifted date(s) in the entry. - the original entry will be placed *after* all the clones, with repeater intact. - the start days in the repeater in the original entry will be shifted to past the last clone. In this way you can spell out a number of instances of a repeating task, and still retain the repeater to cover future instances of the task. As described above, N+1 clones are produced when the original subtree has a repeater. Setting N to 0, then, can be used to remove the repeater from a subtree and create a shifted clone with the original repeater.
org-columns (&optional global columns-fmt-string)
- Access:
C-c C-x C-c - In file: org-colview.el
- Find modifications in git logs
Turn on column view on an Org mode file. Column view applies to the whole buffer if point is before the first headline. Otherwise, it applies to the first ancestor setting "COLUMNS" property. If there is none, it defaults to the current headline. With a ‘C-u’ prefix argument, GLOBAL, turn on column view for the whole buffer unconditionally. When COLUMNS-FMT-STRING is non-nil, use it as the column format.
org-columns–display-here-title
Overlay the newline before the current line with the table title.
org-columns-compute (property)
Summarize the values of PROPERTY hierarchically. Also update existing values for PROPERTY according to the first column specification.
org-columns-content
Switch to contents view while in columns view.
org-columns-delete
Delete the column at point from column view.
org-columns-edit-allowed
Edit the list of allowed values for the current property.
org-columns-edit-attributes
Edit the attributes of the current column.
org-columns-edit-value (&optional key)
Edit the value of the property at point in column view. Where possible, use the standard interface for changing this line.
org-columns-get-format (&optional fmt-string)
Return columns format specifications. When optional argument FMT-STRING is non-nil, use it as the current specifications. This function also sets ‘org-columns-current-fmt-compiled’ and ‘org-columns-current-fmt’.
org-columns-insert-dblock
Create a dynamic block capturing a column view table.
org-columns-move-down
In column view, move cursor down one row. When in agenda column view, also call ‘org-agenda-do-context-action’.
org-columns-move-left
Swap this column with the one to the left.
org-columns-move-right
Swap this column with the one to the right.
org-columns-move-row-down
Move the current table row down.
org-columns-move-row-up
Move the current table row up.
org-columns-move-up
In column view, move cursor up one row. When in agenda column view, also call ‘org-agenda-do-context-action’.
org-columns-narrow (arg)
Make the column narrower by ARG characters.
org-columns-new (&optional spec &rest attributes)
Insert a new column, to the left of the current column. Interactively fill attributes for new column. When column format specification SPEC is provided, edit it instead. When optional argument ATTRIBUTES is provided, it should be a list of column specification attributes to create the new column non-interactively. See ‘org-columns-compile-format’ for details.
org-columns-next-allowed-value (&optional previous nth)
Switch to the next allowed value for this column. When PREVIOUS is set, go to the previous value. When NTH is an integer, select that value.
org-columns-open-link (&optional arg)
org-columns-previous-allowed-value
Switch to the previous allowed value for this column.
org-columns-quit
Remove the column overlays and in this way exit column editing.
org-columns-redo
Construct the column display again.
org-columns-remove-overlays
Remove all currently active column overlays.
org-columns-show-value
Show the full value of the property.
org-columns-todo (&optional _arg)
Change the TODO state during column view.
org-columns-toggle-or-columns-quit
Toggle checkbox at point, or quit column view.
org-columns-widen (arg)
Make the column wider by ARG characters.
org-comment-dwim (_arg)
- In file: org.el
- Find modifications in git logs
Call the comment command you mean. Call ‘org-toggle-comment’ if on a heading, otherwise call ‘comment-dwim’.
org-compute-property-at-point
- In file: org.el
- Find modifications in git logs
Compute the property at point. This looks for an enclosing column format, extracts the operator and then applies it to the property in the column format’s scope.
org-content (&optional arg)
- In file: org.el
- Find modifications in git logs
Show all headlines in the buffer, like a table of contents. With numerical argument ARG, show content up to level ARG.
org-convert-to-odd-levels
- In file: org.el
- Find modifications in git logs
Convert an Org file with all levels allowed to one with odd levels. This will leave level 1 alone, convert level 2 to level 3, level 3 to level 5 etc.
org-convert-to-oddeven-levels
- In file: org.el
- Find modifications in git logs
Convert an Org file with only odd levels to one with odd/even levels. This promotes level 3 to level 2, level 5 to level 3 etc. If the file contains a section with an even level, conversion would destroy the structure of the file. An error is signaled in this case.
org-copy
Like ‘org-refile’, but preserve the refiled subtree.
org-copy-special
- Access:
C-c C-x M-w - In file: org.el
- Find modifications in git logs
Copy region in table or copy current subtree. Calls ‘org-table-copy-region’ or ‘org-copy-subtree’, depending on context. See the individual commands for more information.
org-copy-subtree (&optional n cut force-store-markers nosubtrees)
- In file: org.el
- Find modifications in git logs
Copy the current subtree into the clipboard. With prefix arg N, copy this many sequential subtrees. This is a short-hand for marking the subtree and then copying it. If CUT is non-nil, actually cut the subtree. If FORCE-STORE-MARKERS is non-nil, store the relative locations of some markers in the region, even if CUT is non-nil. This is useful if the caller implements cut-and-paste as copy-then-paste-then-cut.
org-copy-visible (beg end)
- Access:
C-c C-x v - In file: org.el
- Find modifications in git logs
Copy the visible parts of the region.
org-create-math-formula (latex-frag &optional mathml-file)
- In file: org.el
- Find modifications in git logs
Convert LATEX-FRAG to MathML and store it in MATHML-FILE. Use ‘org-latex-to-mathml-convert-command’. If the conversion is successful, return the portion between "<math...> </math>" elements otherwise return nil. When MATHML-FILE is specified, write the results in to that file. When invoked as an interactive command, prompt for LATEX-FRAG, with initial value set to the current active region and echo the results for user inspection.
org-ctrl-c-ctrl-c (&optional arg)
- Access:
C-c C-c - In file: org.el
- Find modifications in git logs
Set tags in headline, or update according to changed information at point. This command does many different things, depending on context: - If column view is active, in agenda or org buffers, quit it. - If there are highlights, remove them. - If a function in ‘org-ctrl-c-ctrl-c-hook’ recognizes this location, this is what we do. - If the cursor is on a statistics cookie, update it. - If the cursor is in a headline, in an agenda or an org buffer, prompt for tags and insert them into the current line, aligned to ‘org-tags-column’. When called with prefix arg, realign all tags in the current buffer. - If the cursor is in one of the special #+KEYWORD lines, this triggers scanning the buffer for these lines and updating the information. - If the cursor is inside a table, realign the table. This command works even if the automatic table editor has been turned off. - If the cursor is on a #+TBLFM line, re-apply the formulas to the entire table. - If the cursor is at a footnote reference or definition, jump to the corresponding definition or references, respectively. - If the cursor is a the beginning of a dynamic block, update it. - If the current buffer is a capture buffer, close note and file it. - If the cursor is on a <<<target>>>, update radio targets and corresponding links in this buffer. - If the cursor is on a numbered item in a plain list, renumber the ordered list. - If the cursor is on a checkbox, toggle it. - If the cursor is on a code block, evaluate it. The variable ‘org-confirm-babel-evaluate’ can be used to control prompting before code block evaluation, by default every code block evaluation requires confirmation. Code block evaluation can be inhibited by setting ‘org-babel-no-eval-on-ctrl-c-ctrl-c’.
org-ctrl-c-minus
- Access:
C-c - - In file: org.el
- Find modifications in git logs
Insert separator line in table or modify bullet status of line. Also turns a plain line or a region of lines into list items. Calls ‘org-table-insert-hline’, ‘org-toggle-item’, or ‘org-cycle-list-bullet’, depending on context.
org-ctrl-c-ret
- Access:
C-c RET - In file: org.el
- Find modifications in git logs
Call ‘org-table-hline-and-move’ or ‘org-insert-heading’.
org-ctrl-c-star
- Access:
C-c * - In file: org.el
- Find modifications in git logs
Compute table, or change heading status of lines. Calls ‘org-table-recalculate’ or ‘org-toggle-heading’, depending on context.
org-ctrl-c-tab (&optional arg)
- Access:
C-c TAB - In file: org.el
- Find modifications in git logs
Toggle columns width in a table, or show children. Call ‘org-table-toggle-column-width’ if point is in a table. Otherwise provide a compact view of the children. ARG is the level to hide.
org-customize
- In file: org.el
- Find modifications in git logs
Call the customize function with org as argument.
org-cut-special
- Access:
C-c C-x C-w - In file: org.el
- Find modifications in git logs
Cut region in table or cut current subtree. Calls ‘org-table-cut-region’ or ‘org-cut-subtree’, depending on context. See the individual commands for more information.
org-cut-subtree (&optional n)
- In file: org.el
- Find modifications in git logs
Cut the current subtree into the clipboard. With prefix arg N, cut this many sequential subtrees. This is a short-hand for marking the subtree and then cutting it.
org-cycle (&optional arg)
TAB-action and visibility cycling for Org mode.
This is the command invoked in Org mode by the ‘TAB’ key. Its main
purpose is outline visibility cycling, but it also invokes other actions
in special contexts.
When this function is called with a ‘C-u’ prefix, rotate the entire
buffer through 3 states (global cycling)
1. OVERVIEW: Show only top-level headlines.
2. CONTENTS: Show all headlines of all levels, but no body text.
3. SHOW ALL: Show everything.
With a ‘C-u C-u’ prefix argument, switch to the startup visibility,
determined by the variable ‘org-startup-folded’, and by any VISIBILITY
properties in the buffer.
With a ‘C-u C-u C-u’ prefix argument, show the entire buffer, including
any drawers.
When inside a table, re-align the table and move to the next field.
When point is at the beginning of a headline, rotate the subtree started
by this line through 3 different states (local cycling)
1. FOLDED: Only the main headline is shown.
2. CHILDREN: The main headline and the direct children are shown.
From this state, you can move to one of the children
and zoom in further.
3. SUBTREE: Show the entire subtree, including body text.
If there is no subtree, switch directly from CHILDREN to FOLDED.
When point is at the beginning of an empty headline and the variable
‘org-cycle-level-after-item/entry-creation’ is set, cycle the level
of the headline by demoting and promoting it to likely levels. This
speeds up creation document structure by pressing ‘TAB’ once or several
times right after creating a new headline.
When there is a numeric prefix, go up to a heading with level ARG, do
a ‘show-subtree’ and return to the previous cursor position. If ARG
is negative, go up that many levels.
When point is not at the beginning of a headline, execute the global
binding for ‘TAB’, which is re-indenting the line. See the option
‘org-cycle-emulate-tab’ for details.
As a special case, if point is at the very beginning of the buffer, if
there is no headline there, and if the variable ‘org-cycle-global-at-bob’
is non-nil, this function acts as if called with prefix argument (‘C-u TAB’,
same as ‘S-TAB’) also when called without prefix argument.
org-cycle-agenda-files
- Access:
C-', C-, - In file: org.el
- Find modifications in git logs
Cycle through the files in ‘org-agenda-files’. If the current buffer visits an agenda file, find the next one in the list. If the current buffer does not, find the first agenda file.
org-cycle-content (&optional arg)
Show all headlines in the buffer, like a table of contents. With numerical argument ARG, show content up to level ARG.
org-cycle-force-archived
- Access:
C-c C-<tab> - In file: org-cycle.el
- Find modifications in git logs
Cycle subtree even if it is archived.
org-cycle-global (&optional arg)
Cycle the global visibility. For details see ‘org-cycle’. With ‘C-u’ prefix ARG, switch to startup visibility. With a numeric prefix, show all headlines up to that level.
org-cycle-level
- In file: org.el
- Find modifications in git logs
Cycle the level of an empty headline through possible states. This goes first to child, then to parent, level, then up the hierarchy. After top level, it switches back to sibling level.
org-cycle-list-bullet (&optional which)
Cycle through the different itemize/enumerate bullets. This cycle the entire list level through the sequence: ‘-’ -> ‘+’ -> ‘*’ -> ‘1.’ -> ‘1)’ If WHICH is a valid string, use that as the new bullet. If WHICH is an integer, 0 means ‘-’, 1 means ‘+’ etc. If WHICH is ‘previous’, cycle backwards.
org-cycle-overview
Switch to overview mode, showing only top-level headlines.
org-cycle-set-visibility-according-to-property
Switch subtree visibility according to VISIBILITY property.
org-date-from-calendar
- Access:
C-c < - In file: org.el
- Find modifications in git logs
Insert time stamp corresponding to cursor date in *Calendar* buffer. If there is already a time stamp at the cursor position, update it.
org-datetree-cleanup
Make sure all entries in the current tree are under the correct date. It may be useful to restrict the buffer to the applicable portion before running this command, even though the command tries to be smart.
org-dblock-update (&optional arg)
- Access:
C-c C-x C-u - In file: org.el
- Find modifications in git logs
User command for updating dynamic blocks. Update the dynamic block at point. With prefix ARG, update all dynamic blocks in the buffer.
org-deadline (arg &optional time)
- Access:
C-c C-d - In file: org.el
- Find modifications in git logs
Insert a "DEADLINE:" string with a timestamp to make a deadline. When called interactively, this command pops up the Emacs calendar to let the user select a date. With one universal prefix argument, remove any deadline from the item. With two universal prefix arguments, prompt for a warning delay. With argument TIME, set the deadline at the corresponding date. TIME can either be an Org date like "2011-07-24" or a delta like "+2d".
org-decompose-region (start end)
Decompose text in the current region. When called from a program, expects two arguments, positions (integers or markers) specifying the region. (fn START END)
org-decrease-number-at-point (&optional inc)
- Access:
C-M-S-<left> - In file: org.el
- Find modifications in git logs
Decrement the number at point. With an optional prefix numeric argument INC, decrement using this numeric value.
org-decrypt-entries
Decrypt all entries in the current buffer.
org-decrypt-entry
Decrypt the content of the current headline.
org-delete-backward-char (N)
- In file: org.el
- Find modifications in git logs
Like ‘delete-backward-char’, insert whitespace at field end in tables. When deleting backwards, in tables this function will insert whitespace in front of the next "|" separator, to keep the table aligned. The table will still be marked for re-alignment if the field did fill the entire column, because, in this case the deletion might narrow the column. This function has :before advice: ‘org-fold-check-before-invisible-edit-maybe’. (fn N)
org-delete-char (N)
- In file: org.el
- Find modifications in git logs
Like ‘delete-char’, but insert whitespace at field end in tables. When deleting characters, in tables this function will insert whitespace in front of the next "|" separator, to keep the table aligned. The table will still be marked for re-alignment if the field did fill the entire column, because, in this case the deletion might narrow the column. This function has :before advice: ‘org-fold-check-before-invisible-edit-maybe’. (fn N)
org-delete-directory (directory &optional recursive trash)
Delete the directory named DIRECTORY. Does not follow symlinks. If RECURSIVE is non-nil, delete files in DIRECTORY as well, with no error if something else is simultaneously deleting them. TRASH non-nil means to trash the directory instead, provided ‘delete-by-moving-to-trash’ is non-nil. When called interactively, TRASH is nil if and only if a prefix argument is given, and a further prompt asks the user for RECURSIVE if DIRECTORY is nonempty. (fn DIRECTORY &optional RECURSIVE TRASH)
org-delete-indentation (&optional arg beg end)
- In file: org.el
- Find modifications in git logs
Join current line to previous and fix whitespace at join. If previous line is a headline add to headline title. Otherwise the function calls ‘delete-indentation’. If there is a region (BEG END), then join the lines in that region. With a non-nil prefix ARG, join the line with the following one, ignoring region.
org-delete-property (property)
- In file: org.el
- Find modifications in git logs
In the current entry, delete PROPERTY.
org-delete-property-globally (property)
- In file: org.el
- Find modifications in git logs
Remove PROPERTY globally, from all entries. This function ignores narrowing, if any.
org-demote-subtree
- Access:
C-c C-> - In file: org.el
- Find modifications in git logs
Demote the entire subtree. See ‘org-demote’ and ‘org-promote’.
org-display-inline-images (&optional include-linked refresh beg end)
Display inline images.
An inline image is a link which follows either of these
conventions:
1. Its path is a file with an extension matching return value
from ‘image-file-name-regexp’ and it has no contents.
2. Its description consists in a single link of the previous
type. In this case, that link must be a well-formed plain
or angle link, i.e., it must have an explicit "file" or
"attachment" type.
Equip each image with the key-map ‘image-map’.
When optional argument INCLUDE-LINKED is non-nil, also links with
a text description part will be inlined. This can be nice for
a quick look at those images, but it does not reflect what
exported files will look like.
When optional argument REFRESH is non-nil, refresh existing
images between BEG and END. This will create new image displays
only if necessary.
BEG and END define the considered part. They default to the
buffer boundaries with possible narrowing.
org-display-outline-path (&optional file-or-title current separator just-return-string)
- In file: org.el
- Find modifications in git logs
Display the current outline path in the echo area. If FILE-OR-TITLE is ‘title’, prepend outline with file title. If it is non-nil or title is not present in document, prepend outline path with the file name. If CURRENT is non-nil, append the current heading to the output. SEPARATOR is passed through to ‘org-format-outline-path’. It separates the different parts of the path and defaults to "/". If JUST-RETURN-STRING is non-nil, return a string, don’t display a message.
org-do-demote
- In file: org.el
- Find modifications in git logs
Demote the current heading lower down the tree. If the region is active in ‘transient-mark-mode’, demote all headings in the region.
org-do-promote
- In file: org.el
- Find modifications in git logs
Promote the current heading higher up the tree. If the region is active in ‘transient-mark-mode’, promote all headings in the region.
org-down-element
- Access:
C-c C-_ - In file: org.el
- Find modifications in git logs
Move to inner element.
org-drag-element-backward
- In file: org.el
- Find modifications in git logs
Move backward element at point.
org-drag-element-forward
- In file: org.el
- Find modifications in git logs
Move forward element at point.
org-drag-line-backward (arg)
- In file: org.el
- Find modifications in git logs
Drag the line at point ARG lines backward.
org-drag-line-forward (arg)
- In file: org.el
- Find modifications in git logs
Drag the line at point ARG lines forward.
org-duration-set-regexps
Set duration related regexps.
org-dynamic-block-insert-dblock (type &optional interactive-p)
- Access:
C-c C-x x - In file: org.el
- Find modifications in git logs
Insert a dynamic block of type TYPE. When used interactively, select the dynamic block types among defined types, per ‘org-dynamic-block-define’. If INTERACTIVE-P is non-nil, call the dynamic block function interactively.
org-edit-agenda-file-list
- In file: org.el
- Find modifications in git logs
Edit the list of agenda files. Depending on setup, this either uses customize to edit the variable ‘org-agenda-files’, or it visits the file that is holding the list. In the latter case, the buffer is set up in a way that saving it automatically kills the buffer and restores the previous window configuration.
org-edit-comment-block
- In file: org-src.el
- Find modifications in git logs
Edit comment block at point. A new buffer is created and the block is copied into it, and the buffer is switched into Org mode. When done, exit with ‘C-c '’. The edited text will then replace the area in the Org mode buffer. Throw an error when not at a comment block.
org-edit-export-block
- In file: org-src.el
- Find modifications in git logs
Edit export block at point. A new buffer is created and the block is copied into it, and the buffer is switched into an appropriate major mode. See also ‘org-src-lang-modes’. When done, exit with ‘C-c '’. The edited text will then replace the area in the Org mode buffer. Throw an error when not at an export block.
org-edit-fixed-width-region
- In file: org-src.el
- Find modifications in git logs
Edit the fixed-width ASCII drawing at point. This must be a region where each line starts with a colon followed by a space or a newline character. A new buffer is created and the fixed-width region is copied into it, and the buffer is switched into the major mode defined in ‘org-edit-fixed-width-region-mode’, which see. When done, exit with ‘C-c '’. The edited text will then replace the area in the Org mode buffer.
org-edit-footnote-reference
- In file: org-src.el
- Find modifications in git logs
Edit definition of footnote reference at point.
org-edit-headline (&optional heading)
- In file: org.el
- Find modifications in git logs
Edit the current headline. Set it to HEADING when provided.
org-edit-inline-src-code
- In file: org-src.el
- Find modifications in git logs
Edit inline source code at point.
org-edit-latex-environment
- In file: org-src.el
- Find modifications in git logs
Edit LaTeX environment at point. The LaTeX environment is copied into a new buffer. Major mode is set to the one associated to "latex" in ‘org-src-lang-modes’, or to ‘latex-mode’ if there is none. When done, exit with ‘C-c '’. The edited text will then replace the LaTeX environment in the Org mode buffer.
org-edit-latex-fragment
- In file: org-src.el
- Find modifications in git logs
Edit LaTeX fragment at point.
org-edit-special (&optional arg)
- Access:
C-c ' - In file: org.el
- Find modifications in git logs
Call a special editor for the element at point. When at a table, call the formula editor with ‘org-table-edit-formulas’. When at table.el table, edit it in dedicated buffer. When in a source code block, call ‘org-edit-src-code’; with prefix argument, switch to session buffer. When in an example block, call ‘org-edit-src-code’. When in an inline code block, call ‘org-edit-inline-src-code’. When in a fixed-width region, call ‘org-edit-fixed-width-region’. When in an export block, call ‘org-edit-export-block’. When in a comment block, call ‘org-edit-comment-block’. When in a LaTeX environment, call ‘org-edit-latex-environment’. When at an INCLUDE, SETUPFILE or BIBLIOGRAPHY keyword, visit the included file. When at a footnote reference, call ‘org-edit-footnote-reference’. When at a planning line call, ‘org-deadline’ and/or ‘org-schedule’. When at an active timestamp, call ‘org-timestamp’. When at an inactive timestamp, call ‘org-timestamp-inactive’. On a link, call ‘ffap’ to visit the link at point. Otherwise, return a user error.
org-edit-src-abort
- In file: org-src.el
- Find modifications in git logs
Abort editing of the src code and return to the Org buffer.
org-edit-src-code (&optional code edit-buffer-name)
- In file: org-src.el
- Find modifications in git logs
Edit the source or example block at point. The code is copied to a separate buffer and the appropriate mode is turned on. When done, exit with ‘C-c '’. This will remove the original code in the Org buffer, and replace it with the edited version. See ‘org-src-window-setup’ to configure the display of windows containing the Org buffer and the code buffer. When optional argument CODE is a string, edit it in a read-only buffer instead. The contents of that buffer will *not* be written back to the source of example block at point. When optional argument EDIT-BUFFER-NAME is non-nil, use it as the name of the sub-editing buffer.
org-edit-src-continue (event)
- In file: org-src.el
- Find modifications in git logs
Unconditionally return to buffer editing area under point. Throw an error if there is no such buffer. EVENT is passed to ‘mouse-set-point’.
org-edit-src-exit
- In file: org-src.el
- Find modifications in git logs
Kill current sub-editing buffer and return to source buffer.
org-edit-src-save
- In file: org-src.el
- Find modifications in git logs
Save parent buffer with current state source-code buffer.
org-edit-table.el
- In file: org-src.el
- Find modifications in git logs
Edit "table.el" table at point. A new buffer is created and the table is copied into it. Then the table is recognized with ‘table-recognize’. When done editing, exit with ‘C-c '’. The edited text will then replace the area in the Org mode buffer. Throw an error when not at such a table.
org-element-cache-reset (&optional all no-persistence)
Reset cache in current buffer. When optional argument ALL is non-nil, reset cache in all Org buffers. When optional argument NO-PERSISTENCE is non-nil, do not try to update the cache persistence in the buffer.
org-element-update-syntax
Update parser internals.
org-emphasize (&optional char)
- Access:
C-c C-x C-f - In file: org.el
- Find modifications in git logs
Insert or change an emphasis, i.e. a font like bold or italic. If there is an active region, change that region to a new emphasis. If there is no region, just insert the marker characters and position the cursor between them. CHAR should be the marker character. If it is a space, it means to remove the emphasis of the selected region. If CHAR is not given (for example in an interactive call) it will be prompted for.
org-encrypt-entries
Encrypt all top-level entries in the current buffer.
org-encrypt-entry
Encrypt the content of the current headline.
org-end-of-item
Go to the end of the current item. Throw an error when not in a list.
org-end-of-item-list
Go to the end of the current list or sublist. Throw an error when not in a list.
org-end-of-line (&optional n)
- In file: org.el
- Find modifications in git logs
Go to the end of the line, but before ellipsis, if any. If this is a headline, and ‘org-special-ctrl-a/e’ is not nil or symbol ‘reversed’, ignore tags on the first attempt, and only move to after the tags when the cursor is already beyond the end of the headline. If ‘org-special-ctrl-a/e’ is symbol ‘reversed’ then ignore tags on the second attempt. With argument N not nil or 1, move forward N - 1 lines first.
org-entities-create-table
Create an Org mode table with all entities.
org-entities-help
Create a Help buffer with all available entities.
org-escape-code-in-region (beg end)
- In file: org-src.el
- Find modifications in git logs
Escape lines between BEG and END. Escaping happens when a line starts with "*", "#+", ",*" or ",#+" by appending a comma to it.
org-evaluate-time-range (&optional to-buffer)
- Access:
C-c C-y - In file: org.el
- Find modifications in git logs
Evaluate a time range by computing the difference between start and end. Normally the result is just printed in the echo area, but with prefix arg TO-BUFFER, the result is inserted just after the date stamp into the buffer. If the time range is actually in a table, the result is inserted into the next column. For time difference computation, a year is assumed to be exactly 365 days in order to avoid rounding problems.
org-eww-copy-for-org-mode
- In file: ol-eww.el
- Find modifications in git logs
Copy current buffer content or active region with ‘org-mode’ style links. This will encode ‘link-title’ and ‘link-location’ with ‘org-link-make-string’ and insert the transformed text into the kill ring, so that it can be yanked into an Org mode buffer with links working correctly. Further lines starting with a star get quoted with a comma to keep the structure of the Org file.
org-export-dispatch (&optional arg)
- Access:
C-c C-e - In file: ox.el
- Find modifications in git logs
Export dispatcher for Org mode. It provides an access to common export related tasks in a buffer. Its interface comes in two flavors: standard and expert. While both share the same set of bindings, only the former displays the valid keys associations in a dedicated buffer. Scrolling (resp. line-wise motion) in this buffer is done with SPC and DEL (resp. C-n and C-p) keys. Set variable ‘org-export-dispatch-use-expert-ui’ to switch to one flavor or the other. When ARG is ‘C-u’, repeat the last export action, with the same set of options used back then, on the current buffer. When ARG is ‘C-u C-u’, display the asynchronous export stack.
org-export-insert-default-template (&optional backend subtreep)
- In file: ox.el
- Find modifications in git logs
Insert all export keywords with default values at beginning of line. BACKEND is a symbol referring to the name of a registered export backend, for which specific export options should be added to the template, or ‘default’ for default template. When it is nil, the user will be prompted for a category. If SUBTREEP is non-nil, export configuration will be set up locally for the subtree through node properties.
org-export-region-to-ascii
Assume region has Org syntax, and convert it to plain ASCII.
org-export-region-to-html
- In file: ox-html.el
- Find modifications in git logs
Assume the current region has Org syntax, and convert it to HTML. This can be used in any buffer. For example, you can write an itemized list in Org syntax in an HTML buffer and use this command to convert it.
org-export-region-to-latex
Assume the current region has Org syntax, and convert it to LaTeX. This can be used in any buffer. For example, you can write an itemized list in Org syntax in an LaTeX buffer and use this command to convert it.
org-export-region-to-md
- In file: ox-md.el
- Find modifications in git logs
Assume the current region has Org syntax, and convert it to Markdown. This can be used in any buffer. For example, you can write an itemized list in Org syntax in a Markdown buffer and use this command to convert it.
org-export-region-to-texinfo
Assume the current region has Org syntax, and convert it to Texinfo. This can be used in any buffer. For example, you can write an itemized list in Org syntax in an Texinfo buffer and use this command to convert it.
org-export-region-to-utf8
Assume region has Org syntax, and convert it to UTF-8.
org-export-stack
- In file: ox.el
- Find modifications in git logs
Menu for asynchronous export results and running processes.
org-export-stack-clear
- In file: ox.el
- Find modifications in git logs
Remove all entries from export stack.
org-export-stack-mode
- In file: ox.el
- Find modifications in git logs
Mode for displaying asynchronous export stack.
Type ‘M-x org-export-stack’ to visualize the asynchronous export
stack.
In an Org Export Stack buffer, use ‘RET’ to view export output
on current line, ‘d’ to remove it from the stack and ‘C’ to clear
stack completely.
Removing entries in a stack buffer does not affect files
or buffers, only display.
Key Binding
-------------------------------------------------------------------------------
TAB forward-button
RET org-export-stack-view
C-n next-line
C-p previous-line
SPC next-line
- negative-argument
0 .. 9 digit-argument
< beginning-of-buffer
> end-of-buffer
? describe-mode
C org-export-stack-clear
S tabulated-list-sort
d org-export-stack-remove
g revert-buffer
h describe-mode
n next-line
p previous-line
q quit-window
v org-export-stack-view
{ tabulated-list-narrow-current-column
} tabulated-list-widen-current-column
DEL previous-line
S-SPC scroll-down-command
M-<left> tabulated-list-previous-column
M-<right> tabulated-list-next-column
<backtab> backward-button
<down> next-line
<follow-link> mouse-face
<mouse-2> mouse-select-window
<up> previous-line
C-M-i backward-button
In addition to any hooks its parent mode ‘tabulated-list-mode’ might
have run, this mode runs the hook ‘org-export-stack-mode-hook’, as the
final or penultimate step during initialization.
org-export-stack-refresh
- In file: ox.el
- Find modifications in git logs
Refresh the export stack.
org-export-stack-remove (&optional source)
- In file: ox.el
- Find modifications in git logs
Remove export results at point from stack. If optional argument SOURCE is non-nil, remove it instead.
org-export-stack-view (&optional in-emacs)
- Access:
RET - In file: ox.el
- Find modifications in git logs
View export results at point in stack. With an optional prefix argument IN-EMACS, force viewing files within Emacs.
org-feed-goto-inbox (feed)
- Access:
C-c C-x G - In file: org-feed.el
- Find modifications in git logs
Go to the inbox that captures the feed named FEED.
org-feed-show-raw-feed (feed)
Show the raw feed buffer of a feed.
org-feed-update (feed &optional retrieve-only)
Get inbox items from FEED. FEED can be a string with an association in ‘org-feed-alist’, or it can be a list structured like an entry in ‘org-feed-alist’.
org-feed-update-all
- Access:
C-c C-x g - In file: org-feed.el
- Find modifications in git logs
Get inbox items from all feeds in ‘org-feed-alist’.
org-fill-paragraph (&optional justify region)
- In file: org.el
- Find modifications in git logs
Fill element at point, when applicable. This function only applies to comment blocks, comments, example blocks and paragraphs. Also, as a special case, re-align table when point is at one. For convenience, when point is at a plain list, an item or a footnote definition, try to fill the first paragraph within. If JUSTIFY is non-nil (interactively, with prefix argument), justify as well. If ‘sentence-end-double-space’ is non-nil, then period followed by one space does not end a sentence, so don’t break a line there. The variable ‘fill-column’ controls the width for filling. The REGION argument is non-nil if called interactively; in that case, if Transient Mark mode is enabled and the mark is active, fill each of the elements in the active region, instead of just filling the current element.
org-find-entry-with-id (ident)
- In file: org.el
- Find modifications in git logs
Locate the entry that contains the ID property with exact value IDENT. IDENT can be a string, a symbol or a number, this function will search for the string representation of it. Return the position where this entry starts, or nil if there is no such entry.
org-find-file-at-mouse (ev)
- In file: org.el
- Find modifications in git logs
Open file link or URL at mouse.
org-fold-hide-block-all
Fold all blocks in the current buffer.
org-fold-hide-block-toggle (&optional force no-error element)
Toggle the visibility of the current block. When optional argument FORCE is ‘off’, make block visible. If it is non-nil, hide it unconditionally. Throw an error when not at a block, unless NO-ERROR is non-nil. When optional argument ELEMENT is provided, consider it instead of the current block. Return a non-nil value when toggling is successful.
org-fold-hide-drawer-all (&optional begin end)
Fold all drawers in the current buffer or active region BEGIN..END.
org-fold-hide-drawer-toggle (&optional force no-error element)
Toggle the visibility of the current drawer. When optional argument FORCE is ‘off’, make drawer visible. If it is non-nil, hide it unconditionally. Throw an error when not at a drawer, unless NO-ERROR is non-nil. When optional argument ELEMENT is provided, consider it instead of the current drawer. Return a non-nil value when toggling is successful.
org-fold-hide-entry
Hide the body directly following this heading.
org-fold-hide-sublevels (levels)
Hide everything but the top LEVELS levels of headers, in whole buffer. This also unhides the top heading-less body, if any. Interactively, the prefix argument supplies the value of LEVELS. When invoked without a prefix argument, LEVELS defaults to the level of the current heading, or to 1 if the current line is not a heading.
org-fold-hide-subtree
Hide everything after this heading at deeper levels.
org-fold-reveal (&optional siblings)
- Access:
C-c C-r - In file: org-fold.el
- Find modifications in git logs
Show current entry, hierarchy above it, and the following headline. This can be used to show a consistent set of context around locations exposed with ‘org-fold-show-context’. With optional argument SIBLINGS, on each level of the hierarchy all siblings are shown. This repairs the tree structure to what it would look like when opened with hierarchical calls to ‘org-cycle’. With a C-u C-u prefix, go to the parent and show the entire tree.
org-fold-show-all (&optional types)
Show all contents in the visible part of the buffer. By default, the function expands headings, blocks and drawers. When optional argument TYPES is a list of symbols among ‘blocks’, ‘drawers’ and ‘headings’, to only expand one specific type.
org-fold-show-branches
Show all subheadings of this heading, but not their bodies.
org-fold-show-children (&optional level)
Show all direct subheadings of this heading. Prefix arg LEVEL is how many levels below the current level should be shown. If direct subheadings are deeper than LEVEL, they are still displayed.
org-fold-show-entry (&optional hide-drawers)
Show the body directly following its heading. Show the heading too, if it is currently invisible.
org-fold-show-subtree
Show everything after this heading at deeper levels.
org-footnote-action (&optional special)
- Access:
C-c C-x f - In file: org-footnote.el
- Find modifications in git logs
Do the right thing for footnotes. When at a footnote reference, jump to the definition. When at a definition, jump to the references if they exist, offer to create them otherwise. When neither at definition or reference, create a new footnote, interactively if possible. With prefix arg SPECIAL, or when no footnote can be created, offer additional commands in a menu.
org-footnote-goto-definition (label &optional location)
Move point to the definition of the footnote LABEL. LOCATION, when non-nil specifies the buffer position of the definition. Throw an error if there is no definition or if it cannot be reached from current narrowed part of buffer. Return a non-nil value if point was successfully moved.
org-footnote-goto-previous-reference (label)
Find the first closest (to point) reference of footnote with label LABEL.
org-footnote-new
Insert a new footnote. This command prompts for a label. If this is a label referencing an existing label, only insert the label. If the footnote label is empty or new, let the user edit the definition of the footnote.
org-footnote-normalize
Turn every footnote in buffer into a numbered one.
org-footnote-renumber-fn:N
Order numbered footnotes into a sequence in the document.
org-force-cycle-archived
- In file: org.el
- Find modifications in git logs
Cycle subtree even if it is archived.
org-force-self-insert (N)
- In file: org.el
- Find modifications in git logs
Needed to enforce self-insert under remapping.
org-forward-element
- Access:
M-} - In file: org.el
- Find modifications in git logs
Move forward by one element. Move to the next element at the same level, when possible.
org-forward-heading-same-level (arg &optional invisible-ok)
- Access:
C-c C-f - In file: org.el
- Find modifications in git logs
Move forward to the ARG’th subheading at same level as this one. Stop at the first and last subheadings of a superior heading. Normally this only looks at visible headings, but when INVISIBLE-OK is non-nil it will also look at invisible ones.
org-forward-paragraph (&optional arg)
- In file: org.el
- Find modifications in git logs
Move forward by a paragraph, or equivalent, unit.
With argument ARG, do it ARG times;
a negative argument ARG = -N means move backward N paragraphs.
The function moves point between two structural
elements (paragraphs, tables, lists, etc.).
It also provides the following special moves for convenience:
- on a table or a property drawer, move to its beginning;
- on comment, example, export, source and verse blocks, stop
at blank lines;
- skip consecutive clocks, diary S-exps, and keywords.
org-forward-sentence (&optional _arg)
- In file: org.el
- Find modifications in git logs
Go to end of sentence, or end of table field. This will call ‘forward-sentence’ or ‘org-table-end-of-field’, depending on context.
org-global-cycle (&optional arg)
- In file: org.el
- Find modifications in git logs
Cycle the global visibility. For details see ‘org-cycle’. With ‘C-u’ prefix ARG, switch to startup visibility. With a numeric prefix, show all headlines up to that level.
org-goto (&optional alternative-interface)
- Access:
C-c C-j - In file: org-goto.el
- Find modifications in git logs
Look up a different location in the current file, keeping current visibility. When you want look-up or go to a different location in a document, the fastest way is often to fold the entire buffer and then dive into the tree. This method has the disadvantage, that the previous location will be folded, which may not be what you want. This command works around this by showing a copy of the current buffer in an indirect buffer, in overview mode. You can dive into the tree in that copy, use ‘org-occur’ and incremental search to find a location. When pressing RET or ‘Q’, the command returns to the original buffer in which the visibility is still unchanged. After RET it will also jump to the location selected in the indirect buffer and expose the headline hierarchy above. With a prefix argument, use the alternative interface: e.g., if ‘org-goto-interface’ is ‘outline’ use ‘outline-path-completion’.
org-goto-calendar (&optional arg)
- Access:
C-c > - In file: org.el
- Find modifications in git logs
Go to the Emacs calendar at the current date. If there is a time stamp in the current line, go to that date. A prefix ARG can be used to force the current date.
org-goto-left
Finish ‘org-goto’ by going to the new location.
org-goto-local-auto-isearch
Start isearch.
org-goto-quit
Finish ‘org-goto’ without cursor motion.
org-goto-ret (&optional _arg)
Finish ‘org-goto’ by going to the new location.
org-goto-right
Finish ‘org-goto’ by going to the new location.
org-habit-toggle-display-in-agenda (arg)
Toggle display of habits in agenda. With ARG toggle display of all vs. undone scheduled habits. See ‘org-habit-show-all-today’.
org-habit-toggle-habits
Toggle display of habits in an agenda buffer.
org-hide-block-all
Fold all blocks in the current buffer.
org-hide-block-toggle (&optional force no-error element)
Toggle the visibility of the current block. When optional argument FORCE is ‘off’, make block visible. If it is non-nil, hide it unconditionally. Throw an error when not at a block, unless NO-ERROR is non-nil. When optional argument ELEMENT is provided, consider it instead of the current block. Return a non-nil value when toggling is successful.
org-hide-block-toggle-maybe
Toggle visibility of block at point. Unlike to ‘org-fold-hide-block-toggle’, this function does not throw an error. Return a non-nil value when toggling is successful.
org-hide-drawer-all (&optional begin end)
Fold all drawers in the current buffer or active region BEGIN..END.
org-hide-drawer-toggle (&optional force no-error element)
Toggle the visibility of the current drawer. When optional argument FORCE is ‘off’, make drawer visible. If it is non-nil, hide it unconditionally. Throw an error when not at a drawer, unless NO-ERROR is non-nil. When optional argument ELEMENT is provided, consider it instead of the current drawer. Return a non-nil value when toggling is successful.
org-hide-entry
Hide the body directly following this heading.
org-html-convert-region-to-html
- In file: ox-html.el
- Find modifications in git logs
Assume the current region has Org syntax, and convert it to HTML. This can be used in any buffer. For example, you can write an itemized list in Org syntax in an HTML buffer and use this command to convert it.
org-html-export-as-html (&optional async subtreep visible-only body-only ext-plist)
- In file: ox-html.el
- Find modifications in git logs
Export current buffer to an HTML buffer. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting buffer should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, only write code between "<body>" and "</body>" tags. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Export is done in a buffer named "*Org HTML Export*", which will be displayed when ‘org-export-show-temporary-export-buffer’ is non-nil.
org-html-export-to-html (&optional async subtreep visible-only body-only ext-plist)
- In file: ox-html.el
- Find modifications in git logs
Export current buffer to a HTML file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, only write code between "<body>" and "</body>" tags. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Return output file’s name.
org-html-htmlize-generate-css
- In file: ox-html.el
- Find modifications in git logs
Create the CSS for all font definitions in the current Emacs session. Use this to create face definitions in your CSS style file that can then be used by code snippets transformed by htmlize. This command just produces a buffer that contains class definitions for all faces used in the current Emacs session. You can copy and paste the ones you need into your CSS file. The face definitions are prepended with ‘org-html-htmlize-font-prefix’. If you then set ‘org-html-htmlize-output-type’ to ‘css’, calls to the function ‘org-html-htmlize-region-for-paste’ will produce code that uses these same face definitions.
org-icalendar-combine-agenda-files (&optional async)
Combine all agenda files into a single iCalendar file. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. The file is stored under the name chosen in ‘org-icalendar-combined-agenda-file’.
org-icalendar-export-agenda-files (&optional async)
Export all agenda files to iCalendar files. When optional argument ASYNC is non-nil, export happens in an external process.
org-icalendar-export-to-ics (&optional async subtreep visible-only body-only)
Export current buffer to an iCalendar file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, only write code between "BEGIN:VCALENDAR" and "END:VCALENDAR". Return ICS file name.
org-id-copy
- In file: org-id.el
- Find modifications in git logs
Copy the ID of the entry at point to the kill ring. Create an ID if necessary.
org-id-get-create (&optional force)
- In file: org-id.el
- Find modifications in git logs
Create an ID for the current entry and return it. If the entry already has an ID, just return it. With optional argument FORCE, force the creation of a new ID.
org-id-goto (id)
- In file: org-id.el
- Find modifications in git logs
Switch to the buffer containing the entry with id ID. Move the cursor to that entry in that buffer.
org-id-store-link
- In file: org-id.el
- Find modifications in git logs
Store a link to the current entry, using its ID. The link description is based on the heading, or if before the first heading, the title keyword if available, or else the filename. When ‘org-link-context-for-files’ and ‘org-id-link-use-context’ are non-nil, add a search string to the link. The link description is then based on the search string target. When in addition ‘org-id-link-consider-parent-id’ is non-nil, the ID can be inherited from a parent entry, with the search string used to still link to the current location.
org-id-update-id-locations (&optional files silent)
- In file: org-id.el
- Find modifications in git logs
Scan relevant files for IDs. Store the relation between files and corresponding IDs. This will scan all agenda files, all associated archives, all open Org files, and all files currently mentioned in ‘org-id-locations’. When FILES is given, scan also these files. If SILENT is non-nil, messages are suppressed.
org-inc-effort
- Access:
C-c C-x E - In file: org.el
- Find modifications in git logs
Increment the value of the effort property in the current entry.
org-increase-number-at-point (&optional inc)
- Access:
C-M-S-<right> - In file: org.el
- Find modifications in git logs
Increment the number at point. With an optional prefix numeric argument INC, increment using this numeric value.
org-indent-block
- In file: org.el
- Find modifications in git logs
Indent the block at point. Signal an error when not at a block.
org-indent-drawer
- In file: org.el
- Find modifications in git logs
Indent the drawer at point. Signal an error when not at a drawer.
org-indent-indent-buffer
Add indentation properties to the accessible part of the buffer.
org-indent-item
Indent a local list item, but not its children. If a region is active, all items inside will be moved.
org-indent-item-tree
Indent a local list item including its children. If a region is active, all items inside will be moved.
org-indent-line
- In file: org.el
- Find modifications in git logs
Indent line depending on context.
Indentation is done according to the following rules:
- Footnote definitions, diary sexps, headlines and inline tasks
have to start at column 0.
- On the very first line of an element, consider, in order, the
next rules until one matches:
1. If there’s a sibling element before, ignoring footnote
definitions and inline tasks, indent like its first line.
2. If element has a parent, indent like its contents. More
precisely, if parent is an item, indent after the bullet.
Else, indent like parent’s first line.
3. Otherwise, indent relatively to current level, if
‘org-adapt-indentation’ is t, or to left margin.
- On a blank line at the end of an element, indent according to
the type of the element. More precisely
1. If element is a plain list, an item, or a footnote
definition, indent like the very last element within.
2. If element is a paragraph, indent like its last non blank
line.
3. Otherwise, indent like its very first line.
- In the code part of a source block, use language major mode
to indent current line if ‘org-src-tab-acts-natively’ is
non-nil.
- Otherwise, indent like the first non-blank line above.
The function doesn’t indent an item as it could break the whole
list structure. Instead, use ‘C-c C-x L’ or ‘C-c C-x R’.
Also align node properties according to ‘org-property-format’.
org-indent-mode (&optional arg)
When active, indent text according to outline structure. Internally this works by adding ‘line-prefix’ and ‘wrap-prefix’ properties, after each buffer modification, on the modified zone. The process is synchronous. Though, initial indentation of buffer, which can take a few seconds on large buffers, is done during idle time. This is a minor mode. If called interactively, toggle the ‘Org-Indent mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-indent-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled.
org-indent-region (start end)
- In file: org.el
- Find modifications in git logs
Indent each non-blank line in the region. Called from a program, START and END specify the region to indent. The function will not indent contents of example blocks, verse blocks and export blocks as leading white spaces are assumed to be significant there.
org-indent-to-column (column &optional minimum)
Indent from point with tabs and spaces until COLUMN is reached. Optional second argument MINIMUM says always do at least MINIMUM spaces even if that goes past COLUMN; by default, MINIMUM is zero. Whether this uses tabs or spaces depends on ‘indent-tabs-mode’. The return value is the column where the insertion ends. (fn COLUMN &optional MINIMUM)
org-info (&optional node)
- In file: org.el
- Find modifications in git logs
Read documentation for Org in the info system. With optional NODE, go directly to that node.
org-info-find-node (&optional nodename)
- Access:
C-c C-x I - In file: org.el
- Find modifications in git logs
Find Info documentation NODENAME or Org documentation according context. Started from ‘gnus-info-find-node’.
org-inlinetask-demote
Demote the inline task at point. If the task has an end part, also demote it.
org-inlinetask-insert-task (&optional no-state)
Insert an inline task. If prefix arg NO-STATE is set, ignore ‘org-inlinetask-default-state’. If there is a region wrap it inside the inline task.
org-inlinetask-promote
Promote the inline task at point. If the task has an end part, promote it. Also, prevents level from going below ‘org-inlinetask-min-level’.
org-insert-all-links (arg &optional pre post)
- Access:
C-c C-M-l - In file: ol.el
- Find modifications in git logs
Insert all links in ‘org-stored-links’. When a universal prefix, do not delete the links from ‘org-stored-links’. When ‘ARG’ is a number, insert the last N link(s). ‘PRE’ and ‘POST’ are optional arguments to define a string to prepend or to append.
org-insert-block-template (type)
- In file: org.el
- Find modifications in git logs
Insert a block structure of the type #+begin_foo/#+end_foo. Select a block from ‘org-structure-template-alist’ then type either RET, TAB or SPC to write the block type. With an active region, wrap the region in the block. Otherwise, insert an empty block. When foo is written as FOO, upcase the #+BEGIN/END as well.
org-insert-columns-dblock
Create a dynamic block capturing a column view table.
org-insert-drawer (&optional arg drawer)
- Access:
C-c C-x d - In file: org.el
- Find modifications in git logs
Insert a drawer at point. When optional argument ARG is non-nil, insert a property drawer. Optional argument DRAWER, when non-nil, is a string representing drawer’s name. Otherwise, the user is prompted for a name. If a region is active, insert the drawer around that region instead. Point is left between drawer’s boundaries.
org-insert-heading (&optional arg invisible-ok level)
- In file: org.el
- Find modifications in git logs
Insert a new heading or an item with the same depth at point. If point is at the beginning of a heading, insert a new heading or a new headline above the current one. When at the beginning of a regular line of text, turn it into a heading. If point is in the middle of a line, split it and create a new headline with the text in the current line after point (see ‘org-M-RET-may-split-line’ on how to modify this behavior). As a special case, on a headline, splitting can only happen on the title itself. E.g., this excludes breaking stars or tags. With a ‘C-u’ prefix, set ‘org-insert-heading-respect-content’ to a non-nil value for the duration of the command. This forces the insertion of a heading after the current subtree, independently on the location of point. With a ‘C-u C-u’ prefix, insert the heading at the end of the tree above the current heading. For example, if point is within a 2nd-level heading, then it will insert a 2nd-level heading at the end of the 1st-level parent subtree. When INVISIBLE-OK is set, stop at invisible headlines when going back. This is important for non-interactive uses of the command. When optional argument LEVEL is a number, insert a heading at that level. For backwards compatibility, when LEVEL is non-nil but not a number, insert a level-1 heading.
org-insert-heading-after-current
- In file: org.el
- Find modifications in git logs
Insert a new heading with same level as current, after current subtree.
org-insert-heading-respect-content (&optional invisible-ok)
- Access:
C-<return> - In file: org.el
- Find modifications in git logs
Insert heading with ‘org-insert-heading-respect-content’ set to t.
org-insert-item (&optional checkbox)
Insert a new item at the current level. If cursor is before first character after bullet of the item, the new item will be created before the current one. If CHECKBOX is non-nil, add a checkbox next to the bullet. Return t when things worked, nil when we are not in an item, or item is invisible.
org-insert-last-stored-link (arg)
- Access:
C-c M-l - In file: ol.el
- Find modifications in git logs
Insert the last link stored in ‘org-stored-links’.
org-insert-link (&optional complete-file link-location description)
- Access:
C-c C-l - In file: ol.el
- Find modifications in git logs
Insert a link. At the prompt, enter the link. Completion can be used to insert any of the link protocol prefixes in use. The history can be used to select a link previously stored with ‘org-store-link’. When the empty string is entered (i.e. if you just press ‘RET’ at the prompt), the link defaults to the most recently stored link. As ‘SPC’ triggers completion in the minibuffer, you need to use ‘M-SPC’ or ‘C-q SPC’ to force the insertion of a space character. Completion candidates include link descriptions. If there is a link under cursor then edit it. You will also be prompted for a description, and if one is given, it will be displayed in the buffer instead of the link. If there is already a link at point, this command will allow you to edit link and description parts. With a ‘C-u’ prefix, prompts for a file to link to. The file name can be selected using completion. The path to the file will be relative to the current directory if the file is in the current directory or a subdirectory. Otherwise, the link will be the absolute path as completed in the minibuffer (i.e. normally ~/path/to/file). You can configure this behavior using the option ‘org-link-file-path-type’. With a ‘C-u C-u’ prefix, enforce an absolute path even if the file is in the current directory or below. A ‘C-u C-u C-u’ prefix negates ‘org-link-keep-stored-after-insertion’. If the LINK-LOCATION parameter is non-nil, this value will be used as the link location instead of reading one interactively. If the DESCRIPTION parameter is non-nil, this value will be used as the default description. If not, and the chosen link type has a non-nil ‘:insert-description’ parameter, that is used to generate a description as described in ‘org-link-parameters’ docstring. Otherwise, if ‘org-link-make-description-function’ is non-nil, this function will be called with the link target, and the result will be the default link description. When called non-interactively, don’t allow editing the default description.
org-insert-link-global
- In file: ol.el
- Find modifications in git logs
Insert a link like Org mode does. This command can be called in any mode to insert a link in Org syntax.
org-insert-structure-template (type)
- Access:
C-c C-,, C-c C-x s - In file: org.el
- Find modifications in git logs
Insert a block structure of the type #+begin_foo/#+end_foo. Select a block from ‘org-structure-template-alist’ then type either RET, TAB or SPC to write the block type. With an active region, wrap the region in the block. Otherwise, insert an empty block. When foo is written as FOO, upcase the #+BEGIN/END as well.
org-insert-subheading (arg)
- In file: org.el
- Find modifications in git logs
Insert a new subheading and demote it. Works for outline headings and for plain lists alike. The prefix argument ARG is passed to ‘org-insert-heading’. Unlike ‘org-insert-heading’, when point is at the beginning of a heading, still insert the new sub-heading below.
org-insert-todo-heading (arg &optional force-heading)
- Access:
M-S-<return>, M-S-RET, C-c C-x M - In file: org.el
- Find modifications in git logs
Insert a new heading with the same level and TODO state as current heading. If the heading has no TODO state, or if the state is DONE, use the first state (TODO by default). Also with ‘C-u’ prefix, force first state. With a ‘C-u C-u’ prefix, force inserting at the end of the parent subtree. When called at a plain list item, insert a new item with an unchecked check box.
org-insert-todo-heading-respect-content (&optional arg)
- Access:
C-S-<return> - In file: org.el
- Find modifications in git logs
Call ‘org-insert-todo-heading’, inserting after current subtree. ARG is passed to ‘org-insert-todo-heading’. This command temporarily sets ‘org-insert-heading-respect-content’ to t.
org-insert-todo-subheading (arg)
- In file: org.el
- Find modifications in git logs
Insert a new subheading with TODO keyword or checkbox and demote it. Works for outline headings and for plain lists alike. The prefix argument ARG is passed to ‘org-insert-todo-heading’.
org-kill-line (&optional _arg)
- In file: org.el
- Find modifications in git logs
Kill line, to tags or end of line. The behavior of this command depends on the user options ‘org-special-ctrl-k’ and ‘org-ctrl-k-protect-subtree’ (which see).
org-kill-note-or-show-branches
- Access:
C-c C-k - In file: org.el
- Find modifications in git logs
Abort storing current note, or show just branches.
org-koma-letter-export-as-latex (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a KOMA Scrlttr2 letter.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer should be accessible
through the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{letter}" and "\end{letter}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Export is done in a buffer named "*Org KOMA-LETTER Export*". It
will be displayed if ‘org-export-show-temporary-export-buffer’ is
non-nil.
org-koma-letter-export-to-latex (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a KOMA Scrlttr2 letter (tex).
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{letter}" and "\end{letter}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
When optional argument PUB-DIR is set, use it as the publishing
directory.
Return output file’s name.
org-koma-letter-export-to-pdf (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a KOMA Scrlttr2 letter (pdf).
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{letter}" and "\end{letter}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return PDF file’s name.
org-latex-convert-region-to-latex
Assume the current region has Org syntax, and convert it to LaTeX. This can be used in any buffer. For example, you can write an itemized list in Org syntax in an LaTeX buffer and use this command to convert it.
org-latex-export-as-latex (&optional async subtreep visible-only body-only ext-plist)
Export current buffer as a LaTeX buffer.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer should be accessible
through the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Export is done in a buffer named "*Org LATEX Export*", which
will be displayed when ‘org-export-show-temporary-export-buffer’
is non-nil.
org-latex-export-to-latex (&optional async subtreep visible-only body-only ext-plist)
Export current buffer to a LaTeX file.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
org-latex-export-to-pdf (&optional async subtreep visible-only body-only ext-plist)
Export current buffer to LaTeX then process through to PDF.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return PDF file’s name.
org-latex-preview (&optional arg)
- Access:
C-c C-x C-l - In file: org.el
- Find modifications in git logs
Toggle preview of the LaTeX fragment at point. If the cursor is on a LaTeX fragment, create the image and overlay it over the source code, if there is none. Remove it otherwise. If there is no fragment at point, display images for all fragments in the current section. With an active region, display images for all fragments in the region. With a ‘C-u’ prefix argument ARG, clear images for all fragments in the current section. With a ‘C-u C-u’ prefix argument ARG, display image for all fragments in the buffer. With a ‘C-u C-u C-u’ prefix argument ARG, clear image for all fragments in the buffer.
org-link-open-from-string (s &optional arg)
- In file: ol.el
- Find modifications in git logs
Open a link in the string S, as if it was in Org mode. Optional argument ARG is passed to ‘org-open-file’ when S is a "file" link.
org-link-preview (&optional arg beg end)
- Access:
C-c C-x C-v - In file: ol.el
- Find modifications in git logs
Toggle display of link previews in the buffer. When region BEG..END is active, preview links in the region. When point is at a link, display a preview for that link only. Otherwise, display previews for links in current entry. With numeric prefix ARG 1, also preview links with description in the active region, at point or in the current section. With prefix ARG ‘C-u’, clear link previews at point or in the current entry. With prefix ARG ‘C-u C-u’, display link previews in the accessible portion of the buffer. With numeric prefix ARG 11, do the same, but include links with descriptions. With prefix ARG ‘C-u C-u C-u’, hide all link previews in the accessible portion of the buffer. This command is designed for interactive use. From Elisp, you can also use ‘org-link-preview-region’.
org-link-preview-clear (&optional beg end)
- In file: ol.el
- Find modifications in git logs
Clear link previews in region BEG to END.
org-link-preview-refresh
- Access:
C-c C-x C-M-v - In file: ol.el
- Find modifications in git logs
Assure display of link previews in buffer and refresh them.
org-link-preview-region (&optional include-linked refresh beg end)
- In file: ol.el
- Find modifications in git logs
Display link previews.
A previewable link type is one that has a ‘:preview’ link
parameter, see ‘org-link-parameters’.
By default, a file link or attachment is previewable if it
follows either of these conventions:
1. Its path is a file with an extension matching return value
from ‘image-file-name-regexp’ and it has no contents.
2. Its description consists in a single link of the previous
type. In this case, that link must be a well-formed plain
or angle link, i.e., it must have an explicit "file" or
"attachment" type.
File links are equipped with the keymap ‘image-map’.
When optional argument INCLUDE-LINKED is non-nil, links with a
text description part will also be inlined. This can be nice for
a quick look at those images, but it does not reflect what
exported files will look like.
When optional argument REFRESH is non-nil, refresh existing
images between BEG and END. This will create new image displays
only if necessary.
BEG and END define the considered part. They default to the
buffer boundaries with possible narrowing.
org-lint (&optional arg)
Check current Org buffer for syntax mistakes. By default, run all checkers. With a ‘C-u’ prefix ARG, select one category of checkers only. With a ‘C-u C-u’ prefix, run one precise checker by its name. ARG can also be a list of checker names, as symbols, to run.
org-lint–hide-checker
Hide all reports from checker that generated the report at point.
org-lint–ignore-checker
Ignore all reports from checker that generated the report at point. Checker will also be ignored in all subsequent reports.
org-lint–jump-to-source
Move to source line that generated the report at point.
org-lint–report-mode
Major mode used to display reports emitted during linting.
Key Binding
-------------------------------------------------------------------------------
TAB .. C-j org-lint--show-source
RET org-lint--jump-to-source
SPC scroll-up-command
- negative-argument
0 .. 9 digit-argument
< beginning-of-buffer
> end-of-buffer
? describe-mode
S tabulated-list-sort
g revert-buffer
h org-lint--hide-checker
i org-lint--ignore-checker
n next-line
p previous-line
q quit-window
{ tabulated-list-narrow-current-column
} tabulated-list-widen-current-column
DEL scroll-down-command
S-SPC scroll-down-command
M-<left> tabulated-list-previous-column
M-<right> tabulated-list-next-column
<backtab> backward-button
<follow-link> mouse-face
<mouse-2> mouse-select-window
C-M-i backward-button
In addition to any hooks its parent mode ‘tabulated-list-mode’ might
have run, this mode runs the hook ‘org-lint--report-mode-hook’, as the
final or penultimate step during initialization.
org-lint–show-source
Show source line that generated the report at point.
org-list-checkbox-radio-mode (&optional arg)
When turned on, use list checkboxes as radio buttons. This is a minor mode. If called interactively, toggle the ‘Org-List-Checkbox-Radio mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-list-checkbox-radio-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled.
org-list-make-subtree
- Access:
C-c C-* - In file: org-list.el
- Find modifications in git logs
Convert the plain list at point into a subtree.
org-list-repair
Fix indentation, bullets and checkboxes in the list at point.
org-man-export-to-man (&optional async subtreep visible-only body-only ext-plist)
- In file: ox-man.el
- Find modifications in git logs
Export current buffer to a Man file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, only the body without any markers. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Return output file’s name.
org-man-export-to-pdf (&optional async subtreep visible-only body-only ext-plist)
- In file: ox-man.el
- Find modifications in git logs
Export current buffer to Groff then process through to PDF. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, only write between markers. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Return PDF file’s name.
org-mark-element
- Access:
M-h - In file: org.el
- Find modifications in git logs
Put point at beginning of this element, mark at end. Interactively, if this command is repeated or (in Transient Mark mode) if the mark is active, it marks the next element after the ones already marked.
org-mark-ring-goto (&optional n)
- Access:
C-c & - In file: org.el
- Find modifications in git logs
Jump to the previous position in the mark ring. With prefix arg N, jump back that many stored positions. When called several times in succession, walk through the entire ring. Org mode commands jumping to a different position in the current file, or to another Org file, automatically push the old position onto the ring.
org-mark-ring-push (&optional pos buffer)
- Access:
C-c % - In file: org.el
- Find modifications in git logs
Put the current position into the mark ring and rotate it. Also push position into the Emacs mark ring. If optional argument POS and BUFFER are not nil, mark this location instead.
org-mark-subtree (&optional up)
- Access:
C-c @ - In file: org.el
- Find modifications in git logs
Mark the current subtree. This puts point at the start of the current subtree, and mark at the end. If a numeric prefix UP is given, move up into the hierarchy of headlines by UP levels before marking the subtree.
org-match-sparse-tree (&optional todo-only match)
- Access:
C-c \ - In file: org.el
- Find modifications in git logs
Create a sparse tree according to tags string MATCH.
MATCH is a string with match syntax. It can contain a selection
of tags ("+work+urgent-boss"), properties ("LEVEL>3"), and
TODO keywords ("TODO=\"WAITING\"") or a combination of
those. See the manual for details.
If optional argument TODO-ONLY is non-nil, only select lines that
are also TODO tasks.
org-md-convert-region-to-md
- In file: ox-md.el
- Find modifications in git logs
Assume the current region has Org syntax, and convert it to Markdown. This can be used in any buffer. For example, you can write an itemized list in Org syntax in a Markdown buffer and use this command to convert it.
org-md-export-as-markdown (&optional async subtreep visible-only)
- In file: ox-md.el
- Find modifications in git logs
Export current buffer to a Markdown buffer. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting buffer should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. Export is done in a buffer named "*Org MD Export*", which will be displayed when ‘org-export-show-temporary-export-buffer’ is non-nil.
org-md-export-to-markdown (&optional async subtreep visible-only)
- In file: ox-md.el
- Find modifications in git logs
Export current buffer to a Markdown file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. Return output file’s name.
org-meta-return (&optional arg)
- Access:
M-RET, C-c C-x RET, C-c C-x m - In file: org.el
- Find modifications in git logs
Insert a new heading or wrap a region in a table. Calls ‘org-insert-heading’, ‘org-insert-item’ or ‘org-table-wrap-region’, depending on context. When called with an argument, unconditionally call ‘org-insert-heading’. This function has :before advice: ‘org-fold-check-before-invisible-edit-maybe’. (fn &optional ARG)
org-metadown (&optional _arg)
- Access:
M-<down>, ESC <down> - In file: org.el
- Find modifications in git logs
Move subtree down or move table row down. Calls ‘org-move-subtree-down’ or ‘org-table-move-row’ or ‘org-move-item-down’, depending on context. Everywhere else, move forward the element at point. See the individual commands for more information. This function runs the functions in ‘org-metadown-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function runs ‘org-metadown-final-hook’ using the same logic.
org-metaleft (&optional _arg)
- Access:
ESC <left>, C-c C-x l - In file: org.el
- Find modifications in git logs
Promote heading, list item at point or move table column left. Calls ‘org-do-promote’, ‘org-outdent-item’ or ‘org-table-move-column’, depending on context. With no specific context, calls the Emacs default ‘backward-word’. See the individual commands for more information. This function runs the functions in ‘org-metaleft-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function runs ‘org-metaleft-final-hook’ using the same logic.
org-metaright (&optional _arg)
- Access:
ESC <right>, C-c C-x r - In file: org.el
- Find modifications in git logs
Demote heading, list item at point or move table column right. In front of a drawer or a block keyword, indent it correctly. Calls ‘org-do-demote’, ‘org-indent-item’, ‘org-table-move-column’, ‘org-indent-drawer’ or ‘org-indent-block’ depending on context. With no specific context, calls the Emacs default ‘forward-word’. See the individual commands for more information. This function runs the functions in ‘org-metaright-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function runs ‘org-metaright-final-hook’ using the same logic.
org-metaup (&optional _arg)
- Access:
M-<up>, ESC <up>, C-c C-x u - In file: org.el
- Find modifications in git logs
Move subtree up or move table row up. Calls ‘org-move-subtree-up’ or ‘org-table-move-row’ or ‘org-move-item-up’, depending on context. Everywhere else, move backward the element at point. See the individual commands for more information. This function runs the functions in ‘org-metaup-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function runs ‘org-metaup-final-hook’ using the same logic.
org-mobile-apply (&optional beg end)
Apply all change requests in the current buffer. If BEG and END are given, only do this in that region.
org-mobile-create-sumo-agenda
Create a file that contains all custom agenda views.
org-mobile-move-capture
Move the contents of the capture file to the inbox file. Return a marker to the location where the new content has been added. If nothing new has been added, return nil.
org-mobile-pull
Pull the contents of ‘org-mobile-capture-file’ and integrate them. Apply all flagged actions, flag entries to be flagged and then call an agenda view showing the flagged items.
org-mobile-push
Push the current state of Org affairs to the target directory. This will create the index file, copy all agenda files there, and also create all custom agenda views, for upload to the mobile phone.
org-mode
- In file: org.el
- Find modifications in git logs
Outline-based notes management and organizer, alias
"Carsten’s outline-mode for keeping track of everything."
Org mode develops organizational tasks around a NOTES file which
contains information about projects as plain text. Org mode is
implemented on top of Outline mode, which is ideal to keep the content
of large files well structured. It supports ToDo items, deadlines and
time stamps, which magically appear in the diary listing of the Emacs
calendar. Tables are easily created with a built-in table editor.
Plain text URL-like links connect to websites, emails (VM), Usenet
messages (Gnus), BBDB entries, and any files related to the project.
For printing and sharing of notes, an Org file (or a part of it)
can be exported as a structured ASCII or HTML file.
The following commands are available:
Key Binding
-------------------------------------------------------------------------------
TAB org-cycle
C-j org-return-and-maybe-indent
RET org-return
| org-force-self-insert
S-TAB org-shifttab
S-RET org-table-copy-down
C-# org-table-rotate-recalc-marks
C-' org-cycle-agenda-files
C-, org-cycle-agenda-files
C-M-S-<left> org-decrease-number-at-point
C-M-S-<right> org-increase-number-at-point
C-S-<down> org-shiftcontroldown
C-S-<left> org-shiftcontrolleft
C-S-<return> org-insert-todo-heading-respect-content
C-S-<right> org-shiftcontrolright
C-S-<up> org-shiftcontrolup
C-<return> org-insert-heading-respect-content
M-S-<down> org-shiftmetadown
M-S-<left> org-shiftmetaleft
M-S-<return> org-insert-todo-heading
M-S-<right> org-shiftmetaright
M-S-<up> org-shiftmetaup
M-<down> org-metadown
M-<left> org-metaleft
M-<right> org-metaright
M-<up> org-metaup
S-<down> org-shiftdown
S-<left> org-shiftleft
S-<mouse-2> org-mouse-yank-link
S-<return> org-table-copy-down
S-<right> org-shiftright
S-<up> org-shiftup
<backtab> org-shifttab
<down-mouse-1> org-mouse-down-mouse
<drag-mouse-3> org-mouse-yank-link
<mouse-3> org-mouse-show-context-menu
M-RET org-meta-return
C-M-t org-transpose-element
M-h org-mark-element
M-{ org-backward-element
M-} org-forward-element
M-S-RET org-insert-todo-heading
ESC S-<down> org-shiftmetadown
ESC S-<left> org-shiftmetaleft
ESC S-<right> org-shiftmetaright
ESC S-<up> org-shiftmetaup
ESC <down> org-metadown
ESC <left> org-metaleft
ESC <right> org-metaright
ESC <up> org-metaup
C-c C-a org-attach
C-c C-b org-backward-heading-same-level
C-c C-c org-ctrl-c-ctrl-c
C-c C-d org-deadline
C-c C-e org-export-dispatch
C-c C-f org-forward-heading-same-level
C-c TAB org-ctrl-c-tab
C-c C-j org-goto
C-c C-k org-kill-note-or-show-branches
C-c C-l org-insert-link
C-c RET org-ctrl-c-ret
C-c C-o org-open-at-point
C-c C-q org-set-tags-command
C-c C-r org-fold-reveal
C-c C-s org-schedule
C-c C-t org-todo
C-c C-w org-refile
C-c C-y org-evaluate-time-range
C-c C-z org-add-note
C-c C-^ org-up-element
C-c C-_ org-down-element
C-c ! org-timestamp-inactive
C-c # org-update-statistics-cookies
C-c $ org-archive-subtree
C-c % org-mark-ring-push
C-c & org-mark-ring-goto
C-c ' org-edit-special
C-c * org-ctrl-c-star
C-c + org-table-sum
C-c , org-priority
C-c - org-ctrl-c-minus
C-c . org-timestamp
C-c / org-sparse-tree
C-c : org-toggle-fixed-width
C-c ; org-toggle-comment
C-c < org-date-from-calendar
C-c = org-table-eval-formula
C-c > org-goto-calendar
C-c ? org-table-field-info
C-c @ org-mark-subtree
C-c [ org-agenda-file-to-front
C-c \ org-match-sparse-tree
C-c ] org-remove-file
C-c ^ org-sort
C-c ` org-table-edit-field
C-c { org-table-toggle-formula-debugger
C-c | org-table-create-or-convert-from-region
C-c } org-table-toggle-coordinate-overlays
C-c ~ org-table-create-with-table.el
C-c C-* org-list-make-subtree
C-c C-, org-insert-structure-template
C-c C-<tab> org-cycle-force-archived
C-c <down> org-shiftdown
C-c <left> org-shiftleft
C-c <right> org-shiftright
C-c <up> org-shiftup
<remap> <backward-paragraph> org-backward-paragraph
<remap> <backward-sentence> org-backward-sentence
<remap> <comment-dwim> org-comment-dwim
<remap> <delete-backward-char> org-delete-backward-char
<remap> <delete-char> org-delete-char
<remap> <delete-indentation> org-delete-indentation
<remap> <fill-paragraph> org-fill-paragraph
<remap> <forward-paragraph> org-forward-paragraph
<remap> <forward-sentence> org-forward-sentence
<remap> <kill-line> org-kill-line
<remap> <move-beginning-of-line> org-beginning-of-line
<remap> <move-end-of-line> org-end-of-line
<remap> <open-line> org-open-line
<remap> <outline-backward-same-level> org-backward-heading-same-level
<remap> <outline-demote> org-demote-subtree
<remap> <outline-forward-same-level> org-forward-heading-same-level
<remap> <outline-insert-heading> org-ctrl-c-ret
<remap> <outline-mark-subtree> org-mark-subtree
<remap> <outline-next-visible-heading> org-next-visible-heading
<remap> <outline-previous-visible-heading> org-previous-visible-heading
<remap> <outline-promote> org-promote-subtree
<remap> <outline-show-branches> org-kill-note-or-show-branches
<remap> <outline-show-children> org-fold-show-children
<remap> <outline-show-subtree> org-fold-show-subtree
<remap> <outline-up-heading> org-up-heading
<remap> <self-insert-command> org-self-insert-command
<remap> <transpose-words> org-transpose-words
<remap> <yank> org-yank
C-c C-a outline-show-all
(this binding is currently shadowed)
C-c C-b outline-backward-same-level
(this binding is currently shadowed)
C-c C-c outline-hide-entry
(this binding is currently shadowed)
C-c C-d outline-hide-subtree
(this binding is currently shadowed)
C-c C-e outline-show-entry-and-parents
(this binding is currently shadowed)
C-c C-f outline-forward-same-level
(this binding is currently shadowed)
C-c TAB outline-show-children
(this binding is currently shadowed)
C-c C-k outline-show-branches
(this binding is currently shadowed)
C-c C-l outline-hide-leaves
(this binding is currently shadowed)
C-c RET outline-insert-heading
(this binding is currently shadowed)
C-c C-n outline-next-visible-heading
C-c C-o outline-hide-other
(this binding is currently shadowed)
C-c C-p outline-previous-visible-heading
C-c C-q outline-hide-sublevels
(this binding is currently shadowed)
C-c C-s outline-show-subtree
(this binding is currently shadowed)
C-c C-t outline-hide-body
(this binding is currently shadowed)
C-c C-u outline-up-heading
C-c C-v outline-move-subtree-down
(this binding is currently shadowed)
C-c C-^ outline-move-subtree-up
(this binding is currently shadowed)
C-c @ outline-mark-subtree
(this binding is currently shadowed)
C-c C-< outline-promote
C-c C-> outline-demote
C-x n b org-narrow-to-block
C-x n e org-narrow-to-element
C-x n s org-narrow-to-subtree
C-c C-v C-a org-babel-sha1-hash
C-c C-v C-b org-babel-execute-buffer
C-c C-v C-c org-babel-check-src-block
C-c C-v C-d org-babel-demarcate-block
C-c C-v C-e org-babel-execute-maybe
C-c C-v C-f org-babel-tangle-file
C-c C-v TAB org-babel-view-src-block-info
C-c C-v C-j org-babel-insert-header-arg
C-c C-v C-l org-babel-load-in-session
C-c C-v C-n org-babel-next-src-block
C-c C-v C-o org-babel-open-src-block-result
C-c C-v C-p org-babel-previous-src-block
C-c C-v C-r org-babel-goto-named-result
C-c C-v C-s org-babel-execute-subtree
C-c C-v C-t org-babel-tangle
C-c C-v C-u org-babel-goto-src-block-head
C-c C-v C-v org-babel-expand-src-block
C-c C-v C-x org-babel-do-key-sequence-in-edit-buffer
C-c C-v C-z org-babel-switch-to-session
C-c C-v I org-babel-view-src-block-info
C-c C-v a org-babel-sha1-hash
C-c C-v b org-babel-execute-buffer
C-c C-v c org-babel-check-src-block
C-c C-v d org-babel-demarcate-block
C-c C-v e org-babel-execute-maybe
C-c C-v f org-babel-tangle-file
C-c C-v g org-babel-goto-named-src-block
C-c C-v h org-babel-describe-bindings
C-c C-v i org-babel-lob-ingest
C-c C-v j org-babel-insert-header-arg
C-c C-v k org-babel-remove-result-one-or-many
C-c C-v l org-babel-load-in-session
C-c C-v n org-babel-next-src-block
C-c C-v o org-babel-open-src-block-result
C-c C-v p org-babel-previous-src-block
C-c C-v r org-babel-goto-named-result
C-c C-v s org-babel-execute-subtree
C-c C-v t org-babel-tangle
C-c C-v u org-babel-goto-src-block-head
C-c C-v v org-babel-expand-src-block
C-c C-v x org-babel-do-key-sequence-in-edit-buffer
C-c C-v z org-babel-switch-to-session-with-code
C-c " a orgtbl-ascii-plot
C-c " g org-plot/gnuplot
C-c C-M-l org-insert-all-links
C-c C-M-w org-refile-reverse
C-c M-b org-previous-block
C-c M-f org-next-block
C-c M-l org-insert-last-stored-link
C-c M-w org-refile-copy
C-c C-x C-a org-archive-subtree-default
C-c C-x C-b org-toggle-checkbox
C-c C-x C-c org-columns
C-c C-x C-d org-clock-display
C-c C-x C-f org-emphasize
C-c C-x TAB org-clock-in
C-c C-x C-j org-clock-goto
C-c C-x C-l org-latex-preview
C-c C-x RET org-meta-return
C-c C-x C-n org-next-link
C-c C-x C-o org-clock-out
C-c C-x C-p org-previous-link
C-c C-x C-q org-clock-cancel
C-c C-x C-r org-toggle-radio-button
C-c C-x C-s org-archive-subtree
C-c C-x C-t org-toggle-timestamp-overlays
C-c C-x C-u org-dblock-update
C-c C-x C-v org-link-preview
C-c C-x C-w org-cut-special
C-c C-x C-x org-clock-in-last
C-c C-x C-y org-paste-special
C-c C-x C-z org-resolve-clocks
C-c C-x ! org-reload
C-c C-x , org-timer-pause-or-continue
C-c C-x - org-timer-item
C-c C-x . org-timer
C-c C-x 0 org-timer-start
C-c C-x ; org-timer-set-timer
C-c C-x < org-agenda-set-restriction-lock
C-c C-x > org-agenda-remove-restriction-lock
C-c C-x @ org-cite-insert
C-c C-x A org-archive-to-archive-sibling
C-c C-x D org-shiftmetadown
C-c C-x E org-inc-effort
C-c C-x G org-feed-goto-inbox
C-c C-x I org-info-find-node
C-c C-x L org-shiftmetaleft
C-c C-x M org-insert-todo-heading
C-c C-x P org-set-property-and-value
C-c C-x R org-shiftmetaright
C-c C-x U org-shiftmetaup
C-c C-x [ org-reftex-citation
C-c C-x \ org-toggle-pretty-entities
C-c C-x _ org-timer-stop
C-c C-x a org-toggle-archive-tag
C-c C-x b org-tree-to-indirect-buffer
C-c C-x c org-clone-subtree-with-time-shift
C-c C-x d org-insert-drawer
C-c C-x e org-set-effort
C-c C-x f org-footnote-action
C-c C-x g org-feed-update-all
C-c C-x l org-metaleft
C-c C-x m org-meta-return
C-c C-x o org-toggle-ordered-property
C-c C-x p org-set-property
C-c C-x q org-toggle-tags-groups
C-c C-x r org-metaright
C-c C-x s org-insert-structure-template
C-c C-x u org-metaup
C-c C-x v org-copy-visible
C-c C-x x org-dynamic-block-insert-dblock
C-c C-x <left> org-shiftcontrolleft
C-c C-x <right> org-shiftcontrolright
C-c / h outline-hide-by-heading-regexp
C-c / s outline-show-by-heading-regexp
C-c C-v C-M-h org-babel-mark-block
C-c C-x C-M-v org-link-preview-refresh
C-c C-x M-w org-copy-special
In addition to any hooks its parent mode ‘outline-mode’ might have
run, this mode runs the hook ‘org-mode-hook’, as the final or
penultimate step during initialization.
org-mode-restart
- In file: org.el
- Find modifications in git logs
Restart ‘org-mode’.
org-mouse-down-mouse (event)
- Access:
<down-mouse-1> - In file: org-mouse.el
- Find modifications in git logs
org-mouse-end-headline
Go to the end of current headline (ignoring tags).
org-mouse-insert-checkbox
org-mouse-insert-heading
Insert a new heading, as ‘org-insert-heading’. If the point is at the :beginning (‘org-mouse-line-position’) of the line, insert the new heading before the current line. Otherwise, insert it after the current heading.
org-mouse-move-tree (event)
- Access:
C-<drag-mouse-1> - In file: org-mouse.el
- Find modifications in git logs
org-mouse-move-tree-start (_event)
- Access:
C-<down-mouse-1> - In file: org-mouse.el
- Find modifications in git logs
org-mouse-remove-match-and-spaces
Remove the match, make just one space around the point.
org-mouse-show-headlines
Change the visibility of the current org buffer to only show headlines.
org-mouse-show-overview
Change visibility of current org buffer to first-level headlines only.
org-mouse-timestamp-today (&optional shift units)
Change the timestamp into SHIFT UNITS in the future. For the acceptable UNITS, see ‘org-timestamp-change’.
org-mouse-transform-to-outline
org-mouse-yank-link (click)
- Access:
<drag-mouse-3>, S-<mouse-2> - In file: org-mouse.el
- Find modifications in git logs
org-move-item-down
Move the item at point down, i.e. swap with following item. Sub-items (items with larger indentation) are considered part of the item, so this really moves item trees.
org-move-item-up
Move the item at point up, i.e. swap with previous item. Sub-items (items with larger indentation) are considered part of the item, so this really moves item trees.
org-move-subtree-down (&optional arg)
- In file: org.el
- Find modifications in git logs
Move the current subtree down past ARG headlines of the same level.
org-move-subtree-up (&optional arg)
- In file: org.el
- Find modifications in git logs
Move the current subtree up past ARG headlines of the same level.
org-narrow-to-block
- Access:
C-x n b - In file: org.el
- Find modifications in git logs
Narrow buffer to the current block. Use the command ‘C-x n w’ to see the whole buffer again.
org-narrow-to-element
- Access:
C-x n e - In file: org.el
- Find modifications in git logs
Narrow buffer to current element. Use the command ‘C-x n w’ to see the whole buffer again.
org-narrow-to-subtree (&optional element)
- Access:
C-x n s - In file: org.el
- Find modifications in git logs
Narrow buffer to the current subtree. Use the command ‘C-x n w’ to see the whole buffer again. With optional argument ELEMENT narrow to subtree around ELEMENT.
org-newline-and-indent (&optional arg)
Insert a newline, then indent according to major mode. Indentation is done using the value of ‘indent-line-function’. In programming language modes, this is the same as TAB. In some text modes, where TAB inserts a tab, this command indents to the column specified by the function ‘current-left-margin’. With ARG, perform this action that many times. Also see ‘open-line’ (bound to C-o) for a command that just inserts a newline without doing any indentation. (fn &optional ARG)
org-next-block (arg &optional backward block-regexp)
- Access:
C-c M-f - In file: org.el
- Find modifications in git logs
Jump to the next block. With a prefix argument ARG, jump forward ARG many blocks. When BACKWARD is non-nil, jump to the previous block. When BLOCK-REGEXP is non-nil, use this regexp to find blocks. Match data is set according to this regexp when the function returns. Return point at beginning of the opening line of found block. Throw an error if no block is found.
org-next-item
Move to the beginning of the next item. Throw an error when not in a list. Also throw an error when at last item, unless ‘org-list-use-circular-motion’ is non-nil.
org-next-link (&optional search-backward)
- Access:
C-c C-x C-n - In file: ol.el
- Find modifications in git logs
Move forward to the next link. If the link is in hidden text, expose it. When SEARCH-BACKWARD is non-nil, move backward.
org-next-visible-heading (arg)
- Access:
C-c C-n - In file: org.el
- Find modifications in git logs
Move to the next visible heading line. With ARG, repeats or can move backward if negative.
org-num-mode (&optional arg)
- In file: org-num.el
- Find modifications in git logs
Dynamic numbering of headlines in an Org buffer. This is a minor mode. If called interactively, toggle the ‘Org-Num mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-num-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled.
org-occur (regexp &optional keep-previous callback)
- In file: org.el
- Find modifications in git logs
Make a compact tree showing all matches of REGEXP. The tree will show the lines where the regexp matches, and any other context defined in ‘org-fold-show-context-detail’, which see. When optional argument KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous call to ‘org-occur’ will be kept, to allow stacking of calls to this command. Optional argument CALLBACK can be a function of no argument. In this case, it is called with point at the end of the match, match data being set accordingly. Current match is shown only if the return value is non-nil. The function must neither move point nor alter narrowing.
org-occur-in-agenda-files (regexp &optional _nlines)
- In file: org.el
- Find modifications in git logs
Call ‘multi-occur’ with buffers for all agenda files.
org-occur-link-in-agenda-files
- In file: org.el
- Find modifications in git logs
Create a link and search for it in the agendas. The link is not stored in ‘org-stored-links’, it is just created for the search purpose.
org-odt-convert (&optional in-file out-fmt open)
- In file: ox-odt.el
- Find modifications in git logs
Convert IN-FILE to format OUT-FMT using a command line converter. IN-FILE is the file to be converted. If unspecified, it defaults to variable ‘buffer-file-name’. OUT-FMT is the desired output format. Use ‘org-odt-convert-process’ as the converter. If OPEN is non-nil then the newly converted file is opened using ‘org-open-file’.
org-odt-export-as-odf (latex-frag &optional odf-file)
- In file: ox-odt.el
- Find modifications in git logs
Export LATEX-FRAG as OpenDocument formula file ODF-FILE. Use ‘org-create-math-formula’ to convert LATEX-FRAG first to MathML. When invoked as an interactive command, use ‘org-latex-regexps’ to infer LATEX-FRAG from currently active region. If no LaTeX fragments are found, prompt for it. Push MathML source to kill ring depending on the value of ‘org-export-copy-to-kill-ring’.
org-odt-export-as-odf-and-open
- In file: ox-odt.el
- Find modifications in git logs
Export LaTeX fragment as OpenDocument formula and immediately open it. Use ‘org-odt-export-as-odf’ to read LaTeX fragment and OpenDocument formula file.
org-odt-export-to-odt (&optional async subtreep visible-only ext-plist)
- In file: ox-odt.el
- Find modifications in git logs
Export current buffer to a ODT file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Return output file’s name.
org-open-at-mouse (ev)
- In file: org.el
- Find modifications in git logs
Open file link or URL at mouse. See the docstring of ‘org-open-file’ for details.
org-open-at-point (&optional arg)
- Access:
C-c C-o - In file: org.el
- Find modifications in git logs
Open thing at point. The thing can be a link, citation, timestamp, footnote, src-block or tags. When point is on a link, follow it. Normally, files will be opened by an appropriate application (see ‘org-file-apps’). If the optional prefix argument ARG is non-nil, Emacs will visit the file. With a double prefix argument, try to open outside of Emacs, in the application the system uses for this file type. When point is on a timestamp, open the agenda at the day specified. When point is a footnote definition, move to the first reference found. If it is on a reference, move to the associated definition. When point is on a src-block or inline src-block, open its result. When point is on a citation, follow it. When point is on a headline, display a list of every link in the entry, so it is possible to pick one, or all, of them. If point is on a tag, call ‘org-tags-view’ instead. On top of syntactically correct links, this function also tries to open links and timestamps in comments, node properties, and keywords if point is on something looking like a timestamp or a link. This function has :around advice: ‘org--mouse-open-at-point’. (fn &optional ARG)
org-open-at-point-global (&optional arg)
- In file: org.el
- Find modifications in git logs
Follow a link or a timestamp like Org mode does. Pass ARG to ‘org-link-open-to-string’. Also follow links and emails as seen by ‘thing-at-point’. This command can be called in any mode to follow an external link or a timestamp that has Org mode syntax. Its behavior is undefined when called on internal links like fuzzy links. Raise a user error when there is nothing to follow.
org-open-line (n)
- In file: org.el
- Find modifications in git logs
Insert a new row in tables, call ‘open-line’ elsewhere. If ‘org-special-ctrl-o’ is nil, just call ‘open-line’ everywhere. As a special case, when a document starts with a table, allow calling ‘open-line’ on the very first character.
org-open-link-from-string (s &optional arg)
Open a link in the string S, as if it was in Org mode. Optional argument ARG is passed to ‘org-open-file’ when S is a "file" link.
org-org-export-as-org (&optional async subtreep visible-only body-only ext-plist)
- In file: ox-org.el
- Find modifications in git logs
Export current buffer to an Org buffer. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting buffer should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, strip document keywords from output. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Export is done in a buffer named "*Org ORG Export*", which will be displayed when ‘org-export-show-temporary-export-buffer’ is non-nil.
org-org-export-to-org (&optional async subtreep visible-only body-only ext-plist)
- In file: ox-org.el
- Find modifications in git logs
Export current buffer to an Org file. If narrowing is active in the current buffer, only export its narrowed part. If a region is active, export that region. A non-nil optional argument ASYNC means the process should happen asynchronously. The resulting file should be accessible through the ‘org-export-stack’ interface. When optional argument SUBTREEP is non-nil, export the sub-tree at point, extracting information from the headline properties first. When optional argument VISIBLE-ONLY is non-nil, don’t export contents of hidden elements. When optional argument BODY-ONLY is non-nil, strip document keywords from output. EXT-PLIST, when provided, is a property list with external parameters overriding Org default settings, but still inferior to file-local settings. Return output file name.
org-outdent-item
Outdent a local list item, but not its children. If a region is active, all items inside will be moved.
org-outdent-item-tree
Outdent a local list item including its children. If a region is active, all items inside will be moved.
org-overview
- In file: org.el
- Find modifications in git logs
Switch to overview mode, showing only top-level headlines.
org-paste-special (arg)
- Access:
C-c C-x C-y - In file: org.el
- Find modifications in git logs
Paste rectangular region into table, or paste subtree relative to level. Calls ‘org-table-paste-rectangle’ or ‘org-paste-subtree’, depending on context. See the individual commands for more information.
org-paste-subtree (&optional level tree for-yank remove)
- In file: org.el
- Find modifications in git logs
Paste the clipboard as a subtree, with modification of headline level. The entire subtree is promoted or demoted in order to match a new headline level. If the cursor is at the beginning of a headline, the same level as that headline is used to paste the tree before current headline. With ‘C-u’ prefix, force inserting at the same level as current headline, after subtree at point. With ‘C-u’ ‘C-u’ prefix, force inserting as a child headline, as the first child. If not, the new level is derived from the *visible* headings before and after the insertion point, and taken to be the inferior headline level of the two. So if the previous visible heading is level 3 and the next is level 4 (or vice versa), level 4 will be used for insertion. This makes sure that the subtree remains an independent subtree and does not swallow low level entries. You can also force a different level, either by using a numeric prefix argument, or by inserting the heading marker by hand. For example, if the cursor is after "*****", then the tree will be shifted to level 5. If optional TREE is given, use this text instead of the kill ring. When FOR-YANK is set, this is called by ‘org-yank’. In this case, do not move back over whitespace before inserting, and move point to the end of the inserted text when done. When REMOVE is non-nil, remove the subtree from the clipboard.
org-plot/collect-options (&optional params)
Collect options from an org-plot ‘#+Plot:’ line. Accepts an optional property list PARAMS, to which the options will be added. Returns the resulting property list.
org-plot/gnuplot (&optional params)
- Access:
C-c " g - In file: org-plot.el
- Find modifications in git logs
Plot table using gnuplot. Gnuplot options can be specified with PARAMS. If not given options will be taken from the +PLOT line directly before or after the table.
org-plot/gnuplot-to-grid-data (table data-file params)
Export the data in TABLE to DATA-FILE for gnuplot. This means in a format appropriate for grid plotting by gnuplot. PARAMS specifies which columns of TABLE should be plotted as independent and dependent variables.
org-plot/goto-nearest-table
Move the point forward to the beginning of nearest table. Return value is the point at the beginning of the table.
org-preview-latex-fragment (&optional arg)
Toggle preview of the LaTeX fragment at point. If the cursor is on a LaTeX fragment, create the image and overlay it over the source code, if there is none. Remove it otherwise. If there is no fragment at point, display images for all fragments in the current section. With an active region, display images for all fragments in the region. With a ‘C-u’ prefix argument ARG, clear images for all fragments in the current section. With a ‘C-u C-u’ prefix argument ARG, display image for all fragments in the buffer. With a ‘C-u C-u C-u’ prefix argument ARG, clear image for all fragments in the buffer.
org-previous-block (arg &optional block-regexp)
- Access:
C-c M-b - In file: org.el
- Find modifications in git logs
Jump to the previous block. With a prefix argument ARG, jump backward ARG many source blocks. When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
org-previous-item
Move to the beginning of the previous item. Throw an error when not in a list. Also throw an error when at first item, unless ‘org-list-use-circular-motion’ is non-nil.
org-previous-link
- Access:
C-c C-x C-p - In file: ol.el
- Find modifications in git logs
Move backward to the previous link. If the link is in hidden text, expose it.
org-previous-visible-heading (arg)
- Access:
C-c C-p - In file: org.el
- Find modifications in git logs
Move to the previous visible heading. With ARG, repeats or can move forward if negative.
org-priority (&optional action)
- Access:
C-c , - In file: org.el
- Find modifications in git logs
Change the priority of an item. When called interactively with a ‘C-u’ prefix, show the priority in the minibuffer instead of changing it. When called programmatically, ACTION can be ‘set’, ‘up’, ‘down’, ‘remove’, an uppercase alphabetic character A through Z, or an integer 0 through 64, inclusive. If a lower-case character is passed as ACTION or entered via interactive prompt, it will automatically be converted to uppercase.
org-priority-down
- In file: org.el
- Find modifications in git logs
Decrease the priority of the current item.
org-priority-show
- In file: org.el
- Find modifications in git logs
Show the priority of the current item as number. Return the priority value.
org-priority-up
- In file: org.el
- Find modifications in git logs
Increase the priority of the current item.
org-promote-subtree
- Access:
C-c C-< - In file: org.el
- Find modifications in git logs
Promote the entire subtree. See also ‘org-promote’.
org-property-action
- In file: org.el
- Find modifications in git logs
Do an action on properties.
org-property-next-allowed-value (&optional previous)
- In file: org.el
- Find modifications in git logs
Switch to the next allowed value for this property.
org-property-previous-allowed-value (&optional _previous)
- In file: org.el
- Find modifications in git logs
Switch to the next allowed value for this property.
org-protocol-create (&optional project-plist)
Create a new org-protocol project interactively. An org-protocol project is an entry in ‘org-protocol-project-alist’ which is used by ‘org-protocol-open-source’. Optionally use PROJECT-PLIST to initialize the defaults for this project. If PROJECT-PLIST is the cdr of an element in ‘org-publish-project-alist’, reuse :base-directory, :html-extension and :base-extension.
org-protocol-create-for-org
Create an Org protocol project for the current file’s project. The visited file needs to be part of a publishing project in ‘org-publish-project-alist’ for this to work. The function delegates most of the work to ‘org-protocol-create’.
org-publish (project &optional force async)
Publish PROJECT. PROJECT is either a project name, as a string, or a project alist (see ‘org-publish-project-alist’ variable). When optional argument FORCE is non-nil, force publishing all files in PROJECT. With a non-nil optional argument ASYNC, publishing will be done asynchronously, in another process.
org-publish-all (&optional force async)
Publish all projects. With prefix argument FORCE, remove all files in the timestamp directory and force publishing all projects. With a non-nil optional argument ASYNC, publishing will be done asynchronously, in another process.
org-publish-current-file (&optional force async)
Publish the current file. With prefix argument FORCE, force publish the file. When optional argument ASYNC is non-nil, publishing will be done asynchronously, in another process.
org-publish-current-project (&optional force async)
Publish the project associated with the current file. With a prefix argument, force publishing of all files in the project.
org-publish-project (project &optional force async)
Publish PROJECT. PROJECT is either a project name, as a string, or a project alist (see ‘org-publish-project-alist’ variable). When optional argument FORCE is non-nil, force publishing all files in PROJECT. With a non-nil optional argument ASYNC, publishing will be done asynchronously, in another process.
org-redisplay-inline-images
Assure display of link previews in buffer and refresh them.
org-refile (&optional arg default-buffer rfloc msg)
- Access:
C-c C-w - In file: org-refile.el
- Find modifications in git logs
Move the entry or entries at point to another heading. The list of target headings is compiled using the information in ‘org-refile-targets’, which see. At the target location, the entry is filed as a subitem of the target heading. Depending on ‘org-reverse-note-order’, the new subitem will either be the first or the last subitem. If there is an active region, all entries in that region will be refiled. However, the region must fulfill the requirement that the first heading sets the top-level of the moved text. With a ‘C-u’ ARG, the command will only visit the target location and not actually move anything. With a prefix ‘C-u C-u’, go to the location where the last refiling operation has put the subtree. With a numeric prefix argument of ‘2’, refile to the running clock. With a numeric prefix argument of ‘3’, emulate ‘org-refile-keep’ being set to t and copy to the target location, don’t move it. Beware that keeping refiled entries may result in duplicated ID properties. RFLOC can be a refile location obtained in a different way. It should be a list with the following 4 elements: 1. Name - an identifier for the refile location, typically the headline text 2. File - the file the refile location is in 3. nil - used for generating refile location candidates, not needed when passing RFLOC 4. Position - the position in the specified file of the headline to refile under MSG is a string to replace "Refile" in the default prompt with another verb. E.g. ‘org-refile-copy’ sets this parameter to "Copy". See also ‘org-refile-use-outline-path’. If you are using target caching (see ‘org-refile-use-cache’), you have to clear the target cache in order to find new targets. This can be done with a ‘0’ prefix (C-0 C-c C-w) or a triple prefix argument (C-u C-u C-u C-c C-w).
org-refile-copy
- Access:
C-c M-w - In file: org-refile.el
- Find modifications in git logs
Like ‘org-refile’, but preserve the refiled subtree.
org-refile-goto-last-stored
Go to the location where the last refile was stored.
org-refile-reverse (&optional arg default-buffer rfloc msg)
- Access:
C-c C-M-w - In file: org-refile.el
- Find modifications in git logs
Refile while temporarily toggling ‘org-reverse-note-order’. So if ‘org-refile’ would append the entry as the last entry under the target heading, ‘org-refile-reverse’ will prepend it as the first entry, and vice-versa.
org-reftex-citation
- Access:
C-c C-x [ - In file: org.el
- Find modifications in git logs
Use ‘reftex-citation’ to insert a citation into the buffer. This looks for a line like #+BIBLIOGRAPHY: foo plain option:-d and derives from it that foo.bib is the bibliography file relevant for this document. It then installs the necessary environment for RefTeX to work in this buffer and calls ‘reftex-citation’ to insert a citation into the buffer. Export of such citations to both LaTeX and HTML is handled by the contributed package ox-bibtex by Taru Karttunen.
org-reload (&optional uncompiled)
- Access:
C-c C-x ! - In file: org.el
- Find modifications in git logs
Reload all Org Lisp files. With prefix arg UNCOMPILED, load the uncompiled versions.
org-remove-file (&optional file)
- Access:
C-c ] - In file: org.el
- Find modifications in git logs
Remove current file from the list of files in variable ‘org-agenda-files’. These are the files which are being checked for agenda entries. Optional argument FILE means use this file instead of the current.
org-remove-inline-images (&optional beg end)
Clear link previews in region BEG to END.
org-remove-occur-highlights (&optional _beg _end noremove)
- In file: org.el
- Find modifications in git logs
Remove the occur highlights from the buffer. BEG and END are ignored. If NOREMOVE is nil, remove this function from the ‘before-change-functions’ in the current buffer.
org-require-autoloaded-modules
- In file: org.el
- Find modifications in git logs
org-reset-checkbox-state-subtree
Reset all checkboxes in an entry subtree.
org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid)
- Access:
C-c C-x C-z - In file: org-clock.el
- Find modifications in git logs
Resolve all currently open Org clocks. If ‘only-dangling-p’ is non-nil, only ask to resolve dangling (i.e., not currently open and valid) clocks.
org-return (&optional indent arg interactive)
- In file: org.el
- Find modifications in git logs
Goto next table row or insert a newline. Calls ‘org-table-next-row’ or ‘newline’, depending on context. When optional INDENT argument is non-nil, call ‘newline-and-indent’ with ARG, otherwise call ‘newline’ with ARG and INTERACTIVE. When ‘org-return-follows-link’ is non-nil and point is on a timestamp, a link or a citation, call ‘org-open-at-point’. However, it will not happen if point is in a table or on a "dead" object (e.g., within a comment). In these case, you need to use ‘org-open-at-point’ directly. This function has :before advice: ‘org-fold-check-before-invisible-edit-maybe’. (fn &optional INDENT ARG INTERACTIVE)
org-return-and-maybe-indent
- In file: org.el
- Find modifications in git logs
Goto next table row, or insert a newline, maybe indented. Call ‘org-table-next-row’ or ‘org-return’, depending on context. See the individual commands for more information. When inserting a newline, if ‘org-adapt-indentation’ is t: indent the line if ‘electric-indent-mode’ is disabled, don’t indent it if it is enabled.
org-return-indent
Goto next table row or insert a newline and indent. Calls ‘org-table-next-row’ or ‘newline-and-indent’, depending on context. See the individual commands for more information.
org-reveal (&optional siblings)
- In file: org.el
- Find modifications in git logs
Show current entry, hierarchy above it, and the following headline. This can be used to show a consistent set of context around locations exposed with ‘org-fold-show-context’. With optional argument SIBLINGS, on each level of the hierarchy all siblings are shown. This repairs the tree structure to what it would look like when opened with hierarchical calls to ‘org-cycle’. With a C-u C-u prefix, go to the parent and show the entire tree.
org-revert-all-org-buffers
- In file: org.el
- Find modifications in git logs
Revert all Org buffers. Prompt for confirmation when there are unsaved changes. Be sure you know what you are doing before letting this function overwrite your changes. This function is useful in a setup where one tracks Org files with a version control system, to revert on one machine after pulling changes from another. I believe the procedure must be like this: 1. M-x org-save-all-org-buffers 2. Pull changes from the other machine, resolve conflicts 3. M-x org-revert-all-org-buffers
org-save-all-org-buffers
- In file: org.el
- Find modifications in git logs
Save all Org buffers without user confirmation.
org-schedule (arg &optional time)
- Access:
C-c C-s - In file: org.el
- Find modifications in git logs
Insert a "SCHEDULED:" string with a timestamp to schedule an item. When called interactively, this command pops up the Emacs calendar to let the user select a date. With one universal prefix argument, remove any scheduling date from the item. With two universal prefix arguments, prompt for a delay cookie. With argument TIME, scheduled at the corresponding date. TIME can either be an Org date like "2011-07-24" or a delta like "+2d".
org-search-view (&optional todo-only string edit-at)
Show all entries that contain a phrase or words or regular expressions. With optional prefix argument TODO-ONLY, only consider entries that are TODO entries. The argument STRING can be used to pass a default search string into this function. If EDIT-AT is non-nil, it means that the user should get a chance to edit this string, with cursor at position EDIT-AT. The search string can be viewed either as a phrase that should be found as is, or it can be broken into a number of snippets, each of which must match in a Boolean way to select an entry. The default depends on the variable ‘org-agenda-search-view-always-boolean’. Even if this is turned off (the default) you can always switch to Boolean search dynamically by preceding the first word with "+" or "-". The default is a direct search of the whole phrase, where each space in the search string can expand to an arbitrary amount of whitespace, including newlines. If using a Boolean search, the search string is split on whitespace and each snippet is searched separately, with logical AND to select an entry. Words prefixed with a minus must *not* occur in the entry. Words without a prefix or prefixed with a plus must occur in the entry. Matching is case-insensitive. Words are enclosed by word delimiters (i.e. they must match whole words, not parts of a word) if ‘org-agenda-search-view-force-full-words’ is set (default is nil). Boolean search snippets enclosed by curly braces are interpreted as regular expressions that must or (when preceded with "-") must not match in the entry. Snippets enclosed into double quotes will be taken as a whole, to include whitespace. - If the search string starts with an asterisk, search only in headlines. - If (possibly after the leading star) the search string starts with an exclamation mark, this also means to look at TODO entries only, an effect that can also be achieved with a prefix argument. - If (possibly after star and exclamation mark) the search string starts with a colon, this will mean that the (non-regexp) snippets of the Boolean search must match as full words. This command searches the agenda files, and in addition the files listed in ‘org-agenda-text-search-extra-files’ unless a restriction lock is active.
org-self-insert-command (N)
- In file: org.el
- Find modifications in git logs
Like ‘self-insert-command’, use ‘overwrite-mode’ for whitespace in tables. If the cursor is in a table looking at whitespace, the whitespace is overwritten, and the table is not marked as requiring realignment. This function has :before advice: ‘org-fold-check-before-invisible-edit-maybe’. (fn N)
org-set-effort (&optional increment value)
- Access:
C-c C-x e - In file: org.el
- Find modifications in git logs
Set the effort property of the current entry. If INCREMENT is non-nil, set the property to the next allowed value. Otherwise, if optional argument VALUE is provided, use it. Eventually, prompt for the new value if none of the previous variables is set.
org-set-property (property value)
- Access:
C-c C-x p - In file: org.el
- Find modifications in git logs
In the current entry, set PROPERTY to VALUE. When called interactively, this will prompt for a property name, offering completion on existing and default properties. And then it will prompt for a value, offering completion either on allowed values (via an inherited xxx_ALL property) or on existing values in other instances of this property in the current file. Throw an error when trying to set a property with an invalid name.
org-set-property-and-value (use-last)
- Access:
C-c C-x P - In file: org.el
- Find modifications in git logs
Allow setting [PROPERTY]: [value] direction from prompt. When use-default, don’t even ask, just use the last "[PROPERTY]: [value]" string from the history.
org-set-visibility-according-to-property
Switch subtree visibility according to VISIBILITY property.
org-setup-comments-handling
- In file: org.el
- Find modifications in git logs
org-shiftcontroldown (&optional n)
- Access:
C-S-<down> - In file: org.el
- Find modifications in git logs
Change timestamps synchronously down in CLOCK log lines. Optional argument N tells to change by that many units.
org-shiftcontrolleft
- Access:
C-S-<left>, C-c C-x <left> - In file: org.el
- Find modifications in git logs
Switch to previous TODO set.
org-shiftcontrolright
- Access:
C-S-<right>, C-c C-x <right> - In file: org.el
- Find modifications in git logs
Switch to next TODO set.
org-shiftcontrolup (&optional n)
- Access:
C-S-<up> - In file: org.el
- Find modifications in git logs
Change timestamps synchronously up in CLOCK log lines. Optional argument N tells to change by that many units.
org-shiftdown (&optional arg)
- Access:
S-<down>, C-c <down> - In file: org.el
- Find modifications in git logs
Act on current element according to context. Call ‘org-timestamp-down’ or ‘org-priority-down’, or ‘org-next-item’, or ‘org-table-move-cell-down’. See the individual commands for more information. This function runs the functions in ‘org-shiftdown-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function also runs ‘org-shiftdown-final-hook’ using the same logic. If none of the previous steps succeed and ‘org-support-shift-select’ is non-nil, the function runs ‘shift-select-mode’ associated command. See that variable for more information.
org-shiftleft (&optional arg)
- Access:
S-<left>, C-c <left> - In file: org.el
- Find modifications in git logs
Act on current element according to context. This does one of the following: - switch a timestamp at point one day into the past - on a headline, switch to the previous TODO keyword. - on an item, switch entire list to the previous bullet type - on a property line, switch to the previous allowed value - on a clocktable definition line, move time block into the past - in a table, move a single cell left This function runs the functions in ‘org-shiftleft-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function runs ‘org-shiftleft-final-hook’ using the same logic. If none of the above succeeds and ‘org-support-shift-select’ is non-nil, runs ‘shift-select-mode’ specific command. See that variable for more information.
org-shiftmetadown (&optional _arg)
- Access:
M-S-<down>, ESC S-<down>, C-c C-x D - In file: org.el
- Find modifications in git logs
Drag the line at point down. In a table, insert an empty row at the current line. On a clock timestamp, update the value of the timestamp like ‘S-<down>’ but also adjust the previous clocked item in the clock history. Everywhere else, drag the line at point down. This function runs the functions in ‘org-shiftmetadown-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function also runs ‘org-shiftmetadown-final-hook’ using the same logic.
org-shiftmetaleft
- Access:
M-S-<left>, ESC S-<left>, C-c C-x L - In file: org.el
- Find modifications in git logs
Promote subtree or delete table column. Calls ‘org-promote-subtree’, ‘org-outdent-item-tree’, or ‘org-table-delete-column’, depending on context. See the individual commands for more information. This function runs the functions in ‘org-shiftmetaleft-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function also runs ‘org-shiftmetaleft-final-hook’ using the same logic.
org-shiftmetaright
- Access:
M-S-<right>, ESC S-<right>, C-c C-x R - In file: org.el
- Find modifications in git logs
Demote subtree or insert table column. Calls ‘org-demote-subtree’, ‘org-indent-item-tree’, or ‘org-table-insert-column’, depending on context. See the individual commands for more information. This function runs the functions in ‘org-shiftmetaright-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function also runs ‘org-shiftmetaright-final-hook’ using the same logic.
org-shiftmetaup (&optional _arg)
- Access:
M-S-<up>, ESC S-<up>, C-c C-x U - In file: org.el
- Find modifications in git logs
Drag the line at point up. In a table, kill the current row. On a clock timestamp, update the value of the timestamp like ‘S-<up>’ but also adjust the previous clocked item in the clock history. Everywhere else, drag the line at point up. This function runs the functions in ‘org-shiftmetaup-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function also runs ‘org-shiftmetaup-final-hook’ using the same logic.
org-shiftright (&optional arg)
- Access:
S-<right>, C-c <right> - In file: org.el
- Find modifications in git logs
Act on the current element according to context. This does one of the following: - switch a timestamp at point one day into the future - on a headline, switch to the next TODO keyword - on an item, switch entire list to the next bullet type - on a property line, switch to the next allowed value - on a clocktable definition line, move time block into the future - in a table, move a single cell right This function runs the functions in ‘org-shiftright-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function runs ‘org-shiftright-final-hook’ using the same logic. If none of the above succeeds and ‘org-support-shift-select’ is non-nil, runs ‘shift-select-mode’ specific command. See that variable for more information.
org-shifttab (&optional arg)
- Access:
S-TAB - In file: org.el
- Find modifications in git logs
Global visibility cycling or move to previous table field. Call ‘org-table-previous-field’ within a table. When ARG is nil, cycle globally through visibility states. When ARG is a numeric prefix, show contents of this level.
org-shiftup (&optional arg)
- Access:
S-<up>, C-c <up> - In file: org.el
- Find modifications in git logs
Act on current element according to context. Call ‘org-timestamp-up’ or ‘org-priority-up’, or ‘org-previous-item’, or ‘org-table-move-cell-up’. See the individual commands for more information. This function runs the functions in ‘org-shiftup-hook’ one by one as a first step, and exits immediately if a function from the hook returns non-nil. In the absence of a specific context, the function also runs ‘org-shiftup-final-hook’ using the same logic. If none of the previous steps succeed and ‘org-support-shift-select’ is non-nil, the function runs ‘shift-select-mode’ associated command. See that variable for more information.
org-show-all (&optional types)
Show all contents in the visible part of the buffer. By default, the function expands headings, blocks and drawers. When optional argument TYPES is a list of symbols among ‘blocks’, ‘drawers’ and ‘headings’, to only expand one specific type.
org-show-block-all
Unfold all blocks in the current buffer.
org-show-children (&optional level)
Show all direct subheadings of this heading. Prefix arg LEVEL is how many levels below the current level should be shown. If direct subheadings are deeper than LEVEL, they are still displayed.
org-show-entry (&optional hide-drawers)
Show the body directly following its heading. Show the heading too, if it is currently invisible.
org-show-priority
- In file: org.el
- Find modifications in git logs
Show the priority of the current item as number. Return the priority value.
org-show-subtree
Show everything after this heading at deeper levels.
org-show-todo-tree (arg)
- In file: org.el
- Find modifications in git logs
Make a compact tree which shows all headlines marked with TODO. The tree will show the lines where the regexp matches, and all higher headlines above the match. With a ‘C-u’ prefix, prompt for a regexp to match. With a numeric prefix N, construct a sparse tree for the Nth element of ‘org-todo-keywords-1’.
org-sort (&optional with-case)
- Access:
C-c ^ - In file: org.el
- Find modifications in git logs
Call ‘org-sort-entries’, ‘org-table-sort-lines’ or ‘org-sort-list’. Optional argument WITH-CASE means sort case-sensitively.
org-sort-entries (&optional with-case sorting-type getkey-func compare-func property interactive?)
- In file: org.el
- Find modifications in git logs
Sort entries on a certain level of an outline tree.
If there is an active region, the entries in the region are sorted.
Else, if the cursor is before the first entry, sort the top-level items.
Else, the children of the entry at point are sorted.
Sorting can be alphabetically, numerically, by date/time as given by
a time stamp, by a property, by priority order, or by a custom function.
The command prompts for the sorting type unless it has been given to the
function through the SORTING-TYPE argument, which needs to be a character,
(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
the precise meaning of each character:
a Alphabetically, ignoring the TODO keyword and the priority, if any.
c By creation time, which is assumed to be the first inactive time stamp
at the beginning of a line.
d By deadline date/time.
k By clocking time.
n Numerically, by converting the beginning of the entry/item to a number.
o By order of TODO keywords.
p By priority according to the cookie.
r By the value of a property.
s By scheduled date/time.
t By date/time, either the first active time stamp in the entry, or, if
none exist, by the first inactive one.
Capital letters will reverse the sort order.
If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
called with point at the beginning of the record. It must return a
value that is compatible with COMPARE-FUNC, the function used to
compare entries.
Comparing entries ignores case by default. However, with an optional argument
WITH-CASE, the sorting considers case as well.
Sorting is done against the visible part of the headlines, it ignores hidden
links.
When sorting is done, call ‘org-after-sorting-entries-or-items-hook’.
A non-nil value for INTERACTIVE? is used to signal that this
function is being called interactively.
org-sort-list (&optional with-case sorting-type getkey-func compare-func interactive?)
Sort list items.
The cursor may be at any item of the list that should be sorted.
Sublists are not sorted. Checkboxes, if any, are ignored.
Sorting can be alphabetically, numerically, by date/time as given
by a time stamp, by a property or by priority.
Comparing entries ignores case by default. However, with an
optional argument WITH-CASE, the sorting considers case as well,
if the current locale allows for it.
The command prompts for the sorting type unless it has been given
to the function through the SORTING-TYPE argument, which needs to
be a character, among ?n ?N ?a ?A ?t ?T ?f ?F ?x or ?X. Here is
the detailed meaning of each character:
n Numerically, by converting the beginning of the item to a number.
a Alphabetically. Only the first line of item is checked.
t By date/time, either the first active time stamp in the entry, if
any, or by the first inactive one. In a timer list, sort the timers.
x By "checked" status of a check list.
Capital letters will reverse the sort order.
If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies
a function to be called with point at the beginning of the
record. It must return a value that is compatible with COMPARE-FUNC,
the function used to compare entries.
Sorting is done against the visible part of the headlines, it
ignores hidden links.
A non-nil value for INTERACTIVE? is used to signal that this
function is being called interactively.
org-sparse-tree (&optional arg type)
- Access:
C-c / - In file: org.el
- Find modifications in git logs
Create a sparse tree, prompt for the details.
This command can create sparse trees. You first need to select the type
of match used to create the tree:
t Show all TODO entries.
T Show entries with a specific TODO keyword.
m Show entries selected by a tags/property match.
p Enter a property name and its value (both with completion on existing
names/values) and show entries with that property.
r Show entries matching a regular expression (‘/’ can be used as well).
b Show deadlines and scheduled items before a date.
a Show deadlines and scheduled items after a date.
d Show deadlines due within ‘org-deadline-warning-days’.
D Show deadlines and scheduled items between a date range.
org-speed-command-help
Show the available speed commands.
org-speed-move-safe (cmd)
Execute CMD, but make sure that the cursor always ends up in a headline. If not, return to the original position and throw an error.
org-speedbar-set-agenda-restriction
Restrict future agenda commands to the location at point in speedbar. If there is already a restriction lock at the location, remove it. To get rid of the restriction, use ‘C-c C-x >’.
org-src-associate-babel-session (info)
- In file: org-src.el
- Find modifications in git logs
Associate edit buffer with comint session. INFO should be a list similar in format to the return value of ‘org-babel-get-src-block-info’.
org-src-do-key-sequence-at-code-block (&optional key)
- In file: org-src.el
- Find modifications in git logs
Execute key sequence at code block in the source Org buffer.
The command bound to KEY in the Org-babel key map is executed
remotely with point temporarily at the start of the code block in
the Org buffer.
This command is not bound to a key by default, to avoid conflicts
with language major mode bindings. To bind it to C-c @ in all
language major modes, you could use
(add-hook 'org-src-mode-hook
(lambda () (define-key org-src-mode-map "\C-c@"
'org-src-do-key-sequence-at-code-block)))
In that case, for example, C-c @ t issued in code edit buffers
would tangle the current Org code block, C-c @ e would execute
the block and C-c @ h would display the other available
Org-babel commands.
org-src-mode (&optional arg)
- In file: org-src.el
- Find modifications in git logs
Minor mode for language major mode buffers generated by Org. This minor mode is turned on in two situations: - when editing a source code snippet with ‘C-c '’ - when formatting a source code snippet for export with htmlize. Key Binding ------------------------------------------------------------------------------- C-x C-s org-edit-src-save C-c C-k org-edit-src-abort C-c ' org-edit-src-exit See also ‘org-src-mode-hook’. This is a minor mode. If called interactively, toggle the ‘Org-Src mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-src-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled.
org-store-agenda-views (&rest _parameters)
Store agenda views.
org-store-link (arg &optional interactive?)
- In file: ol.el
- Find modifications in git logs
Store a link to the current location. This link is added to ‘org-stored-links’ and can later be inserted into an Org buffer with ‘org-insert-link’ (‘C-c C-l’). When optional argument INTERACTIVE? is nil, the link is not stored in ‘org-stored-links’, but returned as a string. For some link types, a ‘C-u’ prefix ARG is interpreted. A single ‘C-u’ negates ‘org-link-context-for-files’ for file links or ‘org-gnus-prefer-web-links’ for links to Usenet articles. A ‘C-u C-u’ prefix ARG forces skipping storing functions that are not part of Org core. A ‘C-u C-u C-u’ prefix ARG forces storing a link for each line in the active region. Assume the function is called interactively if INTERACTIVE? is non-nil. In Org buffers, an additional "human-readable" simple file link is stored as an alternative to persistent org-id or other links, if at a heading with a CUSTOM_ID property or an element with a NAME.
org-submit-bug-report
- In file: org.el
- Find modifications in git logs
Submit a bug report on Org via mail. Don’t hesitate to report any problems or inaccurate documentation. If you don’t have setup sending mail from (X)Emacs, please copy the output buffer into your mail program, as it gives us important information about your Org version and configuration.
org-switchb (&optional arg)
- In file: org.el
- Find modifications in git logs
Switch between Org buffers. With ‘C-u’ prefix, restrict available buffers to files. With ‘C-u C-u’ prefix, restrict available buffers to agenda files.
org-table-align
Align the table at point by aligning all vertical bars.
org-table-beginning-of-field (n)
Move to the beginning of the current table field. If already at or before the beginning, move to the beginning of the previous field. With numeric argument N, move N-1 fields backward first.
org-table-blank-field
Blank the current table field or active region.
org-table-calc-current-TBLFM (&optional arg)
Apply the #+TBLFM in the line at point to the table.
org-table-convert
Convert from Org table to table.el and back. Obviously, this only works within limits. When an Org table is converted to table.el, all horizontal separator lines get lost, because table.el uses these as cell boundaries and has no notion of horizontal lines. A table.el table can be converted to an Org table only if it does not do row or column spanning. Multiline cells will become multiple cells. Beware, Org mode does not test if the table can be successfully converted - it blindly applies a recipe that works for simple tables.
org-table-convert-region (beg0 end0 &optional separator)
Convert region to a table.
The region goes from BEG0 to END0, but these borders will be moved
slightly, to make sure a beginning of line in the first line is
included.
Throw an error when the region has more than
‘org-table-convert-region-max-lines’ lines.
SEPARATOR specifies the field separator in the lines. It can have the
following values:
(4) Use the comma as a field separator
(16) Use a TAB as field separator
(64) Prompt for a regular expression as field separator
integer When a number, use that many spaces, or a TAB, as field separator
regexp When a regular expression, use it to match the separator
nil When nil, the command tries to be smart and figure out the
separator in the following way:
- when each line contains a TAB, assume TAB-separated material
- when each line contains a comma, assume CSV material
- else, assume one or more SPACE characters as separator.
‘babel-auto’
Use the same rules as nil, but do not try any separator when
the region contains a single line and has no commas or tabs.
org-table-copy-down (n)
- Access:
S-RET, S-<return> - In file: org-table.el
- Find modifications in git logs
Copy the value of the current field one row below. If the field at the cursor is empty, copy the content of the nearest non-empty field above. With argument N, use the Nth non-empty field. If the current field is not empty, it is copied down to the next row, and the cursor is moved with it. Therefore, repeating this command causes the column to be filled row-by-row. If the variable ‘org-table-copy-increment’ is non-nil and the field is a number, a timestamp, or is either prefixed or suffixed with a number, it will be incremented while copying. By default, increment by the difference between the value in the current field and the one in the field above, if any. To increment using a fixed integer, set ‘org-table-copy-increment’ to a number. In the case of a timestamp, increment by days. However, when N is 0, do not increment the field at all.
org-table-copy-region (beg end &optional cut)
Copy rectangular region in table to clipboard. A special clipboard is used which can only be accessed with ‘org-table-paste-rectangle’. Return the region copied, as a list of lists of fields.
org-table-create (&optional size)
Query for a size and insert a table skeleton. SIZE is a string Columns x Rows like for example "3x2".
org-table-create-or-convert-from-region (arg)
- Access:
C-c | - In file: org-table.el
- Find modifications in git logs
Convert region to table, or create an empty table. If there is an active region, convert it to a table, using the function ‘org-table-convert-region’. See the documentation of that function to learn how the prefix argument is interpreted to determine the field separator. If there is no such region, create an empty table with ‘org-table-create’.
org-table-create-with-table.el
- Access:
C-c ~ - In file: org-table.el
- Find modifications in git logs
Use the table.el package to insert a new table. If there is already a table at point, convert between Org tables and table.el tables.
org-table-current-column
Return current column number.
org-table-cut-region (beg end)
Copy region in table to the clipboard and blank all relevant fields. If there is no active region, use just the field at point.
org-table-delete-column
Delete a column from the table.
org-table-edit-field (arg)
- Access:
C-c ` - In file: org-table.el
- Find modifications in git logs
Edit table field in a different window. This is mainly useful for fields that contain hidden parts. When called with a ‘C-u’ prefix, just make the full field visible so that it can be edited in place. When called with a ‘C-u C-u’ prefix, toggle ‘org-table-follow-field-mode’.
org-table-edit-formulas
Edit the formulas of the current table in a separate buffer.
org-table-end-of-field (n)
Move to the end of the current table field. If already at or after the end, move to the end of the next table field. With numeric argument N, move N-1 fields forward first.
org-table-eval-formula (&optional arg equation suppress-align suppress-const suppress-store suppress-analysis)
- Access:
C-c = - In file: org-table.el
- Find modifications in git logs
Replace the table field value at the cursor by the result of a calculation. In a table, this command replaces the value in the current field with the result of a formula. It also installs the formula as the "current" column formula, by storing it in a special line below the table. When called with a ‘C-u’ prefix the formula is installed as a field formula. When called with a ‘C-u C-u’ prefix, insert the active equation for the field back into the current field, so that it can be edited there. This is useful in order to use ‘C-c ?’ to check the referenced fields. When called, the command first prompts for a formula, which is read in the minibuffer. Previously entered formulas are available through the history list, and the last used formula is offered as a default. These stored formulas are adapted correctly when moving, inserting, or deleting columns with the corresponding commands. The formula can be any algebraic expression understood by the Calc package. For details, see the Org mode manual. This function can also be called from Lisp programs and offers additional arguments: EQUATION can be the formula to apply. If this argument is given, the user will not be prompted. SUPPRESS-ALIGN is used to speed-up recursive calls by by-passing unnecessary aligns. SUPPRESS-CONST suppresses the interpretation of constants in the formula, assuming that this has been done already outside the function. SUPPRESS-STORE means the formula should not be stored, either because it is already stored, or because it is a modified equation that should not overwrite the stored one. SUPPRESS-ANALYSIS prevents analyzing the table and checking location of point.
org-table-expand (&optional begin end)
Expand all columns in the table at point. Optional arguments BEGIN and END, when non-nil, specify the beginning and end position of the current table.
org-table-export (&optional file format)
Export table to a file, with configurable format. Such a file can be imported into usual spreadsheet programs. FILE can be the output file name. If not given, it will be taken from a TABLE_EXPORT_FILE property in the current entry or higher up in the hierarchy, or the user will be prompted for a file name. FORMAT can be an export format, of the same kind as it used when ‘-mode’ sends a table in a different format. The command suggests a format depending on TABLE_EXPORT_FORMAT, whether it is set locally or up in the hierarchy, then on the extension of the given file name, and finally on the variable ‘org-table-export-default-format’.
org-table-fedit-abort
Abort editing formulas, without installing the changes.
org-table-fedit-finish (&optional arg)
Parse the buffer for formula definitions and install them. With prefix ARG, apply the new formulas to the table.
org-table-fedit-line-down
Move cursor one line down in the window showing the table.
org-table-fedit-line-up
Move cursor one line up in the window showing the table.
org-table-fedit-lisp-indent
- Access:
<tab> - In file: org-table.el
- Find modifications in git logs
Pretty-print and re-indent Lisp expressions in the Formula Editor.
org-table-fedit-ref-down
Shift the reference at point one row/hline down.
org-table-fedit-ref-left
Shift the reference at point one field to the left.
org-table-fedit-ref-right
Shift the reference at point one field to the right.
org-table-fedit-ref-up
Shift the reference at point one row/hline up.
org-table-fedit-scroll (N)
org-table-fedit-scroll-down (N)
org-table-fedit-toggle-coordinates
Toggle the display of coordinates in the referenced table.
org-table-fedit-toggle-ref-type
Convert all references in the buffer from B3 to @3$2 and back.
org-table-field-info (_arg)
- Access:
C-c ? - In file: org-table.el
- Find modifications in git logs
Show info about the current field, and highlight any reference at point.
org-table-follow-field-mode (&optional arg)
Minor mode to make the table field editor window follow the cursor. When this mode is active, the field editor window will always show the current field. The mode exits automatically when the cursor leaves the table (but see ‘org-table-exit-follow-field-mode-when-leaving-table’). This is a minor mode. If called interactively, toggle the ‘Org-Table-Follow-Field mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-table-follow-field-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled.
org-table-goto-column (n &optional on-delim force)
Move the cursor to the Nth column in the current table line. With optional argument ON-DELIM, stop with point before the left delimiter of the field. If there are less than N fields, just go to after the last delimiter. However, when FORCE is non-nil, create new columns if necessary.
org-table-header-line-mode (&optional arg)
Display the first row of the table at point in the header line. This is a minor mode. If called interactively, toggle the ‘Org-Table-Header-Line mode’ mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode. If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number. To check whether the minor mode is enabled in the current buffer, evaluate the variable ‘org-table-header-line-mode’. The mode’s hook is called both when the mode is enabled and when it is disabled.
org-table-hline-and-move (&optional same-column)
Insert a hline and move to the row below that line.
org-table-import (file separator)
Import FILE as a table. The command tries to be smart and figure out the separator in the following way: - when each line contains a TAB, assume TAB-separated material; - when each line contains a comma, assume CSV material; - else, assume one or more SPACE characters as separator. When non-nil, SEPARATOR specifies the field separator in the lines. It can have the following values: - (4) Use the comma as a field separator. - (16) Use a TAB as field separator. - (64) Prompt for a regular expression as field separator. - integer When a number, use that many spaces, or a TAB, as field separator. - regexp When a regular expression, use it to match the separator.
org-table-insert-column
Insert a new column into the table.
org-table-insert-hline (&optional above)
Insert a horizontal-line below the current line into the table. With prefix ABOVE, insert above the current line.
org-table-insert-row (&optional arg)
Insert a new row above the current line into the table. With prefix ARG, insert below the current line.
org-table-iterate (&optional arg)
Recalculate the table until it does not change anymore. The maximum number of iterations is 10, but you can choose a different value with the prefix ARG.
org-table-iterate-buffer-tables
Iterate all tables in the buffer, to converge inter-table dependencies.
org-table-kill-row
Delete the current row or horizontal line from the table.
org-table-maybe-recalculate-line
Recompute the current line if marked for it, and if we haven’t just done it.
org-table-move-cell-down
Move a single cell down in a table. Swap with anything in target cell.
org-table-move-cell-left
Move a single cell left in a table. Swap with anything in target cell.
org-table-move-cell-right
Move a single cell right in a table. Swap with anything in target cell.
org-table-move-cell-up
Move a single cell up in a table. Swap with anything in target cell.
org-table-move-column (&optional left)
Move the current column to the right. With arg LEFT, move to the left.
org-table-move-column-left
Move column to the left.
org-table-move-column-right
Move column to the right.
org-table-move-row (&optional up)
Move the current table line down. With arg UP, move it up.
org-table-move-row-down
Move table row down.
org-table-move-row-up
Move table row up.
org-table-next-field
Go to the next field in the current table, creating new lines as needed. Before doing so, re-align the table if necessary.
org-table-next-row
Go to the next row (same column) in the current table. When next row is an hline or outside the table, create a new empty row. Before doing so, re-align the table if necessary.
org-table-overlay-coordinates
Add overlays to the table at point, to show row/column coordinates.
org-table-paste-rectangle
Paste a rectangular region into a table. The upper right corner ends up in the current field. All involved fields will be overwritten. If the rectangle does not fit into the present table, the table is enlarged as needed. The process ignores horizontal separator lines.
org-table-previous-field
Go to the previous field in the table. Before doing so, re-align the table if necessary.
org-table-recalculate (&optional all noalign)
Recalculate the current table line by applying all stored formulas. With prefix arg ALL, do this for all lines in the table. When called with a ‘C-u C-u’ prefix, or if ALL is the symbol ‘iterate’, recompute the table until it no longer changes. If NOALIGN is not nil, do not re-align the table after the computations are done. This is typically used internally to save time, if it is known that the table will be realigned a little later anyway.
org-table-recalculate-buffer-tables
Recalculate all tables in the current buffer.
org-table-rotate-recalc-marks (&optional newchar)
- Access:
C-# - In file: org-table.el
- Find modifications in git logs
Rotate the recalculation mark in the first column. If in any row, the first field is not consistent with a mark, insert a new column for the markers. When there is an active region, change all the lines in the region, after prompting for the marking character. After each change, a message will be displayed indicating the meaning of the new mark.
org-table-show-reference (&optional local)
Show the location/value of the $ expression at point. When LOCAL is non-nil, show references for the table at point.
org-table-shrink (&optional begin end)
Shrink all columns with a width cookie in the table at point. Columns without a width cookie are expanded. Optional arguments BEGIN and END, when non-nil, specify the beginning and end position of the current table.
org-table-sort-lines (&optional with-case sorting-type getkey-func compare-func interactive?)
Sort table lines according to the column at point. The position of point indicates the column to be used for sorting, and the range of lines is the range between the nearest horizontal separator lines, or the entire table of no such lines exist. If point is before the first column, you will be prompted for the sorting column. If there is an active region, the mark specifies the first line and the sorting column, while point should be in the last line to be included into the sorting. The command then prompts for the sorting type which can be alphabetically, numerically, or by time (as given in a time stamp in the field, or as a HH:MM value). Sorting in reverse order is also possible. With prefix argument WITH-CASE, alphabetic sorting will be case-sensitive if the locale allows for it. If SORTING-TYPE is specified when this function is called from a Lisp program, no prompting will take place. SORTING-TYPE must be a character, any of (?a ?A ?n ?N ?t ?T ?f ?F) where the capital letters indicate that sorting should be done in reverse order. If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be called to extract the key. It must return a value that is compatible with COMPARE-FUNC, the function used to compare entries. A non-nil value for INTERACTIVE? is used to signal that this function is being called interactively.
org-table-sum (&optional beg end nlast)
- Access:
C-c + - In file: org-table.el
- Find modifications in git logs
Sum numbers in region of current table column. The result will be displayed in the echo area, and will be available as kill to be inserted with C-y. If there is an active region, it is interpreted as a rectangle and all numbers in that rectangle will be summed. If there is no active region and point is located in a table column, sum all numbers in that column. If at least one number looks like a time HH:MM or HH:MM:SS, all other numbers are assumed to be times as well (in decimal hours) and the numbers are added as such. If NLAST is a number, only the NLAST fields will actually be summed.
org-table-toggle-column-width (&optional arg)
Shrink or expand current column in an Org table. If a width cookie specifies a width W for the column, the first W visible characters are displayed. Otherwise, the column is shrunk to a single character. When point is before the first column or after the last one, ask for the columns to shrink or expand, as a list of ranges. A column range can be one of the following patterns: N column N only N-M every column between N and M (both inclusive) N- every column between N (inclusive) and the last column -M every column between the first one and M (inclusive) - every column When optional argument ARG is a string, use it as white space separated list of column ranges. When called with ‘C-u’ prefix, call ‘org-table-shrink’, i.e., shrink columns with a width cookie and expand the others. When called with ‘C-u C-u’ prefix, expand all columns.
org-table-toggle-coordinate-overlays
- Access:
C-c } - In file: org-table.el
- Find modifications in git logs
Toggle the display of Row/Column numbers in tables.
org-table-toggle-formula-debugger
Toggle the formula debugger in tables.
org-table-transpose-table-at-point
Transpose Org table at point and eliminate hlines. So a table like | 1 | 2 | 4 | 5 | |---+---+---+---| | a | b | c | d | | e | f | g | h | will be transposed as | 1 | a | e | | 2 | b | f | | 4 | c | g | | 5 | d | h | Note that horizontal lines disappear.
org-table-wrap-region (arg)
Wrap several fields in a column like a paragraph. This is useful if you’d like to spread the contents of a field over several lines, in order to keep the table compact. If there is an active region, and both point and mark are in the same column, the text in the column is wrapped to minimum width for the given number of lines. Generally, this makes the table more compact. A prefix ARG may be used to change the number of desired lines. For example, ‘C-2 M-x org-table-wrap-region’ formats the selected text to two lines. If the region was longer than two lines, the remaining lines remain empty. A negative prefix argument reduces the current number of lines by that amount. The wrapped text is pasted back into the table. If you formatted it to more lines than it was before, fields further down in the table get overwritten - so you might need to make space in the table first. If there is no region, the current field is split at the cursor position and the text fragment to the right of the cursor is prepended to the field one line down. If there is no region, but you specify a prefix ARG, the current field gets blank, and the content is appended to the field above.
org-texinfo-convert-region-to-texinfo
Assume the current region has Org syntax, and convert it to Texinfo. This can be used in any buffer. For example, you can write an itemized list in Org syntax in an Texinfo buffer and use this command to convert it.
org-texinfo-export-to-info (&optional async subtreep visible-only body-only ext-plist)
Export current buffer to Texinfo then process through to INFO.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return INFO file’s name.
org-texinfo-export-to-texinfo (&optional async subtreep visible-only body-only ext-plist)
Export current buffer to a Texinfo file.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting file should be accessible through
the ‘org-export-stack’ interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don’t export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, only write code
between "\begin{document}" and "\end{document}".
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Return output file’s name.
org-time-stamp (arg &optional inactive)
- In file: org.el
- Find modifications in git logs
Prompt for a date/time and insert a time stamp. If the user specifies a time like HH:MM or if this command is called with at least one prefix argument, the time stamp contains the date and the time. Otherwise, only the date is included. All parts of a date not specified by the user are filled in from the timestamp at point, if any, or the current date/time otherwise. If there is already a timestamp at the cursor, it is replaced. With two universal prefix arguments, insert an active timestamp with the current time without prompting the user. When called from Lisp, the timestamp is inactive if INACTIVE is non-nil.
org-time-stamp-inactive (&optional arg)
- In file: org.el
- Find modifications in git logs
Insert an inactive time stamp. An inactive time stamp is enclosed in square brackets instead of angle brackets. It is inactive in the sense that it does not trigger agenda entries. So these are more for recording a certain time/date. If the user specifies a time like HH:MM or if this command is called with at least one prefix argument, the time stamp contains the date and the time. Otherwise, only the date is included. When called with two universal prefix arguments, insert an inactive time stamp with the current time without prompting the user.
org-timer (&optional restart no-insert)
- Access:
C-c C-x . - In file: org-timer.el
- Find modifications in git logs
Insert a H:MM:SS string from the timer into the buffer. The first time this command is used, the timer is started. When used with a ‘C-u’ prefix RESTART, force restarting the timer. When used with a ‘C-u C-u’ prefix RESTART, change all the timer strings in the region by a fixed amount. This can be used to re-calibrate a timer that was not started at the correct moment. If NO-INSERT is non-nil, return the string instead of inserting it in the buffer.
org-timer-change-times-in-region (beg end delta)
Change all h:mm:ss time in region BEG..END by a DELTA.
org-timer-item (&optional arg)
- Access:
C-c C-x - - In file: org-timer.el
- Find modifications in git logs
Insert a description-type item with the current timer value. Prefix argument ARG is passed to ‘org-timer’.
org-timer-pause-or-continue (&optional stop)
- Access:
C-c C-x , - In file: org-timer.el
- Find modifications in git logs
Pause or continue the relative or countdown timer. With prefix arg STOP, stop it entirely.
org-timer-set-timer (&optional opt)
- Access:
C-c C-x ; - In file: org-timer.el
- Find modifications in git logs
Prompt for a duration in minutes or hh:mm:ss and set a timer. If ‘org-timer-default-timer’ is not "0", suggest this value as the default duration for the timer. If a timer is already set, prompt the user if she wants to replace it. Called with a numeric prefix argument OPT, use this numeric value as the duration of the timer in minutes. Called with a C-u prefix argument OPT, use ‘org-timer-default-timer’ without prompting the user for a duration. With two C-u prefix arguments OPT, use ‘org-timer-default-timer’ without prompting the user for a duration and automatically replace any running timer. By default, the timer duration will be set to the number of minutes in the Effort property, if any. You can ignore this by using three C-u prefix arguments.
org-timer-show-remaining-time
Display the remaining time before the timer ends.
org-timer-start (&optional offset)
- Access:
C-c C-x 0 - In file: org-timer.el
- Find modifications in git logs
Set the starting time for the relative timer to now. When called with prefix argument OFFSET, prompt the user for an offset time, with the default taken from a timer stamp at point, if any. If OFFSET is a string or an integer, it is directly taken to be the offset without user interaction. When called with a double prefix arg, all timer strings in the active region will be shifted by a specific amount. You will be prompted for the amount, with the default to make the first timer string in the region 0:00:00.
org-timer-stop
- Access:
C-c C-x _ - In file: org-timer.el
- Find modifications in git logs
Stop the relative or countdown timer.
org-timestamp (arg &optional inactive)
- Access:
C-c . - In file: org.el
- Find modifications in git logs
Prompt for a date/time and insert a time stamp. If the user specifies a time like HH:MM or if this command is called with at least one prefix argument, the time stamp contains the date and the time. Otherwise, only the date is included. All parts of a date not specified by the user are filled in from the timestamp at point, if any, or the current date/time otherwise. If there is already a timestamp at the cursor, it is replaced. With two universal prefix arguments, insert an active timestamp with the current time without prompting the user. When called from Lisp, the timestamp is inactive if INACTIVE is non-nil.
org-timestamp-down (&optional arg)
- In file: org.el
- Find modifications in git logs
Decrease the date item at the cursor by one. If the cursor is on the year, change the year. If it is on the month, the day or the time, change that. If the cursor is on the enclosing bracket, change the timestamp type. With prefix ARG, change by that many units.
org-timestamp-down-day (&optional arg)
- In file: org.el
- Find modifications in git logs
Decrease the date in the time stamp by one day. With prefix ARG, change that many days.
org-timestamp-inactive (&optional arg)
- Access:
C-c ! - In file: org.el
- Find modifications in git logs
Insert an inactive time stamp. An inactive time stamp is enclosed in square brackets instead of angle brackets. It is inactive in the sense that it does not trigger agenda entries. So these are more for recording a certain time/date. If the user specifies a time like HH:MM or if this command is called with at least one prefix argument, the time stamp contains the date and the time. Otherwise, only the date is included. When called with two universal prefix arguments, insert an inactive time stamp with the current time without prompting the user.
org-timestamp-up (&optional arg)
- In file: org.el
- Find modifications in git logs
Increase the date item at the cursor by one. If the cursor is on the year, change the year. If it is on the month, the day or the time, change that. If the cursor is on the enclosing bracket, change the timestamp type. With prefix ARG, change by that many units.
org-timestamp-up-day (&optional arg)
- In file: org.el
- Find modifications in git logs
Increase the date in the time stamp by one day. With prefix ARG, change that many days.
org-todo (&optional arg)
- Access:
C-c C-t - In file: org.el
- Find modifications in git logs
Change the TODO state of an item.
The state of an item is given by a keyword at the start of the heading,
like
*** TODO Write paper
*** DONE Call mom
The different keywords are specified in the variable ‘org-todo-keywords’.
By default the available states are "TODO" and "DONE". So, for this
example: when the item starts with TODO, it is changed to DONE.
When it starts with DONE, the DONE is removed. And when neither TODO nor
DONE are present, add TODO at the beginning of the heading.
You can set up single-character keys to fast-select the new state. See the
‘org-todo-keywords’ and ‘org-use-fast-todo-selection’ for details.
With ‘C-u’ prefix ARG, force logging the state change and take a
logging note.
With a ‘C-u C-u’ prefix, switch to the next set of TODO keywords (nextset).
Another way to achieve this is ‘S-C-<right>’.
With a ‘C-u C-u C-u’ prefix, circumvent any state blocking.
With numeric prefix arg, switch to the Nth state.
With a numeric prefix arg of 0, inhibit note taking for the change.
With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
When called through Elisp, arg is also interpreted in the following way:
‘none’ -> empty state
"" -> switch to empty state
‘done’ -> switch to DONE
‘nextset’ -> switch to the next set of keywords
‘previousset’ -> switch to the previous set of keywords
"WAITING" -> switch to the specified keyword, but only if it
really is a member of ‘org-todo-keywords’.
org-todo-list (&optional arg)
Show all (not done) TODO entries from all agenda files in a single list. The prefix arg can be used to select a specific TODO keyword and limit the list to these. When using ‘C-u’, you will be prompted for a keyword. A numeric prefix directly selects the Nth keyword in ‘org-todo-keywords-1’.
org-todo-yesterday (&optional arg)
- In file: org.el
- Find modifications in git logs
Like ‘org-todo’ but the time of change will be 23:59 of yesterday.
org-toggle-archive-tag (&optional find-done)
- Access:
C-c C-x a - In file: org-archive.el
- Find modifications in git logs
Toggle the archive tag for the current headline. With prefix argument FIND-DONE, check all children of current headline and offer tagging the children that do not contain any open TODO items.
org-toggle-checkbox (&optional toggle-presence)
- Access:
C-c C-x C-b - In file: org-list.el
- Find modifications in git logs
Toggle the checkbox in the current line. With prefix argument TOGGLE-PRESENCE, add or remove checkboxes. With a double prefix argument, set the checkbox to "[-]". When there is an active region, toggle status or presence of the first checkbox there, and make every item inside have the same status or presence, respectively. If point is on a headline, apply this to all checkbox items in the text below the heading, taking as reference the first item in subtree, ignoring planning line and any drawer following it.
org-toggle-comment
- Access:
C-c ; - In file: org.el
- Find modifications in git logs
Change the COMMENT state of an entry.
org-toggle-custom-properties-visibility
- In file: org.el
- Find modifications in git logs
Display or hide properties in ‘org-custom-properties’.
org-toggle-fixed-width
- Access:
C-c : - In file: org.el
- Find modifications in git logs
Toggle fixed-width markup. Add or remove fixed-width markup on current line, whenever it makes sense. Return an error otherwise. If a region is active and if it contains only fixed-width areas or blank lines, remove all fixed-width markup in it. If the region contains anything else, convert all non-fixed-width lines to fixed-width ones. Blank lines at the end of the region are ignored unless the region only contains such lines.
org-toggle-heading (&optional nstars)
- In file: org.el
- Find modifications in git logs
Convert headings to normal text, or items or text to headings. If there is no active region, only convert the current line. With a ‘C-u’ prefix, convert the whole list at point into heading. In a region: - If the first non blank line is a headline, remove the stars from all headlines in the region. - If it is a normal line, turn each and every normal line (i.e., not an heading or an item) in the region into headings. If you want to convert only the first line of this region, use one universal prefix argument. - If it is a plain list item, turn all plain list items into headings. The checkboxes are converted to appropriate TODO or DONE keywords (using ‘car’ or ‘org-done-keywords’ and ‘org-not-done-keywords’ when available). When converting a line into a heading, the number of stars is chosen such that the lines become children of the current entry. However, when a numeric prefix argument is given, its value determines the number of stars to add.
org-toggle-inline-images (&optional include-linked beg end)
Toggle the display of inline images. INCLUDE-LINKED is passed to ‘org-display-inline-images’.
org-toggle-item (arg)
Convert headings or normal lines to items, items to normal lines. If there is no active region, only the current line is considered. If the first non blank line in the region is a headline, convert all headlines to items, shifting text accordingly. If it is an item, convert all items to normal lines. If it is normal text, change region into a list of items. With a prefix argument ARG, change the region in a single item.
org-toggle-latex-fragment (&optional arg)
Toggle preview of the LaTeX fragment at point. If the cursor is on a LaTeX fragment, create the image and overlay it over the source code, if there is none. Remove it otherwise. If there is no fragment at point, display images for all fragments in the current section. With an active region, display images for all fragments in the region. With a ‘C-u’ prefix argument ARG, clear images for all fragments in the current section. With a ‘C-u C-u’ prefix argument ARG, display image for all fragments in the buffer. With a ‘C-u C-u C-u’ prefix argument ARG, clear image for all fragments in the buffer.
org-toggle-link-display
- In file: ol.el
- Find modifications in git logs
Toggle the literal or descriptive display of links in current buffer.
org-toggle-narrow-to-subtree
- In file: org.el
- Find modifications in git logs
Narrow to the subtree at point or widen a narrowed buffer. Use the command ‘C-x n w’ to see the whole buffer again.
org-toggle-ordered-property
- Access:
C-c C-x o - In file: org.el
- Find modifications in git logs
Toggle the ORDERED property of the current entry. For better visibility, you can track the value of this property with a tag. See variable ‘org-track-ordered-property-with-tag’.
org-toggle-pretty-entities
- Access:
C-c C-x \ - In file: org.el
- Find modifications in git logs
Toggle the composition display of entities as UTF8 characters.
org-toggle-sticky-agenda (&optional arg)
Toggle ‘org-agenda-sticky’.
org-toggle-time-stamp-overlays
- In file: org.el
- Find modifications in git logs
Toggle the use of custom time stamp formats.
org-toggle-timestamp-overlays
- Access:
C-c C-x C-t - In file: org.el
- Find modifications in git logs
Toggle the use of custom time stamp formats.
org-toggle-timestamp-type
- In file: org.el
- Find modifications in git logs
Toggle the type (<active> or [inactive]) of a time stamp.
org-transpose-element
- Access:
C-M-t - In file: org.el
- Find modifications in git logs
Transpose current and previous elements, keeping blank lines between. Point is moved after both elements.
org-transpose-words
- In file: org.el
- Find modifications in git logs
Transpose words for Org. This uses the ‘org-mode-transpose-word-syntax-table’ syntax table, which interprets characters in ‘org-emphasis-alist’ as word constituents.
org-tree-to-indirect-buffer (&optional arg)
- Access:
C-c C-x b - In file: org.el
- Find modifications in git logs
Create indirect buffer and narrow it to current subtree. With a numerical prefix ARG, go up to this level and then take that tree. If ARG is negative, go up that many levels. If ‘org-indirect-buffer-display’ is not ‘new-frame’, the command removes the indirect buffer previously made with this command, to avoid proliferation of indirect buffers. However, when you call the command with a ‘C-u’ prefix, or when ‘org-indirect-buffer-display’ is ‘new-frame’, the last buffer is kept so that you can work with several indirect buffers at the same time. If ‘org-indirect-buffer-display’ is ‘dedicated-frame’, the ‘C-u’ prefix also requests that a new frame be made for the new buffer, so that the dedicated frame is not changed.
org-unescape-code-in-region (beg end)
- In file: org-src.el
- Find modifications in git logs
Un-escape lines between BEG and END. Un-escaping happens by removing the first comma on lines starting with ",*", ",#+", ",,*" and ",,#+".
org-unindent-buffer
- In file: org.el
- Find modifications in git logs
Un-indent the visible part of the buffer. Relative indentation (between items, inside blocks, etc.) isn’t modified.
org-up-element
- Access:
C-c C-^ - In file: org.el
- Find modifications in git logs
Move to upper element.
org-up-heading (arg &optional invisible-ok)
- Access:
C-c C-u - In file: org-keys.el
- Find modifications in git logs
Move to the visible heading line of which the present line is a subheading. With argument, move up ARG levels. If INVISIBLE-OK is non-nil, also consider invisible lines. (fn ARG &optional INVISIBLE-OK)
org-update-all-dblocks
- In file: org.el
- Find modifications in git logs
Update all dynamic blocks in the buffer. This function can be used in a hook.
org-update-checkbox-count (&optional all)
Update the checkbox statistics in the current section. This will find all statistic cookies like [57%] and [6/12] and update them with the current numbers. With optional prefix argument ALL, do this for the whole buffer. When ALL is symbol ‘narrow’, update statistics only in the accessible portion of the buffer.
org-update-dblock
- In file: org.el
- Find modifications in git logs
Update the dynamic block at point. This means to empty the block, parse for parameters and then call the correct writing function.
org-update-radio-target-regexp
- In file: ol.el
- Find modifications in git logs
Find all radio targets in this file and update the regular expression. Also refresh fontification if needed.
org-version (&optional here full message)
- In file: org.el
- Find modifications in git logs
Show the Org version. Interactively, or when MESSAGE is non-nil, show it in echo area. With prefix argument, or when HERE is non-nil, insert it at point. In non-interactive uses, a reduced version string is output unless FULL is given.
org-w3m-copy-for-org-mode
- In file: ol-w3m.el
- Find modifications in git logs
Copy current buffer content or active region with Org style links. This will encode ‘link-title’ and ‘link-location’ with ‘org-link-make-string’, and insert the transformed test into the kill ring, so that it can be yanked into an Org buffer with links working correctly.
org-yank (&optional arg)
- In file: org.el
- Find modifications in git logs
Yank. If the kill is a subtree, treat it specially.
This command will look at the current kill and check if is a single
subtree, or a series of subtrees[1]. If it passes the test, and if the
cursor is at the beginning of a line or after the stars of a currently
empty headline, then the yank is handled specially. How exactly depends
on the value of the following variables.
‘org-yank-folded-subtrees’
By default, this variable is non-nil, which results in
subtree(s) being folded after insertion, except if doing so
would swallow text after the yanked text.
‘org-yank-adjusted-subtrees’
When non-nil (the default value is nil), the subtree will be
promoted or demoted in order to fit into the local outline tree
structure, which means that the level will be adjusted so that it
becomes the smaller one of the two *visible* surrounding headings.
Any prefix to this command will cause ‘yank’ to be called directly with
no special treatment. In particular, a simple ‘C-u’ prefix will just
plainly yank the text as it is.
[1] The test checks if the first non-white line is a heading
and if there are no other headings with fewer stars.
orgtbl-ascii-plot (&optional ask)
- Access:
C-c " a - In file: org-table.el
- Find modifications in git logs
Draw an ASCII bar plot in a column. With cursor in a column containing numerical values, this function will draw a plot in a new column. ASK, if given, is a numeric prefix to override the default 12 characters width of the plot. ASK may also be the ‘C-u’ prefix, which will prompt for the width.
orgtbl-create-or-convert-from-region (_arg)
Create table or convert region to table, if no conflicting binding. This installs the table binding ‘C-c |’, but only if there is no conflicting binding to this key outside ‘orgtbl-mode’.
orgtbl-ctrl-c-ctrl-c (arg)
If the cursor is inside a table, realign the table. If it is a table to be sent away to a receiver, do it. With prefix arg, also recompute table.
orgtbl-error
Error when there is no default binding for a table key.
orgtbl-hijacker-command-1 (arg)
In tables, run ‘org-table-delete-column’. Outside of tables, run the binding of ‘M-S-<left>’.
orgtbl-hijacker-command-10 (arg)
In tables, run ‘org-table-copy-region’. Outside of tables, run the binding of ‘C-c M-w’.
orgtbl-hijacker-command-100 (arg)
- Access:
<return> - In file: org-table.el
- Find modifications in git logs
In tables, run ‘orgtbl-ret’. Outside of tables, run the binding of ‘<return>’ or ‘RET’.
orgtbl-hijacker-command-101 (arg)
In tables, run ‘orgtbl-ret’. Outside of tables, run the binding of ‘RET’ or ‘<return>’.
orgtbl-hijacker-command-102 (arg)
In tables, run ‘orgtbl-tab’. Outside of tables, run the binding of ‘<tab>’ or ‘TAB’.
orgtbl-hijacker-command-103 (arg)
In tables, run ‘orgtbl-tab’. Outside of tables, run the binding of ‘TAB’ or ‘<tab>’.
orgtbl-hijacker-command-104 (arg)
- Access:
S-<tab> - In file: org-table.el
- Find modifications in git logs
In tables, run ‘org-table-previous-field’. Outside of tables, run the binding of ‘S-<tab>’ or ‘<tab>’ or ‘TAB’.
orgtbl-hijacker-command-105 (arg)
In tables, run ‘org-table-wrap-region’. Outside of tables, run the binding of ‘M-RET’ or ‘M-<return>’.
orgtbl-hijacker-command-106 (arg)
- Access:
M-<return> - In file: org-table.el
- Find modifications in git logs
In tables, run ‘org-table-wrap-region’. Outside of tables, run the binding of ‘M-<return>’ or ‘M-RET’.
orgtbl-hijacker-command-107 (arg)
- Access:
S-<iso-lefttab> - In file: org-table.el
- Find modifications in git logs
In tables, run ‘org-table-previous-field’. Outside of tables, run the binding of ‘S-<iso-lefttab>’ or ‘<backtab>’ or ‘S-<tab>’ or ‘<tab>’ or ‘TAB’.
orgtbl-hijacker-command-108 (arg)
In tables, run ‘org-table-previous-field’. Outside of tables, run the binding of ‘<backtab>’ or ‘S-<iso-lefttab>’ or ‘S-<tab>’ or ‘<tab>’ or ‘TAB’.
orgtbl-hijacker-command-109 (arg)
In tables, run ‘org-delete-backward-char’. Outside of tables, run the binding of ‘<backspace>’ or ‘DEL’.
orgtbl-hijacker-command-11 (arg)
In tables, run ‘org-table-paste-rectangle’. Outside of tables, run the binding of ‘C-c C-y’.
orgtbl-hijacker-command-12 (arg)
In tables, run ‘org-table-wrap-region’. Outside of tables, run the binding of ‘C-c C-w’.
orgtbl-hijacker-command-13 (arg)
In tables, run ‘org-table-insert-hline’. Outside of tables, run the binding of ‘C-c -’.
orgtbl-hijacker-command-14 (arg)
In tables, run ‘org-table-toggle-coordinate-overlays’. Outside of tables, run the binding of ‘C-c }’.
orgtbl-hijacker-command-15 (arg)
In tables, run ‘org-table-toggle-formula-debugger’.
Outside of tables, run the binding of ‘C-c {’.
orgtbl-hijacker-command-16 (arg)
In tables, run ‘org-table-next-row’. Outside of tables, run the binding of ‘RET’.
orgtbl-hijacker-command-17 (arg)
In tables, run ‘org-table-copy-down’. Outside of tables, run the binding of ‘S-<return>’.
orgtbl-hijacker-command-18 (arg)
In tables, run ‘org-table-field-info’. Outside of tables, run the binding of ‘C-c ?’.
orgtbl-hijacker-command-19 (arg)
In tables, run ‘org-table-blank-field’. Outside of tables, run the binding of ‘C-c SPC’.
orgtbl-hijacker-command-2 (arg)
In tables, run ‘org-table-move-column-left’. Outside of tables, run the binding of ‘M-<left>’.
orgtbl-hijacker-command-20 (arg)
In tables, run ‘org-table-sum’. Outside of tables, run the binding of ‘C-c +’.
orgtbl-hijacker-command-21 (arg)
In tables, run ‘org-table-eval-formula’. Outside of tables, run the binding of ‘C-c =’.
orgtbl-hijacker-command-22 (arg)
In tables, run ‘org-table-edit-formulas’. Outside of tables, run the binding of ‘C-c ’’.
orgtbl-hijacker-command-23 (arg)
In tables, run ‘org-table-edit-field’. Outside of tables, run the binding of ‘C-c ‘’.
orgtbl-hijacker-command-24 (arg)
In tables, run ‘org-table-recalculate’. Outside of tables, run the binding of ‘C-c *’.
orgtbl-hijacker-command-25 (arg)
In tables, run ‘org-table-sort-lines’. Outside of tables, run the binding of ‘C-c ^’.
orgtbl-hijacker-command-26 (arg)
- Access:
M-a - In file: org-table.el
- Find modifications in git logs
In tables, run ‘org-table-beginning-of-field’. Outside of tables, run the binding of ‘M-a’.
orgtbl-hijacker-command-27 (arg)
In tables, run ‘org-table-end-of-field’. Outside of tables, run the binding of ‘M-e’.
orgtbl-hijacker-command-28 (arg)
In tables, run ‘org-table-rotate-recalc-marks’. Outside of tables, run the binding of ‘C-#’.
orgtbl-hijacker-command-3 (arg)
In tables, run ‘org-table-move-column-right’. Outside of tables, run the binding of ‘M-<right>’.
orgtbl-hijacker-command-4 (arg)
In tables, run ‘org-table-insert-column’. Outside of tables, run the binding of ‘M-S-<right>’.
orgtbl-hijacker-command-5 (arg)
In tables, run ‘org-table-kill-row’. Outside of tables, run the binding of ‘M-S-<up>’.
orgtbl-hijacker-command-6 (arg)
In tables, run ‘org-table-insert-row’. Outside of tables, run the binding of ‘M-S-<down>’.
orgtbl-hijacker-command-7 (arg)
In tables, run ‘org-table-move-row-up’. Outside of tables, run the binding of ‘M-<up>’.
orgtbl-hijacker-command-8 (arg)
In tables, run ‘org-table-move-row-down’. Outside of tables, run the binding of ‘M-<down>’.
orgtbl-hijacker-command-9 (arg)
In tables, run ‘org-table-cut-region’. Outside of tables, run the binding of ‘C-c C-w’.
orgtbl-insert-radio-table
Insert a radio table template appropriate for this major mode.
orgtbl-mode (&optional arg)
The Org mode table editor as a minor mode for use in other modes.
This is a minor mode. If called interactively, toggle the ‘OrgTbl mode’
mode. If the prefix argument is positive, enable the mode, and if it is
zero or negative, disable the mode.
If called from Lisp, toggle the mode if ARG is ‘toggle’. Enable the
mode if ARG is nil, omitted, or is a positive number. Disable the mode
if ARG is a negative number.
To check whether the minor mode is enabled in the current buffer,
evaluate the variable ‘orgtbl-mode’.
The mode’s hook is called both when the mode is enabled and when it is
disabled.
Key Binding
-------------------------------------------------------------------------------
TAB orgtbl-hijacker-command-103
RET orgtbl-hijacker-command-101
C-# orgtbl-hijacker-command-28
M-S-<down> orgtbl-hijacker-command-6
M-S-<left> orgtbl-hijacker-command-1
M-S-<right> orgtbl-hijacker-command-4
M-S-<up> orgtbl-hijacker-command-5
M-<down> orgtbl-hijacker-command-8
M-<left> orgtbl-hijacker-command-2
M-<return> orgtbl-hijacker-command-106
M-<right> orgtbl-hijacker-command-3
M-<up> orgtbl-hijacker-command-7
S-<iso-lefttab> orgtbl-hijacker-command-107
S-<return> orgtbl-hijacker-command-17
S-<tab> orgtbl-hijacker-command-104
<backspace> orgtbl-hijacker-command-109
<backtab> orgtbl-hijacker-command-108
<return> orgtbl-hijacker-command-100
<tab> orgtbl-hijacker-command-102
C-c C-c orgtbl-ctrl-c-ctrl-c
C-c C-w orgtbl-hijacker-command-12
C-c C-y orgtbl-hijacker-command-11
C-c SPC orgtbl-hijacker-command-19
C-c ' orgtbl-hijacker-command-22
C-c * orgtbl-hijacker-command-24
C-c + orgtbl-hijacker-command-20
C-c - orgtbl-hijacker-command-13
C-c = orgtbl-hijacker-command-21
C-c ? orgtbl-hijacker-command-18
C-c ^ orgtbl-hijacker-command-25
C-c ` orgtbl-hijacker-command-23
C-c { orgtbl-hijacker-command-15
C-c | orgtbl-create-or-convert-from-region
C-c } orgtbl-hijacker-command-14
M-RET orgtbl-hijacker-command-105
M-a orgtbl-hijacker-command-26
M-e orgtbl-hijacker-command-27
C-c M-w orgtbl-hijacker-command-10
orgtbl-ret
Justification and field motion for ‘orgtbl-mode’.
orgtbl-self-insert-command (N)
Like ‘self-insert-command’, use ‘overwrite-mode’ for whitespace in tables. If the cursor is in a table looking at whitespace, the whitespace is overwritten, and the table is not marked as requiring realignment.
orgtbl-send-table (&optional maybe)
Send a transformed version of table at point to the receiver position. With argument MAYBE, fail quietly if no transformation is defined for this table.
orgtbl-tab (arg)
Justification and field motion for ‘orgtbl-mode’.
orgtbl-toggle-comment
Comment or uncomment the orgtbl at point.
Options
org-M-RET-may-split-line (funcall #'#[nil ('((default ....
- Type: (choice (const :tag "Always" t…
- In file: org.el
- Find modifications in git logs
Non-nil means M-RET will split the line at the cursor position.
When nil, it will go to the end of the line before making a
new line.
You may also set this option in a different way for different
contexts. Valid contexts are:
headline when creating a new headline
item when creating a new item
table in a table field
default the value to be used for all contexts not explicitly
customized
org-adapt-indentation (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Adapt ind…
- In file: org.el
- Find modifications in git logs
Non-nil means adapt indentation to outline node level. When set to t, Org assumes that you write outlines by indenting text in each node to align with the headline, after the stars. When this variable is set to `headline-data', Org only adapts the indentation of the data lines right below the headline, such as planning/clock lines and property/logbook drawers. The following issues are influenced by this variable: - The indentation is increased by one space in a demotion command, and decreased by one in a promotion command. However, in the latter case, if shifting some line in the entry body would alter document structure (e.g., insert a new headline), indentation is not changed at all. - Property drawers and planning information is inserted indented when this variable is set. When nil, they will not be indented. - TAB indents a line relative to current level. The lines below a headline will be indented when this variable is set to t. Note that this is all about true indentation, by adding and removing space characters. See also "org-indent.el" which does level-dependent indentation in a virtual way, i.e. at display time in Emacs.
org-agenda-add-entry-text-descriptive-links (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means export org-links as descriptive links in agenda added text. This variable applies to the text added to the agenda when `org-agenda-add-entry-text-maxlines' is larger than 0. When this variable is nil, the URL will (also) be shown.
org-agenda-add-entry-text-maxlines (funcall #'#[nil (0) (original...
- Type: integer
- In file: org-agenda.el
- Find modifications in git logs
Maximum number of entry text lines to be added to agenda. This is only relevant when `org-agenda-add-entry-text' is part of `org-agenda-before-write-hook', which is the default. When this is 0, nothing will happen. When it is greater than 0, it specifies the maximum number of lines that will be added for each entry that is listed in the agenda view. Note that this variable is not used during display, only when exporting the agenda. For agenda display, see the variables `org-agenda-entry-text-mode' and `org-agenda-entry-text-maxlines'.
org-agenda-auto-exclude-function (funcall #'#[nil (nil) (origin...
- Type: (choice (const nil) (function)…
- In file: org-agenda.el
- Find modifications in git logs
A function called with a tag to decide if it is filtered on \<org-agenda-mode-map>`\[org-agenda-filter-by-tag] RET'. The sole argument to the function, which is called once for each possible tag, is a string giving the name of the tag. The function should return either nil if the tag should be included as normal, "-<TAG>" to exclude the tag, or "+<TAG>" to exclude lines not carrying this tag. Note that for the purpose of tag filtering, only the lower-case version of all tags will be considered, so that this function will only ever see the lower-case version of all tags.
org-agenda-block-separator (funcall #'#[nil ((if (and (di...
- Type: (choice (const :tag "Disabled"…
- In file: org-agenda.el
- Find modifications in git logs
The separator between blocks in the agenda. If this is a string, it will be used as the separator, with a newline added. If it is a character, it will be repeated to fill the window width. If nil the separator is disabled. In `org-agenda-custom-commands' this addresses the separator between the current and the previous block.
org-agenda-bulk-mark-char (funcall #'#[nil (">") (org-ag...
- Type: string
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
A single-character string to be used as the bulk mark.
org-agenda-category-icon-alist (funcall #'#[nil (nil) (origin...
- Type: (alist :key-type (regexp :tag …
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Alist of category icon to be displayed in agenda views.
The icons are displayed in place of the %i placeholders in
`org-agenda-prefix-format', which see.
Each entry should have the following format:
(CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
Where CATEGORY-REGEXP is a regexp matching the categories where
the icon should be displayed.
FILE-OR-DATA either a file path or a string containing image data.
The other fields can be omitted safely if not needed:
TYPE indicates the image type.
DATA-P is a boolean indicating whether the FILE-OR-DATA string is
image data.
PROPS are additional image attributes to assign to the image,
like, e.g. `:ascent center'.
("Org" "/path/to/icon.png" nil nil :ascent center)
If you want to set the display properties yourself, just put a
list as second element:
(CATEGORY-REGEXP (MY PROPERTY LIST))
For example, to display a 16px horizontal space for Emacs
category, you can use:
("Emacs" \='(space . (:width (16))))
org-agenda-clock-consistency-checks (funcall #'#[nil ('(:max-durat...
- Type: plist
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
This is a property list, with the following keys:
:max-duration Mark clocking chunks that are longer than this time.
This is a time string like "HH:MM", or the number
of minutes as an integer.
:min-duration Mark clocking chunks that are shorter that this.
This is a time string like "HH:MM", or the number
of minutes as an integer.
:max-gap Mark gaps between clocking chunks that are longer than
this duration. A number of minutes, or a string
like "HH:MM".
:gap-ok-around List of times during the day which are usually not working
times. When a gap is detected, but the gap contains any
of these times, the gap is *not* reported. For example,
if this is ("4:00" "13:00") then gaps that contain
4:00 in the morning (i.e. the night) and 13:00
(i.e. a typical lunch time) do not cause a warning.
You should have at least one time during the night in this
list, or otherwise the first task each morning will trigger
a warning because it follows a long gap.
Furthermore, the following properties can be used to define faces for
issue display.
:default-face the default face, if the specific face is undefined
:overlap-face face for overlapping clocks
:gap-face face for gaps between clocks
:no-end-time-face face for incomplete clocks
:long-face face for clock intervals that are too long
:short-face face for clock intervals that are too short
org-agenda-clock-report-header (funcall #'#[nil (nil) (origin...
- Type: (choice (string :tag "Header")…
- In file: org-agenda.el
- Find modifications in git logs
Header inserted before the table in Org agenda clock report mode. See Info node `(org) Agenda Commands' for more details.
org-agenda-clockreport-parameter-plist (funcall #'#[nil ('(:link t :m...
- Type: plist
- In file: org-agenda.el
- Find modifications in git logs
Property list with parameters for the clocktable in clockreport mode. This is the display mode that shows a clock table in the daily/weekly agenda, the properties for this dynamic block can be set here. The usual clocktable parameters are allowed here, but you cannot set the properties :name, :tstart, :tend, :block, and :scope - these will be overwritten to make sure the content accurately reflects the current display in the agenda.
org-agenda-cmp-user-defined (funcall #'#[nil (nil) (origin...
- Type: symbol
- In file: org-agenda.el
- Find modifications in git logs
A function to define the comparison `user-defined'. This function must receive two arguments, agenda entry a and b. If a>b, return +1. If a<b, return -1. If they are equal as seen by the user comparison, return nil. When this is defined, you can make `user-defined-up' and `user-defined-down' part of an agenda sorting strategy.
org-agenda-columns-add-appointments-to-effort-sum (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means the duration of an appointment will add to day effort. The property to which appointment durations will be added is the one given in the option `org-effort-property'. If an appointment does not have an end time, `org-agenda-default-appointment-duration' will be used. If that is not set, an appointment without end time will not contribute to the time estimate.
org-agenda-columns-compute-summary-properties (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means recompute all summary properties before column view. When column view in the agenda is listing properties that have a summary operator, it can go to all relevant buffers and recompute the summaries there. This can mean overhead for the agenda column view, but is necessary to have thing up to date. As a special case, a CLOCKSUM property also makes sure that the clock computations are current.
org-agenda-columns-show-summaries (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means show summaries for columns displayed in the agenda view.
org-agenda-compact-blocks (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means make the block agenda more compact. This is done globally by leaving out lines like the agenda span name and week number or the separator lines.
org-agenda-confirm-kill (funcall #'#[nil (1) (original...
- Type: (choice (const :tag "Never" ni…
- In file: org-agenda.el
- Find modifications in git logs
When set, remote killing from the agenda buffer needs confirmation. When t, a confirmation is always needed. When a number N, confirmation is only needed when the text to be killed contains more than N non-white lines.
org-agenda-current-time-string (funcall #'#[nil ((if (and (di...
- Type: string
- In file: org-agenda.el
- Find modifications in git logs
The string for the current time marker in the agenda.
org-agenda-custom-commands (funcall #'#[nil ('(("n" "Agen...
- Type: (repeat (choice :value ("x" "D…
- In file: org-agenda.el
- Find modifications in git logs
Custom commands for the agenda.
\<org-mode-map>
These commands will be offered on the splash screen displayed by the
agenda dispatcher `\[org-agenda]'. Each entry is a list like this:
(key desc type match settings files)
key The key (one or more characters as a string) to be associated
with the command.
desc A description of the command. When omitted or nil, a default
description is built using MATCH.
type The command type, any of the following symbols:
agenda The daily/weekly agenda.
agenda* Appointments for current week/day.
todo Entries with a specific TODO keyword, in all agenda files.
search Entries containing search words entry or headline.
tags Tags/Property/TODO match in all agenda files.
tags-todo Tags/P/T match in all agenda files, TODO entries only.
todo-tree Sparse tree of specific TODO keyword in *current* file.
tags-tree Sparse tree with all tags matches in *current* file.
occur-tree Occur sparse tree for *current* file.
alltodo The global TODO list.
stuck Stuck projects.
... A user-defined function.
match What to search for:
- a single keyword for TODO keyword searches
- a tags/property/todo match expression for searches
- a word search expression for text searches.
- a regular expression for occur searches
For all other commands, this should be the empty string.
settings A list of option settings, similar to that in a let form, so like
this: ((opt1 val1) (opt2 val2) ...). The values will be
evaluated at the moment of execution, so quote them when needed.
files A list of files to write the produced agenda buffer to with
the command `org-store-agenda-views'.
If a file name ends in ".html", an HTML version of the buffer
is written out. If it ends in ".ps", a PostScript version is
produced. Otherwise, only the plain text is written to the file.
You can also define a set of commands, to create a composite agenda buffer.
In this case, an entry looks like this:
(key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
where
desc A description string to be displayed in the dispatcher menu.
cmd An agenda command, similar to the above. However, tree commands
are not allowed. Valid commands for a set are:
(agenda "" settings)
(agenda* "" settings)
(alltodo "" settings)
(stuck "" settings)
(todo "match" settings files)
(search "match" settings files)
(tags "match" settings files)
(tags-todo "match" settings files)
Each command can carry a list of options, and another set of options can be
given for the whole set of commands. Individual command options take
precedence over the general options.
When using several characters as key to a command, the first characters
are prefix commands. For the dispatcher to display useful information, you
should provide a description for the prefix, like
(setq org-agenda-custom-commands
\='(("h" . "HOME + Name tag searches") ; describe prefix "h"
("hl" tags "+HOME+Lisa")
("hp" tags "+HOME+Peter")
("hk" tags "+HOME+Kim")))
See also Info node `(org) Custom Agenda Views'.
org-agenda-custom-commands-contexts (funcall #'#[nil (nil) (org-ag...
- Type: (repeat (list :tag "Rule" (str…
- Since: Emacs version 24.3
- In file: org-agenda.el
- Find modifications in git logs
Alist of custom agenda keys and contextual rules.
For example, if you have a custom agenda command "p" and you
want this command to be accessible only from plain text files,
use this:
(setq org-agenda-custom-commands-contexts
\='(("p" ((in-file . "\\.txt\\'")))))
Here are the available contexts definitions:
in-file: command displayed only in matching files
in-mode: command displayed only in matching modes
not-in-file: command not displayed in matching files
not-in-mode: command not displayed in matching modes
in-buffer: command displayed only in matching buffers
not-in-buffer: command not displayed in matching buffers
[function]: a custom function taking no argument
If you define several checks, the agenda command will be
accessible if there is at least one valid check.
You can also bind a key to another agenda custom command
depending on contextual rules.
(setq org-agenda-custom-commands-contexts
\='(("p" "q" ((in-file . "\\.txt\\'")))))
Here it means: in .txt files, use "p" as the key for the
agenda command otherwise associated with "q". (The command
originally associated with "q" is not displayed to avoid
duplicates.)
org-agenda-day-face-function (funcall #'#[nil (nil) (origin...
- Type: (choice (const nil) (function)…
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Function called to determine what face should be used to display a day. The only argument passed to that function is the day. It should returns a face, or nil if does not want to specify a face and let the normal rules apply.
org-agenda-deadline-faces (funcall #'#[nil ('((1.0 . org...
- Type: (repeat (cons (number :tag "Fr…
- In file: org-faces.el
- Find modifications in git logs
Faces for showing deadlines in the agenda. This is a list of cons cells. The cdr of each cell is a face to be used, and it can also just be like (:foreground "yellow"). Each car is a fraction of the head-warning time that must have passed for this the face in the cdr to be used for display. The numbers must be given in descending order. The head-warning time is normally taken from `org-deadline-warning-days', but can also be specified in the deadline timestamp itself, like this: DEADLINE: <2007-08-13 Mon -8d> You may use d for days, w for weeks, m for months and y for years. Months and years will only be treated in an approximate fashion (30.4 days for a month and 365.24 days for a year).
org-agenda-deadline-leaders (funcall #'#[nil ('("Deadline:...
- Type: (list (string :tag "Deadline t…
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Text preceding deadline items in the agenda view. This is a list with three strings. The first applies when the item has its deadline on the current day. The second applies when the deadline is in the future, the third one when it is in the past. The strings may contain %d to capture the number of days.
org-agenda-default-appointment-duration (funcall #'#[nil (nil) (origin...
- Type: (choice (integer :tag "Minutes…
- In file: org-agenda.el
- Find modifications in git logs
Default duration for appointments that only have a starting time. When nil, no duration is specified in such cases. When non-nil, this must be the number of minutes, e.g. 60 for one hour.
org-agenda-diary-file (funcall #'#[nil ('diary-file)...
- Type: (choice (const :tag "The stand…
- In file: org-agenda.el
- Find modifications in git logs
File to which to add new entries with the `i' key in agenda and calendar. When this is the symbol `diary-file', the functionality in the Emacs calendar will be used to add entries to the `diary-file'. But when this points to a file, `org-agenda-diary-entry' will be used instead.
org-agenda-diary-sexp-prefix (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "None" nil…
- In file: org-agenda.el
- Find modifications in git logs
A regexp that matches part of a diary sexp entry which should be treated as scheduling/deadline information in `org-agenda'. For example, you can use this to extract the `diary-remind-message' from `diary-remind' entries.
org-agenda-entry-text-exclude-regexps (funcall #'#[nil (nil) (origin...
- Type: (repeat (regexp))
- In file: org-agenda.el
- Find modifications in git logs
List of regular expressions to clean up entry text. The complete matches of all regular expressions in this list will be removed from entry text before it is shown in the agenda.
org-agenda-entry-text-leaders (funcall #'#[nil (" > ") (o...
- Type: string
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Text prepended to the entry text in agenda buffers.
org-agenda-entry-text-maxlines (funcall #'#[nil (5) (original...
- Type: integer
- In file: org-agenda.el
- Find modifications in git logs
Number of text lines to be added when `E' is pressed in the agenda. Note that this variable only used during agenda display. To add entry text when exporting the agenda, configure the variable `org-agenda-add-entry-text-maxlines'.
org-agenda-export-html-style (funcall #'#[nil (nil) (origin...
- Type: (choice (const nil) (string))
- In file: org-agenda.el
- Find modifications in git logs
The style specification for exported HTML Agenda files.
If this variable contains a string, it will replace the default <style>
section as produced by `htmlize'.
Since there are different ways of setting style information, this variable
needs to contain the full HTML structure to provide a style, including the
surrounding HTML tags. The style specifications should include definitions
the fonts used by the agenda, here is an example:
<style type="text/css">
p { font-weight: normal; color: gray; }
.org-agenda-structure {
font-size: 110%;
color: #003399;
font-weight: 600;
}
.org-todo {
color: #cc6666;
font-weight: bold;
}
.org-agenda-done {
color: #339933;
}
.org-done {
color: #339933;
}
.title { text-align: center; }
.todo, .deadline { color: red; }
.done { color: green; }
</style>
or, if you want to keep the style in a file,
<link rel="stylesheet" type="text/css" href="mystyles.css">
As the value of this option simply gets inserted into the HTML <head> header,
you can "misuse" it to also add other text to the header.
org-agenda-exporter-settings (funcall #'#[nil (nil) (origin...
- Type: (repeat (list (variable) (sexp…
- In file: org-agenda.el
- Find modifications in git logs
Alist of variable/value pairs that should be active during agenda export.
This is a good place to set options for ps-print and for htmlize.
Note that the way this is implemented, the values will be evaluated
before assigned to the variables. So make sure to quote values you do
*not* want evaluated, for example
(setq org-agenda-exporter-settings
\='((ps-print-color-p \='black-white)))
org-agenda-file-regexp (funcall #'#[nil ("\\`[^.].*\\...
- Type: regexp
- In file: org.el
- Find modifications in git logs
Regular expression to match files for `org-agenda-files'. If any element in the list in that variable contains a directory instead of a normal file, all files in that directory that are matched by this regular expression will be included.
org-agenda-files (funcall #'#[nil (nil) (crm-se...
- Type: (choice (repeat :tag "List of …
- In file: org.el
- Find modifications in git logs
The files to be used for agenda display. If an entry is a directory, all files in that directory that are matched by `org-agenda-file-regexp' will be part of the file list. If the value of the variable is not a list but a single file name, then the list of agenda files is actually stored and maintained in that file, one agenda file per line. In this file paths can be given relative to `org-directory'. Tilde expansion and environment variable substitution are also made. Entries may be added to this list with `\[org-agenda-file-to-front]' and removed with `\[org-remove-file]'.
org-agenda-follow-indirect (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means `org-agenda-follow-mode' displays only the current item's tree, in an indirect buffer.
org-agenda-format-date (funcall #'#[nil ('org-agenda-...
- Type: (choice (string :tag "Format s…
- In file: org-agenda.el
- Find modifications in git logs
Format string for displaying dates in the agenda. Used by the daily/weekly agenda. This should be a format string understood by `format-time-string', or a function returning the formatted date as a string. The function must take a single argument, a calendar-style date list like (month day year).
org-agenda-ignore-properties (funcall #'#[nil (nil) (org-wi...
- Type: (set :greedy t (const stats))
- In file: org.el
- Find modifications in git logs
Avoid updating text properties when building the agenda. Properties are used to prepare buffers for effort estimates, appointments, statistics and subtree-local categories. If you don't use these in the agenda, you can add them to this list and agenda building will be a bit faster. The value is a list, with symbol `stats'.
org-agenda-inactive-leader (funcall #'#[nil ("[") (origin...
- Type: string
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Text preceding item pulled into the agenda by inactive time stamps. These entries are added to the agenda when pressing "[".
org-agenda-include-deadlines (funcall #'#[nil (t) (original...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
If non-nil, include entries within their deadline warning period. Custom commands can set this variable in the options section.
org-agenda-include-diary (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
If non-nil, include in the agenda entries from the Emacs Calendar's diary. Custom commands can set this variable in the options section.
org-agenda-inhibit-startup (funcall #'#[nil (nil) (org-wi...
- Type: boolean
- Since: Emacs version 24.3
- In file: org.el
- Find modifications in git logs
Inhibit startup when preparing agenda buffers. When this variable is t, the initialization of the Org agenda buffers is inhibited: e.g. the visibility state is not set, the tables are not re-aligned, etc.
org-agenda-insert-diary-extract-time (funcall #'#[nil (nil) (org-ag...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means extract any time specification from the diary entry.
org-agenda-insert-diary-strategy (funcall #'#[nil ('date-tree) ...
- Type: (choice (const :tag "first in …
- In file: org-agenda.el
- Find modifications in git logs
Where in `org-agenda-diary-file' should new entries be added? Valid values: date-tree in the date tree, as first child of the date date-tree-last in the date tree, as last child of the date top-level as top-level entries at the end of the file.
org-agenda-jump-prefer-future (funcall #'#[nil ('org-read-da...
- Type: (choice (const :tag "Use org-r…
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Should the agenda jump command prefer the future for incomplete dates? The default is to do the same as configured in `org-read-date-prefer-future'. But you can also set a deviating value here. This may t or nil, or the symbol `org-read-date-prefer-future'.
org-agenda-log-mode-add-notes (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means add first line of notes to log entries in agenda views. If a log item like a state change or a clock entry is associated with notes, the first line of these notes will be added to the entry in the agenda display.
org-agenda-log-mode-items (funcall #'#[nil ('(closed clo...
- Type: (set :greedy t (const closed) …
- In file: org-agenda.el
- Find modifications in git logs
List of items that should be shown in agenda log mode. \<org-agenda-mode-map>This list may contain the following symbols: closed Show entries that have been closed on that day. clock Show entries that have received clocked time on that day. state Show all logged state changes. Note that instead of changing this variable, you can also press `\[universal-argument] \[org-agenda-log-mode]' in the agenda to display all available LOG items temporarily.
org-agenda-loop-over-headlines-in-active-region (funcall #'#[nil (t) (calendar...
- Type: (choice (const :tag "Don't loo…
- Since: Emacs version 27.1
- In file: org-agenda.el
- Find modifications in git logs
Shall some commands act upon headlines in the active region? When set to t, some commands will be performed in all headlines within the active region. When set to `start-level', some commands will be performed in all headlines within the active region, provided that these headlines are of the same level than the first one. When set to a regular expression, those commands will be performed on the matching headlines within the active region. The list of commands is: `org-agenda-schedule', `org-agenda-deadline', `org-agenda-date-prompt', `org-agenda-todo', `org-agenda-archive*', `org-agenda-kill'. See `org-loop-over-headlines-in-active-region' for the equivalent option for Org buffers.
org-agenda-max-effort (funcall #'#[nil (nil) (org-ag...
- Type: (choice (const :tag "No limit"…
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Maximum cumulated effort duration for the agenda. This can be nil (no limit) or a number of minutes (as an integer) or an alist of agenda types with an associated number of minutes to limit entries to in this type.
org-agenda-max-entries (funcall #'#[nil (nil) (org-ag...
- Type: (choice (const :tag "No limit"…
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Maximum number of entries to display in an agenda. This can be nil (no limit) or an integer or an alist of agenda types with an associated number of entries to display in this type.
org-agenda-max-todos (funcall #'#[nil (nil) (org-ag...
- Type: (choice (const :tag "No limit"…
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Maximum number of TODOs to display in an agenda. This can be nil (no limit) or an integer or an alist of agenda types with an associated number of entries to display in this type.
org-agenda-mouse-1-follows-link (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means \`mouse-1' on a link will follow the link in the agenda. A longer mouse click will still set point. Needs to be set before org.el is loaded.
org-agenda-move-date-from-past-immediately-to-today (funcall #'#[nil (t) (original...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means jump to today when moving a past date forward in time. When using S-right in the agenda to move a date forward, and the date stamp currently points to the past, the first key press will move it to today. When nil, just move one day forward even if the date stays in the past.
org-agenda-persistent-filter (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
When set, keep filters from one agenda view to the next.
org-agenda-persistent-marks (funcall #'#[nil (nil) (calend...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means marked items will stay marked after a bulk action. You can toggle this interactively by typing `p' when prompted for a bulk action.
org-agenda-prefer-last-repeat (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Prefer la…
- Since: Emacs version 26.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil sets date for repeated entries to their last repeat. When nil, display SCHEDULED and DEADLINE dates at their base date, and in today's agenda, as a reminder. Display plain timestamps, on the other hand, at every repeat date in the past in addition to the base date. When non-nil, show a repeated entry at its latest repeat date, possibly being today even if it wasn't marked as done. This setting is useful if you do not always mark repeated entries as done and, yet, consider that reaching repeat date starts the task anew. When set to a list of strings, prefer last repeats only for entries with these TODO keywords.
org-agenda-prefix-format (funcall #'#[nil ('((agenda . ...
- Type: (choice (string :tag "General …
- Since: Emacs version 26.1
- In file: org-agenda.el
- Find modifications in git logs
Format specifications for the prefix of items in the agenda views.
An alist with one entry per agenda type. The keys of the
sublists are `agenda', `todo', `search' and `tags'. The values
are format strings.
This format works similar to a `format' string, with the following
meaning:
%c the category of the item, "Diary" for entries from the diary,
or as given by the CATEGORY keyword or derived from the file name
%e the effort required by the item
%l the level of the item (insert X space(s) if item is of level X)
%i the icon category of the item, see `org-agenda-category-icon-alist'
%T the last tag of the item (ignore inherited tags, which come first)
%t the HH:MM time-of-day specification if one applies to the entry
%s Scheduling/Deadline information, a short string
%b show breadcrumbs, i.e., the names of the higher levels
%(expression) Eval `(EXPRESSION)' and replace the control string by
the result.
`(EXPRESSION)' is evaluated with point and buffer associated with
agenda entry/line being rendered. For example, heading lines will be
evaluated with point in the Org buffer at that corresponding heading.
However, diary records will not be evaluated in an Org buffer, but
inside diary buffer. Auxiliary agenda lines like time grids will be
evaluated with the point inside agenda buffer itself.
All specifiers work basically like the standard `%s' of `format', but
may contain two additional characters: a question mark just after the
`%' and a whitespace/punctuation character just before the final letter.
If the first character after `%' is a question mark, the entire field
will only be included if the corresponding value applies to the current
entry. This is useful for fields which should have fixed width when
present, but zero width when absent. For example, "%?-12t" will
result in a 12 character time field if a time of the day is specified,
but will completely disappear in entries which do not contain a time.
If there is punctuation or whitespace character just before the
final format letter, this character will be appended to the field
value if the value is not empty. For example, the format
"%-12:c" leads to "Diary: " if the category is "Diary". If
the category is empty, no additional colon is inserted.
The default value for the agenda sublist is " %-12:c%?-12t% s",
which means:
- Indent the line with two space characters
- Give the category a 12 chars wide field, padded with whitespace on
the right (because of `-'). Append a colon if there is a category
(because of `:').
- If there is a time-of-day, put it into a 12 chars wide field. If no
time, don't put in an empty field, just skip it (because of '?').
- Finally, put the scheduling information.
See also the variables `org-agenda-remove-times-when-in-prefix' and
`org-agenda-remove-tags'.
Custom commands can set this variable in the options section.
org-agenda-query-register (funcall #'#[nil (111) (origin...
- Type: character
- In file: org-agenda.el
- Find modifications in git logs
The register holding the current query string. The purpose of this is that if you construct a query string interactively, you can then use it to define a custom command.
org-agenda-remove-timeranges-from-blocks (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means remove time ranges specifications in agenda items that span on several days.
org-agenda-remove-times-when-in-prefix (funcall #'#[nil (t) (original...
- Type: (choice (const :tag "Always" t…
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means remove duplicate time specifications in agenda items. When the format `org-agenda-prefix-format' contains a `%t' specifier, a time-of-day specification in a headline or diary entry is extracted and placed into the prefix. If this option is non-nil, the original specification (a timestamp or -range, or just a plain time(range) specification like 11:30-4pm) will be removed for agenda display. This makes the agenda less cluttered. The option can be t or nil. It may also be the symbol `beg', indicating that the time should only be removed when it is located at the beginning of the headline/diary entry.
org-agenda-restore-windows-after-quit (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means restore window configuration upon exiting agenda. Before the window configuration is changed for displaying the agenda, the current status is recorded. When the agenda is exited with `q' or `x' and this option is set, the old state is restored. If `org-agenda-window-setup' is `other-frame' or `other-tab', the value of this option will be ignored.
org-agenda-restriction-lock-highlight-subtree (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means highlight the whole subtree when restriction is active. Otherwise only highlight the headline. Highlighting the whole subtree is useful to ensure no edits happen beyond the restricted region.
org-agenda-scheduled-leaders (funcall #'#[nil ('("Scheduled...
- Type: (list (string :tag "Scheduled …
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Text preceding scheduled items in the agenda view. This is a list with two strings. The first applies when the item is scheduled on the current day. The second applies when it has been scheduled previously, it may contain a %d indicating that this is the nth time that this item is scheduled, due to automatic rescheduling of unfinished items for the following day. So this number is one larger than the number of days that passed since this item was scheduled first.
org-agenda-search-headline-for-time (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means search headline for a time-of-day. If the headline contains a time-of-day in one format or another, it will be used to sort the entry into the time sequence of items for a day. Timestamps in the headline will be ignored.
org-agenda-search-view-always-boolean (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means the search string is interpreted as individual parts.
The search string for search view can either be interpreted as a phrase,
or as a list of snippets that define a boolean search for a number of
strings.
When this is non-nil, the string will be split on whitespace, and each
snippet will be searched individually, and all must match in order to
select an entry. A snippet is then a single string of non-white
characters, or a string in double quotes, or a regexp in {} braces.
If a snippet is preceded by "-", the snippet must *not* match.
"+" is syntactic sugar for positive selection. Each snippet may
be found as a full word or a partial word, but see the variable
`org-agenda-search-view-force-full-words'.
When this is nil, search will look for the entire search phrase as one,
with each space character matching any amount of whitespace, including
line breaks.
Even when this is nil, you can still switch to Boolean search dynamically
by preceding the first snippet with "+" or "-". If the first snippet
is a regexp marked with braces like "{abc}", this will also switch to
boolean search.
org-agenda-search-view-force-full-words (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means, search words must be matches as complete words. When nil, they may also match part of a word.
org-agenda-search-view-max-outline-level (funcall #'#[nil (0) (original...
- Type: integer
- Since: Emacs version 26.1
- In file: org-agenda.el
- Find modifications in git logs
Maximum outline level to display in search view. E.g. when this is set to 1, the search view will only show headlines of level 1. When set to 0, the default value, don't limit agenda view by outline level.
org-agenda-show-all-dates (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means `org-agenda' shows every day in the selected range. When nil, only the days which actually have entries are shown.
org-agenda-show-current-time-in-grid (funcall #'#[nil (t) (original...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means show the current time in the time grid.
org-agenda-show-future-repeats (funcall #'#[nil (t) (original...
- Type: (choice (const :tag "Show all …
- In file: org-agenda.el
- Find modifications in git logs
Non-nil shows repeated entries in the future part of the agenda. When set to the symbol `next' only the first future repeat is shown.
org-agenda-show-outline-path (funcall #'#[nil (t) (original...
- Type: (choice (const :tag "Don't sho…
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means show outline path in echo area after line motion. If set to `title', show outline path with prepended document title. Fallback to file name is no title is present.
org-agenda-skip-additional-timestamps-same-entry (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
When nil, multiple same-day timestamps in entry make multiple agenda lines. When non-nil, after the search for timestamps has matched once in an entry, the rest of the entry will not be searched.
org-agenda-skip-archived-trees (funcall #'#[nil (t) (texmathp...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means the agenda will skip any items located in archived trees. An archived tree is a tree marked with the tag ARCHIVE. The use of this variable is no longer recommended, you should leave it at the value t. Instead, use the key `v' to cycle the archives-mode in the agenda.
org-agenda-skip-comment-trees (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means skip trees that start with the COMMENT keyword. When nil, these trees are also scanned by agenda commands.
org-agenda-skip-deadline-if-done (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means don't show deadlines when the corresponding item is done. When nil, the deadline is still shown and should give you a happy feeling. This is relevant for the daily/weekly agenda. It applies only to the actual date of the deadline. Warnings about approaching and past-due deadlines are always turned off when the item is DONE.
org-agenda-skip-deadline-prewarning-if-scheduled (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Always sh…
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means skip deadline prewarning when entry is also scheduled. This will apply on all days where a prewarning for the deadline would be shown, but not at the day when the entry is actually due. On that day, the deadline will be shown anyway. This variable may be set to nil, t, the symbol `pre-scheduled', or a number which will then give the number of days before the actual deadline when the prewarnings should resume. The symbol `pre-scheduled' eliminates the deadline prewarning only prior to the scheduled date. This can be used in a workflow where the first showing of the deadline will trigger you to schedule it, and then you don't want to be reminded of it because you will take care of it on the day when scheduled.
org-agenda-skip-function-global (funcall #'#[nil (nil) (origin...
- Type: sexp
- In file: org-agenda.el
- Find modifications in git logs
Function to be called at each match during agenda construction. If this function returns nil, the current match should not be skipped. If the function decided to skip an agenda match, is must return the buffer position from which the search should be continued. This may also be a Lisp form, which will be evaluated. This variable will be applied to every agenda match, including tags/property searches and TODO lists. So try to make the test function do its checking as efficiently as possible. To implement a skipping condition just for specific agenda commands, use the variable `org-agenda-skip-function' which can be set in the options section of custom agenda commands.
org-agenda-skip-scheduled-delay-if-deadline (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Always ho…
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means skip scheduled delay when entry also has a deadline. This variable may be set to nil, t, the symbol `post-deadline', or a number which will then give the number of days after the actual scheduled date when the delay should expire. The symbol `post-deadline' eliminates the schedule delay when the date is posterior to the deadline.
org-agenda-skip-scheduled-if-deadline-is-shown (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Never" ni…
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means skip scheduling line if same entry shows because of deadline. In the agenda of today, an entry can show up multiple times because it is both scheduled and has a nearby deadline, and maybe a plain time stamp as well. When this variable is nil, the entry will be shown several times. When set to t, then only the deadline is shown and the fact that the entry is scheduled today or was scheduled previously is not shown. When set to the symbol `not-today', skip scheduled previously, but not scheduled today.
org-agenda-skip-scheduled-if-done (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means don't show scheduled items in agenda when they are done. This is relevant for the daily/weekly agenda, not for the TODO list. It applies only to the actual date of the scheduling. Warnings about an item with a past scheduling dates are always turned off when the item is DONE.
org-agenda-skip-scheduled-repeats-after-deadline (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil hides scheduled repeated entries past deadline.
org-agenda-skip-timestamp-if-deadline-is-shown (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Never" ni…
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means skip timestamp line if same entry shows because of deadline. In the agenda of today, an entry can show up multiple times because it has both a plain timestamp and has a nearby deadline. When this variable is t, then only the deadline is shown and the fact that the entry has a timestamp for or including today is not shown. When this variable is nil, the entry will be shown several times.
org-agenda-skip-timestamp-if-done (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means don't select item by timestamp or -range if it is DONE.
org-agenda-sort-noeffort-is-high (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means items without effort estimate are sorted as high effort. This also applies when filtering an agenda view with respect to the < or > effort operator. Then, tasks with no effort defined will be treated as tasks with high effort. When nil, such items are sorted as 0 minutes effort.
org-agenda-sort-notime-is-late (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means items without time are considered late. This is only relevant for sorting. When t, items which have no explicit time like 15:30 will be considered as 99:01, i.e. later than any items which do have a time. When nil, the default time is before 0:00. You can use this option to decide if the schedule for today should come before or after timeless agenda entries.
org-agenda-sorting-strategy (funcall #'#[nil ('((agenda ha...
- Type: (choice (repeat :tag "General"…
- In file: org-agenda.el
- Find modifications in git logs
Sorting structure for the agenda items of a single day.
This is a list of symbols which will be used in sequence to determine
if an entry should be listed before another entry. The following
symbols are recognized:
time-up Put entries with time-of-day indications first, early first.
time-down Put entries with time-of-day indications first, late first.
timestamp-up Sort by any timestamp date, early first.
timestamp-down Sort by any timestamp date, late first.
scheduled-up Sort by scheduled timestamp date, early first.
scheduled-down Sort by scheduled timestamp date, late first.
deadline-up Sort by deadline timestamp date, early first.
deadline-down Sort by deadline timestamp date, late first.
ts-up Sort by active timestamp date, early first.
ts-down Sort by active timestamp date, late first.
tsia-up Sort by inactive timestamp date, early first.
tsia-down Sort by inactive timestamp date, late first.
category-keep Keep the default order of categories, corresponding to the
sequence in `org-agenda-files'.
category-up Sort alphabetically by category, A-Z.
category-down Sort alphabetically by category, Z-A.
tag-up Sort alphabetically by last tag, A-Z.
tag-down Sort alphabetically by last tag, Z-A.
priority-up Sort numerically by priority, high priority last.
priority-down Sort numerically by priority, high priority first.
urgency-up Sort numerically by urgency, high urgency last.
Urgency is calculated based on item's priority,
and proximity to scheduled time and deadline. See
info node `(org)Sorting of agenda items' for
details.
urgency-down Sort numerically by urgency, high urgency first.
todo-state-up Sort by todo state, tasks that are done last.
todo-state-down Sort by todo state, tasks that are done first.
effort-up Sort numerically by estimated effort, high effort last.
effort-down Sort numerically by estimated effort, high effort first.
user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
habit-up Put entries that are habits first.
habit-down Put entries that are habits last.
alpha-up Sort headlines alphabetically.
alpha-down Sort headlines alphabetically, reversed.
The different possibilities will be tried in sequence, and testing stops
if one comparison returns a "not-equal". For example,
(setq org-agenda-sorting-strategy
\='(time-up category-keep priority-down))
means: Pull out all entries having a specified time of day and sort them,
in order to make a time schedule for the current day the first thing in the
agenda listing for the day. Of the entries without a time indication, keep
the grouped in categories, don't sort the categories, but keep them in
the sequence given in `org-agenda-files'. Within each category sort by
priority.
Leaving out `category-keep' would mean that items will be sorted across
categories by priority.
Instead of a single list, this can also be a set of list for specific
contents, with a context symbol in the car of the list, any of
`agenda', `todo', `tags', `search' for the corresponding agenda views.
Custom commands can bind this variable in the options section.
org-agenda-span (funcall #'#[nil ('week) (orig...
- Type: (choice (const :tag "Day" day)…
- In file: org-agenda.el
- Find modifications in git logs
Number of days to include in overview display. Can be day, week, month, year, or any number of days. Custom commands can set this variable in the options section.
org-agenda-start-on-weekday (funcall #'#[nil (1) (original...
- Type: (choice (const :tag "Today" ni…
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means start the overview always on the specified weekday. 0 denotes Sunday, 1 denotes Monday, etc. When nil, always start on the current day. Custom commands can set this variable in the options section. This variable only applies when agenda spans either 7 or 14 days.
org-agenda-start-with-archives-mode (funcall #'#[nil (nil) (origin...
- Type: symbol
- In file: org-agenda.el
- Find modifications in git logs
Initial value of archive mode in a newly created agenda window. See `org-agenda-archives-mode' for acceptable values and their meaning.
org-agenda-start-with-clockreport-mode (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
The initial value of clockreport-mode in a newly created agenda window.
org-agenda-start-with-entry-text-mode (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
The initial value of entry-text-mode in a newly created agenda window.
org-agenda-start-with-follow-mode (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
The initial value of follow mode in a newly created agenda window.
org-agenda-start-with-log-mode (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Don't sho…
- In file: org-agenda.el
- Find modifications in git logs
The initial value of log-mode in a newly created agenda window. See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further explanations on the possible values.
org-agenda-sticky (funcall #'#[nil (nil) (org-ag...
- Type: boolean
- Since: Emacs version 24.3
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means agenda q key will bury agenda buffers. Agenda commands will then show existing buffer instead of generating new ones. When nil, `q' will kill the single agenda buffer.
org-agenda-text-search-extra-files (funcall #'#[nil (nil) (crm-se...
- Type: (set :greedy t (const :tag "Ag…
- In file: org.el
- Find modifications in git logs
List of extra files to be searched by text search commands. These files will be searched in addition to the agenda files by the commands `org-search-view' (`\[org-agenda] s') and `org-occur-in-agenda-files'. Note that these files will only be searched for text search commands, not for the other agenda views like todo lists, tag searches or the weekly agenda. This variable is intended to list notes and possibly archive files that should also be searched by these two commands. In fact, if the first element in the list is the symbol `agenda-archives', then all archive files of all agenda files will be added to the search scope.
org-agenda-time-grid (funcall #'#[nil ((let ((graph...
- Type: (list (set :greedy t :tag "Gri…
- In file: org-agenda.el
- Find modifications in git logs
The settings for time grid for agenda display. This is a list of four items. The first item is again a list. It contains symbols specifying conditions when the grid should be displayed: daily if the agenda shows a single day weekly if the agenda shows an entire week today show grid on current date, independent of daily/weekly display require-timed show grid only if at least one item has a time specification remove-match skip grid times already present in an entry The second item is a list of integers, indicating the times that should have a grid line. The third item is a string which will be placed right after the times that have a grid line. The fourth item is a string placed after the grid times. This will align with agenda items.
org-agenda-time-leading-zero (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means use leading zero for military times in agenda. For example, 9:30am would become 09:30 rather than 9:30.
org-agenda-timegrid-use-ampm (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
When set, show AM/PM style timestamps on the timegrid.
org-agenda-timerange-leaders (funcall #'#[nil ('("" "(%d/%d...
- Type: (list (string :tag "Deadline t…
- In file: org-agenda.el
- Find modifications in git logs
Text preceding timerange entries in the agenda view. This is a list with two strings. The first applies when the range is entirely on one day. The second applies if the range spans several days. The strings may have two "%d" format specifiers which will be filled with the sequence number of the days, and the total number of days in the range, respectively.
org-agenda-todo-ignore-deadlines (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Ignore ne…
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means ignore some deadline TODO items when making TODO list.
There are different motivations for using different values, please think
carefully when configuring this variable.
This applies when creating the global TODO list.
Valid values are:
near Don't show near deadline entries. A deadline is near when it is
closer than `org-deadline-warning-days' days. The idea behind this
is that such items will appear in the agenda anyway.
far Don't show TODO entries where a deadline has been defined, but
is not going to happen anytime soon. This is useful if you want to use
the TODO list to figure out what to do now.
past Don't show entries with a deadline timestamp for today or in the past.
future Don't show entries with a deadline timestamp in the future, not even
when they become `near' ones. Use it with caution.
all Ignore all TODO entries that do have a deadline.
t Same as `near', for backward compatibility.
This variable can also have an integer as a value. See
`org-agenda-todo-ignore-timestamp' for more details.
See also `org-agenda-todo-ignore-with-date'.
See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
to make his option also apply to the tags-todo list.
org-agenda-todo-ignore-scheduled (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Ignore fu…
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means, ignore some scheduled TODO items when making TODO list.
This applies when creating the global todo list.
Valid values are:
past Don't show entries scheduled today or in the past.
future Don't show entries scheduled in the future.
The idea behind this is that by scheduling it, you don't want to
think about it until the scheduled date.
all Don't show any scheduled entries in the global todo list.
The idea behind this is that by scheduling it, you have already
"taken care" of this item.
t Same as `all', for backward compatibility.
This variable can also have an integer as a value. See
`org-agenda-todo-ignore-timestamp' for more details.
See also `org-agenda-todo-ignore-with-date'.
See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
to make his option also apply to the tags-todo list.
org-agenda-todo-ignore-time-comparison-use-seconds (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Compare t…
- Since: Emacs version 24.4
- In file: org-agenda.el
- Find modifications in git logs
Time unit to use when possibly ignoring an agenda item. See the docstring of various `org-agenda-todo-ignore-*' options. The default is to compare time stamps using days. An item is thus considered to be in the future if it is at least one day after today. Non-nil means to compare time stamps using seconds. An item is then considered future if it has a time value later than current time.
org-agenda-todo-ignore-timestamp (funcall #'#[nil (nil) (origin...
- Type: (choice (const :tag "Ignore fu…
- Since: Emacs version 24.1
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means don't show entries with a timestamp.
This applies when creating the global todo list.
Valid values are:
past Don't show entries for today or in the past.
future Don't show entries with a timestamp in the future.
The idea behind this is that if it has a future
timestamp, you don't want to think about it until the
date.
all Don't show any entries with a timestamp in the global todo list.
The idea behind this is that by setting a timestamp, you
have already "taken care" of this item.
This variable can also have an integer as a value. If positive (N),
todos with a timestamp N or more days in the future will be ignored. If
negative (-N), todos with a timestamp N or more days in the past will be
ignored. If 0, todos with a timestamp either today or in the future will
be ignored. For example, a value of -1 will exclude todos with a
timestamp in the past (yesterday or earlier), while a value of 7 will
exclude todos with a timestamp a week or more in the future.
See also `org-agenda-todo-ignore-with-date'.
See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
to make his option also apply to the tags-todo list.
org-agenda-todo-ignore-with-date (funcall #'#[nil (nil) (origin...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means don't show entries with a date in the global todo list. You can use this if you prefer to mark mere appointments with a TODO keyword, but don't want them to show up in the TODO list. When this is set, it also covers deadlines and scheduled items, the settings of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines' will be ignored. See also the variable `org-agenda-tags-todo-honor-ignore-options'.
org-agenda-todo-keyword-format (funcall #'#[nil ("%-1s") (ori...
- Type: string
- In file: org-agenda.el
- Find modifications in git logs
Format for the TODO keyword in agenda lines. Set this to something like "%-12s" if you want all TODO keywords to occupy a fixed space in the agenda display.
org-agenda-todo-list-sublevels (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means check also the sublevels of a TODO entry for TODO entries. When nil, the sublevels of a TODO entry are not checked, resulting in potentially much shorter TODO lists.
org-agenda-use-tag-inheritance (funcall #'#[nil ('(todo searc...
- Type: (choice (const :tag "Use tag i…
- Since: Emacs version 26.1
- In file: org-agenda.el
- Find modifications in git logs
List of agenda view types where to use tag inheritance. In tags/tags-todo/tags-tree agenda views, tag inheritance is controlled by `org-use-tag-inheritance'. In other agenda types, `org-use-tag-inheritance' is not used for the selection of the agenda entries. Still, you may want the agenda to be aware of the inherited tags anyway, e.g. for later tag filtering. Allowed value are `todo', `search' and `agenda'. This variable has no effect if `org-agenda-show-inherited-tags' is set to `always'. In that case, the agenda is aware of those tags. The default value sets tags in every agenda type. Setting this option to nil will speed up non-tags agenda view a lot.
org-agenda-use-time-grid (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means show a time grid in the agenda schedule. A time grid is a set of lines for specific times (like every two hours between 8:00 and 20:00). The items scheduled for a day at specific times are sorted in between these lines. For details about when the grid will be shown, and what it will look like, see the variable `org-agenda-time-grid'.
org-agenda-view-columns-initially (funcall #'#[nil (nil) (origin...
- Type: boolean
- Since: Emacs version 26.1
- In file: org-agenda.el
- Find modifications in git logs
When non-nil, switch to columns view right after creating the agenda.
org-agenda-weekend-days (funcall #'#[nil ('(6 0)) (ori...
- Type: (set :greedy t (const :tag "Mo…
- In file: org-agenda.el
- Find modifications in git logs
Which days are weekend? These days get the special face `org-agenda-date-weekend' in the agenda.
org-agenda-window-frame-fractions (funcall #'#[nil ('(0.5 . 0.75...
- Type: (cons (number :tag "Minimum") …
- In file: org-agenda.el
- Find modifications in git logs
The min and max height of the agenda window as a fraction of frame height. The value of the variable is a cons cell with two numbers between 0 and 1. It only matters if `org-agenda-window-setup' is `reorganize-frame'.
org-agenda-window-setup (funcall #'#[nil ('reorganize-...
- Type: (choice (const current-window)…
- In file: org-agenda.el
- Find modifications in git logs
How the agenda buffer should be displayed.
Possible values for this option are:
current-window Show agenda in the current window, keeping all other windows.
other-window Use `switch-to-buffer-other-window' to display agenda.
only-window Show agenda, deleting all other windows.
reorganize-frame Show only two windows on the current frame, the current
window and the agenda.
other-frame Use `switch-to-buffer-other-frame' to display agenda.
Also, when exiting the agenda, kill that frame.
other-tab Use `switch-to-buffer-other-tab' to display the
agenda, making use of the `tab-bar-mode' introduced
in Emacs version 27.1. Also, kill that tab when
exiting the agenda view.
See also the variable `org-agenda-restore-windows-after-quit'.
org-agenda-with-colors (funcall #'#[nil (t) (original...
- Type: boolean
- In file: org-agenda.el
- Find modifications in git logs
Non-nil means use colors in agenda views.
org-allow-promoting-top-level-subtree (funcall #'#[nil (nil) (buffer...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
When non-nil, allow promoting a top level subtree. The leading star of the top level headline will be replaced by a #.
org-archive-default-command (funcall #'#[nil ('org-archive...
- Type: (choice (const org-archive-sub…
- In file: org-archive.el
- Find modifications in git logs
The default archiving command.
org-archive-file-header-format (funcall #'#[nil ("\nArchived ...
- Type: string
- Since: Emacs version 24.4
- In file: org-archive.el
- Find modifications in git logs
The header format string for newly created archive files. When nil, no header will be inserted. When a string, a %s formatter will be replaced by the file name.
org-archive-location (funcall #'#[nil ("%s_archive:...
- Type: string
- In file: org.el
- Find modifications in git logs
The location where subtrees should be archived.
The value of this variable is a string, consisting of two parts,
separated by a double-colon. The first part is a filename and
the second part is a headline.
When the filename is omitted, archiving happens in the same file.
%s in the filename will be replaced by the current file
name (without the directory part). Archiving to a different file
is useful to keep archived entries from contributing to the
Org Agenda.
The archived entries will be filed as subtrees of the specified
headline. When the headline is omitted, the subtrees are simply
filed away at the end of the file, as top-level entries. Also in
the heading you can use %s to represent the file name, this can be
useful when using the same archive for a number of different files.
Here are a few examples:
"%s_archive::"
If the current file is Projects.org, archive in file
Projects.org_archive, as top-level trees. This is the default.
"::* Archived Tasks"
Archive in the current file, under the top-level headline
"* Archived Tasks".
"~/org/archive.org::"
Archive in file ~/org/archive.org (absolute path), as top-level trees.
"~/org/archive.org::* From %s"
Archive in file ~/org/archive.org (absolute path), under headlines
"From FILENAME" where file name is the current file name.
"~/org/datetree.org::datetree/* Finished Tasks"
The "datetree/" string is special, signifying to archive
items to the datetree. Items are placed in either the CLOSED
date of the item, or the current date if there is no CLOSED date.
The heading will be a subentry to the current date. There doesn't
need to be a heading, but there always needs to be a slash after
datetree. For example, to store archived items directly in the
datetree, use "~/org/datetree.org::datetree/".
"basement::** Finished Tasks"
Archive in file ./basement (relative path), as level 3 trees
below the level 2 heading "** Finished Tasks".
You may define it locally by setting an ARCHIVE property. If
such a property is found in the file or in an entry, and anywhere
up the hierarchy, it will be used.
You can also set it for the whole file using the keyword-syntax:
#+ARCHIVE: basement::** Finished Tasks
org-archive-mark-done (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No" nil) …
- In file: org-archive.el
- Find modifications in git logs
Non-nil means mark entries as DONE when they are moved to the archive file. This can be a string to set the keyword to use. When non-nil, Org will use the first keyword in its list that means done.
org-archive-reversed-order (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-archive.el
- Find modifications in git logs
Non-nil means make the tree first child under the archive heading, not last.
org-archive-save-context-info (funcall #'#[nil ('(time file ...
- Type: (set :greedy t (const :tag "Ti…
- In file: org-archive.el
- Find modifications in git logs
Parts of context info that should be stored as properties when archiving.
When a subtree is moved to an archive file, it loses information given by
context, like inherited tags, the category, and possibly also the TODO
state (depending on the variable `org-archive-mark-done').
This variable can be a list of any of the following symbols:
time The time of archiving.
file The file where the entry originates.
ltags The local tags, in the headline of the subtree.
itags The tags the subtree inherits from further up the hierarchy.
todo The pre-archive TODO state.
category The category, taken from file name or #+CATEGORY lines.
olpath The outline path to the item. These are all headlines above
the current item, separated by /, like a file path.
For each symbol present in the list, a property will be created in
the archived entry, with a prefix "ARCHIVE_", to remember this
information.
org-archive-sibling-heading (funcall #'#[nil ("Archive") (...
- Type: string
- In file: org-archive.el
- Find modifications in git logs
Name of the local archive sibling that is used to archive entries locally. Locally means: in the tree, under a sibling. See `org-archive-to-archive-sibling' for more information.
org-archive-stamp-time (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-archive.el
- Find modifications in git logs
Non-nil means add a time stamp to entries moved to an archive file. This variable is obsolete and has no effect anymore, instead add or remove `time' from the variable `org-archive-save-context-info'.
org-archive-subtree-save-file-p (funcall #'#[nil ('from-org) (...
- Type: (choice (const :tag "Save arch…
- In file: org-archive.el
- Find modifications in git logs
Conditionally save the archive file after archiving a subtree. This variable can be any of the following symbols: t saves in all cases. `from-org' prevents saving from an agenda-view. `from-agenda' saves only when the archive is initiated from an agenda-view. nil prevents saving in all cases. Note that, regardless of this value, the archive buffer is never saved when archiving into a location in the current buffer.
org-ascii-bullets (funcall #'#[nil ('((ascii 42 ...
- Type: (list (cons :tag "Bullet chara…
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Bullet characters for headlines converted to lists in ASCII export. Alist whose key is a symbol among `ascii', `latin1' and `utf-8' and whose value is a list of characters. The first character is used for the first level considered as low level, and so on. If there are more levels than characters given here, the list will be repeated. Note that this variable doesn't affect plain lists representation.
org-ascii-caption-above (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
When non-nil, place caption string before the element. Otherwise, place it right after it.
org-ascii-charset (funcall #'#[nil ('ascii) (t)]...
- Type: (choice (const :tag "ASCII" as…
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
The charset allowed to represent various elements and objects. Possible values are: `ascii' Only use plain ASCII characters `latin1' Include Latin-1 characters `utf-8' Use all UTF-8 characters
org-ascii-format-drawer-function (funcall #'#[nil (#'(lambda (_...
- Type: function
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Function called to format a drawer in ASCII. The function must accept three parameters: NAME the drawer name, like "LOGBOOK" CONTENTS the contents of the drawer. WIDTH the text width within the drawer. The function should return either the string to be exported or nil to ignore the drawer. The default value simply returns the value of CONTENTS.
org-ascii-format-inlinetask-function (funcall #'#[nil ('org-ascii-f...
- Type: function
- Since: Emacs version 26.1
- In file: ox-ascii.el
- Find modifications in git logs
Function called to format an inlinetask in ASCII. The function must accept nine parameters: TODO the todo keyword, as a string TODO-TYPE the todo type, a symbol among `todo', `done' and nil. PRIORITY the inlinetask priority, as a string NAME the inlinetask name, as a string. TAGS the inlinetask tags, as a list of strings. CONTENTS the contents of the inlinetask, as a string. WIDTH the width of the inlinetask, as a number. INLINETASK the inlinetask itself. INFO the info channel. The function should return either the string to be exported or nil to ignore the inline task.
org-ascii-global-margin (funcall #'#[nil (0) (t)])
- Type: integer
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Width of the left margin, in number of characters.
org-ascii-headline-spacing (funcall #'#[nil ('(1 . 2)) (t...
- Type: (choice (const :tag "Replicate…
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Number of blank lines inserted around headlines. This variable can be set to a cons cell. In that case, its car represents the number of blank lines present before headline contents whereas its cdr reflects the number of blank lines after contents. A nil value replicates the number of blank lines found in the original Org buffer at the same place.
org-ascii-indented-line-width (funcall #'#[nil ('auto) (t)])
- Type: (choice (integer :tag "Number …
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Additional indentation width for the first line in a paragraph. If the value is an integer, indent the first line of each paragraph by this width, unless it is located at the beginning of a section, in which case indentation is removed from that line. If it is the symbol `auto' preserve indentation from original document.
org-ascii-inlinetask-width (funcall #'#[nil (30) (t)])
- Type: integer
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Width of inline tasks, in number of characters. This number ignores any margin.
org-ascii-inner-margin (funcall #'#[nil (2) (t)])
- Type: integer
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Width of the inner margin, in number of characters. Inner margin is applied between each headline.
org-ascii-links-to-notes (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Non-nil means convert links to notes before the next headline. When nil, the link will be exported in place. If the line becomes long in this way, it will be wrapped.
org-ascii-list-margin (funcall #'#[nil (0) (t)])
- Type: integer
- Since: Emacs version 26.1
- In file: ox-ascii.el
- Find modifications in git logs
Width of margin used for plain lists, in characters. This margin applies to top level list only, not to its sub-lists.
org-ascii-paragraph-spacing (funcall #'#[nil ('auto) (t)])
- Type: (choice (integer :tag "Number …
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Number of white lines between paragraphs. If the value is an integer, add this number of blank lines between contiguous paragraphs. If is it the symbol `auto', keep the same number of blank lines as in the original document.
org-ascii-quote-margin (funcall #'#[nil (6) (t)])
- Type: integer
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Width of margin used for quoting text, in characters. This margin is applied on both sides of the text. It is also applied on the left side of contents in descriptive lists.
org-ascii-table-keep-all-vertical-lines (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Non-nil means keep all vertical lines in ASCII tables. When nil, vertical lines will be removed except for those needed for column grouping.
org-ascii-table-use-ascii-art (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Non-nil means "table.el" tables are turned into ASCII art. It only makes sense when export charset is `utf-8'. It is nil by default since it requires "ascii-art-to-unicode.el" package, available through, e.g., GNU ELPA.
org-ascii-table-widen-columns (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Non-nil means widen narrowed columns for export. When nil, narrowed columns will look in ASCII export just like in Org mode, i.e. with "=>" as ellipsis.
org-ascii-text-width (funcall #'#[nil (72) (t)])
- Type: integer
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Maximum width of exported text. This number includes margin size, as set in `org-ascii-global-margin'.
org-ascii-underline (funcall #'#[nil ('((ascii 61 ...
- Type: (list (cons :tag "Underline ch…
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Characters for underlining headings in ASCII export. Alist whose key is a symbol among `ascii', `latin1' and `utf-8' and whose value is a list of characters. For each supported charset, this variable associates a sequence of underline characters. In a sequence, the characters will be used in order for headlines level 1, 2, ... If no character is available for a given level, the headline won't be underlined.
org-ascii-verbatim-format (funcall #'#[nil ("`%s'") (t)]...
- Type: string
- Since: Emacs version 24.4
- In file: ox-ascii.el
- Find modifications in git logs
Format string used for verbatim text and inline code.
org-attach-archive-delete (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Never del…
- Since: Emacs version 26.1
- In file: org-attach.el
- Find modifications in git logs
Non-nil means attachments are deleted upon archiving a subtree. When set to `query', ask the user instead.
org-attach-auto-tag (funcall #'#[nil ("ATTACH") (t...
- Type: (choice (const :tag "None" nil…
- In file: org-attach.el
- Find modifications in git logs
Tag that will be triggered automatically when an entry has an attachment.
org-attach-commands (funcall #'#[nil ('(((97 1) or...
- Type: (repeat (list (repeat :tag "Ke…
- In file: org-attach.el
- Find modifications in git logs
The list of commands for the attachment dispatcher. Each entry in this list is a list of three elements: - A list of keys (characters) to select the command (the fist character in the list is shown in the attachment dispatcher's splash buffer and minibuffer prompt). - A command that is called interactively when one of these keys is pressed. - A docstring for this command in the attachment dispatcher's splash buffer.
org-attach-dir-relative (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-attach.el
- Find modifications in git logs
Non-nil means directories in DIR property are added as relative links. Defaults to absolute location.
org-attach-expert (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-attach.el
- Find modifications in git logs
Non-nil means do not show the splash buffer with the attach dispatcher.
org-attach-git-annex-auto-get (funcall #'#[nil ('ask) (t)])
- Type: (choice (const :tag "confirm w…
- Since: Emacs version 26.1
- In file: org-attach-git.el
- Find modifications in git logs
Confirmation preference for automatically getting annex files. If this is the symbol `ask', prompt using `y-or-n-p'. If t, always get. If nil, never get.
org-attach-git-annex-cutoff (funcall #'#[nil ((* 32 1024))...
- Type: (choice (const :tag "None" nil…
- Since: Emacs version 24.4
- In file: org-attach-git.el
- Find modifications in git logs
If non-nil, files larger than this will be annexed instead of stored.
org-attach-git-dir (funcall #'#[nil ('default) (t...
- Type: (choice (const :tag "Default" …
- In file: org-attach-git.el
- Find modifications in git logs
Attachment directory with the Git repository to use. The default value is to use `org-attach-id-dir'. When set to `individual-repository', then the directory attached to the current node, if correctly initialized as a Git repository, will be used instead.
org-attach-id-dir (funcall #'#[nil ("data/") (t)...
- Type: directory
- In file: org-attach.el
- Find modifications in git logs
The directory where attachments are stored. If this is a relative path, it will be interpreted relative to the directory where the Org file lives.
org-attach-id-to-path-function-list (funcall #'#[nil ('(org-attach...
- Type: (repeat (function :tag "Functi…
- In file: org-attach.el
- Find modifications in git logs
List of functions used to derive attachment path from an ID string. The functions are called with a single ID argument until the return value is an existing folder. If no folder has been created yet for the given ID, then the first non-nil value defines the attachment dir to be created. Usually, the ID format passed to the functions is defined by `org-id-method'. It is advised that the first function in the list do not generate all the attachment dirs inside the same parent dir. Some file systems may have performance issues in such scenario. Care should be taken when customizing this variable. Previously created attachment folders might not be correctly mapped upon removing functions from the list. Then, Org will not be able to detect the existing attachments.
org-attach-method (funcall #'#[nil ('cp) (t)])
- Type: (choice (const :tag "Copy" cp)…
- In file: org-attach.el
- Find modifications in git logs
The preferred method to attach a file.
Allowed values are:
mv rename the file to move it into the attachment directory
cp copy the file
ln create a hard link. Note that this is not supported
on all systems, and then the result is not defined.
lns create a symbol link. Note that this is not supported
on all systems, and then the result is not defined.
org-attach-preferred-new-method (funcall #'#[nil ('id) (t)])
- Type: (choice (const :tag "ID parame…
- In file: org-attach.el
- Find modifications in git logs
Preferred way to attach to nodes without existing ID and DIR property.
This choice is used when adding attachments to nodes without ID
and DIR properties.
Allowed values are:
id Create and use an ID parameter
dir Create and use a DIR parameter
ask Ask the user for input of which method to choose
nil Prefer to not create a new parameter
nil means that ID or DIR has to be created explicitly
before attaching files.
org-attach-store-link-p (funcall #'#[nil ('attached) (...
- Type: (choice (const :tag "Don't sto…
- In file: org-attach.el
- Find modifications in git logs
Non-nil means store a link to a file when attaching it. When t, store the link to original file location. When `file', store link to the attached file location. When `attached', store attach: link to the attached file.
org-attach-sync-delete-empty-dir (funcall #'#[nil ('query) (t)]...
- Type: (choice (const :tag "Never del…
- In file: org-attach.el
- Find modifications in git logs
Determine what to do with an empty attachment directory on sync. When set to nil, don't touch the directory. When set to `query', ask the user instead, else remove without asking.
org-attach-use-inheritance (funcall #'#[nil ('selective) ...
- Type: (choice (const :tag "Don't use…
- In file: org-attach.el
- Find modifications in git logs
Attachment inheritance for the outline. Enabling inheritance for `org-attach' implies two things. First, that attachment links will look through all parent headings until it finds the linked attachment. Second, that running `org-attach' inside a node without attachments will make `org-attach' operate on the first parent heading it finds with an attachment. Selective means to respect the inheritance setting in `org-use-property-inheritance'.
org-babel-C++-compiler (funcall #'#[nil ("g++") (t)])
- Type: string
- Since: Emacs version 24.3
- In file: ob-C.el
- Find modifications in git logs
Command used to compile a C++ source code file into an executable. May be either a command in the path, like g++ or an absolute path name, like /usr/local/bin/g++ parameter may be used, like g++ -v
org-babel-C-compiler (funcall #'#[nil ("gcc") (t)])
- Type: string
- Since: Emacs version 24.3
- In file: ob-C.el
- Find modifications in git logs
Command used to compile a C source code file into an executable. May be either a command in the path, like gcc or an absolute path name, like /usr/local/bin/gcc parameter may be used, like gcc -v
org-babel-D-compiler (funcall #'#[nil ("rdmd") (t)]...
- Type: string
- Since: Emacs version 24.3
- In file: ob-C.el
- Find modifications in git logs
Command used to compile and execute a D source code file. May be either a command in the path, like rdmd or an absolute path name, like /usr/local/bin/rdmd parameter may be used, like rdmd --chatty
org-babel-R-command (funcall #'#[nil ("R --slave -...
- Type: string
- Since: Emacs version 24.1
- In file: ob-R.el
- Find modifications in git logs
Name of command to use for executing R code.
org-babel-clojure-backend (funcall #'#[nil ((cond ((exec...
- Type: (choice (const :tag "babashka"…
- In file: ob-clojure.el
- Find modifications in git logs
Backend used to evaluate Clojure code blocks.
org-babel-clojure-default-ns (funcall #'#[nil ("user") (cid...
- Type: string
- In file: ob-clojure.el
- Find modifications in git logs
Default Clojure namespace for source block when finding ns failed.
org-babel-clojurescript-backend (funcall #'#[nil ((cond ((or (...
- Type: (choice (const :tag "nbb" nbb)…
- In file: ob-clojure.el
- Find modifications in git logs
Backend used to evaluate ClojureScript code blocks.
org-babel-comint-fallback-regexp-threshold (funcall #'#[nil (5.0) (org-el...
- Type: float
- In file: ob-comint.el
- Find modifications in git logs
Waiting time until trying to use fallback regexp to detect prompt. This is useful when prompt unexpectedly changes.
org-babel-csharp-additional-project-flags (funcall #'#[nil (nil) (t)])
- Type: (choice string (const nil))
- In file: ob-csharp.el
- Find modifications in git logs
Will be passed in the "PropertyGroup" defining the project. This is taken as-is. It should be a string in XML-format.
org-babel-csharp-compiler (funcall #'#[nil ("dotnet") (t...
- Type: string
- In file: ob-csharp.el
- Find modifications in git logs
The program to call for compiling a csharp project.
org-babel-csharp-default-target-framework (funcall #'#[nil ((format "net...
- Type: string
- In file: ob-csharp.el
- Find modifications in git logs
The desired target framework to use.
org-babel-csharp-generate-compile-command (funcall #'#[nil (#'org-babel-...
- Type: function
- In file: ob-csharp.el
- Find modifications in git logs
A function creating the compile command. It must take two parameters intended for the target binary directory and a .sln file, .csproj file, or a base directory where either can be found.
org-babel-csharp-generate-restore-command (funcall #'#[nil (#'org-babel-...
- Type: function
- In file: ob-csharp.el
- Find modifications in git logs
A function creating a project restore command. It must take one parameter defining the project to perform a restore on.
org-babel-exp-call-line-template (funcall #'#[nil ("") (t)])
- Type: string
- In file: ob-exp.el
- Find modifications in git logs
Template used to export call lines. This template may be customized to include the call line name with any export markup. The template is filled out using `org-fill-template', and the following %keys may be used. line --- call line An example value would be "\n: call: %line" to export the call line wrapped in a verbatim environment. Note: the results are inserted separately after the contents of this template.
org-babel-exp-code-template (funcall #'#[nil ("#+begin_src...
- Type: string
- In file: ob-exp.el
- Find modifications in git logs
Template used to export the body of code blocks. This template may be customized to include additional information such as the code block name, or the values of particular header arguments. The template is filled out using `org-fill-template', and the following %keys may be used. lang ------ the language of the code block name ------ the name of the code block body ------ the body of the code block switches -- the switches associated to the code block header-args the header arguments of the code block In addition to the keys mentioned above, every header argument defined for the code block may be used as a key and will be replaced with its value.
org-babel-exp-inline-code-template (funcall #'#[nil ("src_%lang[%...
- Type: string
- In file: ob-exp.el
- Find modifications in git logs
Template used to export the body of inline code blocks. This template may be customized to include additional information such as the code block name, or the values of particular header arguments. The template is filled out using `org-fill-template', and the following %keys may be used. lang ------ the language of the code block name ------ the name of the code block body ------ the body of the code block switches -- the switches associated to the code block header-args the header arguments of the code block In addition to the keys mentioned above, every header argument defined for the code block may be used as a key and will be replaced with its value.
org-babel-fortran-compiler (funcall #'#[nil ("gfortran") ...
- Type: string
- In file: ob-fortran.el
- Find modifications in git logs
Fortran command used to compile Fortran source code file.
org-babel-groovy-command (funcall #'#[nil ("groovy") (t...
- Type: string
- Since: Emacs version 24.3
- In file: ob-groovy.el
- Find modifications in git logs
Name of the command to use for executing Groovy code. May be either a command in the path, like groovy or an absolute path name, like /usr/local/bin/groovy parameters may be used, like groovy -v
org-babel-hash-show-time (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ob-core.el
- Find modifications in git logs
Non-nil means show the time the code block was evaluated in the result hash.
org-babel-haskell-compiler (funcall #'#[nil ("ghc") (hask...
- Type: string
- In file: ob-haskell.el
- Find modifications in git logs
Command used to compile a Haskell source code file into an executable. May be either a command in the path, like "ghc" or an absolute path name, like "/usr/local/bin/ghc". The command can include a parameter, such as "ghc -v".
org-babel-inline-result-wrap (funcall #'#[nil ("=%s") (t)]…=
- Type: string
- In file: ob-core.el
- Find modifications in git logs
Format string used to wrap inline results. This string must include a "%s" which will be replaced by the results.
org-babel-java-command (funcall #'#[nil ("java") (t)]...
- Type: string
- In file: ob-java.el
- Find modifications in git logs
Name of the java command. May be either a command in the path, like java or an absolute path name, like /usr/local/bin/java. Parameters may be used, like java -verbose.
org-babel-java-compiler (funcall #'#[nil ("javac") (t)...
- Type: string
- In file: ob-java.el
- Find modifications in git logs
Name of the java compiler. May be either a command in the path, like javac or an absolute path name, like /usr/local/bin/javac. Parameters may be used, like javac -verbose.
org-babel-java-hline-to (funcall #'#[nil ("null") (t)]...
- Type: string
- In file: ob-java.el
- Find modifications in git logs
Replace hlines in incoming tables with this when translating to java.
org-babel-java-null-to (funcall #'#[nil ('hline) (t)]...
- Type: symbol
- In file: ob-java.el
- Find modifications in git logs
Replace `null' in java tables with this before returning.
org-babel-js-cmd (funcall #'#[nil ("node") (t)]...
- Type: (choice (const "node") (const …
- Since: Emacs version 24.1
- In file: ob-js.el
- Find modifications in git logs
Name of command used to evaluate js blocks.
org-babel-julia-command (funcall #'#[nil ("julia") (es...
- Type: string
- Since: Emacs version 24.3
- In file: ob-julia.el
- Find modifications in git logs
Name of command to use for executing julia code.
org-babel-latex-begin-env (funcall #'#[nil (#'(lambda (_...
- Type: function
- In file: ob-latex.el
- Find modifications in git logs
Function that evaluates to the begin part of the document environment. It takes 1 argument which is the parameters of the source block. This allows adding additional code that will be ignored when exporting the literal LaTeX source.
org-babel-latex-end-env (funcall #'#[nil (#'(lambda (_...
- Type: function
- In file: ob-latex.el
- Find modifications in git logs
Closure which evaluates at runtime to the end part of the document environment. It takes 1 argument which is the parameters of the source block. This allows adding additional code that will be ignored when exporting the literal LaTeX source.
org-babel-latex-htlatex (funcall #'#[nil ("htlatex") (...
- Type: string
- In file: ob-latex.el
- Find modifications in git logs
The htlatex command to enable conversion of LaTeX to SVG or HTML.
org-babel-latex-htlatex-packages (funcall #'#[nil ('("[usenames...
- Type: (repeat (string))
- In file: ob-latex.el
- Find modifications in git logs
Packages to use for htlatex export.
org-babel-latex-pdf-svg-process (funcall #'#[nil ("inkscape --...
- Type: string
- In file: ob-latex.el
- Find modifications in git logs
Command to convert a PDF file to an SVG file.
org-babel-latex-preamble (funcall #'#[nil (#'(lambda (_...
- Type: function
- In file: ob-latex.el
- Find modifications in git logs
Closure which evaluates at runtime to the LaTeX preamble. It takes 1 argument which is the parameters of the source block.
org-babel-latex-process-alist (funcall #'#[nil ((list (cons ...
- Type: (alist :tag "LaTeX to image ba…
- In file: ob-latex.el
- Find modifications in git logs
Definitions of external processes for LaTeX result generation. See `org-preview-latex-process-alist' for more details. The following process symbols are recognized: - `png' :: Process used to produce .png output.
org-babel-lilypond-commands (funcall #'#[nil ((cond ((eq s...
- Type: (list (string :tag "Lilypond …
- Since: Emacs version 24.4
- In file: ob-lilypond.el
- Find modifications in git logs
Commands to run lilypond and view or play the results. These should be executables that take a filename as an argument. On some system it is possible to specify the filename directly and the viewer or player will be determined from the file type; you can leave the string empty on this case.
org-babel-lisp-dir-fmt (funcall #'#[nil ("(cl:let ((c...
- Type: string
- In file: ob-lisp.el
- Find modifications in git logs
Format string used to wrap code bodies to set the current directory. For example a value of "(progn ;; %s\n %%s)" would ignore the current directory string.
org-babel-lisp-eval-fn (funcall #'#[nil (#'slime-eval...
- Type: symbol
- Since: Emacs version 26.1
- In file: ob-lisp.el
- Find modifications in git logs
The function to be called to evaluate code on the Lisp side. Valid values include `slime-eval' and `sly-eval'.
org-babel-load-languages (funcall #'#[nil ('((emacs-lis...
- Type: (alist :tag "Babel Languages" …
- In file: org.el
- Find modifications in git logs
Languages which can be evaluated in Org buffers. \<org-mode-map> This list can be used to load support for any of the available languages with babel support (see info node `(org) Languages'). Each language will depend on a different set of system executables and/or Emacs modes. When a language is "loaded", code blocks in that language can be evaluated with `org-babel-execute-src-block', which is bound by default to \[org-ctrl-c-ctrl-c]. The `org-babel-no-eval-on-ctrl-c-ctrl-c' option can be set to remove code block evaluation from \[org-ctrl-c-ctrl-c]. By default, only Emacs Lisp is loaded, since it has no specific requirement.
org-babel-lua-None-to (funcall #'#[nil ('hline) (t)]...
- Type: symbol
- Since: Emacs version 26.1
- In file: ob-lua.el
- Find modifications in git logs
Replace `None' in Lua tables with this before returning.
org-babel-lua-command (funcall #'#[nil ("lua") (t)])
- Type: string
- Since: Emacs version 26.1
- In file: ob-lua.el
- Find modifications in git logs
Name of the command for executing Lua code.
org-babel-lua-hline-to (funcall #'#[nil ("None") (t)]...
- Type: string
- Since: Emacs version 26.1
- In file: ob-lua.el
- Find modifications in git logs
Replace `hlines' in incoming tables with this when translating to Lua.
org-babel-lua-mode (funcall #'#[nil ('lua-mode) (...
- Type: symbol
- Since: Emacs version 26.1
- In file: ob-lua.el
- Find modifications in git logs
Preferred Lua mode for use in running Lua interactively. This will typically be `lua-mode'.
org-babel-lua-multiple-values-separator (funcall #'#[nil (", ") (t)])
- Type: string
- In file: ob-lua.el
- Find modifications in git logs
Separate multiple values with this string.
org-babel-maxima-command (funcall #'#[nil ((if (boundp ...
- Type: string
- In file: ob-maxima.el
- Find modifications in git logs
Command used to call maxima on the shell.
org-babel-no-eval-on-ctrl-c-ctrl-c (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: ob-core.el
- Find modifications in git logs
\<org-mode-map>Remove code block evaluation from the `\[org-ctrl-c-ctrl-c]' key binding.
org-babel-noweb-wrap-end (funcall #'#[nil (">>") (t)])
- Type: string
- In file: ob-core.el
- Find modifications in git logs
String used to end a noweb reference in a code block. See also `org-babel-noweb-wrap-start'.
org-babel-noweb-wrap-start (funcall #'#[nil ("<<") (t)])
- Type: string
- In file: ob-core.el
- Find modifications in git logs
String used to begin a noweb reference in a code block. See also `org-babel-noweb-wrap-end'.
org-babel-ocaml-command (funcall #'#[nil ("ocaml") (t)...
- Type: string
- Since: Emacs version 24.4
- In file: ob-ocaml.el
- Find modifications in git logs
Name of the command for executing Ocaml code.
org-babel-plantuml-svg-text-to-path (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ob-plantuml.el
- Find modifications in git logs
When non-nil, export text in SVG images to paths using Inkscape.
org-babel-process-comment-text (funcall #'#[nil ('org-remove-...
- Type: function
- Since: Emacs version 24.1
- In file: ob-tangle.el
- Find modifications in git logs
Function called to process raw Org text collected to be inserted as comments in tangled source-code files. The function should take a single string argument and return a string result. The default value is `org-remove-indentation'.
org-babel-python-None-to (funcall #'#[nil ('hline) (t)]...
- Type: symbol
- In file: ob-python.el
- Find modifications in git logs
Replace `None' in python tables with this before returning.
org-babel-python-command (funcall #'#[nil ('auto) (t)])
- Type: (choice string (const auto))
- In file: ob-python.el
- Find modifications in git logs
Command (including arguments) for interactive and non-interactive Python code. When not `auto', it overrides `org-babel-python-command-session' and `org-babel-python-command-nonsession'.
org-babel-python-command-nonsession (funcall #'#[nil ("python") (t...
- Type: string
- In file: ob-python.el
- Find modifications in git logs
Command (including arguments) for executing non-interactive Python code. If `org-babel-python-command' is set, then it overrides this option.
org-babel-python-command-session (funcall #'#[nil ('auto) (t)])
- Type: (choice string (const auto))
- In file: ob-python.el
- Find modifications in git logs
Command (including arguments) for starting interactive Python sessions. If `auto' (the default), uses the values from `python-shell-interpreter' and `python-shell-interpreter-args'. If `org-babel-python-command' is set, then it overrides this option.
org-babel-python-hline-to (funcall #'#[nil ("None") (t)]...
- Type: string
- In file: ob-python.el
- Find modifications in git logs
Replace hlines in incoming tables with this when translating to python.
org-babel-remote-temporary-directory (funcall #'#[nil ("/tmp/") (*t...
- Type: string
- In file: ob-core.el
- Find modifications in git logs
Directory to hold temporary files on remote hosts.
org-babel-results-keyword (funcall #'#[nil ("RESULTS") (...
- Type: string
- Since: Emacs version 24.4
- In file: ob-core.el
- Find modifications in git logs
Keyword used to name results generated by code blocks. It should be "RESULTS". However any capitalization may be used.
org-babel-ruby-hline-to (funcall #'#[nil ("nil") (inf-...
- Type: string
- Since: Emacs version 24.4
- In file: ob-ruby.el
- Find modifications in git logs
Replace hlines in incoming tables with this when translating to ruby.
org-babel-ruby-nil-to (funcall #'#[nil ('hline) (inf...
- Type: symbol
- Since: Emacs version 24.4
- In file: ob-ruby.el
- Find modifications in git logs
Replace nil in ruby tables with this before returning.
org-babel-scheme-null-to (funcall #'#[nil ('hline) (gei...
- Type: symbol
- Since: Emacs version 26.1
- In file: ob-scheme.el
- Find modifications in git logs
Replacement for `()' and `null' in tabulated Scheme results.
org-babel-shell-names (funcall #'#[nil ('("sh" "bash...
- Type: (repeat (string :tag "Shell na…
- In file: ob-shell.el
- Find modifications in git logs
List of names of shell supported by babel shell code blocks. Call `org-babel-shell-initialize' when modifying this variable outside the Customize interface.
org-babel-shell-results-defaults-to-output (funcall #'#[nil (t) (org-babe...
- Type: boolean
- In file: ob-shell.el
- Find modifications in git logs
Let shell execution defaults to ":results output". When set to t, use ":results output" when no :results setting is set. This is especially useful for inline source blocks. When set to nil, stick to the convention of using :results value as the default setting when no :results is set, the "value" of a shell execution being its exit code.
org-babel-tangle-comment-format-beg (funcall #'#[nil ("[[%link][%s...
- Type: string
- Since: Emacs version 24.1
- In file: ob-tangle.el
- Find modifications in git logs
Format of inserted comments in tangled code files. The following format strings can be used to insert special information into the output using `org-fill-template'. %start-line --- the line number at the start of the code block %file --------- the file from which the code block was tangled %link --------- Org style link to the code block %source-name -- name of the code block Upon insertion the formatted comment will be commented out, and followed by a newline. To inhibit this post-insertion processing set the `org-babel-tangle-uncomment-comments' variable to a non-nil value. Whether or not comments are inserted during tangling is controlled by the :comments header argument.
org-babel-tangle-comment-format-end (funcall #'#[nil ("%source-nam...
- Type: string
- Since: Emacs version 24.1
- In file: ob-tangle.el
- Find modifications in git logs
Format of inserted comments in tangled code files. The following format strings can be used to insert special information into the output using `org-fill-template'. %start-line --- the line number at the start of the code block %file --------- the file from which the code block was tangled %link --------- Org style link to the code block %source-name -- name of the code block Upon insertion the formatted comment will be commented out, and followed by a newline. To inhibit this post-insertion processing set the `org-babel-tangle-uncomment-comments' variable to a non-nil value. Whether or not comments are inserted during tangling is controlled by the :comments header argument.
org-babel-tangle-default-file-mode (funcall #'#[nil (420) (org-id...
- Type: integer
- In file: ob-tangle.el
- Find modifications in git logs
The default mode, an integer value, only used when the :tangle-mode header argument specifies chmod-style symbolic notation. The default value 420 corresponds to the octal #o644, which is read-write permissions for the user, read-only for everyone else.
org-babel-tangle-lang-exts (funcall #'#[nil ('(("emacs-li...
- Type: (repeat (cons (string "Languag…
- In file: ob-tangle.el
- Find modifications in git logs
Alist mapping languages to their file extensions. The key is the language name, the value is the string that should be inserted as the extension commonly used to identify files written in this language. If no entry is found in this list, then the name of the language is used.
org-babel-tangle-remove-file-before-write (funcall #'#[nil ('auto) (org-...
- Type: (choice (const :tag "Replace c…
- In file: ob-tangle.el
- Find modifications in git logs
How to overwrite the existing tangle target. When set to nil, `org-babel-tangle' will replace contents of an existing tangle target (and fail when tangle target is read-only). When set to t, the tangle target (including read-only) will be deleted first and a new file, possibly with different ownership and permissions, will be created. When set to symbol `auto', overwrite read-only tangle targets and replace contents otherwise.
org-babel-tangle-uncomment-comments (funcall #'#[nil (nil) (org-id...
- Type: boolean
- In file: ob-tangle.el
- Find modifications in git logs
Inhibits automatic commenting and addition of trailing newline of tangle comments. Use `org-babel-tangle-comment-format-beg' and `org-babel-tangle-comment-format-end' to customize the format of tangled comments.
org-babel-tangle-use-relative-file-links (funcall #'#[nil (t) (org-id-l...
- Type: boolean
- In file: ob-tangle.el
- Find modifications in git logs
Use relative path names in links from tangled source back the Org file.
org-babel-uppercase-example-markers (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 26.1
- In file: ob-core.el
- Find modifications in git logs
When non-nil, begin/end example markers will be inserted in upper case.
org-bbdb-anniversary-field (funcall #'#[nil ('anniversary...
- Type: symbol
- In file: ol-bbdb.el
- Find modifications in git logs
The BBDB field which contains anniversaries. The anniversaries are stored in the following format YYYY-MM-DD Class-or-Format-String where class is one of the customized classes for anniversaries; birthday and wedding are predefined. Format-String can take three substitutions 1) the name of the record containing this anniversary, 2) the number of years, and 3) an ordinal suffix for the year. Multiple anniversaries can be separated by \n.
org-bbdb-anniversary-format-alist (funcall #'#[nil ('(("birthday...
- Type: (alist :key-type (string :tag …
- In file: ol-bbdb.el
- Find modifications in git logs
How different types of anniversaries should be formatted.
An alist of elements (STRING . FORMAT) where STRING is the name of an
anniversary class and format is either:
1) A format string with the following substitutions (in order):
- the name of the record containing this anniversary
- the number of years
- an ordinal suffix (st, nd, rd, th) for the year
2) A function to be called with three arguments: NAME YEARS SUFFIX
(string int string) returning a string for the diary or nil.
3) An Emacs Lisp form that should evaluate to a string (or nil) in the
scope of variables NAME, YEARS and SUFFIX (among others).
org-bbdb-default-anniversary-format (funcall #'#[nil ("birthday") ...
- Type: string
- In file: ol-bbdb.el
- Find modifications in git logs
Default anniversary class.
org-bbdb-extract-date-fun (funcall #'#[nil ('org-bbdb-an...
- Type: function
- In file: ol-bbdb.el
- Find modifications in git logs
How to retrieve `month date year' from the anniversary field. Customize if you have already filled your BBDB with dates different from YYYY-MM-DD. The function must return a list (month date year).
org-bbdb-general-anniversary-description-after (funcall #'#[nil (7) (date t)]...
- Type: integer
- Since: Emacs version 26.1
- In file: ol-bbdb.el
- Find modifications in git logs
When to switch anniversary descriptions to a more general format. Anniversary descriptions include the point in time, when the anniversary appears. This is, in its most general form, just the date of the anniversary. Or more specific terms, like "today", "tomorrow" or "in n days" are used to describe the time span. If the anniversary happens in less than that number of days, the specific description is used. Otherwise, the general one is used.
org-beamer-column-view-format (funcall #'#[nil ("%45ITEM %10...
- Type: (choice (const :tag "Do not in…
- Since: Emacs version 24.4
- In file: ox-beamer.el
- Find modifications in git logs
Column view format that should be used to fill the template.
org-beamer-environments-extra (funcall #'#[nil (nil) (t)])
- Type: (repeat (list (string :tag "En…
- In file: ox-beamer.el
- Find modifications in git logs
Environments triggered by tags in Beamer export.
Each entry has 4 elements:
name Name of the environment
key Selection key for `org-beamer-select-environment'
open The opening template for the environment, with the following escapes
%a the action/overlay specification
%A the default action/overlay specification
%R the raw BEAMER_act value
%o the options argument, with square brackets
%O the raw BEAMER_opt value
%h the headline text
%r the raw headline text (i.e. without any processing)
%H if there is headline text, that raw text in {} braces
%U if there is headline text, that raw text in [] brackets
%l the label, obtained from `org-beamer--get-label'
close The closing string of the environment.
org-beamer-frame-default-options (funcall #'#[nil ("") (t)])
- Type: (string :tag "[options]")
- In file: ox-beamer.el
- Find modifications in git logs
Default options string to use for frames. For example, it could be set to "allowframebreaks".
org-beamer-frame-environment (funcall #'#[nil ("orgframe") ...
- Type: (string :tag "Beamer frame")
- In file: ox-beamer.el
- Find modifications in git logs
Name of the alternative beamer frame environment.
In frames marked as fragile, this environment is used in place of
the usual frame environment.
This permits insertion of a beamer frame inside example blocks,
working around beamer limitations. See
https://list.orgmode.org/87a5nux3zr.fsf@t14.reltub.ca/T/#mc7221e93f138bdd56c916b194b9230d3a6c3de09
This option may need to be changed when "\end{orgframe}" string is
used inside beamer slides.
org-beamer-frame-level (funcall #'#[nil (1) (t)])
- Type: integer
- In file: ox-beamer.el
- Find modifications in git logs
The level at which headlines become frames. Headlines at a lower level will be translated into a sectioning structure. At a higher level, they will be translated into blocks. If a headline with a "BEAMER_env" property set to "frame" is found within a tree, its level locally overrides this number. This variable has no effect on headlines with the "BEAMER_env" property set to either "ignoreheading", "appendix", or "note", which will respectively, be invisible, become an appendix or a note. This integer is relative to the minimal level of a headline within the parse tree, defined as 1.
org-beamer-outline-frame-options (funcall #'#[nil ("") (t)])
- Type: (string :tag "Outline frame op…
- In file: ox-beamer.el
- Find modifications in git logs
Outline frame options appended after \begin{frame}.
You might want to put e.g. "allowframebreaks=0.9" here.
org-beamer-outline-frame-title (funcall #'#[nil ("Outline") (...
- Type: (string :tag "Outline frame ti…
- In file: ox-beamer.el
- Find modifications in git logs
Default title of a frame containing an outline.
org-beamer-subtitle-format (funcall #'#[nil ("\\subtitle{...
- Type: (string :tag "Format string")
- Since: Emacs version 26.1
- In file: ox-beamer.el
- Find modifications in git logs
Format string used for transcoded subtitle. The format string should have at most one "%s"-expression, which is replaced with the subtitle.
org-beamer-theme (funcall #'#[nil ("default") (...
- Type: (choice (const :tag "Do not in…
- Since: Emacs version 24.4
- In file: ox-beamer.el
- Find modifications in git logs
Default theme used in Beamer presentations.
org-bibtex-autogen-keys (funcall #'#[nil (nil) (org-id...
- Type: boolean
- Since: Emacs version 24.1
- In file: ol-bibtex.el
- Find modifications in git logs
Set to a truth value to use `bibtex-generate-autokey' to generate keys.
org-bibtex-export-arbitrary-fields (funcall #'#[nil (nil) (org-id...
- Type: boolean
- Since: Emacs version 24.1
- In file: ol-bibtex.el
- Find modifications in git logs
When converting to bibtex allow fields not defined in `org-bibtex-fields'. This only has effect if `org-bibtex-prefix' is defined, so as to ensure that other org-properties, such as CATEGORY or LOGGING are not placed in the exported bibtex entry.
org-bibtex-headline-format-function (funcall #'#[nil (#'org-bibtex...
- Type: function
- Since: Emacs version 26.1
- In file: ol-bibtex.el
- Find modifications in git logs
Function returning the headline text for `org-bibtex-write'. It should take a single argument, the bibtex entry (an alist as returned by `org-bibtex-read'). The default value simply returns the entry title.
org-bibtex-key-property (funcall #'#[nil ("CUSTOM_ID")...
- Type: string
- Since: Emacs version 24.1
- In file: ol-bibtex.el
- Find modifications in git logs
Property that holds the bibtex key. By default, this is CUSTOM_ID, which enables easy linking to bibtex headlines from within an org file. This can be set to ID to enable global links, but only with great caution, as global IDs must be unique.
org-bibtex-prefix (funcall #'#[nil (nil) (org-id...
- Type: (choice (const nil) (string))
- Since: Emacs version 24.1
- In file: ol-bibtex.el
- Find modifications in git logs
Optional prefix for all bibtex property names. For example setting to `BIB_' would allow interoperability with fireforg.
org-bibtex-treat-headline-as-title (funcall #'#[nil (t) (org-id-l...
- Type: boolean
- Since: Emacs version 24.1
- In file: ol-bibtex.el
- Find modifications in git logs
Treat headline text as title if title property is absent. If an entry is missing a title property, use the headline text as the property. If this value is t, `org-bibtex-check' will ignore a missing title field.
org-bibtex-type-property-name (funcall #'#[nil ("btype") (or...
- Type: string
- Since: Emacs version 24.1
- In file: ol-bibtex.el
- Find modifications in git logs
Property in which to store bibtex entry type (e.g., article).
org-blank-before-new-entry (funcall #'#[nil ('((heading ....
- Type: (list (cons (const heading) (c…
- In file: org.el
- Find modifications in git logs
Should `org-insert-heading' leave a blank line before new heading/item? The value is an alist, with `heading' and `plain-list-item' as CAR, and a boolean flag as CDR. The cdr may also be the symbol `auto', in which case Org will look at the surrounding headings/items and try to make an intelligent decision whether to insert a blank line or not.
org-bookmark-names-plist (funcall #'#[nil ('(:last-capt...
- Type: plist
- In file: org.el
- Find modifications in git logs
Names for bookmarks automatically set by some Org commands. This can provide strings as names for a number of bookmarks Org sets automatically. The following keys are currently implemented: :last-capture :last-capture-marker :last-refile When a key does not show up in the property list, the corresponding bookmark is not set.
org-calc-default-modes (funcall #'#[nil ('(calc-inter...
- Type: plist
- In file: org-table.el
- Find modifications in git logs
List with Calc mode settings for use in `calc-eval' for table formulas. The list must contain alternating symbols (Calc modes variables and values). Don't remove any of the default settings, just change the values. Org mode relies on the variables to be present in the list.
org-calendar-follow-timestamp-change (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means make the calendar window follow timestamp changes. When a timestamp is modified and the calendar window is visible, it will be moved to the new date.
org-calendar-insert-diary-entry-key (funcall #'#[nil ([105]) (flys...
- Type: sexp
- In file: org-compat.el
- Find modifications in git logs
The key to be installed in `calendar-mode-map' for adding diary entries. This option is irrelevant until `org-agenda-diary-file' has been configured to point to an Org file. When that is the case, the command `org-agenda-diary-entry' will be bound to the key given here, by default `i'. In the calendar, `i' normally adds entries to `diary-file'. So if you want to continue doing this, you need to change this to a different key.
org-calendar-to-agenda-key (funcall #'#[nil ('default) (f...
- Type: (choice (const :tag "Bind to `…
- In file: org-compat.el
- Find modifications in git logs
Key to be installed in `calendar-mode-map' for switching to the agenda. The command `org-calendar-goto-agenda' will be bound to this key. When set to `default', bind the function to `c', but only if it is available in the Calendar keymap. This is the default choice because `c' can then be used to switch back and forth between agenda and calendar. When nil, `org-calendar-goto-agenda' is not bound to any key.
org-capture-bookmark (funcall #'#[nil (t) (org-tabl...
- Type: boolean
- Since: Emacs version 24.3
- In file: org-compat.el
- Find modifications in git logs
When non-nil, add bookmark pointing at the last stored position when capturing.
org-capture-templates (funcall #'#[nil (nil) (org-re...
- Type: (repeat (choice :value ("" "" …
- In file: org-capture.el
- Find modifications in git logs
Templates for the creation of new entries.
Each entry is a list with the following items:
keys The keys that will select the template, as a string, characters
only, for example "a" for a template to be selected with a
single key, or "bt" for selection with two keys. When using
several keys, keys using the same prefix key must be together
in the list and preceded by a 2-element entry explaining the
prefix key, for example
("b" "Templates for marking stuff to buy")
The "C" key is used by default for quick access to the
customization of the template variable. But if you want to use
that key for a template, you can.
description A short string describing the template, will be shown during
selection.
type The type of entry. Valid types are:
entry an Org node, with a headline. Will be filed
as the child of the target entry or as a
top-level entry. Its default template is:
"* %?
%a"
item a plain list item, will be placed in the
first plain list at the target location.
Its default template is:
"- %?"
checkitem a checkbox item. This differs from the
plain list item only in so far as it uses a
different default template. Its default
template is:
"- [ ] %?"
table-line a new line in the first table at target location.
Its default template is:
"| %? |"
plain text to be inserted as it is.
target Specification of where the captured item should be placed.
In Org files, targets usually define a node. Entries
(type `entry') will become children of this node, other
types will be added to the table or list in the body of
this node.
<file-spec>
Most target specifications contain a file name. If that file
name is the empty string, it defaults to `org-default-notes-file'.
A file can also be given as a variable or as a function called
with no argument. When an absolute path is not specified for a
target, it is taken as relative to `org-directory'.
Valid values are:
(file <file-spec>)
Text will be placed at the beginning or end of that file
(id "id of existing Org entry")
File as child of this entry, or in the body of the entry
(file+headline <file-spec> "node headline")
(file+headline <file-spec> function-returning-string)
(file+headline <file-spec> symbol-containing-string)
Fast configuration if the target heading is unique in the file
(file+olp <file-spec> "Level 1 heading" "Level 2" ...)
(file+olp <file-spec> function-returning-list-of-strings)
(file+olp <file-spec> symbol-containing-list-of-strings)
For non-unique headings, the full outline path is safer
(file+regexp <file-spec> "regexp to find location")
File to the entry containing matching regexp
(file+olp+datetree <file-spec> "Level 1 heading" ...)
(file+olp+datetree <file-spec> function-returning-list-of-strings)
(file+olp+datetree <file-spec> symbol-containing-list-of-strings)
Will create a heading in a date tree for today's date.
If no heading is given, the tree will be on top level.
To prompt for date instead of using TODAY, use the
:time-prompt property. To create a week-tree, use the
:tree-type property.
(file+function <file-spec> function-finding-location)
A function to find the right location in the file
(clock)
File to the entry that is currently being clocked
(here)
The exact position to insert the template
(function function-finding-location)
Most general way: write your own function which both visits
the file and moves point to the right location
For (here) target, the template will be always inserted
in place.
When the target points to headline, the template will
be inserted into the headline body (for non-`entry' types)
or as an immediate child.
When the target points to text inside heading body, the
exact place where the template will be inserted depends
on its type:
entry will be inserted as a child of the Org
heading the point is in.
item, will be inserted in the nearest existing Org
checkitem list, if there is one. The list will be
searched from the point to the end of current
heading body.
table-line will be inserted into the nearest table, if any
searching from point to the end of current
heading body.
plain plain text will be inserted in place.
template The template for creating the capture item.
If it is an empty string or nil, a default template based on
the entry type will be used (see the "type" section above).
Instead of a string, this may also be one of:
(file "/path/to/template-file")
(function function-returning-the-template)
in order to get a template from a file, or dynamically
from a function.
The rest of the entry is a property list of additional options. Recognized
properties are:
:prepend Normally newly captured information will be appended at
the target location (last child, last table line,
last list item...). Setting this property will
change that.
:immediate-finish When set, do not offer to edit the information, just
file it away immediately. This makes sense if the
template only needs information that can be added
automatically.
:jump-to-captured When set, jump to the captured entry when finished.
:refile-targets When exiting capture mode via `org-capture-refile', the
variable `org-refile-targets' will be temporarily bound
to the value of this property.
:empty-lines Set this to the number of lines that should be inserted
before and after the new item. Default 0, only common
other value is 1.
:empty-lines-before Set this to the number of lines that should be inserted
before the new item. Overrides :empty-lines for the
number lines inserted before.
:empty-lines-after Set this to the number of lines that should be inserted
after the new item. Overrides :empty-lines for the
number of lines inserted after.
:clock-in Start the clock in this item.
:clock-keep Keep the clock running when filing the captured entry.
:clock-resume Start the interrupted clock when finishing the capture.
Note that :clock-keep has precedence over :clock-resume.
When setting both to t, the current clock will run and
the previous one will not be resumed.
:time-prompt Prompt for a date/time to be used for date/week trees
and when filling the template.
:tree-type When `week', make a week tree instead of the month-day
tree. When `month', make a month tree instead of the
month-day tree. When any subset of
`(year quarter month week day)', create a
datetree hierarchy with the specified
levels. Can also be a function, in which
case it should take the date as an argument
and generate a list of pairs to pass to
`org-datetree-find-create-hierarchy'.
:unnarrowed Do not narrow the target buffer, simply show the
full buffer. Default is to narrow it so that you
only see the new stuff.
:table-line-pos Specification of the location in the table where the
new line should be inserted. It should be a string like
"II-3", meaning that the new line should become the
third line before the second horizontal separator line.
:kill-buffer If the target file was not yet visited by a buffer when
capture was invoked, kill the buffer again after capture
is finalized.
:no-save Do not save the target file after finishing the capture.
:hook A nullary function or list of nullary functions run before
`org-capture-mode-hook' when the template is selected.
:prepare-finalize A nullary function or list of nullary functions run before
`org-capture-prepare-finalize-hook'
when the template is selected.
:before-finalize A nullary function or list of nullary functions run before
`org-capture-before-finalize-hook'
when the template is selected.
:after-finalize A nullary function or list of nullary functions run before
`org-capture-after-finalize-hook'
when the template is selected.
The template defines the text to be inserted. Often this is an
Org mode entry (so the first line should start with a star) that
will be filed as a child of the target headline. It can also be
freely formatted text. Furthermore, the following %-escapes will
be replaced with content and expanded:
%[pathname] Insert the contents of the file given by
`pathname'. These placeholders are expanded at the very
beginning of the process so they can be used to extend the
current template.
%(sexp) Evaluate elisp `(sexp)' and replace it with the results.
Only placeholders pre-existing within the template, or
introduced with %[pathname] are expanded this way.
Since this happens after expanding non-interactive
%-escapes, those can be used to fill the expression.
The evaluation happens with Org mode set as major mode
in a temporary buffer.
Examples: %(org-id-new), %(eval default-directory)
%<...> The result of `format-time-string' on the ... format
specification.
%t Time stamp, date only. The time stamp is the current
time, except when called from agendas with
`\[org-agenda-capture]' or with
`org-capture-use-agenda-date' set.
%T Time stamp as above, with date and time.
%u, %U Like the above, but inactive time stamps.
%i Initial content, copied from the active region. If
there is text before %i on the same line, such as
indentation, and %i is not inside a %(sexp), that prefix
will be added before every line in the inserted text.
%a Annotation, normally the link created with `org-store-link'.
%A Like %a, but prompt for the description part.
%l Like %a, but only insert the literal link.
%L Like %l, but without brackets (the link content itself).
%c Current kill ring head.
%x Content of the X clipboard.
%k Title of currently clocked task.
%K Link to currently clocked task.
%n User name (taken from the variable `user-full-name').
%f File visited by current buffer when `org-capture' was called.
%F Full path of the file or directory visited by current buffer.
%:keyword Specific information for certain link types, see below.
%^g Prompt for tags, with completion on tags in target file.
%^G Prompt for tags, with completion on all tags in all agenda files.
%^t Like %t, but prompt for date. Similarly %^T, %^u, %^U.
You may define a prompt like: %^{Please specify birthday}t.
The default date is that of %t, see above.
%^C Interactive selection of which kill or clip to use.
%^L Like %^C, but insert as link.
%^{prop}p Prompt the user for a value for property `prop'.
A default value can be specified like this:
%^{prop|default}p.
%^{prompt} Prompt the user for a string and replace this sequence with it.
A default value and a completion table can be specified like this:
%^{prompt|default|completion2|completion3|...}.
%^{prompt}X where X is one of g, G, t, T, u, U, C, or L.
Same as %^X (see above), but also supply custom
prompt/completions. Default value and completions as in
%^{prompt|default|...}X are allowed.
%? After completing the template, position cursor here.
%\1 ... %\N Insert the text entered at the nth %^{prompt} (but not
%^{prompt}X), where N is a number, starting from 1.
%\*1...%\*N Same as \N, but for all the prompts, including
%^{prompt} and %^{prompt}X.
Apart from these general escapes, you can access information specific to
the link type that is created. For example, calling `org-capture' in emails
or in Gnus will record the author and the subject of the message, which you
can access with "%:from" and "%:subject", respectively. Here is a
complete list of what is recorded for each link type.
Link type | Available information
------------------------+------------------------------------------------------
bbdb | %:type %:name %:company
vm, wl, mh, mew, rmail, | %:type %:subject %:message-id
gnus | %:from %:fromname %:fromaddress
| %:to %:toname %:toaddress
| %:fromto (either "to NAME" or "from NAME")
| %:date %:date-timestamp (as active timestamp)
| %:date-timestamp-inactive (as inactive timestamp)
gnus | %:group, for messages also all email fields
eww, w3, w3m | %:type %:url
info | %:type %:file %:node
calendar | %:type %:date
When you need to insert a literal percent sign in the template,
you can escape ambiguous cases with a backward slash, e.g., \%i.
org-capture-templates-contexts (funcall #'#[nil (nil) (org-re...
- Type: (repeat (choice (list :tag "Sh…
- Since: Emacs version 24.3
- In file: org-capture.el
- Find modifications in git logs
Alist of capture templates and valid contexts.
For example, if you have a capture template "c" and you want
this template to be accessible only from `message-mode' buffers,
use this:
(setq org-capture-templates-contexts
\='(("c" ((in-mode . "message-mode")))
("d" (my-context-function
(in-mode . "org-mode")))))
Here are the available contexts definitions:
in-file: command displayed only in matching files
in-mode: command displayed only in matching modes
not-in-file: command not displayed in matching files
not-in-mode: command not displayed in matching modes
in-buffer: command displayed only in matching buffers
not-in-buffer: command not displayed in matching buffers
[function]: a custom function taking no argument
If you define several checks, the agenda command will be
accessible if there is at least one valid check.
You can also bind a key to another capture template depending on
contextual rules.
(setq org-capture-templates-contexts
\='(("c" "d" ((in-mode . "message-mode")))))
Here it means: in `message-mode buffers', use "c" as the
key for the capture template otherwise associated with "d".
(The template originally associated with "d" is not displayed
to avoid duplicates.)
org-capture-use-agenda-date (funcall #'#[nil (nil) (org-re...
- Type: boolean
- Since: Emacs version 24.3
- In file: org-capture.el
- Find modifications in git logs
Non-nil means use the date at point when capturing from agendas. When nil, you can still capture using the date at point with `\[org-agenda-capture]'.
org-checkbox-hierarchical-statistics (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-list.el
- Find modifications in git logs
Non-nil means checkbox statistics counts only the state of direct children. When nil, all boxes below the cookie are counted. This can be set to nil on a per-node basis using a COOKIE_DATA property with the word "recursive" in the value.
org-cite-activate-processor (funcall #'#[nil ('basic) (org...
- Type: (choice (const :tag "Default f…
- In file: oc.el
- Find modifications in git logs
Processor used for activating citations, as a symbol.
org-cite-adjust-note-numbers (funcall #'#[nil (t) (org-elem...
- Type: (choice (const :tag "Automatic…
- In file: oc.el
- Find modifications in git logs
When non-nil, allow process to modify location of note numbers. When this variable is non-nil, it is possible to swap between author-date and note style without modifying the document. To that effect, citations should always be located as in an author-date style. Prior to turning the citation into a footnote, the citation processor moves the citation (i.e., the future note number), and the surrounding punctuation, according to rules defined in `org-cite-note-rules'. When nil, the note number is not moved.
org-cite-basic-column-separator (funcall #'#[nil (" ") (t)])
- Type: string
- In file: oc-basic.el
- Find modifications in git logs
Column separator in completion table, as a string.
org-cite-basic-complete-key-crm-separator (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Use \";;\…
- In file: oc-basic.el
- Find modifications in git logs
When non-nil, use `completing-read-multiple' with this as the separator. When nil, use multiple `completing-read' prompts. When set to a string, it should be a regexp to be used as `crm-separator' (which see). The regexp string can carry the text properties `separator', which if present `completing-read-multiple' will show as part of the prompt. When set to symbol `dynamic', use ";;..." as a separator with the number of ";" sufficient so that none of the completion candidates contain the separator.
org-cite-basic-max-key-distance (funcall #'#[nil (2) (t)])
- Type: integer
- In file: oc-basic.el
- Find modifications in git logs
Maximum (Levenshtein) distance between a wrong key and its suggestions.
org-cite-basic-mouse-over-key-face (funcall #'#[nil ('highlight) ...
- Type: face
- In file: oc-basic.el
- Find modifications in git logs
Face used when mouse is over a citation key.
org-cite-basic-sorting-field (funcall #'#[nil ('author) (t)...
- Type: symbol
- In file: oc-basic.el
- Find modifications in git logs
Field used to sort bibliography items as a symbol, or nil.
org-cite-biblatex-options (funcall #'#[nil (nil) (t)])
- Type: (choice (string :tag "Options …
- In file: oc-biblatex.el
- Find modifications in git logs
Options added to "biblatex" package. If "biblatex" package is already required in the document, e.g., through `org-latex-packages-alist' variable, these options are ignored.
org-cite-biblatex-style-shortcuts (funcall #'#[nil ('(("a" . "au...
- Type: (repeat (cons :tag "Shortcut" …
- In file: oc-biblatex.el
- Find modifications in git logs
List of shortcuts associated to style or variant names. Each entry is a pair (NAME . STYLE-NAME) where NAME is the name of the shortcut, as a string, and STYLE-NAME is the name of a style in `org-cite-biblatex-styles'.
org-cite-biblatex-styles (funcall #'#[nil ('(("author" ...
- Type: (repeat (list :tag "Style/vari…
- In file: oc-biblatex.el
- Find modifications in git logs
List of styles and variants, with associated BibLaTeX commands. Each style follows the pattern (NAME VARIANT COMMAND MULTI-COMMAND NO-OPTION) where: NAME is the name of the style, as a string, or nil. The nil style is the default style. As such, it must have an entry in the list. VARIANT is the name of the style variant, as a string or nil. The nil variant is the default variant for the current style. As such, each style name must be associated to a nil variant. COMMAND is the LaTeX command to use, as a string. It should not contain the leading backslash character. MULTI-COMMAND is the LaTeX command to use when a multi-cite command is appropriate. When nil, the style is deemed inappropriate for multi-cites. The command should not contain the leading backslash character. NO-OPTION is a boolean. When non-nil, no optional argument should be added to the LaTeX command. Each NAME-VARIANT pair should be unique in the list. It is also possible to provide shortcuts for style and variant names. See `org-cite-biblatex-style-shortcuts'.
org-cite-bibtex-bibliography-style (funcall #'#[nil ("plain") (t)...
- Type: (choice (const :tag "Plain" "p…
- In file: oc-bibtex.el
- Find modifications in git logs
Default BibTeX bibliography style. BibTeX provides the following default styles: "plain" Sorted numbered entries "abbrv" Sorted numbered entries with abbreviated author name "unsrt" Unsorted numbered entries "alpha" Alphabetized entries with unique short id "acm" ACM Transactions "apalike" APA-like "ieeetr" IEEE Transactions "siam" SIAM
org-cite-csl-bibtex-titles-to-sentence-case (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: oc-csl.el
- Find modifications in git logs
Convert bibtex title fields to sentence-case by default. When non-nil, title fields in bibtex bibliography entries are converted to sentence-case before being formatted according to a CSL style, except for entries with a `langid' field specifying a non-English language. When nil, title conversion is limited to entries having a `langid' field specifying a variant of English. Conversion of titles to sentence-case by default is in most cases useful because the CSL standard assumes that English titles are specified in sentence-case but the bibtex bibliography format requires them to be written in title-case.
org-cite-csl-html-hanging-indent (funcall #'#[nil ("1.5em") (t)...
- Type: string
- In file: oc-csl.el
- Find modifications in git logs
Size of hanging-indent for HTML output in valid CSS units.
org-cite-csl-html-label-width-per-char (funcall #'#[nil ("0.6em") (t)...
- Type: string
- In file: oc-csl.el
- Find modifications in git logs
Character width in CSS units for calculating entry label widths. Used only when `second-field-align' is activated by the used CSL style.
org-cite-csl-latex-hanging-indent (funcall #'#[nil ("1.5em") (t)...
- Type: string
- In file: oc-csl.el
- Find modifications in git logs
Size of hanging-indent for LaTeX output in valid LaTeX units.
org-cite-csl-latex-label-separator (funcall #'#[nil ("0.6em") (t)...
- Type: string
- In file: oc-csl.el
- Find modifications in git logs
Distance between citation label and bibliography item for LaTeX output.
The value is a string representing the distance in valid LaTeX units.
Used only when `second-field-align' is activated by the used CSL
style.
The indentation length in these cases is computed as the sum of
`org-cite-csl-latex-label-separator' and the maximal label width, for
example,
indentation length
<------------------------->
max. label width separator
<---------------><-------->
[Doe22] John Doe. A title...
[DoeSmithJones19] John Doe, Jane Smith and...
[SmithDoe02] Jane Smith and John Doe...
The maximal label width, in turn, is calculated as the product of
`org-cite-csl-latex-label-width-per-char' and the maximal label
length measured in characters.
org-cite-csl-latex-label-width-per-char (funcall #'#[nil ("0.45em") (t...
- Type: string
- In file: oc-csl.el
- Find modifications in git logs
Character width in LaTeX units for calculating entry label widths. Used only when `second-field-align' is activated by the used CSL style. See the documentation of `org-cite-csl-latex-label-separator' for details.
org-cite-csl-latex-preamble (funcall #'#[nil ("\\usepackag...
- Type: string
- In file: oc-csl.el
- Find modifications in git logs
LaTeX preamble content inserted by the `csl' citation processor.
This preamble can be anything as long as it provides definitions
for the environment and commands that Citeproc's `org-latex'
formatter uses for formatting citations and bibliographies. In
particular, it has to define
- the commands \cslblock{<text>}, \cslleftmargin{<text>},
\cslrightinline{<text>} and \cslindent{<text>} for formatting
text that have, respectively, the CSL display attributes
`block', `left-margin', `right-inline' and `indent';
- the commands \cslcitation{<item_no>}{<item_text>} and
\cslbibitem{<item_no>}{<item_text>}, which are used to
format individual citations and bibliography items, including
hyperlinking citations to the corresponding bibliography entry
using their numerical id, which is passed as the first,
<item_no> argument;
- and the environment \cslbibliography{<hanging-indent>}{<entry-spacing>},
in which bibliographies are wrapped; the value of the
<hanging-indent> argument is 1 if hanging indent should be
applied and 0 if not, while the <entry-spacing> argument is an
integer specifying the number of extra line-heights
required between bibliography entries in addition to normal
line spacing.
When present, the placeholders [CSL-HANGINDENT], [CSL-LABELSEP],
[CSL-LABELWIDTH-PER-CHAR] and [CSL-MAXLABEL-CHARS] are replaced,
respectively, by the contents of the customizable variables
`org-cite-csl-latex-hanging-indent', `org-cite-csl-latex-label-separator',
`org-cite-csl-latex-label-width-per-char', and the maximal label length
in the bibliography measured in characters.
org-cite-csl-link-cites (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: oc-csl.el
- Find modifications in git logs
When non-nil, link cites to references.
org-cite-csl-locales-dir (funcall #'#[nil (nil) (t)])
- Type: (choice (directory :tag "Local…
- In file: oc-csl.el
- Find modifications in git logs
Directory of CSL locale files. If nil then only the fallback en-US locale will be available.
org-cite-csl-no-citelinks-backends (funcall #'#[nil ('(ascii)) (t...
- Type: (repeat symbol)
- In file: oc-csl.el
- Find modifications in git logs
List of export backends for which cite linking is disabled. Cite linking for export backends derived from any of the backends listed here, is also disabled.
org-cite-csl-styles-dir (funcall #'#[nil (nil) (t)])
- Type: (choice (directory :tag "Style…
- In file: oc-csl.el
- Find modifications in git logs
Directory of CSL style files. Relative style file names are expanded according to document's default directory. If it fails and the variable is non-nil, Org looks for style files in this directory, too.
org-cite-export-processors (funcall #'#[nil ('((t basic))...
- Type: (choice (const :tag "No export…
- In file: oc.el
- Find modifications in git logs
Processor used for exporting citations, as a triplet, or nil. When nil, citations and bibliography are not exported. When non-nil, the value is an association list between export backends and citation export processors: (BACKEND . PROCESSOR) where BACKEND is the name of an export backend or t, and PROCESSOR is a triplet following the pattern (NAME BIBLIOGRAPHY-STYLE CITATION-STYLE) There, NAME is the name of a registered citation processor providing export functionality, as a symbol. BIBLIOGRAPHY-STYLE (respectively CITATION-STYLE) is the desired default style to use when printing a bibliography (respectively exporting a citation), as a string or nil. Both BIBLIOGRAPHY-STYLE and CITATION-STYLE are optional. NAME is mandatory. The export process selects the citation processor associated to the current export backend, or the most specific backend the current one is derived from, or, if all are inadequate, to the processor associated to t. For example, with the following value ((beamer natbib) (latex biblatex) (t csl)) exporting with `beamer' or any backend derived from it will use `natbib', whereas exporting with `latex' or any backend derived from it but different from `beamer' will use `biblatex' processor. Any other backend, such as `html', will use `csl' processor. CITATION-STYLE is overridden by adding a style to any citation object. A nil style lets the export processor choose the default output. Any style not recognized by the export processor is equivalent to nil. The citation triplet can also be set with the CITE_EXPORT keyword. E.g., #+CITE_EXPORT: basic note numeric or #+CITE_EXPORT: basic In that case, `basic' processor is used on every export, independently on the backend.
org-cite-follow-processor (funcall #'#[nil ('basic) (org...
- Type: (choice (const :tag "No follow…
- In file: oc.el
- Find modifications in git logs
Processor used for following citations, as a symbol.
org-cite-global-bibliography (funcall #'#[nil (nil) (org-el...
- Type: (choice (const :tag "No global…
- In file: oc.el
- Find modifications in git logs
List of bibliography files available in all documents. File names must be absolute.
org-cite-insert-processor (funcall #'#[nil ('basic) (org...
- Type: (choice (const :tag "No insert…
- In file: oc.el
- Find modifications in git logs
Processor used for inserting citations, as a symbol.
org-cite-natbib-bibliography-style (funcall #'#[nil ('unsrtnat) (...
- Type: (choice (const unsrtnat) (symb…
- In file: oc-natbib.el
- Find modifications in git logs
Default bibliography style.
org-cite-natbib-options (funcall #'#[nil (nil) (t)])
- Type: (set (const :tag "use round pa…
- In file: oc-natbib.el
- Find modifications in git logs
List of options added to "natbib" package. If "natbib" package is already required in the document, e.g., through `org-latex-packages-alist' variable, these options are ignored.
org-cite-note-rules (funcall #'#[nil ('(("en-us" i...
- Type: (repeat (list :tag "Typographi…
- In file: oc.el
- Find modifications in git logs
Alist between languages and typographic rules for citations in note style.
When `org-cite-adjust-note-numbers' is non-nil, and note style is requested,
citation processor is allowed to move the note marker according to some specific
rules, detailed here. More accurately, a rule is a list following the pattern
(LANGUAGE-TAG . RULE)
LANGUAGE-TAG is a down-cased string representing a language tag as defined in
RFC 4646. It may constituted of a language and a region separated with an
hyphen (e.g., "en-us"), or the language alone (e.g., "fr"). A language
without a region applies to all regions.
RULE is a triplet
(PUNCTUATION NUMBER ORDER)
PUNCTUATION is the desired location of the punctuation with regards to the
quotation, if any. It may be `inside', `outside', or `adaptive'. The latter
permits subtler control over the punctuation: when there is no space between
the quotation mark and the punctuation, it is equivalent to `inside'.
Otherwise, it means `outside', as illustrated in the following examples:
"A quotation ending without punctuation" [cite:@org21].
"A quotation ending with a period"[cite:@org21].
Notwithstanding the above, a space always appear before the citation when it
is to become anything else than a note.
NUMBER is the desired location of the note number with regards to the
quotation mark, if any. It may be `inside', `outside', or `same'. When set
to `same', the number appears on the same side as the punctuation, unless
there is punctuation on both sides or on none.
ORDER is the relative position of the citation with regards to the closest
punctuation. It may be `after' or `before'.
For example (adaptive same before) corresponds to French typography.
When the locale is unknown to this variable, the default rule is:
(adaptive outside after)
This roughly follows the Oxford Guide to Style recommendations.
org-cite-punctuation-marks (funcall #'#[nil ('("." "," ";...
- Type: (repeat string)
- In file: oc.el
- Find modifications in git logs
List of strings that can be moved around when placing note numbers. When `org-cite-adjust-note-numbers' is non-nil, the citation processor is allowed to shuffle punctuation marks specified in this list in order to place note numbers according to rules defined in `org-cite-note-rules'.
org-clock-ask-before-exiting (funcall #'#[nil (t) (org-stat...
- Type: boolean
- In file: org-clock.el
- Find modifications in git logs
If non-nil, ask if the user wants to clock out before exiting Emacs. This variable only has effect if set with \[customize].
org-clock-auto-clock-resolution (funcall #'#[nil ('when-no-clo...
- Type: (choice (const :tag "Never" ni…
- In file: org-clock.el
- Find modifications in git logs
When to automatically resolve open clocks found in Org buffers.
org-clock-auto-clockout-timer (funcall #'#[nil (nil) (org-st...
- Type: (choice (integer :tag "Clock o…
- In file: org-clock.el
- Find modifications in git logs
Timer for auto clocking out when Emacs is idle. When set to a number, auto clock out the currently clocked in task after this number of seconds of idle time. This is only effective when `org-clock-auto-clockout-insinuate' is added to the user configuration.
org-clock-clocked-in-display (funcall #'#[nil ('mode-line) ...
- Type: (choice (const :tag "Mode line…
- In file: org-clock.el
- Find modifications in git logs
Where to display clocked in task and accumulated time when clocked in. Allowed values are: both displays in both mode line and frame title mode-line displays only in mode line (default) frame-title displays only in frame title nil current clock is not displayed
org-clock-clocktable-default-properties (funcall #'#[nil ('(:maxlevel ...
- Type: plist
- In file: org-clock.el
- Find modifications in git logs
Default properties for new clocktables. These will be inserted into the BEGIN line, to make it easy for users to play with them.
org-clock-clocktable-formatter (funcall #'#[nil ('org-clockta...
- Type: function
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Function to turn clocking data into a table. For more information, see `org-clocktable-write-default'.
org-clock-clocktable-language-setup (funcall #'#[nil ('(("en" "Fil...
- Type: alist
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Terms used in clocktable, translated to different languages.
org-clock-continuously (funcall #'#[nil (nil) (org-st...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Non-nil means to start clocking from the last clock-out time, if any.
org-clock-display-default-range (funcall #'#[nil ('thisyear) (...
- Type: (choice (const today) (const y…
- In file: org-clock.el
- Find modifications in git logs
Default range when displaying clocks with `org-clock-display'. Valid values are: `today', `yesterday', `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear' and `untilnow'.
org-clock-file-time-cell-format (funcall #'#[nil ("*%s*") (org...
- Type: string
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Format string for the file time cells.
org-clock-frame-title-format (funcall #'#[nil ('(t org-mode...
- Type: sexp
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
The value for `frame-title-format' when clocking in. When `org-clock-clocked-in-display' is set to `frame-title' or `both', clocking in will replace `frame-title-format' with this value. Clocking out will restore `frame-title-format'. This uses the same format as `frame-title-format', which see.
org-clock-goto-before-context (funcall #'#[nil (2) (org-stat...
- Type: integer
- In file: org-clock.el
- Find modifications in git logs
Number of lines of context to display before currently clocked-in entry. This applies when using `org-clock-goto'.
org-clock-goto-may-find-recent-task (funcall #'#[nil (t) (org-stat...
- Type: boolean
- In file: org-clock.el
- Find modifications in git logs
Non-nil means `org-clock-goto' can go to recent task if no active clock.
org-clock-heading-function (funcall #'#[nil (nil) (org-st...
- Type: (choice (const nil) (function)…
- In file: org-clock.el
- Find modifications in git logs
When non-nil, should be a function to create `org-clock-heading'. This is the string shown in the mode line when a clock is running. The function is called with point at the beginning of the headline.
org-clock-history-length (funcall #'#[nil (5) (org-stat...
- Type: integer
- In file: org-clock.el
- Find modifications in git logs
Number of clock tasks to remember in history. Clocking in using history works best if this is at most 35, in which case all digits and capital letters are used up by the *Clock Task Select* buffer.
org-clock-idle-time (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "Never" ni…
- In file: org-clock.el
- Find modifications in git logs
When non-nil, resolve open clocks if the user is idle more than X minutes.
org-clock-in-resume (funcall #'#[nil (nil) (org-st...
- Type: boolean
- In file: org-clock.el
- Find modifications in git logs
If non-nil, resume clock when clocking into task with open clock. When clocking into a task with a clock entry which has not been closed, the clock can be resumed from that point.
org-clock-in-switch-to-state (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "Don't for…
- In file: org-clock.el
- Find modifications in git logs
Set task to a special todo state while clocking it. The value should be the state to which the entry should be switched. If the value is a function, it must take one parameter (the current TODO state of the item) and return the state to switch it to.
org-clock-into-drawer (funcall #'#[nil (t) (org-stat...
- Type: (choice (const :tag "Always" t…
- Since: Emacs version 26.1
- In file: org-clock.el
- Find modifications in git logs
Non-nil when clocking info should be wrapped into a drawer. When non-nil, clocking info will be inserted into the same drawer as log notes (see variable `org-log-into-drawer'), if it exists, or "LOGBOOK" otherwise. If necessary, the drawer will be created. When an integer, the drawer is created only when the number of clocking entries in an item reaches or exceeds this value. When a string, it becomes the name of the drawer, ignoring the log notes drawer altogether. Do not check directly this variable in a Lisp program. Call function `org-clock-into-drawer' instead.
org-clock-mode-line-total (funcall #'#[nil ('auto) (org-...
- Type: (choice (const :tag "Current c…
- In file: org-clock.el
- Find modifications in git logs
Default setting for the time included for the mode line clock. This can be overruled locally using the CLOCK_MODELINE_TOTAL property. Allowed values are: current Only the time in the current instance of the clock today All time clocked into this task today repeat All time clocked into this task since last repeat all All time ever recorded for this task auto Automatically, either `all', or `repeat' for repeating tasks
org-clock-out-remove-zero-time-clocks (funcall #'#[nil (nil) (org-st...
- Type: boolean
- In file: org-clock.el
- Find modifications in git logs
Non-nil means remove the clock line when the resulting time is zero.
org-clock-out-switch-to-state (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "Don't for…
- In file: org-clock.el
- Find modifications in git logs
Set task to a special todo state after clocking out. The value should be the state to which the entry should be switched. If the value is a function, it must take one parameter (the current TODO state of the item) and return the state to switch it to.
org-clock-out-when-done (funcall #'#[nil (t) (org-stat...
- Type: (choice (const :tag "No" nil) …
- In file: org-clock.el
- Find modifications in git logs
When non-nil, clock will be stopped when the clocked entry is marked DONE. \<org-mode-map>DONE here means any DONE-like state. A nil value means clock will keep running until stopped explicitly with `\[org-clock-out]', or until the clock is started in a different item. Instead of t, this can also be a list of TODO states that should trigger clocking out.
org-clock-persist (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "Just the …
- In file: org-clock.el
- Find modifications in git logs
When non-nil, save the running clock when Emacs is closed. The clock is resumed when Emacs restarts. When this is t, both the running clock, and the entire clock history are saved. When this is the symbol `clock', only the running clock is saved. When this is the symbol `history', only the clock history is saved. When Emacs restarts with saved clock information, the file containing the running clock as well as all files mentioned in the clock history will be visited. All this depends on running `org-clock-persistence-insinuate' in your Emacs initialization file.
org-clock-persist-file (funcall #'#[nil ((locate-user...
- Type: string
- In file: org-clock.el
- Find modifications in git logs
File to save clock data to.
org-clock-persist-query-resume (funcall #'#[nil (t) (org-stat...
- Type: boolean
- In file: org-clock.el
- Find modifications in git logs
When non-nil, ask before resuming any stored clock during load.
org-clock-persist-query-save (funcall #'#[nil (nil) (org-st...
- Type: boolean
- In file: org-clock.el
- Find modifications in git logs
When non-nil, ask before saving the current clock on exit.
org-clock-report-include-clocking-task (funcall #'#[nil (nil) (org-st...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
When non-nil, include the current clocking task time in clock reports.
org-clock-resolve-expert (funcall #'#[nil (nil) (org-st...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Non-nil means do not show the splash buffer with the clock resolver.
org-clock-rounding-minutes (funcall #'#[nil (0) (org-stat...
- Type: (choice (integer :tag "Minutes…
- Since: Emacs version 24.4
- In file: org-clock.el
- Find modifications in git logs
Rounding minutes when clocking in or out. The default value is 0 so that no rounding is done. When set to a non-integer value, use the car of `org-time-stamp-rounding-minutes', like for setting a timestamp. E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47 and you clock in: then the clock starts at 14:45. If you clock out within the next 5 minutes, the clock line will be removed; if you clock out 8 minutes after your clocked in, the clock out time will be 14:50.
org-clock-sound (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "No sound"…
- In file: org-clock.el
- Find modifications in git logs
Sound to use for notifications. Possible values are: nil No sound played t Standard Emacs beep file name Play this sound file, fall back to beep
org-clock-string-limit (funcall #'#[nil (0) (org-stat...
- Type: integer
- In file: org-clock.el
- Find modifications in git logs
Maximum length of clock strings in the mode line. 0 means no limit.
org-clock-task-overrun-text (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "Just mark…
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Extra mode line text to indicate that the clock is overrun. The can be nil to indicate that instead of adding text, the clock time should get a different face (`org-mode-line-clock-overrun'). When this is a string, it is prepended to the clock string as an indication, also using the face `org-mode-line-clock-overrun'.
org-clock-total-time-cell-format (funcall #'#[nil ("*%s*") (org...
- Type: string
- Since: Emacs version 24.1
- In file: org-clock.el
- Find modifications in git logs
Format string for the total time cells.
org-clock-x11idle-program-name (funcall #'#[nil ((if (executa...
- Type: string
- In file: org-clock.el
- Find modifications in git logs
Name of the program which prints X11 idle time in milliseconds. you can do "~$ sudo apt-get install xprintidle" if you are using a Debian-based distribution. Alternatively, can find x11idle.c in https://orgmode.org/worg/code/scripts/x11idle.c
org-clocktable-defaults (funcall #'#[nil ((list :maxle...
- Type: plist
- In file: org-clock.el
- Find modifications in git logs
Default properties for clock tables.
org-clone-delete-id (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Remove ID property of clones of a subtree. When non-nil, clones of a subtree don't inherit the ID property. Otherwise they inherit the ID property with a new unique identifier.
org-closed-keep-when-no-todo (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
Remove CLOSED: timestamp when switching back to a non-todo state?
org-coderef-label-format (funcall #'#[nil ("(ref:%s)") ...
- Type: string
- In file: org-src.el
- Find modifications in git logs
The default coderef format. This format string will be used to search for coderef labels in literal examples (EXAMPLE and SRC blocks). The format can be overwritten in an individual literal example with the -l option, like #+BEGIN_SRC pascal +n -r -l "((%s))" ... #+END_SRC If you want to use this for HTML export, make sure that the format does not introduce special font-locking, and avoid the HTML special characters `<', `>', and `&'. The reason for this restriction is that the labels are searched for only after htmlize has done its job.
org-columns-checkbox-allowed-values (funcall #'#[nil ('("[ ]" "[X]...
- Type: (repeat (choice (const :tag "U…
- In file: org-colview.el
- Find modifications in git logs
Allowed values for columns with SUMMARY-TYPE that uses checkbox. The affected summary types are "X%", "X/", and "X" (see info node `(org)Column attributes').
org-columns-dblock-formatter (funcall #'#[nil (#'org-column...
- Type: function
- In file: org-colview.el
- Find modifications in git logs
Function to format data in column view dynamic blocks. For more information, see `org-columns-dblock-write-default'.
org-columns-default-format (funcall #'#[nil ("%25ITEM %TO...
- Type: string
- In file: org.el
- Find modifications in git logs
The default column format, if no other format has been defined. This variable can be set on the per-file basis by inserting a line #+COLUMNS: %25ITEM .....
org-columns-default-format-for-agenda (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "No defaul…
- In file: org.el
- Find modifications in git logs
The default column format in an agenda buffer. This will be used for column view in the agenda unless a format has been set by adding `org-overriding-columns-format' to the local settings list of a custom agenda view. When nil, the columns format for the first item in the agenda list will be used, or as a fall-back, `org-columns-default-format'.
org-columns-ellipses (funcall #'#[nil ("..") (crm-s...
- Type: string
- In file: org.el
- Find modifications in git logs
The ellipses to be used when a field in column view is truncated. When this is the empty string, as many characters as possible are shown, but then there will be no visual indication that the field has been truncated. When this is a string of length N, the last N characters of a truncated field are replaced by this string. If the column is narrower than the ellipses string, only part of the ellipses string will be shown.
org-columns-modify-value-for-display-function (funcall #'#[nil (nil) (org-in...
- Type: (choice (const nil) (function)…
- In file: org-colview.el
- Find modifications in git logs
Function that modifies values for display in column view. For example, it can be used to cut out a certain part from a timestamp. The function must take 2 arguments: column-title The title of the column (*not* the property name) value The value that should be modified. The function should return the value that should be displayed, or nil if the normal value should be used.
org-columns-skip-archived-trees (funcall #'#[nil (t) (texmathp...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means ignore archived trees when creating column view.
org-columns-summary-types (funcall #'#[nil (nil) (org-in...
- Type: (alist :key-type (string :tag …
- Since: Emacs version 26.1
- In file: org-colview.el
- Find modifications in git logs
Alist between operators and summarize functions. Each association follows the pattern (LABEL . SUMMARIZE), or (LABEL SUMMARIZE COLLECT) where LABEL is a string used in #+COLUMNS definition describing the summary type. It can contain any character but "}". It is case-sensitive. SUMMARIZE is a function called with two arguments. The first argument is a non-empty list of values, as non-empty strings. The second one is a format string or nil. It has to return a string summarizing the list of values. COLLECT is a function called with one argument, a property name. It is called in the context of a headline and must return the collected property, or the empty string. You can use this to only collect a property if a related conditional properties is set, e.g., to return VACATION_DAYS only if CONFIRMED is true. Note that the return value can become one value for a higher-order summary, so the function is expected to handle its own output. Types defined in this variable take precedence over those defined in `org-columns-summary-types-default', which see.
org-confirm-babel-evaluate (funcall #'#[nil (t) (t)])
- Type: (choice boolean function)
- Since: Emacs version 24.1
- In file: ob-core.el
- Find modifications in git logs
Confirm before evaluation. \<org-mode-map>Require confirmation before interactively evaluating code blocks in Org buffers. The default value of this variable is t, meaning confirmation is required for any code block evaluation. This variable can be set to nil to inhibit any future confirmation requests. This variable can also be set to a function which takes two arguments the language of the code block and the body of the code block. Such a function should then return a non-nil value if the user should be prompted for execution or nil if no prompt is required. Warning: Disabling confirmation may result in accidental evaluation of potentially harmful code. It may be advisable remove code block execution from `\[org-ctrl-c-ctrl-c]' as further protection against accidental code block evaluation. The `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can be used to remove code block execution from the `\[org-ctrl-c-ctrl-c]' keybinding.
org-crypt-disable-auto-save (funcall #'#[nil ('ask) (t)])
- Type: (choice (const :tag "Always" t…
- Since: Emacs version 24.1
- In file: org-crypt.el
- Find modifications in git logs
What org-decrypt should do if `auto-save-mode' is enabled.
t : Disable `auto-save-mode' for the current buffer
prior to decrypting an entry.
nil : Leave `auto-save-mode' enabled.
This may cause data to be written to disk unencrypted!
`ask' : Ask user whether or not to disable `auto-save-mode'
for the current buffer.
`encrypt': Leave `auto-save-mode' enabled for the current buffer,
but automatically re-encrypt all decrypted entries
*before* auto-saving.
NOTE: This only works for entries which have a tag
that matches `org-crypt-tag-matcher'.
org-crypt-key (funcall #'#[nil ("") (t)])
- Type: (choice (string :tag "Public k…
- In file: org-crypt.el
- Find modifications in git logs
The default key to use when encrypting the contents of a heading. If this variable is nil, always use symmetric encryption, unconditionally. Otherwise, The string is matched against all keys in the key ring. In particular, the empty string matches no key. If no key is found, look for the `epa-file-encrypt-to' local variable. Ultimately fall back to symmetric encryption. This setting can be overridden in the CRYPTKEY property.
org-crypt-tag-matcher (funcall #'#[nil ("crypt") (t)...
- Type: string
- In file: org-crypt.el
- Find modifications in git logs
The tag matcher used to find headings whose contents should be encrypted. See the "Match syntax" section of the org manual for more details.
org-ctrl-k-protect-subtree (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Do not pr…
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Non-nil means, do not delete a hidden subtree with `C-k'. When set to the symbol `error', simply throw an error when `C-k' is used to kill (part-of) a headline that has hidden text behind it. Any other non-nil value will result in a query to the user, if it is OK to kill that hidden subtree. When nil, kill without remorse.
org-custom-properties (funcall #'#[nil (nil) (crm-se...
- Type: (repeat (string :tag "Property…
- Since: Emacs version 24.3
- In file: org.el
- Find modifications in git logs
List of properties (as strings) with a special meaning. The default use of these custom properties is to let the user hide them with `org-toggle-custom-properties-visibility'.
org-cycle-emulate-tab (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Never" ni…
- In file: org-cycle.el
- Find modifications in git logs
Where should `org-cycle' emulate TAB. nil Never white Only in completely white lines whitestart Only at the beginning of lines, before the first non-white char t Everywhere except in headlines exc-hl-bol Everywhere except at the start of a headline If TAB is used in a place where it does not emulate TAB, the current subtree visibility is cycled.
org-cycle-global-at-bob (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Cycle globally if cursor is at beginning of buffer and not at a headline. This makes it possible to do global cycling without having to use `S-TAB' or `\[universal-argument] TAB'. For this special case to work, the first line of the buffer must not be a headline -- it may be empty or some other text. When used in this way, `org-cycle-hook' is disabled temporarily to make sure the cursor stays at the beginning of the buffer. When this option is nil, don't do anything special at the beginning of the buffer.
org-cycle-hide-block-startup (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Non-nil means entering Org mode will fold all blocks. This can also be set in on a per-file basis with #+STARTUP: hideblocks #+STARTUP: nohideblocks
org-cycle-hide-drawer-startup (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Non-nil means entering Org mode will fold all drawers. This can also be set in on a per-file basis with #+STARTUP: hidedrawers #+STARTUP: nohidedrawers
org-cycle-include-plain-lists (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Never" ni…
- In file: org-list.el
- Find modifications in git logs
When t, make TAB cycle visibility on plain list items. Cycling plain lists works only when the cursor is on a plain list item. When the cursor is on an outline heading, plain lists are treated as text. This is the most stable way of handling this, which is why it is the default. When this is the symbol `integrate', then integrate plain list items when cycling, as if they were children of outline headings. This setting can lead to strange effects when switching visibility to `children', because the first "child" in a subtree decides what children should be listed. If that first "child" is a plain list item with an implied large level number, all true children and grand children of the outline heading will be exposed in a children' view.
org-cycle-level-after-item/entry-creation (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Non-nil means cycle entry level or item indentation in new empty entries. When the cursor is at the end of an empty headline, i.e., with only stars and maybe a TODO keyword, TAB will then switch the entry to become a child, and then all possible ancestor states, before returning to the original state. This makes data entry extremely fast: M-RET to create a new headline, on TAB to make it a child, two or more tabs to make it a (grand-)uncle. When the cursor is at the end of an empty plain list item, one TAB will make it a subitem, two or more tabs will back up to make this an item higher up in the item hierarchy.
org-cycle-level-faces (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-faces.el
- Find modifications in git logs
Non-nil means level styles cycle after level `org-n-level-faces'. Then so level org-n-level-faces+1 is styled like level 1. If nil, then all levels >= `org-n-level-faces' are styled like level `org-n-level-faces'.
org-cycle-link-previews-display (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Non-nil means auto display link previews under subtree when cycling.
org-cycle-max-level (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No limit"…
- In file: org-cycle.el
- Find modifications in git logs
Maximum level which should still be subject to visibility cycling. Levels higher than this will, for cycling, be treated as text, not a headline. When `org-odd-levels-only' is set, a value of N in this variable actually means 2N-1 stars as the limiting headline. When nil, cycle all levels. Note that the limiting level of cycling is also influenced by `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but `org-inlinetask-min-level' is, cycling will be limited to levels one less than its value.
org-cycle-open-archived-trees (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Non-nil means `org-cycle' will open archived trees. An archived tree is a tree marked with the tag ARCHIVE. When nil, archived trees will stay folded. You can still open them with normal outline commands like `show-all', but not with the cycling commands.
org-cycle-separator-lines (funcall #'#[nil (2) (t)])
- Type: integer
- In file: org-cycle.el
- Find modifications in git logs
Number of empty lines needed to keep an empty line between collapsed trees. If you leave an empty line between the end of a subtree and the following headline, this empty line is hidden when the subtree is folded. Org mode will leave (exactly) one empty line visible if the number of empty lines is equal or larger to the number given in this variable. So the default 2 means at least 2 empty lines after the end of a subtree are needed to produce free space between a collapsed subtree and the following headline. If the number is negative, and the number of empty lines is at least -N, all empty lines are shown. Special case: when 0, never leave empty lines in collapsed view.
org-cycle-skip-children-state-if-no-children (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-cycle.el
- Find modifications in git logs
Non-nil means skip CHILDREN state in entries that don't have any.
org-datetree-add-timestamp (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Do not ad…
- Since: Emacs version 24.3
- In file: org-datetree.el
- Find modifications in git logs
When non-nil, add a time stamp matching date of entry. Added time stamp is active unless value is `inactive'.
org-deadline-past-days (funcall #'#[nil (10000) (orig...
- Type: integer
- Since: Emacs version 26.1
- In file: org-agenda.el
- Find modifications in git logs
Number of days to warn about missed deadlines. When an item has deadline on a date, it shows up in the agenda on this day and will appear as a reminder until it is marked DONE or for the number of days given here.
org-deadline-warning-days (funcall #'#[nil (14) (crm-sep...
- Type: integer
- In file: org.el
- Find modifications in git logs
Number of days before expiration during which a deadline becomes active. This variable governs the display in sparse trees and in the agenda. When 0 or negative, it means use this number (the absolute value of it) even if a deadline has a different individual lead time specified. Custom commands can set this variable in the options section.
org-default-notes-file (funcall #'#[nil ((convert-sta...
- Type: file
- In file: org.el
- Find modifications in git logs
Default target for storing notes. Used as a fall back file for org-capture.el, for templates that do not specify a target file.
org-directory (funcall #'#[nil ("~/org") (cr...
- Type: directory
- In file: org.el
- Find modifications in git logs
Directory with Org files. This is just a default location to look for Org files. There is no need at all to put your files into this directory. It is used in the following situations: 1. When a capture template specifies a target file that is not an absolute path. The path will then be interpreted relative to `org-directory' 2. When the value of variable `org-agenda-files' is a single file, any relative paths in this file will be taken as relative to `org-directory'.
org-display-custom-times (funcall #'#[nil (nil) (crm-se...
- Type: sexp
- In file: org.el
- Find modifications in git logs
Non-nil means overlay custom formats over all time stamps. The formats are defined through the variable `org-timestamp-custom-formats'. To turn this on on a per-file basis, insert anywhere in the file: #+STARTUP: customtime
org-display-remote-inline-images (funcall #'#[nil ('skip) (org-...
- Type: (choice (const :tag "Ignore re…
- In file: ol.el
- Find modifications in git logs
How to display remote inline images.
Possible values of this option are:
skip Don't display remote images.
download Always download and display remote images.
t
cache Display remote images, and open them in separate buffers
for caching. Silently update the image buffer when a file
change is detected.
org-disputed-keys (funcall #'#[nil ('(([(shift u...
- Type: alist
- In file: org-keys.el
- Find modifications in git logs
Keys for which Org mode and other modes compete. This is an alist, cars are the default keys, second element specifies the alternative to use when `org-replace-disputed-keys' is t. Keys can be specified in any syntax supported by `define-key'. The value of this option takes effect only at Org mode startup, therefore you'll have to restart Emacs to apply it after changing.
org-ditaa-default-exec-mode (funcall #'#[nil ('jar) (t)])
- Type: (choice (const :tag "Use java …
- In file: ob-ditaa.el
- Find modifications in git logs
Method to use for ditaa diagram generation when generating png or svg output. `jar' means to use java together with a JAR. The JAR must be set via `org-ditaa-jar-path'. `ditaa' means to use the ditaa executable. The executable can be configured via `org-ditaa-exec'.
org-ditaa-eps-jar-path (funcall #'#[nil ((expand-file...
- Type: string
- Since: Emacs version 24.4
- In file: ob-ditaa.el
- Find modifications in git logs
Path to the DitaaEps.jar executable. Used when generating eps or pdf output.
org-ditaa-exec (funcall #'#[nil ("ditaa") (t)...
- Type: string
- In file: ob-ditaa.el
- Find modifications in git logs
File name of the ditaa executable.
org-ditaa-jar-path (funcall #'#[nil ((expand-file...
- Type: string
- In file: ob-ditaa.el
- Find modifications in git logs
Path to the ditaa.jar file.
org-ditaa-java-exec (funcall #'#[nil ("java") (t)]...
- Type: string
- In file: ob-ditaa.el
- Find modifications in git logs
Java executable to use when evaluating ditaa blocks using a JAR.
org-duration-format (funcall #'#[nil ('(("d") (spe...
- Type: (choice (const :tag "Use H:MM"…
- In file: org-duration.el
- Find modifications in git logs
Format definition for a duration.
The value can be set to, respectively, the symbols `h:mm:ss' or
`h:mm', which means a duration is expressed as, respectively,
a "H:MM:SS" or "H:MM" string.
Alternatively, the value can be a list of entries following the
pattern:
(UNIT . REQUIRED?)
UNIT is a unit string, as defined in `org-duration-units'. The
time duration is formatted using only the time components that
are specified here.
Units with a zero value are skipped, unless REQUIRED? is non-nil.
In that case, the unit is always used.
The list can also contain one of the following special entries:
(special . h:mm)
(special . h:mm:ss)
Units shorter than an hour are ignored. The hours and
minutes part of the duration is expressed unconditionally
with H:MM, or H:MM:SS, pattern.
(special . PRECISION)
A duration is expressed with a single unit, PRECISION being
the number of decimal places to show. The unit chosen is the
first one required or with a non-zero integer part. If there
is no such unit, the smallest one is used.
Eventually, if the list contains the symbol `compact', the
duration is expressed in a compact form, without any white space
between units.
For example,
(("d" . nil) ("h" . t) ("min" . t))
means a duration longer than a day is expressed in days, hours
and minutes, whereas a duration shorter than a day is always
expressed in hours and minutes, even when shorter than an hour.
On the other hand, the value
(("d" . nil) ("min" . nil))
means a duration longer than a day is expressed in days and
minutes, whereas a duration shorter than a day is expressed
entirely in minutes, even when longer than an hour.
The following format
(("d" . nil) (special . h:mm))
means that any duration longer than a day is expressed with both
a "d" unit and a "H:MM" part, whereas a duration shorter than
a day is expressed only as a "H:MM" string.
Eventually,
(("d" . nil) ("h" . nil) (special . 2))
expresses a duration longer than a day as a decimal number, with
a 2-digits fractional part, of "d" unit. A duration shorter
than a day uses "h" unit instead.
org-duration-units (funcall #'#[nil ((list '("min...
- Type: (choice (const :tag "H:MM" h:m…
- Since: Emacs version 26.1
- In file: org-duration.el
- Find modifications in git logs
Conversion factor to minutes for a duration.
Each entry has the form (UNIT . MODIFIER).
In a duration string, a number followed by UNIT is multiplied by
the specified number of MODIFIER to obtain a duration in minutes.
For example, the following value
\=`(("min" . 1)
("h" . 60)
("d" . ,(* 60 8))
("w" . ,(* 60 8 5))
("m" . ,(* 60 8 5 4))
("y" . ,(* 60 8 5 4 10)))
is meaningful if you work an average of 8 hours per day, 5 days
a week, 4 weeks a month and 10 months a year.
When setting this variable outside the Customize interface, make
sure to call the following command:
\[org-duration-set-regexps]
org-edit-fixed-width-region-mode (funcall #'#[nil ('artist-mode...
- Type: (choice (const artist-mode) (c…
- In file: org-src.el
- Find modifications in git logs
The mode that should be used to edit fixed-width regions. These are the regions where each line starts with a colon.
org-edit-keep-region (funcall #'#[nil ('((org-metal...
- Type: (choice (const :tag "Keep regi…
- In file: org.el
- Find modifications in git logs
Shall some Org editing commands keep region active? This variable can be nil, t, or an a list of entries like (COMMAND-NAME . KEEP-REGION-P)
org-edit-src-auto-save-idle-delay (funcall #'#[nil (0) (t)])
- Type: integer
- Since: Emacs version 24.4
- In file: org-src.el
- Find modifications in git logs
Delay before saving a source code buffer back into its base buffer. When a positive integer N, save after N seconds of idle time. When 0 (the default), don't auto-save. If you want to save the source code buffer itself, don't use this. Check `org-edit-src-turn-on-auto-save' instead.
org-edit-src-persistent-message (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-src.el
- Find modifications in git logs
Non-nil means show persistent exit help message while editing src examples. The message is shown in the header-line, which will be created in the first line of the window showing the editing buffer.
org-edit-src-turn-on-auto-save (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: org-src.el
- Find modifications in git logs
Non-nil means turn `auto-save-mode' on when editing a source block. This will save the content of the source code editing buffer into a newly created file, not the base buffer for this source block. If you want to regularly save the base buffer instead of the source code editing buffer, see `org-edit-src-auto-save-idle-delay' instead.
org-edit-timestamp-down-means-later (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means S-down will increase the time in a time stamp. When nil, S-up will increase.
org-ellipsis (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Default" …
- In file: org.el
- Find modifications in git logs
The ellipsis to use in the Org mode outline. When nil, just use the standard three dots. When a non-empty string, use that string instead. The change affects only Org mode (which will then use its own display table). Changing this requires executing `\[org-mode]' in a buffer to become effective. It cannot be set as a local variable.
org-emphasis-alist (funcall #'#[nil ('(("*" bold)...
- Type: (repeat (list (choice (const :…
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
Alist of characters and faces to emphasize text. Text starting and ending with a special character will be emphasized, for example *bold*, _underlined_ and /italic/. This variable sets the face to be used by font-lock for highlighting in Org buffers. Marker characters must be one of */_=~+. You need to reload Org or to restart Emacs after customizing this.
org-enforce-todo-checkbox-dependencies (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means unchecked boxes will block switching the parent to DONE. When this is nil, checkboxes have no influence on switching TODO states. When non-nil, you first need to check off all check boxes before the TODO entry can be switched to DONE. This variable needs to be set before org.el is loaded, and you need to restart Emacs after a change to make the change effective. The only way to change it while Emacs is running is through the customize interface.
org-enforce-todo-dependencies (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means undone TODO entries will block switching the parent to DONE. Also, if a parent has an :ORDERED: property, switching an entry to DONE will be blocked if any prior sibling is not yet done. Finally, if the parent is blocked because of ordered siblings of its own, the child will also be blocked.
org-entities-user (funcall #'#[nil (nil) (t)])
- Type: (repeat (list (string :tag "na…
- Since: Emacs version 24.1
- In file: org-entities.el
- Find modifications in git logs
User-defined entities used in Org to produce special characters.
Each entry in this list is a list of strings. It associates the name
of the entity that can be inserted into an Org file as \name with the
appropriate replacements for the different export backends. The order
of the fields is the following
name As a string, without the leading backslash.
LaTeX replacement In ready LaTeX, no further processing will take place.
LaTeX mathp Either t or nil. When t this entity needs to be in
math mode.
HTML replacement In ready HTML, no further processing will take place.
Usually this will be an &...; entity.
ASCII replacement Plain ASCII, no extensions.
Latin1 replacement Use the special characters available in latin1.
utf-8 replacement Use the special characters available in utf-8.
If you define new entities here that require specific LaTeX
packages to be loaded, add these packages to `org-latex-packages-alist'.
org-export-allow-bind-keywords (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means BIND keywords can define local variable values. This is a potential security risk, which is why the default value is nil. You can also allow them through local buffer variables.
org-export-async-init-file (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Regular s…
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
File used to initialize external export process. Value must be either nil or an absolute file name. When nil, the external process is launched like a regular Emacs session, loading user's initialization file and any site specific configuration. If a file is provided, it, and only it, is loaded at start-up. Therefore, using a specific configuration makes the process to load faster and the export more portable.
org-export-backends (funcall #'#[nil ('(ascii html...
- Type: (set :greedy t (const :tag " …
- Since: Emacs version 26.1
- In file: org.el
- Find modifications in git logs
List of export backends that should be always available.
If a description starts with <C>, the file is not part of Emacs and Org mode,
so loading it will require that you have properly installed org-contrib
package from NonGNU Emacs Lisp Package Archive
https://elpa.nongnu.org/nongnu/org-contrib.html
Unlike to `org-modules', libraries in this list will not be
loaded along with Org, but only once the export framework is
needed.
This variable needs to be set before org.el is loaded. If you
need to make a change while Emacs is running, use the customize
interface or run the following code, where VAL stands for the new
value of the variable, after updating it:
(progn
(setq org-export-registered-backends
(cl-remove-if-not
(lambda (backend)
(let ((name (org-export-backend-name backend)))
(or (memq name val)
(catch \='parentp
(dolist (b val)
(and (org-export-derived-backend-p b name)
(throw \='parentp t)))))))
org-export-registered-backends))
(let ((new-list (mapcar #\='org-export-backend-name
org-export-registered-backends)))
(dolist (backend val)
(cond
((not (load (format "ox-%s" backend) t t))
(message "Problems while trying to load export backend \=`%s\='"
backend))
((not (memq backend new-list)) (push backend new-list))))
(set-default \='org-export-backends new-list)))
Adding a backend to this list will also pull the backend it
depends on, if any.
org-export-body-only (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
The initial "Body only" setting when exporting with `org-export-dispatch'. Non-nil means only export body code, without the surrounding template.
org-export-coding-system (funcall #'#[nil (nil) (t)])
- Type: coding-system
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Coding system for the exported file.
org-export-copy-to-kill-ring (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Always" t…
- Since: Emacs version 26.1
- In file: ox.el
- Find modifications in git logs
Non-nil means pushing export output to the kill ring. This variable is ignored during asynchronous export.
org-export-creator-string (funcall #'#[nil ((format "Ema...
- Type: (string :tag "Creator string")
- In file: ox.el
- Find modifications in git logs
Information about the creator of the document. This option can also be set on with the CREATOR keyword.
org-export-date-timestamp-format (funcall #'#[nil (nil) (t)])
- Type: (choice (string :tag "Timestam…
- In file: ox.el
- Find modifications in git logs
Timestamp format string to use for DATE keyword. The format string, when specified, only applies if date consists in a single timestamp. Otherwise its value will be ignored. See `format-time-string' for details on how to build this string.
org-export-default-language (funcall #'#[nil ("en") (t)])
- Type: (string :tag "Language")
- In file: ox.el
- Find modifications in git logs
The default language for export and clocktable translations, as a string. This may have an association in `org-clock-clocktable-language-setup', `org-export-smart-quotes-alist' and `org-export-dictionary'. This option can also be set with the LANGUAGE keyword.
org-export-dispatch-use-expert-ui (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means using a non-intrusive `org-export-dispatch'.
In that case, no help buffer is displayed. Though, an indicator
for current export scope is added to the prompt ("b" when
output is restricted to body only, "s" when it is restricted to
the current subtree, "v" when only visible elements are
considered for export, "f" when publishing functions should be
passed the FORCE argument and "a" when the export should be
asynchronous). Also, [?] allows switching back to standard
mode.
org-export-expand-links (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
When non-nil, expand environment variables in file paths.
org-export-force-publishing (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
The initial "Force publishing" setting for `org-export-dispatch'. Non-nil means force all files in the project to be published.
org-export-global-macros (funcall #'#[nil (nil) (t)])
- Type: (repeat (cons (string :tag "Na…
- Since: Emacs version 26.1
- In file: ox.el
- Find modifications in git logs
Alist between macro names and expansion templates. This variable defines macro expansion templates available globally. Associations follow the pattern (NAME . TEMPLATE) where NAME is a string beginning with a letter and consisting of alphanumeric characters only. TEMPLATE is the string to which the macro is going to be expanded. Inside, "$1", "$2"... are place-holders for macro's arguments. Moreover, if the template starts with "(eval", it will be parsed as an Elisp expression and evaluated accordingly.
org-export-headline-levels (funcall #'#[nil (3) (t)])
- Type: integer
- In file: ox.el
- Find modifications in git logs
This level and its ancestors will be exported as a headline. Descendants of this level will usually produce itemized or enumerated lists when exported, but backend behavior may differ. This option can also be set with the OPTIONS keyword, e.g. "H:2".
org-export-in-background (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means export and publishing commands will run in background. Results from an asynchronous export are never displayed automatically. But you can retrieve them with `\[org-export-stack]'.
org-export-initial-scope (funcall #'#[nil ('buffer) (t)...
- Type: (choice (const :tag "Export cu…
- In file: ox.el
- Find modifications in git logs
The initial scope when exporting with `org-export-dispatch'. This variable can be either set to `buffer' or `subtree'.
org-export-preserve-breaks (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means preserve all line breaks when exporting. This option can also be set with the OPTIONS keyword, e.g. "\n:t".
org-export-process-citations (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means process citations using citation processors. nil will leave citation processing to export backend.
org-export-replace-macros (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
When non-nil, replace macros before export.
This variable does not affect {{{results}}} macros when processing
code block results.
org-export-show-temporary-export-buffer (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means show buffer after exporting to temp buffer. When Org exports to a file, the buffer visiting that file is never shown, but remains buried. However, when exporting to a temporary buffer, that buffer is popped up in a second window. When this variable is nil, the buffer remains buried also in these cases.
org-export-smart-quotes-alist (funcall #'#[nil ('(("ar" (pri...
- Type: (alist :key-type (string :tag …
- In file: ox.el
- Find modifications in git logs
Smart quotes translations. Alist whose CAR is a language string and CDR is an alist with quote type as key and a plist associating various encodings to their translation as value. A quote type can be any symbol among `primary-opening', `primary-closing', `secondary-opening', `secondary-closing' and `apostrophe'. Valid encodings include `:utf-8', `:html', `:latex' and `:texinfo'. If no translation is found, the quote character is left as-is.
org-export-snippet-translation-alist (funcall #'#[nil (nil) (t)])
- Type: (repeat (cons (string :tag "Sh…
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Alist between export snippets backends and exporter backends.
This variable allows providing shortcuts for export snippets.
For example, with:
(setq org-export-snippet-translation-alist
\='(("h" . "html")))
the HTML backend will recognize the contents of "@@h:<b>@@" as
HTML code while every other backend will ignore it.
org-export-timestamp-file (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means insert a time stamp into the exported file. The time stamp shows when the file was created. This option can also be set with the OPTIONS keyword, e.g. "timestamp:nil".
org-export-use-babel (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Never" ni…
- Since: Emacs version 24.1
- In file: ob-exp.el
- Find modifications in git logs
Switch controlling code evaluation and header processing during export. When set to nil no code will be evaluated as part of the export process and no header arguments will be obeyed. Users who wish to avoid evaluating code on export should use the header argument `:eval never-export'.
org-export-visible-only (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
The initial "Visible only" setting when exporting with `org-export-dispatch'. Non-nil means don't export the contents of hidden elements.
org-export-with-archived-trees (funcall #'#[nil ('headline) (...
- Type: (choice (const :tag "Not at al…
- In file: ox.el
- Find modifications in git logs
Whether sub-trees with the ARCHIVE tag should be exported. This can have three different values: nil Do not export, pretend this tree is not present. t Do export the entire tree. `headline' Only export the headline, but skip the tree below it. This option can also be set with the OPTIONS keyword, e.g. "arch:nil".
org-export-with-broken-links (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Ignore br…
- Since: Emacs version 26.1
- In file: ox.el
- Find modifications in git logs
Non-nil means do not raise an error on broken links. When this variable is non-nil, broken links are ignored, without stopping the export process. If it is set to `mark', broken links are marked as such in the output, with a string like [BROKEN LINK: path] where PATH is the un-resolvable reference. This option can also be set with the OPTIONS keyword, e.g., "broken-links:mark".
org-export-with-clocks (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means export CLOCK keywords. This option can also be set with the OPTIONS keyword, e.g. "c:t".
org-export-with-creator (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 26.1
- In file: ox.el
- Find modifications in git logs
Non-nil means the postamble should contain a creator sentence. The sentence can be set in `org-export-creator-string', which see. This option can also be set with the OPTIONS keyword, e.g., "creator:t".
org-export-with-date (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means insert date in the exported document. This option can also be set with the OPTIONS keyword, e.g. "date:nil".
org-export-with-drawers (funcall #'#[nil ('(not "LOGBO...
- Type: (choice (const :tag "All drawe…
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means export contents of standard drawers. When t, all drawers are exported. This may also be a list of drawer names to export, as strings. If that list starts with `not', only drawers with such names will be ignored. This variable doesn't apply to properties drawers. See `org-export-with-properties' instead. This option can also be set with the OPTIONS keyword, e.g. "d:nil".
org-export-with-email (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means insert author email into the exported file. This option can also be set with the OPTIONS keyword, e.g. "email:t".
org-export-with-emphasize (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means interpret *word*, /word/, _word_ and +word+. If the export target supports emphasizing text, the word will be typeset in bold, italic, with an underline or strike-through, respectively. This option can also be set with the OPTIONS keyword, e.g. "*:nil".
org-export-with-entities (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means interpret entities when exporting. For example, HTML export converts \alpha to α and \AA to Å. For a list of supported names, see the constant `org-entities' and the user option `org-entities-user'. This option can also be set with the OPTIONS keyword, e.g. "e:nil".
org-export-with-fixed-width (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means export lines starting with ":". This option can also be set with the OPTIONS keyword, e.g. "::nil".
org-export-with-footnotes (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means Org footnotes should be exported. This option can also be set with the OPTIONS keyword, e.g. "f:nil".
org-export-with-inlinetasks (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means inlinetasks should be exported. This option can also be set with the OPTIONS keyword, e.g. "inline:nil".
org-export-with-latex (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Do not pr…
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means process LaTeX environments and fragments. This option can also be set with the OPTIONS line, e.g. "tex:verbatim". Allowed values are: nil Ignore math snippets. `verbatim' Keep everything in verbatim. t Allow export of math snippets.
org-export-with-planning (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means include planning info in export. Planning info is the line containing either SCHEDULED:, DEADLINE:, CLOSED: timestamps, or a combination of them. This option can also be set with the OPTIONS keyword, e.g. "p:t".
org-export-with-priority (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means include priority cookies in export. This option can also be set with the OPTIONS keyword, e.g. "pri:t".
org-export-with-properties (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "All prope…
- Since: Emacs version 26.1
- In file: ox.el
- Find modifications in git logs
Non-nil means export contents of properties drawers. When t, all properties are exported. This may also be a list of properties to export, as strings. This option can also be set with the OPTIONS keyword, e.g. "prop:t".
org-export-with-section-numbers (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means add section numbers to headlines when exporting. When set to an integer n, numbering will only happen for headlines whose relative level is higher or equal to n. This option can also be set with the OPTIONS keyword, e.g. "num:t".
org-export-with-smart-quotes (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means activate smart quotes during export.
This option can also be set with the OPTIONS keyword,
e.g., "\=':t".
When setting this to non-nil, you need to take care of
using the correct Babel package when exporting to LaTeX.
E.g., you can load Babel for french like this:
#+LATEX_HEADER: \usepackage[french]{babel}
org-export-with-special-strings (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means interpret "\-", "--" and "---" for export. When this option is turned on, these strings will be exported as: Org HTML LaTeX UTF-8 -----+----------+--------+------- \- ­ \- -- – -- – --- — --- — ... … \ldots … This option can also be set with the OPTIONS keyword, e.g. "-:nil".
org-export-with-sub-superscripts (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Interpret…
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means interpret "_" and "^" for export. If you want to control how Org displays those characters, see `org-use-sub-superscripts'. When this option is turned on, you can use TeX-like syntax for sub- and superscripts and see them exported correctly. You can also set the option with #+OPTIONS: ^:t See `org-use-sub-superscripts' docstring for more details.
org-export-with-tables (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ox.el
- Find modifications in git logs
Non-nil means export tables. This option can also be set with the OPTIONS keyword, e.g. "|:nil".
org-export-with-tasks (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "All tasks…
- In file: ox.el
- Find modifications in git logs
Non-nil means include TODO items for export. This may have the following values: t include tasks independent of state. `todo' include only tasks that are not yet done. `done' include only tasks that are already done. nil ignore all tasks. list of keywords include tasks with these keywords. This option can also be set with the OPTIONS keyword, e.g. "tasks:nil".
org-export-with-timestamps (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "All times…
- In file: ox.el
- Find modifications in git logs
Non-nil means allow timestamps in export. It can be set to any of the following values: t export all timestamps. `active' export active timestamps, including diary timestamps. `active-exclude-diary' export active timestamps, excluding diary timestamps. `inactive' export inactive timestamps only. nil do not export timestamps This only applies to timestamps isolated in a paragraph containing only timestamps. Other timestamps are always exported. This option can also be set with the OPTIONS keyword, e.g. "<:nil".
org-export-with-title (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 26.1
- In file: ox.el
- Find modifications in git logs
Non-nil means print title into the exported file. This option can also be set with the OPTIONS keyword, e.g. "title:nil".
org-export-with-toc (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "No Table …
- In file: ox.el
- Find modifications in git logs
Non-nil means create a table of contents in exported files. The table of contents contains headlines with levels up to `org-export-headline-levels'. When this variable is set to an integer N, include levels up to N in the table of contents. Although it may then be different from `org-export-headline-levels', it is cannot be larger than the number of headline levels. When nil, no table of contents is created. This option can also be set with the OPTIONS keyword, e.g. "toc:nil" or "toc:3".
org-export-with-todo-keywords (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox.el
- Find modifications in git logs
Non-nil means include TODO keywords in export. When nil, remove all these keywords from the export. This option can also be set with the OPTIONS keyword, e.g. "todo:nil".
org-extend-today-until (funcall #'#[nil (0) (crm-sepa...
- Type: integer
- In file: org.el
- Find modifications in git logs
The hour when your day really ends. Must be an integer. This has influence for the following applications: - When switching the agenda to "today". If it is still earlier than the time given here, the day recognized as TODAY is actually yesterday. - When a date is read from the user and it is still before the time given here, the current date and time will be assumed to be yesterday, 23:59. Also, timestamps inserted in capture templates follow this rule. IMPORTANT: This is a feature whose implementation is and likely will remain incomplete. Really, it is only here because past midnight seems to be the favorite working time of John Wiegley :-)
org-faces-easy-properties (funcall #'#[nil ('((todo . :f...
- Type: (repeat (cons (choice (const t…
- Since: Emacs version 24.1
- In file: org-faces.el
- Find modifications in git logs
The property changes by easy faces. This is an alist, the keys show the area of application, the values can be `:foreground' or `:background'. A color string for special keywords will then be interpreted as either foreground or background color.
org-fast-tag-selection-single-key (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "No" nil) …
- In file: org.el
- Find modifications in git logs
Non-nil means fast tag selection exits after first change. When nil, you have to press RET to exit it. During fast tag selection, you can toggle this flag with `C-c'. This variable can also have the value `expert'. In this case, the window displaying the tags menu is not even shown, until you press `C-c' again.
org-feed-alist (funcall #'#[nil (nil) (t)])
- Type: (repeat (list :value ("" "http…
- In file: org-feed.el
- Find modifications in git logs
Alist specifying RSS feeds that should create inputs for Org.
Each entry in this list specified an RSS feed that should be queried
to create inbox items in Org. Each entry is a list with the following items:
name a custom name for this feed
URL the Feed URL
file the target Org file where entries should be listed, when
nil the target becomes the current buffer (may be an
indirect buffer) each time the feed update is invoked
headline the headline under which entries should be listed
Additional arguments can be given using keyword-value pairs. Many of these
specify functions that receive one or a list of "entries" as their single
argument. An entry is a property list that describes a feed item. The
property list has properties for each field in the item, for example `:title'
for the `<title>' field and `:pubDate' for the publication date. In addition,
it contains the following properties:
`:item-full-text' the full text in the <item> tag
`:guid-permalink' t when the guid property is a permalink
Here are the keyword-value pair allows in `org-feed-alist'.
:drawer drawer-name
The name of the drawer for storing feed information. The default is
"FEEDSTATUS". Using different drawers for different feeds allows
several feeds to target the same inbox heading.
:filter filter-function
A function to select interesting entries in the feed. It gets a single
entry as parameter. It should return the entry if it is relevant, or
nil if it is not.
:template template-string
The default action on new items in the feed is to add them as children
under the headline for the feed. The template describes how the entry
should be formatted. If not given, it defaults to
`org-feed-default-template'.
:formatter formatter-function
Instead of relying on a template, you may specify a function to format
the outline node to be inserted as a child. This function gets passed
a property list describing a single feed item, and it should return a
string that is a properly formatted Org outline node of level 1.
:new-handler function
If adding new items as children to the outline is not what you want
to do with new items, define a handler function that is called with
a list of all new items in the feed, each one represented as a property
list. The handler should do what needs to be done, and org-feed will
mark all items given to this handler as "handled", i.e. they will not
be passed to this handler again in future readings of the feed.
When the handler is called, point will be at the feed headline.
:changed-handler function
This function gets passed a list of all entries that have been
handled before, but are now still in the feed and have *changed*
since last handled (as evidenced by a different sha1 hash).
When the handler is called, point will be at the feed headline.
:parse-feed function
This function gets passed a buffer, and should return a list
of entries, each being a property list containing the
`:guid' and `:item-full-text' keys. The default is
`org-feed-parse-rss-feed'; `org-feed-parse-atom-feed' is an
alternative.
:parse-entry function
This function gets passed an entry as returned by the parse-feed
function, and should return the entry with interesting properties added.
The default is `org-feed-parse-rss-entry'; `org-feed-parse-atom-entry'
is an alternative.
org-feed-default-template (funcall #'#[nil ("\n* %h\n %...
- Type: (string :tag "Template")
- In file: org-feed.el
- Find modifications in git logs
Template for the Org node created from RSS feed items.
This is just the default, each feed can specify its own.
Any fields from the feed item can be interpolated into the template with
%name, for example %title, %description, %pubDate etc. In addition, the
following special escapes are valid as well:
%h The title, or the first line of the description
%t The date as a stamp, either from <pubDate> (if present), or
the current date
%T Date and time
%u,%U Like %t,%T, but inactive time stamps
%a A link, from <guid> if that is a permalink, else from <link>
%(sexp) Evaluate elisp `(sexp)' and replace with the result, the simple
%-escapes above can be used as arguments, e.g. %(capitalize \"%h\")
org-feed-drawer (funcall #'#[nil ("FEEDSTATUS"...
- Type: (string :tag "Drawer Name")
- In file: org-feed.el
- Find modifications in git logs
The name of the drawer for feed status information. Each feed may also specify its own drawer name using the `:drawer' parameter in `org-feed-alist'.
org-feed-retrieve-method (funcall #'#[nil ('url-retriev...
- Type: (choice (const :tag "Internall…
- In file: org-feed.el
- Find modifications in git logs
The method to be used to retrieve a feed URL. This can be `curl' or `wget' to call these external programs, or it can be an Emacs Lisp function that will return a buffer containing the content of the file pointed to by the URL.
org-feed-save-after-adding (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-feed.el
- Find modifications in git logs
Non-nil means save buffer after adding new feed items.
org-file-apps (funcall #'#[nil ('((auto-mode...
- Type: (repeat (cons (choice :value "…
- In file: org.el
- Find modifications in git logs
Applications for opening `file:path' items in a document.
\<org-mode-map>
Org mode uses system defaults for different file types, but you
can use this variable to set the application for a given file
extension. The entries in this list are cons cells where the car
identifies files and the cdr the corresponding command.
Possible values for the file identifier are:
"string" A string as a file identifier can be interpreted in different
ways, depending on its contents:
- Alphanumeric characters only:
Match links with this file extension.
Example: ("pdf" . "evince %s")
to open PDFs with evince.
- Regular expression: Match links where the
filename matches the regexp. If you want to
use groups here, use shy groups.
Example: ("\\.x?html\\\='" . "firefox %s")
("\\(?:xhtml\\|html\\)\\\='" . "firefox %s")
to open *.html and *.xhtml with firefox.
- Regular expression which contains (non-shy) groups:
Match links where the whole link, including "::", and
anything after that, matches the regexp.
In a custom command string, %1, %2, etc. are replaced with
the parts of the link that were matched by the groups.
For backwards compatibility, if a command string is given
that does not use any of the group matches, this case is
handled identically to the second one (i.e. match against
file name only).
In a custom function, you can access the group matches with
(match-string n link).
Example: ("\\.pdf::\\([0-9]+\\)\\\='" . "evince -p %1 %s")
to open [[file:document.pdf::5]] with evince at page 5.
Likely, you will need more entries: without page
number; with search pattern; with
cross-reference anchor; some combination of
options. Consider simple pattern here and a
Lisp function to determine command line
arguments instead. Passing an argument list to
`call-process' or `make-process' directly avoids
treating some character in peculiar file names
as shell specials that prompt parts of said file
names to be executed as subcommands.
`directory' Matches a directory
`remote' Matches a remote file, accessible through tramp.
Remote files most likely should be visited through Emacs
because external applications cannot handle such paths.
`auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
so all files Emacs knows how to handle. Using this with
command `emacs' will open most files in Emacs. Beware that this
will also open html files inside Emacs, unless you add
("html" . default) to the list as well.
`system' The system command to open files, like `open' on Windows
and macOS, and mailcap under GNU/Linux. This is the command
that will be selected if you call `org-open-at-point' with a
double prefix argument (`\[universal-argument] \[universal-argument] \[org-open-at-point]').
t Default for files not matched by any of the other options.
Possible values for the command are:
`emacs' The file will be visited by the current Emacs process.
`default' Use the default application for this file type, which is the
association for t in the list, most likely in the system-specific
part. This can be used to overrule an unwanted setting in the
system-specific variable.
`system' Use the system command for opening files, like "open".
This command is specified by the entry whose car is `system'.
Most likely, the system-specific version of this variable
does define this command, but you can overrule/replace it
here.
`mailcap' Use command specified in the mailcaps.
string A command to be executed by a shell; %s will be replaced
by the path to the file.
function A Lisp function, which will be called with two arguments:
the file path and the original link string, without the
"file:" prefix.
For more examples, see the system specific constants
`org-file-apps-macos'
`org-file-apps-windowsnt'
`org-file-apps-gnu'.
org-fold-catch-invisible-edits (funcall #'#[nil ('smart) (org...
- Type: (choice (const :tag "Do not ch…
- Since: Emacs version 24.1
- In file: org-fold.el
- Find modifications in git logs
Check if in invisible region before inserting or deleting a character.
Valid values are:
nil Do not check, so just do invisible edits.
error Throw an error and do nothing.
show Make point visible, and do the requested edit.
show-and-error Make point visible, then throw an error and abort the edit.
smart Make point visible, and do insertion/deletion if it is
adjacent to visible text and the change feels predictable.
Never delete a previously invisible character or add in the
middle or right after an invisible region. Basically, this
allows insertion and backward-delete right before ellipses.
FIXME: maybe in this case we should not even show?
This variable only affects commands listed in
`org-fold-catch-invisible-edits-commands'.
org-fold-catch-invisible-edits-commands (funcall #'#[nil ('((org-self-...
- Type: (alist :key-type symbol :value…
- In file: org-fold.el
- Find modifications in git logs
Alist of commands where Org checks for invisible edits. Each element is (COMMAND . KIND), where COMMAND is symbol representing command as stored in `this-command' and KIND is symbol `insert', symbol `delete', or symbol `delete-backward'. The checks are performed around `point'. This variable must be set before loading Org in order to take effect. Also, see `org-fold-catch-invisible-edits'.
org-fold-core-style (funcall #'#[nil ((if (version...
- Type: (choice (const :tag "Overlays"…
- In file: org-fold-core.el
- Find modifications in git logs
Internal implementation detail used to hide folded text. Can be either `text-properties' or `overlays'. The former is faster on large files in Emacs <29, while the latter is generally less error-prone with regard to third-party packages. Important: This variable must be set before loading Org.
org-fold-show-context-detail (funcall #'#[nil ('((agenda . ...
- Type: (choice (const :tag "Canonical…
- Since: Emacs version 26.1
- In file: org-fold.el
- Find modifications in git logs
Alist between context and visibility span when revealing a location.
\<org-mode-map>Some actions may move point into invisible
locations. As a consequence, Org always exposes a neighborhood
around point. How much is shown depends on the initial action,
or context. Valid contexts are
agenda when exposing an entry from the agenda
org-goto when using the command `org-goto' (`\[org-goto]')
occur-tree when using the command `org-occur' (`\[org-sparse-tree] /')
tags-tree when constructing a sparse tree based on tags matches
link-search when exposing search matches associated with a link
mark-goto when exposing the jump goal of a mark
bookmark-jump when exposing a bookmark location
isearch when exiting from an incremental search
default default for all contexts not set explicitly
Allowed visibility spans are
minimal show current headline; if point is not on headline,
also show entry
local show current headline, entry and next headline
ancestors show current headline and its direct ancestors; if
point is not on headline, also show entry
ancestors-full show current subtree and its direct ancestors
lineage show current headline, its direct ancestors and all
their children; if point is not on headline, also show
entry and first child
tree show current headline, its direct ancestors and all
their children; if point is not on headline, also show
entry and all children
canonical show current headline, its direct ancestors along with
their entries and children; if point is not located on
the headline, also show current entry and all children
As special cases, a nil or t value means show all contexts in
`minimal' or `canonical' view, respectively.
Some views can make displayed information very compact, but also
make it harder to edit the location of the match. In such
a case, use the command `org-fold-reveal' (`\[org-fold-reveal]') to show
more context.
org-fontify-done-headline (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means change the face of a headline if it is marked DONE. Normally, only the TODO/DONE keyword indicates the state of a headline. When this is non-nil, the headline after the keyword is set to the `org-headline-done' as an additional indication.
org-fontify-emphasized-text (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means fontify *bold*, /italic/ and _underlined_ text. Changing this variable requires a restart of Emacs to take effect.
org-fontify-quote-and-verse-blocks (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-faces.el
- Find modifications in git logs
Non-nil means, add a special face to #+begin_quote and #+begin_verse block. When nil, format these as normal Org. This is the default, because the content of these blocks will still be treated as Org syntax.
org-fontify-todo-headline (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means change the face of a headline if it is marked as TODO. Normally, only the TODO/DONE keyword indicates the state of a headline. When this is non-nil, the headline after the keyword is set to the `org-headline-todo' as an additional indication.
org-fontify-whole-block-delimiter-line (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means fontify the whole line for begin/end lines of blocks. This is useful when setting a background color for the org-block-begin-line and org-block-end-line faces.
org-fontify-whole-heading-line (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means fontify the whole line for headings. This is useful when setting a background color for the org-level-* faces.
org-footnote-auto-adjust (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No adjust…
- In file: org-footnote.el
- Find modifications in git logs
Non-nil means automatically adjust footnotes after insert/delete. When this is t, after each insertion or deletion of a footnote, simple fn:N footnotes will be renumbered, and all footnotes will be sorted. If you want to have just sorting or just renumbering, set this variable to `sort' or `renumber'. The main values of this variable can be set with in-buffer options: #+STARTUP: fnadjust #+STARTUP: nofnadjust
org-footnote-auto-label (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Prompt fo…
- In file: org-footnote.el
- Find modifications in git logs
Non-nil means define automatically new labels for footnotes.
Possible values are:
nil Prompt the user for each label.
t Create unique labels of the form [fn:1], [fn:2], etc.
anonymous Create anonymous footnotes
confirm Like t, but let the user edit the created value.
The label can be removed from the minibuffer to create
an anonymous footnote.
random Automatically generate a unique, random label.
org-footnote-define-inline (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-footnote.el
- Find modifications in git logs
Non-nil means define footnotes inline, at reference location. When nil, footnotes will be defined in a special section near the end of the document. When t, the [fn:label:definition] notation will be used to define the footnote at the reference position.
org-footnote-fill-after-inline-note-extraction (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-footnote.el
- Find modifications in git logs
Non-nil means fill paragraphs after extracting footnotes. When extracting inline footnotes, the lengths of lines can change a lot. When this option is set, paragraphs from which an inline footnote has been extracted will be filled again.
org-footnote-section (funcall #'#[nil ("Footnotes")...
- Type: (choice (string :tag "Collect …
- In file: org-footnote.el
- Find modifications in git logs
Outline heading containing footnote definitions. This can be nil, to place footnotes locally at the end of the current outline node. It can also be a string representing the name of a special outline heading under which footnotes should be put. This variable defines the place where Org puts the definition automatically, i.e. when creating the footnote, and when sorting the notes. However, by hand, you may place definitions *anywhere*. If this is a string, during export, all subtrees starting with this heading will be ignored. If you don't use the customize interface to change this variable, you will need to run the following command after the change: `\[universal-argument] \[org-element-cache-reset]'
org-format-latex-header (funcall #'#[nil ("\\documentc...
- Type: string
- In file: org.el
- Find modifications in git logs
The document header used for processing LaTeX fragments. It is imperative that this header make sure that no page number appears on the page. The package defined in the variables `org-latex-default-packages-alist' and `org-latex-packages-alist' will either replace the placeholder "[PACKAGES]" in this header, or they will be appended.
org-format-latex-options (funcall #'#[nil ('(:foregroun...
- Type: plist
- In file: org.el
- Find modifications in git logs
Options for creating images from LaTeX fragments.
This is a property list with the following properties:
:foreground the foreground color for images embedded in Emacs, e.g. "Black".
`default' means use the foreground of the default face.
`auto' means use the foreground from the text face.
:background the background color, or "Transparent".
`default' means use the background of the default face.
`auto' means use the background from the text face.
:scale a scaling factor for the size of the images, to get more pixels
:html-foreground, :html-background, :html-scale
the same numbers for HTML export.
:matchers a list indicating which matchers should be used to
find LaTeX fragments. Valid members of this list are:
"begin" find environments
"$1" find single characters surrounded by $.$
"$" find math expressions surrounded by $...$
"$$" find math expressions surrounded by $$....$$
"\(" find math expressions surrounded by \(...\)
"\=\[" find math expressions surrounded by \=\[...\]
org-format-latex-signal-error (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Non-nil means signal an error when image creation of LaTeX snippets fails. When nil, just push out a message.
org-global-properties (funcall #'#[nil (nil) (crm-se...
- Type: (repeat (cons (string :tag "Pr…
- In file: org.el
- Find modifications in git logs
List of property/value pairs that can be inherited by any entry. This list will be combined with the constant `org-global-properties-fixed'. The entries in this list are cons cells where the car is a property name and cdr is a string with the value. Buffer local properties are added either by a document property drawer :PROPERTIES: :NAME: VALUE :END: or by adding lines like #+PROPERTY: NAME VALUE
org-gnus-no-server (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: ol-gnus.el
- Find modifications in git logs
Should Gnus be started using `gnus-no-server'?
org-gnus-prefer-web-links (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ol-gnus.el
- Find modifications in git logs
If non-nil, `org-store-link' creates web links to Google groups. \<org-mode-map>When nil, Gnus will be used for such links. Using a prefix argument to the command `\[org-store-link]' (`org-store-link') negates this setting for the duration of the command.
org-goto-auto-isearch (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-goto.el
- Find modifications in git logs
Non-nil means typing characters in `org-goto' starts incremental search. When nil, you can use these keybindings to navigate the buffer: q Quit the Org Goto interface n Go to the next visible heading p Go to the previous visible heading f Go one heading forward on same level b Go one heading backward on same level u Go one heading up
org-goto-interface (funcall #'#[nil ('outline) (t...
- Type: (choice (const :tag "Outline" …
- In file: org-goto.el
- Find modifications in git logs
The default interface to be used for `org-goto'. Allowed values are: `outline' The interface shows an outline of the relevant file and the correct heading is found by moving through the outline or by searching with incremental search. `outline-path-completion' Headlines in the current buffer are offered via completion. This is the interface also used by the refile command.
org-goto-max-level (funcall #'#[nil (5) (t)])
- Type: integer
- In file: org-goto.el
- Find modifications in git logs
Maximum target level when running `org-goto' with refile interface.
org-habit-completed-glyph (funcall #'#[nil (42) (t)])
- Type: character
- Since: Emacs version 24.1
- In file: org-habit.el
- Find modifications in git logs
Glyph character used to show completed days on which a task was done.
org-habit-following-days (funcall #'#[nil (7) (t)])
- Type: integer
- In file: org-habit.el
- Find modifications in git logs
Number of days after today to appear in consistency graphs.
org-habit-graph-column (funcall #'#[nil (40) (t)])
- Type: integer
- In file: org-habit.el
- Find modifications in git logs
The absolute column at which to insert habit consistency graphs. Note that consistency graphs will overwrite anything else in the buffer.
org-habit-preceding-days (funcall #'#[nil (21) (t)])
- Type: integer
- In file: org-habit.el
- Find modifications in git logs
Number of days before today to appear in consistency graphs.
org-habit-scheduled-past-days (funcall #'#[nil (nil) (t)])
- Type: (choice integer (const nil))
- In file: org-habit.el
- Find modifications in git logs
Value to use instead of `org-scheduled-past-days', for habits only. If nil, `org-scheduled-past-days' is used. Setting this to say 10000 is a way to make habits always show up as a reminder, even if you set `org-scheduled-past-days' to a small value because you regard scheduled items as a way of "turning on" TODO items on a particular date, rather than as a means of creating calendar-based reminders.
org-habit-show-all-today (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-habit.el
- Find modifications in git logs
If non-nil, show the consistency graph of all habits on today's agenda, even if they are not scheduled.
org-habit-show-done-always-green (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-habit.el
- Find modifications in git logs
Non-nil means DONE days will always be green in the consistency graph. It will be green even if it was done after the deadline.
org-habit-show-habits (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-habit.el
- Find modifications in git logs
If non-nil, show habits in agenda buffers.
org-habit-show-habits-only-for-today (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-habit.el
- Find modifications in git logs
If non-nil, only show habits on today's agenda, and not for future days. Note that even when shown for future days, the graph is always relative to the current effective date.
org-habit-today-glyph (funcall #'#[nil (33) (t)])
- Type: character
- Since: Emacs version 24.1
- In file: org-habit.el
- Find modifications in git logs
Glyph character used to identify today.
org-hide-emphasis-markers (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means font-lock should hide the emphasis marker characters.
org-hide-leading-stars (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means hide the first N-1 stars in a headline. This works by using the face `org-hide' for these stars. This face is white for a light background, and black for a dark background. You may have to customize the face `org-hide' to make this work. Changing it requires restart of `font-lock-mode' to become effective also in regions already fontified. You may also set this on a per-file basis by adding one of the following lines to the buffer: #+STARTUP: hidestars #+STARTUP: showstars
org-hide-macro-markers (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means font-lock should hide the brackets marking macro calls.
org-hierarchical-todo-statistics (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means TODO statistics covers just direct children. When nil, all entries in the subtree are considered. This has only an effect if `org-provide-todo-statistics' is set. To set this to nil for only a single subtree, use a COOKIE_DATA property and include the word "recursive" into the value.
org-highlight-links (funcall #'#[nil ('(bracket an...
- Type: (set :greedy t (const :tag "Do…
- In file: org.el
- Find modifications in git logs
Types of links that should be highlighted in Org files.
This is a list of symbols, each one of them leading to the
highlighting of a certain link type.
You can still open links that are not highlighted.
In principle, it does not hurt to turn on highlighting for all
link types. There may be a small gain when turning off unused
link types. The types are:
bracket The recommended [[link][description]] or [[link]] links with hiding.
angle Links in angular brackets that may contain whitespace like
<bbdb:Carsten Dominik>.
plain Plain links in normal text, no whitespace, like https://gnu.org.
radio Text that is matched by a radio target, see manual for details.
tag Tag settings in a headline (link to tag search).
date Time stamps (link to calendar).
footnote Footnote labels.
If you set this variable during an Emacs session, use `org-mode-restart'
in the Org buffer so that the change takes effect.
org-highlight-sparse-tree-matches (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means highlight all matches that define a sparse tree. The highlights will automatically disappear the next time the buffer is changed by an edit command. Must be non-nil to traverse the sparse tree using `next-error'.
org-html-allow-name-attribute-in-anchors (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
When nil, do not set "name" attribute in anchors. By default, when appropriate, anchors are formatted with "id" but without "name" attribute.
org-html-checkbox-type (funcall #'#[nil ('ascii) (htm...
- Type: (choice (const :tag "ASCII cha…
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
The type of checkboxes to use for HTML export. See `org-html-checkbox-types' for the values used for each option.
org-html-coding-system (funcall #'#[nil ('utf-8) (htm...
- Type: coding-system
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Coding system for HTML export. Use utf-8 as the default value.
org-html-container-element (funcall #'#[nil ("div") (html...
- Type: string
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
HTML element to use for wrapping top level sections. Can be set with the in-buffer HTML_CONTAINER property or for publishing, with :html-container. Note that changing the default will prevent you from using org-info.js for your website.
org-html-content-class (funcall #'#[nil ("content") (...
- Type: string
- Since: Emacs version 27.2
- In file: ox-html.el
- Find modifications in git logs
CSS class name to use for the top level content wrapper. Can be set with the in-buffer HTML_CONTENT_CLASS property or for publishing, with :html-content-class.
org-html-creator-string (funcall #'#[nil ((format "<a ...
- Type: (string :tag "Creator string")
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Information about the creator of the HTML document. This option can also be set on with the CREATOR keyword.
org-html-datetime-formats (funcall #'#[nil ('("%F" . "%F...
- Type: (cons string string)
- In file: ox-html.el
- Find modifications in git logs
Formats used for the timestamp added as metadata to the time HTML element. This only has an effect when `org-html-html5-fancy' is enabled, but does not affect how the timestamp is displayed. The format in CAR represents the timestamp used for timestamps without a time component, CDR the one for the full date and time. Note that the HTML standard restricts what timestamp formats are considered valid for the datetime attribute. See `format-time-string' for more information on its components.
org-html-divs (funcall #'#[nil ('((preamble ...
- Type: (list :greedy t (list :tag "Pr…
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Alist of the three section elements for HTML export. The car of each entry is one of `preamble', `content' or `postamble'. The cdrs of each entry are the ELEMENT_TYPE and ID for each section of the exported document. Note that changing the default will prevent you from using org-info.js for your website.
org-html-doctype (funcall #'#[nil ("xhtml-stric...
- Type: (choice (const "html4-strict")…
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Document type definition to use for exported HTML files. Can be set with the in-buffer HTML_DOCTYPE property or for publishing, with :html-doctype.
org-html-equation-reference-format (funcall #'#[nil ("\\eqref{%s}...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The MathJax command to use when referencing equations.
This is a format control string that expects a single string argument
specifying the label that is being referenced. The argument is
generated automatically on export.
The default is to wrap equations in parentheses (using "\eqref{%s})".
Most common values are:
\eqref{%s} Wrap the equation in parentheses
\ref{%s} Do not wrap the equation in parentheses
org-html-extension (funcall #'#[nil ("html") (htm...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The extension for exported HTML files.
org-html-footnote-format (funcall #'#[nil ("<sup>%s</su...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The format for the footnote reference. %s will be replaced by the footnote reference itself.
org-html-footnote-separator (funcall #'#[nil ("<sup>, </su...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Text used to separate footnotes.
org-html-footnotes-section (funcall #'#[nil ("<div id\"f…=
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Format for the footnotes section. Should contain a two instances of %s. The first will be replaced with the language-specific word for "Footnotes", the second one will be replaced by the footnotes themselves.
org-html-format-drawer-function (funcall #'#[nil (#'(lambda (_...
- Type: function
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Function called to format a drawer in HTML code. The function must accept two parameters: NAME the drawer name, like "LOGBOOK" CONTENTS the contents of the drawer. The function should return the string to be exported. The default value simply returns the value of CONTENTS.
org-html-format-headline-function (funcall #'#[nil ('org-html-fo...
- Type: function
- Since: Emacs version 26.1
- In file: ox-html.el
- Find modifications in git logs
Function to format headline text. This function will be called with six arguments: TODO the todo keyword (string or nil). TODO-TYPE the type of todo (symbol: `todo', `done', nil) PRIORITY the priority of the headline (integer or nil) TEXT the main headline text (string). TAGS the tags (string or nil). INFO the export options (plist). The function result will be used in the section format string.
org-html-format-inlinetask-function (funcall #'#[nil ('org-html-fo...
- Type: function
- Since: Emacs version 26.1
- In file: ox-html.el
- Find modifications in git logs
Function called to format an inlinetask in HTML code. The function must accept seven parameters: TODO the todo keyword, as a string TODO-TYPE the todo type, a symbol among `todo', `done' and nil. PRIORITY the inlinetask priority, as a string NAME the inlinetask name, as a string. TAGS the inlinetask tags, as a list of strings. CONTENTS the contents of the inlinetask, as a string. INFO the export options, as a plist The function should return the string to be exported.
org-html-head (funcall #'#[nil ("") (htmlize...
- Type: (choice (string :tag "Literal …
- In file: ox-html.el
- Find modifications in git logs
Org-wide head definitions for exported HTML files.
This variable can contain the full HTML structure to provide a
style, including the surrounding HTML tags. You can consider
including definitions for the following classes: title, todo,
done, timestamp, timestamp-kwd, tag, target. Can be a string, or
a function that accepts the INFO plist and returns a string.
For example, a valid value would be:
<style>
p { font-weight: normal; color: gray; }
h1 { color: black; }
.title { text-align: center; }
.todo, .timestamp-kwd { color: red; }
.done { color: green; }
</style>
If you want to refer to an external style, use something like
<link rel="stylesheet" type="text/css" href="mystyles.css" />
As the value of this option simply gets inserted into the HTML
<head> header, you can use it to add any arbitrary text to the
header.
You can set this on a per-file basis using #+HTML_HEAD:,
or for publication projects using the :html-head property.
org-html-head-extra (funcall #'#[nil ("") (htmlize...
- Type: (choice (string :tag "Literal …
- In file: ox-html.el
- Find modifications in git logs
More head information to add in the HTML output. You can set this on a per-file basis using #+HTML_HEAD_EXTRA:, or for publication projects using the :html-head-extra property. Can be a string, or a function that accepts the INFO plist and returns a string.
org-html-head-include-default-style (funcall #'#[nil (t) (htmlize-...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil means include the default style in exported HTML files. The actual style is defined in `org-html-style-default' and should not be modified. Use `org-html-head' to use your own style information.
org-html-head-include-scripts (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil means include the JavaScript snippets in exported HTML files. The actual script is defined in `org-html-scripts'.
org-html-home/up-format (funcall #'#[nil ("<div id\"o…=
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Snippet used to insert the HOME and UP links. This is a format string, the first %s will receive the UP link, the second the HOME link. If both `org-html-link-up' and `org-html-link-home' are empty, the entire snippet will be ignored.
org-html-html5-fancy (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil means using new HTML5 elements. This variable is ignored for anything other than HTML5 export.
org-html-htmlize-font-prefix (funcall #'#[nil ("org-") (htm...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The prefix for CSS class names for htmlize font specifications.
org-html-htmlize-output-type (funcall #'#[nil ('inline-css)...
- Type: (choice (const css) (const inl…
- In file: ox-html.el
- Find modifications in git logs
Output type to be used by htmlize when formatting code snippets. Choices are `css' to export the CSS selectors only,`inline-css' to export the CSS attribute values inline in the HTML or nil to export plain text. We use as default `inline-css', in order to make the resulting HTML self-containing. However, this will fail when using Emacs in batch mode for export, because then no rich font definitions are in place. It will also not be good if people with different Emacs setup contribute HTML files to a website, because the fonts will represent the individual setups. In these cases, it is much better to let Org/Htmlize assign classes only, and to use a style file to define the look of these classes. To get a start for your css file, start Emacs session and make sure that all the faces you are interested in are defined, for example by loading files in all modes you want. Then, use the command `\[org-html-htmlize-generate-css]' to extract class definitions.
org-html-indent (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil means to indent the generated HTML. Warning: non-nil may break indentation of source code blocks.
org-html-infojs-options (funcall #'#[nil ((mapcar #'(l...
- Type: (set :greedy t :inline t (cons…
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Options settings for the INFOJS JavaScript. Each of the options must have an entry in `org-html-infojs-opts-table'. The value can either be a string that will be passed to the script, or a property. This property is then assumed to be a property that is defined by the Export/Publishing setup of Org. The `sdepth' and `tdepth' parameters can also be set to "max", which means to use the maximum value consistent with other options.
org-html-infojs-template (funcall #'#[nil ("<script src...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The template for the export style additions when org-info.js is used. Option settings will replace the %MANAGER-OPTIONS cookie.
org-html-inline-image-rules (funcall #'#[nil ((list (cons ...
- Type: (alist :key-type (string :tag …
- In file: ox-html.el
- Find modifications in git logs
Rules characterizing image files that can be inlined into HTML. A rule consists in an association whose key is the type of link to consider, and value is a regexp that will be matched against link's path.
org-html-inline-images (funcall #'#[nil (t) (htmlize-...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil means inline images into exported HTML pages. This is done using an <img> tag. When nil, an anchor with href is used to link to the image.
org-html-klipse-css (funcall #'#[nil ("https://sto...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Location of the codemirror CSS file for use with klipse.
org-html-klipse-js (funcall #'#[nil ("https://sto...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Location of the klipse javascript file.
org-html-klipse-selection-script (funcall #'#[nil ("window.klip...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
JavaScript snippet to activate klipse.
org-html-klipsify-src (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
When non-nil, source code blocks are editable in exported presentation.
org-html-link-home (funcall #'#[nil ("") (htmlize...
- Type: (string :tag "File or URL")
- In file: ox-html.el
- Find modifications in git logs
Where should the "HOME" link of exported HTML pages lead?
org-html-link-org-files-as-html (funcall #'#[nil (t) (htmlize-...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
Non-nil means make file links to "file.org" point to "file.html". When Org mode is exporting an Org file to HTML, links to non-HTML files are directly put into a "href" tag in HTML. However, links to other Org files (recognized by the extension ".org") should become links to the corresponding HTML file, assuming that the linked Org file will also be converted to HTML. Links to "file.org.gpg" are also converted. When nil, the links still point to the plain ".org" file.
org-html-link-up (funcall #'#[nil ("") (htmlize...
- Type: (string :tag "File or URL")
- In file: ox-html.el
- Find modifications in git logs
Where should the "UP" link of exported HTML pages lead?
org-html-link-use-abs-url (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Should we prepend relative links with HTML_LINK_HOME?
org-html-mathjax-options (funcall #'#[nil ('((path "htt...
- Type: (list :greedy t (list :tag "pa…
- In file: ox-html.el
- Find modifications in git logs
Options for MathJax setup.
Alist of the following elements.
path The path to MathJax version 3 or later.
scale Scaling with HTML-CSS, MathML and SVG output engines.
align How to align display math: left, center, or right.
font The font to use with HTML-CSS and SVG output. Needs
MathJax version 4+. MathJax 4 provides 11 fonts:
"mathjax-modern" Latin-Modern font, default in MathJax 4+
"mathjax-asana" Asana-Math font
"mathjax-bonum" Gyre Bonum font
"mathjax-dejavu" Gyre DejaVu font
"mathjax-pagella" Gyre Pagella font
"mathjax-schola" Gyre Schola font
"mathjax-termes" Gyre Termes font
"mathjax-stix2" STIX2 font
"mathjax-fira" Fira and Fira-Math fonts
"mathjax-euler" Neo Euler font that extends Latin-Modern
"mathjax-tex" The original MathJax TeX font
overflow How to break displayed equations when too large. Needs
MathJax 4 or newer. Supported options include
"overflow", "scale", "scroll", "truncate",
"linebreak", and "elide".
linebreaks Let MathJax perform automatic linebreaks. Valid values
are "true" and "false".
indent If align is not center, how far from the left/right side? For
example, "1em".
multlinewidth The width of the multline environment.
tags How to number equations. Valid values are "none",
"all" and "ams".
tagindent The amount tags are indented.
tagside Which side to show tags/labels on. Valid values are
"left" and "right"
You can also customize this for some buffer, using something like
#+HTML_MATHJAX: align: left indent: 5em tagside: left
For further information about MathJax options, see the MathJax documentation:
https://docs.mathjax.org/
To maintain compatibility with pre-9.6 Org that used MathJax 2,
the following conversions take place.
The legacy "autonumber" option, with the value "AMS",
"None", or "All", becomes the "tags" option set to the
value "ams", "none", or "all", respectively.
Any legacy values of the "scale" option, specified as
percentage strings, become converted to unit-interval numbers.
For example, a legacy scale of "150" becomes a scale of 1.5.
The legacy "linebreaks" option, with the value "true" or
"false", becomes the "overflow" option set to the value
"linebreak" or "overflow", respectively.
The legacy values of the "font" option, namely "TeX",
"STIX-Web", "Asana-Math", "Neo-Euler", "Gyre-Pagella",
"Gyre-Termes", "Latin-Modern", become converted to the
corresponding MathJax 4+ font names.
Legacy options and values always take precedence.
org-html-mathjax-template (funcall #'#[nil ("<script>\n ...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The MathJax template. See also `org-html-mathjax-options'.
org-html-metadata-timestamp-format (funcall #'#[nil ("%Y-%m-%d %a...
- Type: string
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Format used for timestamps in preamble, postamble and metadata. See `format-time-string' for more information on its components.
org-html-postamble (funcall #'#[nil ('auto) (html...
- Type: (choice (const :tag "No postam…
- In file: ox-html.el
- Find modifications in git logs
Non-nil means insert a postamble in HTML export. When set to `auto', check against the `org-export-with-author/email/creator/date' variables to set the content of the postamble. When t, insert a string as defined by the formatting string in `org-html-postamble-format'. When set to a string, use this formatting string instead (see `org-html-postamble-format' for an example of such a formatting string). When set to a function, apply this function and insert the returned string. The function takes the property list of export options as its only argument. Setting :html-postamble in publishing projects will take precedence over this variable.
org-html-postamble-format (funcall #'#[nil ('(("en" "<p ...
- Type: (repeat (list (string :tag "La…
- In file: ox-html.el
- Find modifications in git logs
Alist of languages and format strings for the HTML postamble. The first element of each list is the language code, as used for the LANGUAGE keyword. See `org-export-default-language'. The second element of each list is a format string to format the postamble itself. This format string can contain these elements: %t stands for the title. %s stands for the subtitle. %a stands for the author's name. %e stands for the author's email. %d stands for the date. %c will be replaced by `org-html-creator-string'. %v will be replaced by `org-html-validation-link'. %T will be replaced by the export time. %C will be replaced by the last modification time. If you need to use a "%" character, you need to escape it like that: "%%".
org-html-preamble (funcall #'#[nil (t) (htmlize-...
- Type: (choice (const :tag "No preamb…
- In file: ox-html.el
- Find modifications in git logs
Non-nil means insert a preamble in HTML export. When t, insert a string as defined by the formatting string in `org-html-preamble-format'. When set to a string, use this formatting string instead (see `org-html-postamble-format' for an example of such a formatting string). When set to a function, apply this function and insert the returned string. The function takes the property list of export options as its only argument. Setting :html-preamble in publishing projects will take precedence over this variable.
org-html-preamble-format (funcall #'#[nil ('(("en" ""))...
- Type: (repeat (list (string :tag "La…
- In file: ox-html.el
- Find modifications in git logs
Alist of languages and format strings for the HTML preamble. The first element of each list is the language code, as used for the LANGUAGE keyword. See `org-export-default-language'. The second element of each list is a format string to format the preamble itself. This format string can contain these elements: %t stands for the title. %s stands for the subtitle. %a stands for the author's name. %e stands for the author's email. %d stands for the date. %c will be replaced by `org-html-creator-string'. %v will be replaced by `org-html-validation-link'. %T will be replaced by the export time. %C will be replaced by the last modification time. If you need to use a "%" character, you need to escape it like that: "%%". See the default value of `org-html-postamble-format' for an example.
org-html-prefer-user-labels (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
When non-nil use user-defined names and ID over internal ones. By default, Org generates its own internal ID values during HTML export. This process ensures that these values are unique and valid, but the keys are not available in advance of the export process, and not so readable. When this variable is non-nil, Org will use NAME keyword, or the real name of the target to create the ID attribute. Independently of this variable, however, CUSTOM_ID are always used as a reference.
org-html-scripts (funcall #'#[nil ("<script>\n/...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Basic JavaScript to allow highlighting references in code blocks.
org-html-self-link-headlines (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
When non-nil, the headlines contain a hyperlink to themselves.
org-html-style-default (funcall #'#[nil ("<style type...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
The default style specification for exported HTML files. You can use `org-html-head' and `org-html-head-extra' to add to this style. If you don't want to include this default style, customize `org-html-head-include-default-style'.
org-html-table-align-individual-fields (funcall #'#[nil (t) (htmlize-...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
Non-nil means attach style attributes for alignment to each table field. When nil, alignment will only be specified in the column tags, but this is ignored by some browsers (like Firefox, Safari). Opera does it right though.
org-html-table-caption-above (funcall #'#[nil (t) (htmlize-...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
When non-nil, place caption string at the beginning of the table. Otherwise, place it near the end.
org-html-table-default-attributes (funcall #'#[nil ('(:border "2...
- Type: (plist :key-type (symbol :tag …
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Default attributes and values which will be used in table tags. This is a plist where attributes are symbols, starting with colons, and values are strings. When exporting to HTML5, these values will be disregarded.
org-html-table-row-close-tag (funcall #'#[nil ("</tr>") (ht...
- Type: (choice :tag "Closing tag" (st…
- In file: ox-html.el
- Find modifications in git logs
The closing tag for table rows. This is customizable so that alignment options can be specified. Instead of strings, this can be a Lisp function that will be evaluated for each row in order to construct the table row tags. See documentation of `org-html-table-row-open-tag'.
org-html-table-row-open-tag (funcall #'#[nil ("<tr>") (htm...
- Type: (choice :tag "Opening tag" (st…
- In file: ox-html.el
- Find modifications in git logs
The opening tag for table rows.
This is customizable so that alignment options can be specified.
Instead of strings, these can be a Lisp function that will be
evaluated for each row in order to construct the table row tags.
The function will be called with these arguments:
`number': row number (0 is the first row)
`group-number': group number of current row
`start-group?': non-nil means the row starts a group
`end-group?': non-nil means the row ends a group
`top?': non-nil means this is the top row
`bottom?': non-nil means this is the bottom row
For example:
(setq org-html-table-row-open-tag
(lambda (number group-number start-group? end-group-p top? bottom?)
(cond (top? "<tr class=\"tr-top\">")
(bottom? "<tr class=\"tr-bottom\">")
(t (if (= (mod number 2) 1)
"<tr class=\"tr-odd\">"
"<tr class=\"tr-even\">")))))
will use the "tr-top" and "tr-bottom" classes for the top row
and the bottom row, and otherwise alternate between "tr-odd" and
"tr-even" for odd and even rows.
org-html-tag-class-prefix (funcall #'#[nil ("") (htmlize...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Prefix to class names for TODO keywords. Each tag gets a class given by the tag itself, with this prefix. The default prefix is empty because it is nice to just use the keyword as a class name. But if you get into conflicts with other, existing CSS classes, then this prefix can be very useful.
org-html-text-markup-alist (funcall #'#[nil ('((bold . "<...
- Type: (alist :key-type (symbol :tag …
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Alist of HTML expressions to convert text markup. The key must be a symbol among `bold', `code', `italic', `strike-through', `underline' and `verbatim'. The value is a formatting string to wrap fontified text with. If no association can be found for a given markup, text will be returned as-is.
org-html-todo-kwd-class-prefix (funcall #'#[nil ("") (htmlize...
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Prefix to class names for TODO keywords. Each TODO keyword gets a class given by the keyword itself, with this prefix. The default prefix is empty because it is nice to just use the keyword as a class name. But if you get into conflicts with other, existing CSS classes, then this prefix can be very useful.
org-html-toplevel-hlevel (funcall #'#[nil (2) (htmlize-...
- Type: integer
- In file: ox-html.el
- Find modifications in git logs
The <H> level for level 1 headings in HTML export. This is also important for the classes that will be wrapped around headlines and outline structure. If this variable is 1, the top-level headlines will be <h1>, and the corresponding classes will be outline-1, section-number-1, and outline-text-1. If this is 2, all of these will get a 2 instead. The default for this variable is 2, because we use <h1> for formatting the document title.
org-html-use-infojs (funcall #'#[nil ('when-config...
- Type: (choice (const :tag "Never" ni…
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil when Sebastian Rose's Java Script org-info.js should be active. This option can be nil or t to never or always use the script. It can also be the symbol `when-configured', meaning that the script will be linked into the export file if and only if there is a "#+INFOJS_OPT:" line in the buffer. See also the variable `org-html-infojs-options'.
org-html-validation-link (funcall #'#[nil ("<a href\"h…=
- Type: string
- In file: ox-html.el
- Find modifications in git logs
Link to HTML validation service.
org-html-viewport (funcall #'#[nil ('((width "de...
- Type: (choice (const :tag "Disable" …
- Since: Emacs version 26.1
- In file: ox-html.el
- Find modifications in git logs
Viewport options for mobile-optimized sites. The following values are recognized width Size of the viewport. initial-scale Zoom level when the page is first loaded. minimum-scale Minimum allowed zoom level. maximum-scale Maximum allowed zoom level. user-scalable Whether zoom can be changed. The viewport meta tag is inserted if this variable is non-nil. See the following site for a reference: https://developer.mozilla.org/en-US/docs/Mozilla/Mobile/Viewport_meta_tag
org-html-with-latex (funcall #'#[nil (org-export-w...
- Type: (choice (const :tag "Do not pr…
- Since: Emacs version 24.4
- In file: ox-html.el
- Find modifications in git logs
Non-nil means process LaTeX math snippets.
When set, the exporter will process LaTeX environments and
fragments.
This option can also be set with the +OPTIONS line,
e.g. "tex:mathjax". Allowed values are:
nil Ignore math snippets.
`verbatim' Keep everything in verbatim
`mathjax', t Do MathJax preprocessing and arrange for MathJax.js to
be loaded.
`html' Use `org-latex-to-html-convert-command' to convert
LaTeX fragments to HTML.
SYMBOL Any symbol defined in `org-preview-latex-process-alist',
e.g., `dvipng'.
org-html-wrap-src-lines (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- In file: ox-html.el
- Find modifications in git logs
If non-nil, wrap individual lines of source blocks in "code" elements. In this case, add line number in attribute "data-ox-html-linenr" when line numbers are enabled.
org-html-xml-declaration (funcall #'#[nil ('(("html" . ...
- Type: (choice (string :tag "Single d…
- In file: ox-html.el
- Find modifications in git logs
The extension for exported HTML files. %s will be replaced with the charset of the exported file. This may be a string, or an alist with export extensions and corresponding declarations. This declaration only applies when exporting to XHTML.
org-icalendar-alarm-time (funcall #'#[nil (0) (t)])
- Type: integer
- Since: Emacs version 24.1
- In file: ox-icalendar.el
- Find modifications in git logs
Number of minutes for triggering an alarm for exported timed events. A zero value (the default) turns off the definition of an alarm trigger for timed events. If non-zero, alarms are created. - a single alarm per entry is defined - The alarm will go off N minutes before the event - only a DISPLAY action is defined.
org-icalendar-categories (funcall #'#[nil ('(local-tags...
- Type: (repeat (choice (const :tag "T…
- In file: ox-icalendar.el
- Find modifications in git logs
Items that should be entered into the "categories" field. This is a list of symbols, the following are valid: `category' The Org mode category of the current file or tree `todo-state' The todo state, if any `local-tags' The tags, defined in the current line `all-tags' All tags, including inherited ones.
org-icalendar-combined-agenda-file (funcall #'#[nil ("~/org.ics")...
- Type: file
- In file: ox-icalendar.el
- Find modifications in git logs
The file name for the iCalendar file covering all agenda files. This file is created with the command `\[org-icalendar-combine-agenda-files]'. The file name should be absolute. It will be overwritten without warning.
org-icalendar-combined-description (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-icalendar.el
- Find modifications in git logs
Calendar description for the combined iCalendar (all agenda files).
org-icalendar-combined-name (funcall #'#[nil ("OrgMode") (...
- Type: string
- In file: ox-icalendar.el
- Find modifications in git logs
Calendar name for the combined iCalendar representing all agenda files.
org-icalendar-date-time-format (funcall #'#[nil (":%Y%m%dT%H%...
- Type: (choice (const :tag "Local tim…
- Since: Emacs version 24.1
- In file: ox-icalendar.el
- Find modifications in git logs
Format-string for exporting icalendar DATE-TIME. See `format-time-string' for a full documentation. The only difference is that `org-icalendar-timezone' is used for %Z. Interesting value are: - ":%Y%m%dT%H%M%S" for local time - ";TZID=%Z:%Y%m%dT%H%M%S" for local time with explicit timezone - ":%Y%m%dT%H%M%SZ" for time expressed in Universal Time
org-icalendar-deadline-summary-prefix (funcall #'#[nil ("DL: ") (t)]...
- Type: string
- In file: ox-icalendar.el
- Find modifications in git logs
String prepended to exported headlines with a deadline.
org-icalendar-force-alarm (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-icalendar.el
- Find modifications in git logs
Non-nil means alarm will be created even if is set to zero. This overrides default behavior where zero means no alarm. With this set to non-nil and alarm set to zero, alarm will be created and will fire at the event start.
org-icalendar-include-bbdb-anniversaries (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-icalendar.el
- Find modifications in git logs
Non-nil means a combined iCalendar file should include anniversaries. The anniversaries are defined in the BBDB database.
org-icalendar-include-body (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Nothing" …
- In file: ox-icalendar.el
- Find modifications in git logs
Amount of text below headline to be included in iCalendar export. This is a number of characters that should maximally be included. Properties, scheduling and clocking lines will always be removed. The text will be inserted into the DESCRIPTION field.
org-icalendar-include-sexps (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox-icalendar.el
- Find modifications in git logs
Non-nil means export to iCalendar files should also cover sexp entries. These are entries like in the diary, but directly in an Org file.
org-icalendar-include-todo (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "None" nil…
- In file: ox-icalendar.el
- Find modifications in git logs
Non-nil means create VTODO components from TODO items.
Valid values are:
nil don't include any task.
t include tasks that are not in DONE state.
`unblocked' include all TODO items that are not blocked.
`all' include both done and not done items.
\("TODO" ...) include specific TODO keywords.
org-icalendar-scheduled-summary-prefix (funcall #'#[nil ("S: ") (t)])
- Type: string
- In file: ox-icalendar.el
- Find modifications in git logs
String prepended to exported scheduled headlines.
org-icalendar-store-UID (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-icalendar.el
- Find modifications in git logs
Non-nil means store any created UIDs in properties. The iCalendar standard requires that all entries have a unique identifier. Org will create these identifiers as needed. When this variable is non-nil, the created UIDs will be stored in the ID property of the entry. Then the next time this entry is exported, it will be exported with the same UID, superseding the previous form of it. This is essential for synchronization services. This variable is not turned on by default because we want to avoid creating a property drawer in every entry if people are only playing with this feature, or if they are only using it locally.
org-icalendar-timezone (funcall #'#[nil ((getenv "TZ"...
- Type: (choice (const :tag "Unspecifi…
- In file: ox-icalendar.el
- Find modifications in git logs
The time zone string for iCalendar export. When nil or the empty string, use output from (current-time-zone).
org-icalendar-todo-unscheduled-start (funcall #'#[nil ('recurring-d...
- Type: (choice (const :tag "Warning d…
- In file: ox-icalendar.el
- Find modifications in git logs
Exported start date of unscheduled TODOs.
If `org-icalendar-use-scheduled' contains `todo-start' and a task
has a "SCHEDULED" timestamp, that is always used as the start
date. Otherwise, this variable controls whether a start date is
exported and what its value is.
Note that the iCalendar spec RFC 5545 does not generally require
tasks to have a start date, except for repeating tasks which do
require a start date. However some iCalendar programs ignore the
requirement for repeating tasks, and allow repeating deadlines
without a matching start date.
This variable has no effect when `org-icalendar-include-todo' is nil.
Valid values are:
`recurring-deadline-warning' If deadline repeater present,
use `org-deadline-warning-days' as start.
`deadline-warning' If deadline present,
use `org-deadline-warning-days' as start.
`current-datetime' Use the current date-time as start.
nil Never add a start time for unscheduled tasks.
org-icalendar-ttl (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No refres…
- In file: ox-icalendar.el
- Find modifications in git logs
Time to live for the exported calendar. Subscribing clients to the exported ics file can derive the time interval to read the file again from the server. One example of such client is Nextcloud calendar, which respects the setting of X-PUBLISHED-TTL in ICS files. Setting `org-icalendar-ttl' to "PT1H" would advise a server to reload the file every hour. See https://icalendar.org/iCalendar-RFC-5545/3-8-2-5-duration.html for a complete description of possible specifications of this option. For example, "PT1H" stands for 1 hour and "PT0H27M34S" stands for 0 hours, 27 minutes and 34 seconds. The default value is nil, which means no such option is set in the ICS file. This option can also be set on a per-document basis with the ICAL-TTL export keyword.
org-icalendar-use-deadline (funcall #'#[nil ('(event-if-n...
- Type: (set :greedy t (const :tag "DE…
- In file: ox-icalendar.el
- Find modifications in git logs
Contexts where iCalendar export should use a deadline time stamp. This is a list with possibly several symbols in it. Valid symbols are: `event-if-todo' Deadlines in TODO entries become calendar events. `event-if-todo-not-done' Deadlines in TODO entries with not-DONE state become events. `event-if-not-todo' Deadlines in non-TODO entries become calendar events. `todo-due' Use deadlines in TODO entries as due-dates.
org-icalendar-use-scheduled (funcall #'#[nil ('(todo-start...
- Type: (set :greedy t (const :tag "SC…
- In file: ox-icalendar.el
- Find modifications in git logs
Contexts where iCalendar export should use a scheduling time stamp. This is a list with possibly several symbols in it. Valid symbols are: `event-if-todo' Scheduling time stamps in TODO entries become an event. `event-if-todo-not-done' Scheduling time stamps in TODO entries with not-DONE state become events. `event-if-not-todo' Scheduling time stamps in non-TODO entries become an event. `todo-start' Scheduling time stamps in TODO entries become start date. (See also `org-icalendar-todo-unscheduled-start', which controls the start date for TODO entries without a scheduling time stamp)
org-icalendar-with-timestamps (funcall #'#[nil ('active) (t)...
- Type: (choice (const :tag "All times…
- In file: ox-icalendar.el
- Find modifications in git logs
Non-nil means make an event from plain time stamps. It can be set to `active', `active-exclude-diary', `inactive', t or nil, in order to make an event from, respectively, only active timestamps (with/without diary timestamps), only inactive ones, all of them or none. This variable has the same options as `org-export-with-timestamps', and takes precedence over it. However, note that this variable applies to all timestamps within an entry, whereas `org-export-with-timestamps' only applies to timestamps isolated in a paragraph containing only timestamps. It can also be set with the #+OPTIONS line, e.g. "<:t".
org-id-completion-targets (funcall #'#[nil ('((nil . t) ...
- Type: (repeat (cons (choice :value o…
- In file: org-id.el
- Find modifications in git logs
Candidate headings for completing "id:" links in `\[org-insert-link]'. This variable has the same form as `org-refile-targets', which see.
org-id-extra-files (funcall #'#[nil ('org-agenda-...
- Type: (choice (symbol :tag "Variable…
- In file: org-id.el
- Find modifications in git logs
Files to be searched for IDs, besides the agenda files. When Org reparses files to remake the list of files and IDs it is tracking, it will normally scan the agenda files, the archives related to agenda files, any files that are listed as ID containing in the current register, and any Org file currently visited by Emacs. You can list additional files here. This variable is only relevant when `org-id-track-globally' is set.
org-id-include-domain (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-id.el
- Find modifications in git logs
Non-nil means add the domain name to new IDs. This ensures global uniqueness of IDs, and is also suggested by the relevant RFCs. This is relevant only if `org-id-method' is `org' or `ts'. When uuidgen is used, the domain will never be added. The default is to not use this because we have no really good way to get the true domain, and Org entries will normally not be shared with enough people to make this necessary.
org-id-link-consider-parent-id (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-id.el
- Find modifications in git logs
Non-nil means storing a link to an Org entry considers inherited IDs. When this option is non-nil and `org-id-link-use-context' is enabled, ID properties inherited from parent entries will be considered when storing an ID link. If no ID is found in this way, a new one may be created as normal (see `org-id-link-to-org-use-id'). For example, given this org file: * Parent :PROPERTIES: :ID: abc :END: ** Child 1 ** Child 2 With `org-id-link-consider-parent-id' and `org-id-link-use-context' both enabled, storing a link with point at "Child 1" will produce a link "<id:abc::*Child 1>". This allows linking to uniquely-named sub-entries within a parent entry with an ID, without requiring every sub-entry to have its own ID.
org-id-link-to-org-use-id (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Create ID…
- Since: Emacs version 24.3
- In file: org-id.el
- Find modifications in git logs
Non-nil means storing a link to an Org file will use entry IDs.
\<org-mode-map>
The variable can have the following values:
t Create an ID if needed to make a link to the current entry.
create-if-interactive
If `org-store-link' is called directly (interactively, as a user
command), do create an ID to support the link. But when doing the
job for capture, only use the ID if it already exists. The
purpose of this setting is to avoid proliferation of unwanted
IDs, just because you happen to be in an Org file when you
call `org-capture' that automatically and preemptively creates a
link. If you do want to get an ID link in a capture template to
an entry not having an ID, create it first by explicitly creating
a link to it, using `\[org-store-link]' first.
create-if-interactive-and-no-custom-id
Like create-if-interactive, but do not create an ID if there is
a CUSTOM_ID property defined in the entry.
use-existing
Use existing ID, do not create one.
nil Never use an ID to make a link, instead link using a text search for
the headline text.
org-id-link-use-context (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-id.el
- Find modifications in git logs
Non-nil means enables search string context in org-id links. Search strings are added by `org-id-store-link' when both the general option `org-link-context-for-files' and the org-id option `org-id-link-use-context' are non-nil.
org-id-locations-file (funcall #'#[nil ((locate-user...
- Type: file
- In file: org-id.el
- Find modifications in git logs
The file for remembering in which file an ID was defined. This variable is only relevant when `org-id-track-globally' is set.
org-id-locations-file-relative (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-id.el
- Find modifications in git logs
Determine if `org-id-locations' should be stored as relative links. Non-nil means that links to locations are stored as links relative to the location of where `org-id-locations-file' is stored. Nil means to store absolute paths to files. This customization is useful when folders are shared across systems but mounted at different roots. Relative path to `org-id-locations-file' still has to be maintained across systems.
org-id-method (funcall #'#[nil ('uuid) (t)])
- Type: (choice (const :tag "Org's int…
- In file: org-id.el
- Find modifications in git logs
The method that should be used to create new IDs.
An ID will consist of the optional prefix specified in `org-id-prefix',
and a unique part created by the method this variable specifies.
Allowed values are:
org Org's own internal method, using an encoding of the current time to
microsecond accuracy, and optionally the current domain of the
computer. See the variable `org-id-include-domain'.
uuid Create random (version 4) UUIDs. If the program defined in
`org-id-uuid-program' is available it is used to create the ID.
Otherwise an internal functions is used.
ts Create ID's based on timestamps as specified in `org-id-ts-format'.
org-id-prefix (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No prefix…
- In file: org-id.el
- Find modifications in git logs
The prefix for IDs. This may be a string, or it can be nil to indicate that no prefix is required. When a string, the string should have no space characters as IDs are expected to have no space characters in them.
org-id-search-archives (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-id.el
- Find modifications in git logs
Non-nil means search also the archive files of agenda files for entries. This is a possibility to reduce overhead, but it means that entries moved to the archives can no longer be found by ID. This variable is only relevant when `org-id-track-globally' is set.
org-id-track-globally (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-id.el
- Find modifications in git logs
Non-nil means track IDs through files, so that links work globally. This work by maintaining a hash table for IDs and writing this table to disk when exiting Emacs. Because of this, it works best if you use a single Emacs process, not many. When nil, IDs are not tracked. Links to IDs will still work within a buffer, but not if the entry is located in another file. IDs can still be used if the entry with the id is in the same file as the link.
org-id-ts-format (funcall #'#[nil ("%Y%m%dT%H%M...
- Type: string
- In file: org-id.el
- Find modifications in git logs
Timestamp format for IDs generated using `ts' `org-id-method'. The format should be suitable to pass as an argument to `format-time-string'. Defaults to ISO8601 timestamps without separators and without timezone, local time and precision down to 1e-6 seconds.
org-id-uuid-program (funcall #'#[nil ("uuidgen") (...
- Type: string
- In file: org-id.el
- Find modifications in git logs
The uuidgen program.
org-image-actual-width (funcall #'#[nil (t) (org-with...
- Type: (choice (const :tag "Use the i…
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
When non-nil, use the actual width of images when inlining them. When set to a number, use imagemagick (when available) to set the image's width to this value. When set to a number in a list, try to get the width from any #+ATTR.* keyword if it matches a width specification like #+ATTR_HTML: :width 300px and fall back on that number if none is found. When set to nil, first try to get the width from #+ATTR_ORG. If that is not found, use the first #+ATTR_xxx :width specification. If that is also not found, fall back on the original image width. Finally, Org mode is quite flexible in the width specifications it supports and intelligently interprets width specifications for other backends when rendering an image in an org buffer. This behavior is described presently. 1. A floating point value between 0 and 2 is interpreted as the percentage of the text area that should be taken up by the image. 2. A number followed by a percent sign is divided by 100 and then interpreted as a floating point value. 3. If a number is followed by other text, extract the number and discard the remaining text. That number is then interpreted as a floating-point value. For example, #+ATTR_LATEX: :width 0.7\linewidth would be interpreted as 70% of the text width. 4. If t is provided the original image width is used. This is useful when you want to specify a width for a backend, but still want to use the original image width in the org buffer. This requires Emacs >= 24.1, built with imagemagick support.
org-image-align (funcall #'#[nil ('left) (org-...
- Type: (choice (const :tag "Left alig…
- In file: ol.el
- Find modifications in git logs
How to align images previewed using `org-link-preview-region'. Only stand-alone image links are affected by this setting. These are links without surrounding text. Possible values of this option are: left Insert image at specified position. center Center image previews. right Right-align image previews.
org-image-max-width (funcall #'#[nil ('fill-column...
- Type: (choice (const :tag "Do not li…
- In file: ol.el
- Find modifications in git logs
When non-nil, limit the displayed image width. This setting only takes effect when `org-image-actual-width' is set to t or when #+ATTR* is set to t. Possible values: - `fill-column' :: limit width to `fill-column' - `window' :: limit width to window width - integer :: limit width to number in pixels - float :: limit width to that fraction of window width - nil :: do not limit image width
org-indent-boundary-char (funcall #'#[nil (32) (org-inl...
- Type: character
- In file: org-indent.el
- Find modifications in git logs
The end of the virtual indentation strings, a single-character string. The default is just a space, but if you wish, you can use "|" or so. This can be useful on a terminal window - under a windowing system, it may be prettier to customize the `org-indent' face.
org-indent-indentation-per-level (funcall #'#[nil (2) (org-inli...
- Type: integer
- In file: org-indent.el
- Find modifications in git logs
Indentation per level in number of characters.
org-indent-mode-turns-off-org-adapt-indentation (funcall #'#[nil (t) (org-inli...
- Type: boolean
- In file: org-indent.el
- Find modifications in git logs
Non-nil means setting `org-indent-mode' will turn off indentation adaptation. For details see the variable `org-adapt-indentation'.
org-indent-mode-turns-on-hiding-stars (funcall #'#[nil (t) (org-inli...
- Type: boolean
- In file: org-indent.el
- Find modifications in git logs
Non-nil means setting `org-indent-mode' will turn on `org-hide-leading-stars'.
org-indirect-buffer-display (funcall #'#[nil ('other-windo...
- Type: (choice (const :tag "In curren…
- In file: org.el
- Find modifications in git logs
How should indirect tree buffers be displayed?
This applies to indirect buffers created with the commands
`org-tree-to-indirect-buffer' and `org-agenda-tree-to-indirect-buffer'.
Valid values are:
current-window Display in the current window
other-window Just display in another window.
dedicated-frame Create one new frame, and reuse it each time.
new-frame Make a new frame each time. Note that in this case
previously-made indirect buffers are kept, and you need to
kill these buffers yourself.
org-info-other-documents (funcall #'#[nil ('(("dir" . "...
- Type: (alist :key-type string :value…
- In file: ol-info.el
- Find modifications in git logs
Alist of documents generated from Texinfo source. When converting Info links to HTML, links to any one of these manuals are converted to use these URL.
org-inlinetask-default-state (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No state"…
- Since: Emacs version 24.1
- In file: org-inlinetask.el
- Find modifications in git logs
Non-nil means make inline tasks have a TODO keyword initially. This should be the state `org-inlinetask-insert-task' should use by default, or nil if no state should be assigned.
org-inlinetask-min-level (funcall #'#[nil (15) (t)])
- Type: (choice (const :tag "Off" nil)…
- In file: org-inlinetask.el
- Find modifications in git logs
Minimum level a headline must have before it is treated as an inline task. Don't set it to something higher than `29' or clocking will break since this is the hardcoded maximum number of stars `org-clock-sum' will work with. It is strongly recommended that you set `org-cycle-max-level' not at all, or to a number smaller than this one. See `org-cycle-max-level' docstring for more details.
org-inlinetask-show-first-star (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-inlinetask.el
- Find modifications in git logs
Non-nil means display the first star of an inline task as additional marker. When nil, the first star is not shown.
org-insert-mode-line-in-empty-file (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means insert the first line setting Org mode in empty files. When the function `org-mode' is called interactively in an empty file, this normally means that the file name does not automatically trigger Org mode. To ensure that the file will always be in Org mode in the future, a line enforcing Org mode will be inserted into the buffer, if this option has been set.
org-koma-letter-class-option-file (funcall #'#[nil ("NF") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Letter Class Option File. This option can also be set with the LCO keyword.
org-koma-letter-closing (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Letter's closing, as a string.
This option can also be set with the CLOSING keyword. Moreover,
when:
(1) Either `org-koma-letter-prefer-special-headings' is non-nil
or the CLOSING keyword is empty;
(2) `org-koma-letter-headline-is-opening-maybe' is non-nil;
(3) the letter contains a headline with the special
tag "closing";
then the opening will be set as the title of the closing special
heading title.
org-koma-letter-default-class (funcall #'#[nil ("default-kom...
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Default class for `org-koma-letter'. The value must be a member of `org-latex-classes'.
org-koma-letter-email (funcall #'#[nil ('org-koma-le...
- Type: (radio (function-item org-koma…
- In file: ox-koma-letter.el
- Find modifications in git logs
Sender's email address. This variable defaults to the value `org-koma-letter-email' which returns `user-mail-address'. Alternatively a string, nil or a function may be given. Functions must return a string. This option can also be set with the EMAIL keyword.
org-koma-letter-from-address (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Sender's address, as a string. This option can also be set with one or more FROM_ADDRESS keywords.
org-koma-letter-from-logo (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Commands for inserting the sender's logo, e. g., \includegraphics{logo}.
This option can also be set with the FROM_LOGO keyword.
org-koma-letter-headline-is-opening-maybe (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil means a headline may be used as an opening and closing. See also `org-koma-letter-opening' and `org-koma-letter-closing'.
org-koma-letter-location (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Sender's extension field, as a string.
This option can also be set with the LOCATION keyword.
Moreover, when:
(1) Either `org-koma-letter-prefer-special-headings' is non-nil
or there is no LOCATION keyword or the LOCATION keyword is
empty;
(2) the letter contains a headline with the special
tag "location";
then the location will be set as the content of the location
special heading.
The location field is typically printed right of the address
field (See Figure 4.9. in the English manual of 2015-10-03).
org-koma-letter-opening (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Letter's opening, as a string.
This option can also be set with the OPENING keyword. Moreover,
when:
(1) Either `org-koma-letter-prefer-special-headings' is non-nil
or the CLOSING keyword is empty
(2) `org-koma-letter-headline-is-opening-maybe' is non-nil;
(3) the letter contains a headline without a special
tag (e.g. "to" or "ps");
then the opening will be implicitly set as the untagged headline title.
org-koma-letter-phone-number (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Sender's phone number, as a string. This option can also be set with the PHONE_NUMBER keyword.
org-koma-letter-place (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Place from which the letter is sent, as a string. This option can also be set with the PLACE keyword.
org-koma-letter-prefer-special-headings (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil means prefer headlines over keywords for TO and FROM. This option can also be set with the OPTIONS keyword, e.g.: "special-headings:t".
org-koma-letter-prefer-subject (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil means title should be interpreted as subject if subject is missing. This option can also be set with the OPTIONS keyword, e.g. "title-subject:t".
org-koma-letter-signature (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Signature, as a string.
This option can also be set with the SIGNATURE keyword.
Moreover, when:
(1) Either `org-koma-letter-prefer-special-headings' is non-nil
or there is no CLOSING keyword or the CLOSING keyword is empty;
(2) `org-koma-letter-headline-is-opening-maybe' is non-nil;
(3) the letter contains a headline with the special
tag "closing";
then the signature will be set as the content of the
closing special heading.
Note if the content is empty the signature will not be set.
org-koma-letter-subject-format (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "No export…
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil means include the subject. Support formatting options. When t, insert a subject using default options. When nil, do not insert a subject at all. It can also be a list of symbols among the following ones: `afteropening' Subject after opening `beforeopening' Subject before opening `centered' Subject centered `left' Subject left-justified `right' Subject right-justified `titled' Add title/description to subject `underlined' Set subject underlined `untitled' Do not add title/description to subject Please refer to the KOMA-script manual (Table 4.16. in the English manual of 2012-07-22). This option can also be set with the OPTIONS keyword, e.g.: "subject:(underlined centered)".
org-koma-letter-url (funcall #'#[nil ("") (t)])
- Type: string
- In file: ox-koma-letter.el
- Find modifications in git logs
Sender's URL, e. g., the URL of her homepage. This option can also be set with the URL keyword.
org-koma-letter-use-backaddress (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil prints return address in line above to address. This option can also be set with the OPTIONS keyword, e.g.: "backaddress:t".
org-koma-letter-use-email (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil prints sender's email address. This option can also be set with the OPTIONS keyword, e.g.: "email:t".
org-koma-letter-use-foldmarks (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "Activate …
- In file: ox-koma-letter.el
- Find modifications in git logs
Configure appearance of folding marks. When t, activate default folding marks. When nil, do not insert folding marks at all. It can also be a list of symbols among the following ones: `B' Activate upper horizontal mark on left paper edge `b' Deactivate upper horizontal mark on left paper edge `H' Activate all horizontal marks on left paper edge `h' Deactivate all horizontal marks on left paper edge `L' Activate left vertical mark on upper paper edge `l' Deactivate left vertical mark on upper paper edge `M' Activate middle horizontal mark on left paper edge `m' Deactivate middle horizontal mark on left paper edge `P' Activate punch or center mark on left paper edge `p' Deactivate punch or center mark on left paper edge `T' Activate lower horizontal mark on left paper edge t Deactivate lower horizontal mark on left paper edge `V' Activate all vertical marks on upper paper edge `v' Deactivate all vertical marks on upper paper edge This option can also be set with the OPTIONS keyword, e.g.: "foldmarks:(b l m t)".
org-koma-letter-use-from-logo (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil prints sender's FROM_LOGO. This option can also be set with the OPTIONS keyword, e.g.: "from-logo:t".
org-koma-letter-use-phone (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil prints sender's phone number. This option can also be set with the OPTIONS keyword, e.g.: "phone:t".
org-koma-letter-use-place (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil prints the letter's place next to the date. This option can also be set with the OPTIONS keyword, e.g.: "place:nil".
org-koma-letter-use-url (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-koma-letter.el
- Find modifications in git logs
Non-nil prints sender's URL. This option can also be set with the OPTIONS keyword, e.g.: "url:t".
org-latex-active-timestamp-format (funcall #'#[nil ("\\textit{%s...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
A `format' string to be applied to active timestamps.
org-latex-bib-compiler (funcall #'#[nil ("bibtex") (e...
- Type: (choice (const :tag "BibTeX" "…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Command to process a LaTeX file's bibliography. The shorthand %bib in `org-latex-pdf-process' is replaced with this value. A better approach is to use a compiler suit such as `latexmk'.
org-latex-caption-above (funcall #'#[nil ('(table)) (e...
- Type: (choice (const :tag "For all e…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
When non-nil, place caption string at the beginning of elements. Otherwise, place it near the end. When value is a list of symbols, put caption above selected elements only. Allowed symbols are: `image', `table', `src-block' and `special-block'.
org-latex-classes (funcall #'#[nil ('(("article"...
- Type: (repeat (list (string :tag "La…
- In file: ox-latex.el
- Find modifications in git logs
Alist of LaTeX classes and associated header and structure.
If #+LATEX_CLASS is set in the buffer, use its value and the
associated information. Here is the structure of each cell:
(class-name
header-string
(numbered-section . unnumbered-section)
...)
The header string
-----------------
The HEADER-STRING is the header that will be inserted into the
LaTeX file. It should contain the \documentclass macro, and
anything else that is needed for this setup. To this header, the
following commands will be added:
- Calls to \usepackage for all packages mentioned in the
variables `org-latex-default-packages-alist' and
`org-latex-packages-alist'. Thus, your header definitions
should avoid to also request these packages.
- Lines specified via "#+LATEX_HEADER:" and
"#+LATEX_HEADER_EXTRA:" keywords.
If you need more control about the sequence in which the header
is built up, or if you want to exclude one of these building
blocks for a particular class, you can use the following
macro-like placeholders.
[DEFAULT-PACKAGES] \usepackage statements for default packages
[NO-DEFAULT-PACKAGES] do not include any of the default packages
[PACKAGES] \usepackage statements for packages
[NO-PACKAGES] do not include the packages
[EXTRA] the stuff from #+LATEX_HEADER(_EXTRA)
[NO-EXTRA] do not include #+LATEX_HEADER(_EXTRA) stuff
So a header like
\documentclass{article}
[NO-DEFAULT-PACKAGES]
[EXTRA]
\providecommand{\alert}[1]{\textbf{#1}}
[PACKAGES]
will omit the default packages, and will include the
#+LATEX_HEADER and #+LATEX_HEADER_EXTRA lines, then have a call
to \providecommand, and then place \usepackage commands based
on the content of `org-latex-packages-alist'.
If your header, `org-latex-default-packages-alist' or
`org-latex-packages-alist' inserts "\usepackage[AUTO]{inputenc}",
AUTO will automatically be replaced with a coding system derived
from `buffer-file-coding-system'. See also the variable
`org-latex-inputenc-alist' for a way to influence this mechanism.
Likewise, if your header contains "\usepackage[AUTO]{babel}"
or "\usepackage[AUTO]{polyglossia}", AUTO will be replaced
with the language related to the language code specified by
`org-export-default-language'. Note that constructions such as
"\usepackage[french,AUTO,english]{babel}" are permitted. For
Polyglossia the language will be set via the macros
"\setmainlanguage" and "\setotherlanguage". See also
`org-latex-guess-babel-language' and
`org-latex-guess-polyglossia-language'.
The sectioning structure
------------------------
The sectioning structure of the class is given by the elements
following the header string. For each sectioning level, a number
of strings is specified. A %s formatter is mandatory in each
section string and will be replaced by the title of the section.
Instead of a cons cell (numbered . unnumbered), you can also
provide a list of 2 or 4 elements,
(numbered-open numbered-close)
or
(numbered-open numbered-close unnumbered-open unnumbered-close)
providing opening and closing strings for a LaTeX environment
that should represent the document section. The opening clause
should have a %s to represent the section title.
Instead of a list of sectioning commands, you can also specify
a function name. That function will be called with two
parameters, the (reduced) level of the headline, and a predicate
non-nil when the headline should be numbered. It must return
a format string in which the section title will be added.
org-latex-compiler (funcall #'#[nil ("pdflatex") ...
- Type: (choice (const :tag "pdfLaTeX"…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
LaTeX compiler to use. Must be an element in `org-latex-compilers' or the empty quote. Can also be set in buffers via #+LATEX_COMPILER. See also `org-latex-compiler-file-string'.
org-latex-compiler-file-string (funcall #'#[nil ("%% Intended...
- Type: (choice (const :tag "Comment" …
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
LaTeX compiler format-string. See also `org-latex-compiler'.
org-latex-custom-lang-environments (funcall #'#[nil (nil) (engrav...
- Type: (repeat (list (symbol :tag "La…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Alist mapping languages to language-specific LaTeX environments.
It is used during export of source blocks by the listings and
minted LaTeX packages. The environment may be a simple string,
composed of only letters and numbers. In this case, the string
is directly the name of the LaTeX environment to use. The
environment may also be a format string. In this case the format
string will be directly exported. This format string may contain
these elements:
%s for the formatted source
%c for the caption
%f for the float attribute
%l for an appropriate label
%o for the LaTeX attributes
For example,
(setq org-latex-custom-lang-environments
\='((python "pythoncode")
(ocaml "\\begin{listing}
\\begin{minted}[%o]{ocaml}
%s\\end{minted}
\\caption{%c}
\\label{%l}")))
would have the effect that if Org encounters a Python source block
during LaTeX export it will produce
\begin{pythoncode}
<source block body>
\end{pythoncode}
and if Org encounters an Ocaml source block during LaTeX export it
will produce
\begin{listing}
\begin{minted}[<attr_latex options>]{ocaml}
<source block body>
\end{minted}
\caption{<caption>}
\label{<label>}
\end{listing}
org-latex-default-class (funcall #'#[nil ("article") (...
- Type: (string :tag "LaTeX class")
- In file: ox-latex.el
- Find modifications in git logs
The default LaTeX class.
org-latex-default-figure-position (funcall #'#[nil ("htbp") (eng...
- Type: string
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Default position for LaTeX figures.
org-latex-default-footnote-command (funcall #'#[nil ("\\footnote{...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Default command used to insert footnotes.
Customize this command if the LaTeX class provides a different
command like "\sidenote{%s%s}" that you want to use.
The value will be passed as an argument to `format' as the following
(format org-latex-default-footnote-command
footnote-description footnote-label)
org-latex-default-packages-alist (funcall #'#[nil ('(("" "amsma...
- Type: (repeat (choice (list :tag "op…
- In file: org.el
- Find modifications in git logs
Alist of default packages to be inserted in the header.
Change this only if one of the packages here causes an
incompatibility with another package you are using.
The packages in this list are needed by one part or another of
Org mode to function properly:
- fontspec: for font and character selection in lualatex and xetex
- inputenc, fontenc: for basic font and character selection
in pdflatex
- graphicx: for including images
- longtable: For multipage tables
- wrapfig: for figure placement
- rotating: for sideways figures and tables
- ulem: for underline and strike-through
- amsmath: for subscript and superscript and math environments
- amssymb: for various symbols used for interpreting the entities
in `org-entities'. You can skip some of this package if you don't
use any of the symbols.
- capt-of: for captions outside of floats
- hyperref: for cross references
Therefore you should not modify this variable unless you know
what you are doing. The one reason to change it anyway is that
you might be loading some other package that conflicts with one
of the default packages. Each element is either a cell or
a string.
A cell is of the format
("options" "package" SNIPPET-FLAG COMPILERS)
If SNIPPET-FLAG is non-nil, the package also needs to be included
when compiling LaTeX snippets into images for inclusion into
non-LaTeX output.
COMPILERS is a list of compilers that should include the package,
see `org-latex-compiler'. If the document compiler is not in the
list, and the list is non-nil, the package will not be inserted
in the final document.
A string will be inserted as-is in the header of the document.
org-latex-default-quote-environment (funcall #'#[nil ("quote") (en...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Default environment used to `quote' blocks.
org-latex-default-table-environment (funcall #'#[nil ("tabular") (...
- Type: string
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Default environment used to build tables.
org-latex-default-table-mode (funcall #'#[nil ('table) (eng...
- Type: (choice (const :tag "Table" ta…
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Default mode for tables.
Value can be a symbol among:
`table' Regular LaTeX table.
`math' In this mode, every cell is considered as being in math
mode and the complete table will be wrapped within a math
environment. It is particularly useful to write matrices.
`inline-math' This mode is almost the same as `math', but the
math environment will be inlined.
`verbatim' The table is exported as it appears in the Org
buffer, within a verbatim environment.
This value can be overridden locally with, i.e. ":mode math" in
LaTeX attributes.
When modifying this variable, it may be useful to change
`org-latex-default-table-environment' accordingly.
org-latex-diary-timestamp-format (funcall #'#[nil ("\\textit{%s...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
A `format' string to be applied to diary timestamps.
org-latex-engraved-options (funcall #'#[nil ('(("commandc...
- Type: (alist :key-type (string :tag …
- In file: ox-latex.el
- Find modifications in git logs
Association list of options for the latex fvextra package when engraving code.
These options are set using \fvset{...} in the preamble of the
LaTeX export. Each element of the alist should be a list or cons
cell containing two strings: the name of the option, and the
value. For example,
(setq org-latex-engraved-options
\='(("highlightcolor" "green") ("frame" "lines")))
; or
(setq org-latex-engraved-options
\='(("highlightcolor" . "green") ("frame" . "lines")))
will result in the following LaTeX in the preamble
\fvset{%
bgcolor=bg,
frame=lines}
This will affect all fvextra environments. Note that the same
options will be applied to all blocks. If you need
block-specific options, you may use the following syntax:
#+ATTR_LATEX: :options key1=value1,key2=value2
#+BEGIN_SRC <LANG>
...
#+END_SRC
org-latex-engraved-preamble (funcall #'#[nil ("\\usepackag...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Preamble content injected when using engrave-faces-latex for source blocks. This is relevant when `org-latex-src-block-backend' is set to `engraved'. There is quite a lot of flexibility in what this preamble can be, as long as it: - Loads the fvextra package. - Loads the package xcolor (if it is not already loaded elsewhere). - Defines a "Code" environment (note the capital C), which all "Verbatim" environments (provided by fvextra) will be wrapped with. In the default value the colors "EFD" and "EfD" are provided as they are respectively the foreground and background colors, just in case they aren't provided by the generated preamble, so we can assume they are always set. Within this preamble there are two recognized macro-like placeholders: [FVEXTRA-SETUP] [LISTINGS-SETUP] Unless you have a very good reason, both of these placeholders should be included in the preamble. FVEXTRA-SETUP sets fvextra's defaults according to `org-latex-engraved-options', and LISTINGS-SETUP creates the listings environment used for captioned or floating code blocks, as well as defining \listoflistings.
org-latex-engraved-theme (funcall #'#[nil (nil) (engrav...
- Type: symbol
- In file: ox-latex.el
- Find modifications in git logs
The theme that should be used for engraved code, when non-nil. This can be set to any theme defined in `engrave-faces-themes' (from the engrave-faces package) or loadable by Emacs. When set to t, the current Emacs theme is used. When nil, no theme is applied.
org-latex-footnote-defined-format (funcall #'#[nil ("\\textsuper...
- Type: (choice (const :tag "Use plain…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Format string used to format reference to footnote already defined. %s will be replaced by the label of the referred footnote.
org-latex-footnote-separator (funcall #'#[nil ("\\textsuper...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Text used to separate footnotes.
org-latex-format-drawer-function (funcall #'#[nil (#'(lambda (_...
- Type: function
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Function called to format a drawer in LaTeX code. The function must accept two parameters: NAME the drawer name, like "LOGBOOK" CONTENTS the contents of the drawer. The function should return the string to be exported. The default function simply returns the value of CONTENTS.
org-latex-format-headline-function (funcall #'#[nil ('org-latex-f...
- Type: function
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Function for formatting the headline's text. This function will be called with six arguments: TODO the todo keyword (string or nil) TODO-TYPE the type of todo (symbol: `todo', `done', nil) PRIORITY the priority of the headline (integer or nil) TEXT the main headline text (string) TAGS the tags (list of strings or nil) INFO the export options (plist) The function result will be used in the section format string.
org-latex-format-inlinetask-function (funcall #'#[nil ('org-latex-f...
- Type: function
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Function called to format an inlinetask in LaTeX code. The function must accept seven parameters: TODO the todo keyword (string or nil) TODO-TYPE the todo type (symbol: `todo', `done', nil) PRIORITY the inlinetask priority (integer or nil) NAME the inlinetask name (string) TAGS the inlinetask tags (list of strings or nil) CONTENTS the contents of the inlinetask (string or nil) INFO the export options (plist) The function should return the string to be exported.
org-latex-hyperref-template (funcall #'#[nil ("\\hypersetu...
- Type: (choice (const :tag "No templa…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Template for hyperref package options. This format string may contain these elements: %a for AUTHOR keyword %t for TITLE keyword %s for SUBTITLE keyword %k for KEYWORDS line %d for DESCRIPTION line %c for CREATOR line %l for Language keyword %L for capitalized language keyword %D for DATE keyword If you need to use a "%" character, you need to escape it like that: "%%". As a special case, a nil value prevents template from being inserted. Setting :latex-hyperref-template in publishing projects will take precedence over this variable.
org-latex-image-default-height (funcall #'#[nil ("") (engrave...
- Type: string
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Default height for images. This value will not be used if a width is provided, or if the image is wrapped within a "figure" or "wrapfigure" environment.
org-latex-image-default-option (funcall #'#[nil ("") (engrave...
- Type: string
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Default option for images.
org-latex-image-default-scale (funcall #'#[nil ("") (engrave...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Default scale for images. This value will not be used if a width or a scale is provided, or if the image is wrapped within a "wrapfigure" environment. Scale overrides width and height.
org-latex-image-default-width (funcall #'#[nil (".9\\linewid...
- Type: string
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Default width for images. This value will not be used if a height is provided.
org-latex-images-centered (funcall #'#[nil (t) (engrave-...
- Type: boolean
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
When non-nil, images are centered.
org-latex-inactive-timestamp-format (funcall #'#[nil ("\\textit{%s...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
A `format' string to be applied to inactive timestamps.
org-latex-inline-image-rules (funcall #'#[nil ((list (cons ...
- Type: (alist :key-type (string :tag …
- In file: ox-latex.el
- Find modifications in git logs
Rules characterizing image files that can be inlined into LaTeX. A rule consists in an association whose key is the type of link to consider, and value is a regexp that will be matched against link's path. Note that, by default, the image extension *actually* allowed depend on the way the LaTeX file is processed. When used with pdflatex, pdf, jpg and png images are OK. When processing through dvi to Postscript, only ps and eps are allowed. The default we use here encompasses both.
org-latex-inputenc-alist (funcall #'#[nil (nil) (engrav...
- Type: (repeat (cons (string :tag "De…
- In file: ox-latex.el
- Find modifications in git logs
Alist of inputenc coding system names, and what should really be used.
For example, adding an entry
("utf8" . "utf8x")
will cause \usepackage[utf8x]{inputenc} to be used for buffers that
are written as utf8 files.
org-latex-known-warnings (funcall #'#[nil ('(("Referenc...
- Type: (repeat (cons (regexp :tag "Re…
- In file: ox-latex.el
- Find modifications in git logs
Alist of regular expressions and associated messages for the user. The regular expressions are used to find possible warnings in the log of a LaTeX-run. These warnings will be reported after calling `org-latex-compile'.
org-latex-link-with-unknown-path-format (funcall #'#[nil ("\\texttt{%s...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Format string for links with unknown path type.
org-latex-listings-langs (funcall #'#[nil ('((emacs-lis...
- Type: (repeat (list (symbol :tag "Ma…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Alist mapping languages to their listing language counterpart. The key is a symbol, the major mode symbol without the "-mode". The value is the string that should be inserted as the language parameter for the listings package. If the mode name and the listings name are the same, the language does not need an entry in this list - but it does not hurt if it is present.
org-latex-listings-options (funcall #'#[nil (nil) (engrav...
- Type: (repeat (list (string :tag "Li…
- In file: ox-latex.el
- Find modifications in git logs
Association list of options for the latex listings package.
These options are supplied as a comma-separated list to the
\lstlisting command. Each element of the association list should be
a list or cons cell containing two strings: the name of the
option, and the value. For example,
(setq org-latex-listings-options
\='(("basicstyle" "\\small")
("keywordstyle" "\\color{black}\\bfseries\\underbar")))
; or
(setq org-latex-listings-options
\='(("basicstyle" . "\\small")
("keywordstyle" . "\\color{black}\\bfseries\\underbar")))
will typeset the code in a small size font with underlined, bold
black keywords.
Note that the same options will be applied to blocks of all
languages. If you need block-specific options, you may use the
following syntax:
#+ATTR_LATEX: :options key1=value1,key2=value2
#+BEGIN_SRC <LANG>
...
#+END_SRC
org-latex-listings-src-omit-language (funcall #'#[nil (nil) (engrav...
- Type: boolean
- In file: ox-latex.el
- Find modifications in git logs
Discard src block language parameter in listings.
Set this option to t to omit the "language=" in the parameters to
"lstlisting" environments when exporting an src block.
This is necessary, for example, when the "fancyvrb" package is used
instead of "listings":
#+LATEX_HEADER: \RequirePackage{fancyvrb}
#+LATEX_HEADER: \DefineVerbatimEnvironment{verbatim}{Verbatim}{...}
#+LATEX_HEADER: \DefineVerbatimEnvironment{lstlisting}{Verbatim}{...}
org-latex-logfiles-extensions (funcall #'#[nil ('("aux" "bcf...
- Type: (repeat (string :tag "Extensio…
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
The list of file extensions to consider as LaTeX logfiles. The logfiles will be removed if `org-latex-remove-logfiles' is non-nil.
org-latex-mathml-directory (funcall #'#[nil ("ltxmathml/"...
- Type: string
- In file: org.el
- Find modifications in git logs
Path to store MathML files converted from LaTeX fragments. A relative path here creates many directories relative to the processed Org files paths. An absolute path puts all files in the same place.
org-latex-minted-langs (funcall #'#[nil ('((emacs-lis...
- Type: (repeat (list (symbol :tag "Ma…
- In file: ox-latex.el
- Find modifications in git logs
Alist mapping languages to their minted language counterpart. The key is a symbol, the major mode symbol without the "-mode". The value is the string that should be inserted as the language parameter for the minted package. If the mode name and the listings name are the same, the language does not need an entry in this list - but it does not hurt if it is present. Note that minted uses all lower case for language identifiers, and that the full list of language identifiers can be obtained with: pygmentize -L lexers
org-latex-minted-options (funcall #'#[nil (nil) (engrav...
- Type: (repeat (list (string :tag "Mi…
- In file: ox-latex.el
- Find modifications in git logs
Association list of options for the latex minted package.
These options are supplied within square brackets in
\begin{minted} environments. Each element of the alist should
be a list or cons cell containing two strings: the name of the
option, and the value. For example,
(setq org-latex-minted-options
\='(("bgcolor" "bg") ("frame" "lines")))
; or
(setq org-latex-minted-options
\='(("bgcolor" . "bg") ("frame" . "lines")))
will result in source blocks being exported with
\begin{minted}[bgcolor=bg,frame=lines]{<LANG>}
as the start of the minted environment. Note that the same
options will be applied to blocks of all languages. If you need
block-specific options, you may use the following syntax:
#+ATTR_LATEX: :options key1=value1,key2=value2
#+BEGIN_SRC <LANG>
...
#+END_SRC
org-latex-packages-alist (funcall #'#[nil (nil) (crm-se...
- Type: (repeat (choice (list :tag "op…
- In file: org.el
- Find modifications in git logs
Alist of packages to be inserted in every LaTeX header.
These will be inserted after `org-latex-default-packages-alist'.
Each element is either a cell or a string.
A cell is of the format:
("options" "package" SNIPPET-FLAG COMPILERS)
SNIPPET-FLAG, when non-nil, indicates that this package is also
needed when turning LaTeX snippets into images for inclusion into
non-LaTeX output.
COMPILERS is a list of compilers that should include the package,
see `org-latex-compiler'. If the document compiler is not in the
list, and the list is non-nil, the package will not be inserted
in the final document.
A string will be inserted as-is in the header of the document.
Make sure that you only list packages here which:
- you want in every file;
- do not conflict with the setup in `org-format-latex-header';
- do not conflict with the default packages in
`org-latex-default-packages-alist'.
org-latex-pdf-process (funcall #'#[nil ((if (and (ex...
- Type: (choice (repeat :tag "Shell co…
- In file: ox-latex.el
- Find modifications in git logs
Commands to process a LaTeX file to a PDF file. The command output will be parsed to extract compilation errors and warnings according to `org-latex-known-warnings'. This is a list of strings, each of them will be given to the shell as a command. %f in the command will be replaced by the relative file name, %F by the absolute file name, %b by the file base name (i.e. without directory and extension parts), %o by the base directory of the file, %O by the absolute file name of the output file, %latex is the LaTeX compiler (see `org-latex-compiler'), and %bib is the BibTeX-like compiler (see `org-latex-bib-compiler'). The reason why this is a list is that it usually takes several runs of `pdflatex', maybe mixed with a call to `bibtex'. Org does not have a clever mechanism to detect which of these commands have to be run to get to a stable result, and it also does not do any error checking. Consider a smart LaTeX compiler such as `texi2dvi' or `latexmk', which calls the "correct" combinations of auxiliary programs. Alternatively, this may be a Lisp function that does the processing, so you could use this to apply the machinery of AUCTeX or the Emacs LaTeX mode. This function should accept the file name as its single argument.
org-latex-prefer-user-labels (funcall #'#[nil (nil) (engrav...
- Type: boolean
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Use user-provided labels instead of internal ones when non-nil.
When this variable is non-nil, Org will use the value of
CUSTOM_ID property, NAME keyword or Org target as the key for the
\label commands generated.
By default, Org generates its own internal labels during LaTeX
export. This process ensures that the \label keys are unique
and valid, but it means the keys are not available in advance of
the export process.
Setting this variable gives you control over how Org generates
labels during LaTeX export, so that you may know their keys in
advance. One reason to do this is that it allows you to refer to
various elements using a single label both in Org's link syntax
and in embedded LaTeX code.
For example, when this variable is non-nil, a headline like this:
** Some section
:PROPERTIES:
:CUSTOM_ID: sec:foo
:END:
This is section [[#sec:foo]].
#+BEGIN_EXPORT latex
And this is still section \ref{sec:foo}.
#+END_EXPORT
will be exported to LaTeX as:
\subsection{Some section}
\label{sec:foo}
This is section \ref{sec:foo}.
And this is still section \ref{sec:foo}.
A non-default value of `org-latex-reference-command' will change the
command (\ref by default) used to create label references.
Note, however, that setting this variable introduces a limitation
on the possible values for CUSTOM_ID and NAME. When this
variable is non-nil, Org passes their value to \label unchanged.
You are responsible for ensuring that the value is a valid LaTeX
\label key, and that no other \label commands with the same key
appear elsewhere in your document. (Keys may contain letters,
numbers, and the following punctuation: `_' `.' `-' `:'.) There
are no such limitations on CUSTOM_ID and NAME when this variable
is nil.
For headlines that do not define the CUSTOM_ID property or
elements without a NAME, Org will continue to use its default
labeling scheme to generate labels and resolve links into proper
references.
org-latex-reference-command (funcall #'#[nil ("\\ref{%s}")...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
Format string that takes a reference to produce a LaTeX reference command.
The reference is a label such as sec:intro. A format string of "\ref{%s}"
produces numbered references and will always work. It may be desirable to make
use of a package such as hyperref or cleveref and then change the format string
to "\autoref{%s}" or "\cref{%s}" for example.
org-latex-remove-logfiles (funcall #'#[nil (t) (engrave-...
- Type: boolean
- In file: ox-latex.el
- Find modifications in git logs
Non-nil means remove the logfiles produced by PDF production. By default, logfiles are files with these extensions: .aux, .idx, .log, .out, .toc, .nav, .snm and .vrb. To define the set of logfiles to remove, set `org-latex-logfiles-extensions'.
org-latex-src-block-backend (funcall #'#[nil ('verbatim) (...
- Type: (choice (const :tag "Use listi…
- In file: ox-latex.el
- Find modifications in git logs
Backend used to generate source code listings.
This sets the behavior for fontifying source code, possibly even with
color. There are four implementations of this functionality you may
choose from (ordered from least to most capable):
1. Verbatim
2. Listings
3. Minted
4. Engraved
The first two options provide basic syntax
highlighting (listings), or none at all (verbatim).
When using listings, you also need to make use of LaTeX package
"listings". The "xcolor" LaTeX package is also needed for
color management. These can simply be added to
`org-latex-packages-alist', using customize or something like:
(require \='ox-latex)
(add-to-list \='org-latex-packages-alist \='("" "listings"))
(add-to-list \='org-latex-packages-alist \='("" "xcolor"))
There are two further options for more comprehensive
fontification. The first can be set with,
(setq org-latex-src-block-backend \='minted)
which causes source code to be exported using the LaTeX package
minted as opposed to listings. If you want to use minted, you
need to add the minted package to `org-latex-packages-alist', for
example using customize, or with
(require \='ox-latex)
(add-to-list \='org-latex-packages-alist \='("newfloat" "minted"))
In addition, it is necessary to install pygments
(URL `https://pygments.org>'), and to configure the variable
`org-latex-pdf-process' so that the -shell-escape option is
passed to pdflatex.
The minted choice has possible repercussions on the preview of
latex fragments (see `org-latex-preview'). If you run
into previewing problems, please consult
URL `https://orgmode.org/worg/org-tutorials/org-latex-preview.html'.
The most comprehensive option can be set with,
(setq org-latex-src-block-backend \='engraved)
which causes source code to be run through
`engrave-faces-latex-buffer', which generates colorings using
Emacs's font-lock information. This requires the Emacs package
engrave-faces (available from GNU ELPA), and the LaTeX package
fvextra be installed.
The styling of the engraved result can be customized with
`org-latex-engraved-preamble' and `org-latex-engraved-options'.
The default preamble also uses the LaTeX package tcolorbox in
addition to fvextra.
org-latex-subtitle-format (funcall #'#[nil ("\\\\\\medsk...
- Type: (string :tag "Format string")
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Format string used for transcoded subtitle. The format string should have at most one "%s"-expression, which is replaced with the subtitle.
org-latex-subtitle-separate (funcall #'#[nil (nil) (engrav...
- Type: boolean
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Non-nil means the subtitle is not typeset as part of title.
org-latex-table-scientific-notation (funcall #'#[nil (nil) (engrav...
- Type: (choice (string :tag "Format s…
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
Format string to display numbers in scientific notation.
The format should have "%s" twice, for mantissa and exponent
(i.e., "%s\\times10^{%s}").
When nil, no transformation is made.
org-latex-tables-booktabs (funcall #'#[nil (nil) (engrav...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-latex.el
- Find modifications in git logs
When non-nil, display tables in a formal "booktabs" style. This option assumes that the "booktabs" package is properly loaded in the header of the document. This value can be ignored locally with ":booktabs t" and ":booktabs nil" LaTeX attributes.
org-latex-tables-centered (funcall #'#[nil (t) (engrave-...
- Type: boolean
- In file: ox-latex.el
- Find modifications in git logs
When non-nil, tables are exported in a center environment.
org-latex-text-markup-alist (funcall #'#[nil ('((bold . "\...
- Type: alist
- Since: Emacs version 26.1
- In file: ox-latex.el
- Find modifications in git logs
Alist of LaTeX expressions to convert text markup. The key must be a symbol among `bold', `code', `italic', `strike-through', `underline' and `verbatim'. The value is a formatting string to wrap fontified text with. Value can also be set to the following symbols: `verb' and `protectedtexttt'. For the former, Org will use "\verb" to create a format string and select a delimiter character that isn't in the string. For the latter, Org will use "\texttt" to typeset and try to protect special characters. If no association can be found for a given markup, text will be returned as-is.
org-latex-title-command (funcall #'#[nil ("\\maketitle...
- Type: (string :tag "Format string")
- In file: ox-latex.el
- Find modifications in git logs
The command used to insert the title just after \begin{document}.
This format string may contain these elements:
%a for AUTHOR keyword
%t for TITLE keyword
%s for SUBTITLE keyword
%k for KEYWORDS line
%d for DESCRIPTION line
%c for CREATOR line
%l for Language keyword
%L for capitalized language keyword
%D for DATE keyword
If you need to use a "%" character, you need to escape it
like that: "%%".
Setting :latex-title-command in publishing projects will take
precedence over this variable.
org-latex-to-html-convert-command (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "None" nil…
- In file: org.el
- Find modifications in git logs
Shell command to convert LaTeX fragments to HTML.
This command is very open-ended: the output of the command will
directly replace the LaTeX fragment in the resulting HTML.
Replace format-specifiers in the command as noted below and use
`shell-command' to convert LaTeX to HTML.
%i: The LaTeX fragment to be converted (shell-escaped).
It must not be used inside a quoted argument, the result of %i
expansion inside a quoted argument is undefined.
For example, this could be used with LaTeXML as
"latexmlc literal:%i --profile=math --preload=siunitx.sty 2>/dev/null".
org-latex-to-mathml-convert-command (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "None" nil…
- In file: org.el
- Find modifications in git logs
Command to convert LaTeX fragments to MathML.
Replace format-specifiers in the command as noted below and use
`shell-command' to convert LaTeX to MathML.
%j: Executable file in fully expanded form as specified by
`org-latex-to-mathml-jar-file'.
%I: Input LaTeX file in fully expanded form.
%i: Shell-escaped LaTeX fragment to be converted.
It must not be used inside a quoted argument, the result of %i
expansion inside a quoted argument is undefined.
%o: Output MathML file.
This command is used by `org-create-math-formula'.
When using MathToWeb as the converter, set this option to
"java -jar %j -unicode -force -df %o %I".
When using LaTeXML set this option to
"latexmlmath %i --presentationmathml=%o".
org-latex-to-mathml-jar-file (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "None" nil…
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Value of"%j" in `org-latex-to-mathml-convert-command'. Use this to specify additional executable file say a jar file. When using MathToWeb as the converter, specify the full-path to your mathtoweb.jar file.
org-latex-toc-command (funcall #'#[nil ("\\tableofco...
- Type: string
- In file: ox-latex.el
- Find modifications in git logs
LaTeX command to set the table of contents, list of figures, etc. This command only applies to the table of contents generated with the toc:t, toc:1, toc:2, toc:3, ... options, not to those generated with the #+TOC keyword.
org-latex-toc-include-unnumbered (funcall #'#[nil (nil) (engrav...
- Type: boolean
- In file: ox-latex.el
- Find modifications in git logs
Whether to include unnumbered headings in the table of contents. The default behaviour is to include numbered headings only, as it is usually the case in LaTeX (but different from other Org exporters). To include an unnumbered heading, set the `:UNNUMBERED:' property to `toc'
org-latex-use-sans (funcall #'#[nil (nil) (engrav...
- Type: boolean
- In file: ox-latex.el
- Find modifications in git logs
Whether to typeset the document with the Sans font family. The default behaviour is to typeset with the Roman font family.
org-level-color-stars-only (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means fontify only the stars in each headline. When nil, the entire headline is fontified. Changing it requires restart of `font-lock-mode' to become effective also in regions already fontified.
org-link-abbrev-alist (funcall #'#[nil (nil) (org-id...
- Type: (repeat (cons (string :tag "Pr…
- In file: ol.el
- Find modifications in git logs
Alist of link abbreviations.
The car of each element is a string, to be replaced at the start of a link.
The cdrs are replacement values, like ("linkkey" . REPLACE). Abbreviated
links in Org buffers can have an optional tag after a double colon, e.g.,
[[linkkey:tag][description]]
The `linkkey' must be a single word, starting with a letter, followed
by letters, numbers, `-' or `_'.
If REPLACE is a string, the tag will simply be appended to create the link.
If the string contains "%s", the tag will be inserted there. If the string
contains "%h", it will cause a url-encoded version of the tag to be inserted
at that point (see the function `url-hexify-string'). If the string contains
the specifier "%(my-function)", then the custom function `my-function' will
be invoked: this function takes the tag as its only argument and must return
a string.
REPLACE may also be a function that will be called with the tag as the
only argument to create the link, which should be returned as a string.
See the manual for examples.
org-link-context-for-files (funcall #'#[nil (t) (org-id-l...
- Type: (choice boolean integer)
- In file: ol.el
- Find modifications in git logs
Non-nil means file links from `org-store-link' contain context. \<org-mode-map> A search string is added to the file name with "::" as separator and used to find the context when the link is activated by the command `org-open-at-point'. When this option is t, the entire active region is be placed in the search string of the file link. If set to a positive integer N, only the first N lines of context are stored. Using a prefix argument to the command `org-store-link' (`\[universal-argument] \[org-store-link]') negates this setting for the duration of the command.
org-link-descriptive (funcall #'#[nil (t) (org-id-l...
- Type: boolean
- In file: ol.el
- Find modifications in git logs
Non-nil means Org displays descriptive links. E.g. [[https://orgmode.org][Org website]] is displayed as "Org Website", hiding the link itself and just displaying its description. When set to nil, Org displays the full links literally. You can interactively set the value of this variable by calling `org-toggle-link-display' or from the "Org > Hyperlinks" menu.
org-link-doi-server-url (funcall #'#[nil ("https://doi...
- Type: string
- Since: Emacs version 24.3
- In file: ol-doi.el
- Find modifications in git logs
The URL of the DOI server.
org-link-elisp-confirm-function (funcall #'#[nil ('yes-or-no-p...
- Type: (choice (const :tag "with yes-…
- In file: ol.el
- Find modifications in git logs
Non-nil means ask for confirmation before executing Emacs Lisp links.
Elisp links can be dangerous: just think about a link
[[elisp:(shell-command "rm -rf ~/*")][Web Search]]
This link would show up in your Org document as "Web Search",
but really it would remove your entire home directory.
Therefore we advise against setting this variable to nil.
Just change it to `y-or-n-p' if you want to confirm with a
single keystroke rather than having to type "yes".
org-link-elisp-skip-confirm-regexp (funcall #'#[nil ("") (org-id-...
- Type: regexp
- Since: Emacs version 24.1
- In file: ol.el
- Find modifications in git logs
A regexp to skip confirmation for Elisp links.
org-link-email-description-format (funcall #'#[nil ("Email %c: %...
- Type: string
- In file: ol.el
- Find modifications in git logs
Format of the description part of a link to an email or Usenet message.
The following %-escapes will be replaced by corresponding information:
%F full "From" field
%f name, taken from "From" field, address if no name
%T full "To" field
%t first name in "To" field, address if no name
%c correspondent. Usually "from NAME", but if you sent it yourself, it
will be "to NAME". See also the variable `org-link-from-user-regexp'.
%s subject
%d date
%m message-id.
You may use normal field width specification between the % and the letter.
This is for example useful to limit the length of the subject.
Examples: "%f on: %.30s", "Email from %f", "Email %c"
org-link-file-path-type (funcall #'#[nil ('adaptive) (...
- Type: (choice (const relative) (cons…
- In file: ol.el
- Find modifications in git logs
How the path name in file links should be stored.
Valid values are:
relative Relative to the current directory, i.e. the directory of the file
into which the link is being inserted.
absolute Absolute path, if possible with ~ for home directory.
noabbrev Absolute path, no abbreviation of home directory.
adaptive Use relative path for files in the current directory and sub-
directories of it. For other files, use an absolute path.
Alternatively, users may supply a custom function that takes the
filename in the link as an argument and returns the path.
org-link-frame-setup (funcall #'#[nil ('((vm . vm-v...
- Type: (list (cons (const vm) (choice…
- In file: ol.el
- Find modifications in git logs
Setup the frame configuration for following links.
When following a link with Emacs, it may often be useful to display
this link in another window or frame. This variable can be used to
set this up for the different types of links.
For VM, use any of
`vm-visit-folder'
`vm-visit-folder-other-window'
`vm-visit-folder-other-frame'
For Gnus, use any of
`gnus'
`gnus-other-frame'
`org-gnus-no-new-news'
`org-gnus-no-new-news-other-frame'
For FILE, use any of
`find-file'
`find-file-other-window'
`find-file-other-frame'
For Wanderlust use any of
`wl'
`wl-other-frame'
For the calendar, use the variable `calendar-setup'.
For BBDB, it is currently only possible to display the matches in
another window.
org-link-from-user-regexp (funcall #'#[nil ((let ((mail ...
- Type: regexp
- In file: ol.el
- Find modifications in git logs
Regexp matched against the "From:" header of an email or Usenet message. It should match if the message is from the user him/herself.
org-link-keep-stored-after-insertion (funcall #'#[nil (nil) (org-id...
- Type: boolean
- In file: ol.el
- Find modifications in git logs
Non-nil means keep link in list for entire session. \<org-mode-map> The command `org-store-link' adds a link pointing to the current location to an internal list. These links accumulate during a session. The command `org-insert-link' can be used to insert links into any Org file (offering completion for all stored links). When this option is nil, every link which has been inserted once using `\[org-insert-link]' will be removed from the list, to make completing the unused links more efficient.
org-link-make-description-function (funcall #'#[nil (nil) (org-id...
- Type: (choice (const nil) (function)…
- In file: ol.el
- Find modifications in git logs
Function to use for generating link descriptions from links. This function must take two parameters: the first one is the link, the second one is the description generated by `org-insert-link'. The function should return the description to use. If it returns nil, no default description is used, but no error is thrown (from the user’s perspective, this is equivalent to a default description of "").
org-link-parameters (funcall #'#[nil (nil) (org-id...
- Type: (alist :tag "Link display para…
- In file: ol.el
- Find modifications in git logs
Alist of properties that defines all the links in Org mode. The key in each association is a string of the link type. Subsequent optional elements make up a property list for that type. All properties are optional. However, the most important ones are, in this order, `:follow', `:export', and `:store', described below. `:follow' Function used to follow the link, when the `org-open-at-point' command runs on it. It is called with two arguments: the path, as a string, and a universal prefix argument. Here, you may use `org-link-open-as-file' helper function for types similar to "file". `:export' Function that accepts four arguments: - the path, as a string, - the description as a string, or nil, - the export backend, - the export communication channel, as a plist. When nil, export for that type of link is delegated to the backend. `:store' Function responsible for storing the link. See the function `org-store-link-functions' for a description of the expected arguments. Additional properties provide more specific control over the link. `:activate-func' Function to run at the end of Font Lock activation. It must accept four arguments: - the buffer position at the start of the link, - the buffer position at its end, - the path, as a string, - a boolean, non-nil when the link has brackets. `:complete' Function that inserts a link with completion. The function takes one optional prefix argument. `:insert-description' String or function used as a default when prompting users for a link's description. A string is used as-is, a function is called with two arguments: the link location (a string such as "~/foobar", "id:some-org-id" or "https://www.foo.com") and the description generated by `org-insert-link'. It should return the description to use (this reflects the behavior of `org-link-make-description-function'). If it returns nil, no default description is used, but no error is thrown (from the user's perspective, this is equivalent to a default description of ""). `:display' Value for `invisible' text property on the hidden parts of the link. The most useful value is `full', which will not fold the link in descriptive display. Default is `org-link'. `:face' Face for the link, or a function returning a face. The function takes one argument, which is the path. The default face is `org-link'. `:preview' Function to run to generate an in-buffer preview for the link. It must accept three arguments: - an overlay placed from the start to the end of the link - the link path, as a string - the syntax node for the link This function must return a non-nil value to indicate success. A return value of nil implies that the preview failed, and the overlay placed on the link will be removed. `:help-echo' String or function used as a value for the `help-echo' text property. The function is called with one argument, the help string to display, and should return a string. `:htmlize-link' Function or plist for the `htmlize-link' text property. The function takes no argument. Default is (:uri "type:path") `:keymap' Active keymap when point is on the link. Default is `org-mouse-map'. `:mouse-face' Face used when hovering over the link. Default is `highlight'.
org-link-preview-batch-size (funcall #'#[nil (6) (org-id-l...
- Type: natnum
- In file: ol.el
- Find modifications in git logs
Number of links that are previewed at once with `org-link-preview'. Links are previewed asynchronously, in batches spaced out in time (see `org-link-preview-delay'). Set this to a large integer for more immediate previews, but at the expense of higher lag.
org-link-preview-delay (funcall #'#[nil (0.05) (org-i...
- Type: number
- In file: ol.el
- Find modifications in git logs
Idle delay in seconds between link previews when using `org-link-preview'. Links are previewed in batches (see `org-link-preview-batch-size') spaced out by this delay. Set this to a small number for more immediate previews, but at the expense of higher lag.
org-link-search-must-match-exact-headline (funcall #'#[nil ('query-to-cr...
- Type: (choice (const :tag "Use fuzzy…
- Since: Emacs version 24.1
- In file: ol.el
- Find modifications in git logs
Control fuzzy link behavior when specific matches not found. When nil, if a fuzzy link does not match a more specific target (such as a heading, named block, target, or code ref), attempt a regular text search. When set to the special value `query-to-create', offer to create a new heading matching the link instead. Otherwise, signal an error rather than attempting a regular text search. This option only affects behavior in Org buffers. Spaces and statistics cookies are ignored during heading searches.
org-link-shell-confirm-function (funcall #'#[nil ('yes-or-no-p...
- Type: (choice (const :tag "with yes-…
- In file: ol.el
- Find modifications in git logs
Non-nil means ask for confirmation before executing shell links.
Shell links can be dangerous: just think about a link
[[shell:rm -rf ~/*][Web Search]]
This link would show up in your Org document as "Web Search",
but really it would remove your entire home directory.
Therefore we advise against setting this variable to nil.
Just change it to `y-or-n-p' if you want to confirm with a
single keystroke rather than having to type "yes".
org-link-shell-skip-confirm-regexp (funcall #'#[nil ("") (org-id-...
- Type: regexp
- Since: Emacs version 24.1
- In file: ol.el
- Find modifications in git logs
Regexp to skip confirmation for shell links.
org-link-translation-function (funcall #'#[nil (nil) (org-id...
- Type: (choice (const nil) (function)…
- In file: ol.el
- Find modifications in git logs
Function to translate links with different syntax to Org syntax. This can be used to translate links created for example by the Planner or emacs-wiki packages to Org syntax. The function must accept two parameters, a TYPE containing the link protocol name like "rmail" or "gnus" as a string, and the linked path, which is everything after the link protocol. It should return a cons with possibly modified values of type and path.
org-link-use-indirect-buffer-for-internals (funcall #'#[nil (nil) (org-id...
- Type: boolean
- In file: ol.el
- Find modifications in git logs
Non-nil means use indirect buffer to display infile links. Activating internal links (from one location in a file to another location in the same file) normally just jumps to the location. When the link is activated with a `\[universal-argument]' prefix (or with mouse-3), the link is displayed in another window. When this option is set, the other window actually displays an indirect buffer clone of the current buffer, to avoid any visibility changes to the current buffer.
org-list-allow-alphabetical (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-list.el
- Find modifications in git logs
Non-nil means single character alphabetical bullets are allowed. Both uppercase and lowercase are handled. Lists with more than 26 items will fallback to standard numbering. Alphabetical counters like "[@c]" will be recognized. This variable needs to be set before org.el is loaded. If you need to make a change while Emacs is running, use the customize interface or run the following code after updating it: `\[org-element-update-syntax]'
org-list-automatic-rules (funcall #'#[nil ('((checkbox ...
- Type: (alist :tag "Sets of rules" :k…
- Since: Emacs version 24.1
- In file: org-list.el
- Find modifications in git logs
Non-nil means apply set of rules when acting on lists.
\<org-mode-map>
By default, automatic actions are taken when using
`\[org-meta-return]',
`\[org-metaright]',
`\[org-metaleft]',
`\[org-shiftmetaright]',
`\[org-shiftmetaleft]',
`\[org-ctrl-c-minus]',
`\[org-toggle-checkbox]',
`\[org-insert-todo-heading]'.
You can disable individually these rules by setting them to nil.
Valid rules are:
checkbox when non-nil, checkbox statistics is updated each time
you either insert a new checkbox or toggle a checkbox.
indent when non-nil, indenting or outdenting list top-item
with its subtree will move the whole list and
outdenting a list whose bullet is * to column 0 will
change that bullet to "-".
org-list-demote-modify-bullet (funcall #'#[nil (nil) (t)])
- Type: (repeat (cons (choice :tag "If…
- In file: org-list.el
- Find modifications in git logs
Default bullet type installed when demoting an item.
This is an association list, for each bullet type, this alist will point
to the bullet that should be used when this item is demoted.
For example,
(setq org-list-demote-modify-bullet
\='(("+" . "-") ("-" . "+") ("*" . "+")))
will make
+ Movies
+ Silence of the Lambs
+ My Cousin Vinny
+ Books
+ The Hunt for Red October
+ The Road to Omaha
into
+ Movies
- Silence of the Lambs
- My Cousin Vinny
+ Books
- The Hunt for Red October
- The Road to Omaha
org-list-indent-offset (funcall #'#[nil (0) (t)])
- Type: integer
- Since: Emacs version 24.1
- In file: org-list.el
- Find modifications in git logs
Additional indentation for sub-items in a list. By setting this to a small number, usually 1 or 2, one can more clearly distinguish sub-items in a list.
org-list-two-spaces-after-bullet-regexp (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "never" ni…
- In file: org-list.el
- Find modifications in git logs
A regular expression matching bullets that should have 2 spaces after them. When nil, no bullet will have two spaces after them. When a string, it will be used as a regular expression. When the bullet type of a list is changed, the new bullet type will be matched against this regexp. If it matches, there will be two spaces instead of one after the bullet in each item of the list.
org-list-use-circular-motion (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-list.el
- Find modifications in git logs
Non-nil means commands implying motion in lists should be cyclic. \<org-mode-map> In that case, the item following the last item is the first one, and the item preceding the first item is the last one. This affects the behavior of `\[org-move-item-up]', `\[org-move-item-down]', `\[org-next-item]', `\[org-previous-item]'.
org-log-done (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "No loggin…
- In file: org.el
- Find modifications in git logs
Information to record when a task moves to the DONE state. Possible values are: nil Don't add anything, just change the keyword time Add a time stamp to the task note Prompt for a note and add it with template `org-log-note-headings' This option can also be set with on a per-file-basis with #+STARTUP: nologdone #+STARTUP: logdone #+STARTUP: lognotedone You can have local logging settings for a subtree by setting the LOGGING property to one or more of these keywords.
org-log-done-with-time (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means the CLOSED time stamp will contain date and time. When nil, only the date will be recorded.
org-log-into-drawer (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Not into …
- In file: org.el
- Find modifications in git logs
Non-nil means insert state change notes and time stamps into a drawer. When nil, state changes notes will be inserted after the headline and any scheduling and clock lines, but not inside a drawer. The value of this variable should be the name of the drawer to use. LOGBOOK is proposed as the default drawer for this purpose, you can also set this to a string to define the drawer of your choice. A value of t is also allowed, representing "LOGBOOK". A value of t or nil can also be set with on a per-file-basis with #+STARTUP: logdrawer #+STARTUP: nologdrawer If this variable is set, `org-log-state-notes-insert-after-drawers' will be ignored. You can set the property LOG_INTO_DRAWER to overrule this setting for a subtree. Do not check directly this variable in a Lisp program. Call function `org-log-into-drawer' instead.
org-log-note-clock-out (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means record a note when clocking out of an item. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: lognoteclock-out #+STARTUP: nolognoteclock-out
org-log-note-headings (funcall #'#[nil ('((done . "C...
- Type: (list :greedy t (cons (const :…
- In file: org.el
- Find modifications in git logs
Headings for notes added to entries. The value is an alist, with the car being a symbol indicating the note context, and the cdr is the heading to be used. The heading may also be the empty string. The following placeholders can be used: %t a time stamp. %T an active time stamp instead the default inactive one %d a short-format time stamp. %D an active short-format time stamp. %s the new TODO state or time stamp (inactive), in double quotes. %S the old TODO state or time stamp (inactive), in double quotes. %u the user name. %U full user name. In fact, it is not a good idea to change the `state' entry, because Agenda Log mode depends on the format of these entries.
org-log-redeadline (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "No loggin…
- In file: org.el
- Find modifications in git logs
Information to record when the deadline date of a task is modified. Possible values are: nil Don't add anything, just change the date time Add a time stamp to the task note Prompt for a note and add it with template `org-log-note-headings' This option can also be set with on a per-file-basis with #+STARTUP: nologredeadline #+STARTUP: logredeadline #+STARTUP: lognoteredeadline You can have local logging settings for a subtree by setting the LOGGING property to one or more of these keywords. This variable has an effect when calling `org-deadline' or `org-agenda-deadline' only.
org-log-refile (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "No loggin…
- Since: Emacs version 24.1
- In file: org-refile.el
- Find modifications in git logs
Information to record when a task is refiled. Possible values are: nil Don't add anything time Add a time stamp to the task note Prompt for a note and add it with template `org-log-note-headings' This option can also be set with on a per-file-basis with #+STARTUP: nologrefile #+STARTUP: logrefile #+STARTUP: lognoterefile You can have local logging settings for a subtree by setting the LOGGING property to one or more of these keywords. When bulk-refiling, e.g., from the agenda, the value `note' is forbidden and will temporarily be changed to `time'.
org-log-repeat (funcall #'#[nil ('time) (crm-...
- Type: (choice (const :tag "Don't for…
- In file: org.el
- Find modifications in git logs
Non-nil means record moving through the DONE state when triggering repeat. An auto-repeating task is immediately switched back to TODO when marked DONE. If you are not logging state changes (by adding "@" or "!" to the TODO keyword definition), or set `org-log-done' to record a closing note, there will be no record of the task moving through DONE. This variable forces taking a note anyway. nil Don't force a record time Record a time stamp note Prompt for a note and add it with template `org-log-note-headings' This option can also be set with on a per-file-basis with #+STARTUP: nologrepeat #+STARTUP: logrepeat #+STARTUP: lognoterepeat You can have local logging settings for a subtree by setting the LOGGING property to one or more of these keywords.
org-log-reschedule (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "No loggin…
- In file: org.el
- Find modifications in git logs
Information to record when the scheduling date of a task is modified. Possible values are: nil Don't add anything, just change the date time Add a time stamp to the task note Prompt for a note and add it with template `org-log-note-headings' This option can also be set with on a per-file-basis with #+STARTUP: nologreschedule #+STARTUP: logreschedule #+STARTUP: lognotereschedule You can have local logging settings for a subtree by setting the LOGGING property to one or more of these keywords. This variable has an effect when calling `org-schedule' or `org-agenda-schedule' only.
org-log-state-notes-insert-after-drawers (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means insert state change notes after any drawers in entry. Only the drawers that *immediately* follow the headline and the deadline/scheduled line are skipped. When nil, insert notes right after the heading and perhaps the line with deadline/scheduling if present. This variable will have no effect if `org-log-into-drawer' is set.
org-log-states-order-reversed (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means the latest state note will be directly after heading. When nil, the state change notes will be ordered according to time. This option can also be set with on a per-file-basis with #+STARTUP: logstatesreversed #+STARTUP: nologstatesreversed
org-loop-over-headlines-in-active-region (funcall #'#[nil (t) (crm-sepa...
- Type: (choice (const :tag "Don't loo…
- In file: org.el
- Find modifications in git logs
Shall some commands act upon headlines in the active region? When set to t, some commands will be performed in all headlines within the active region. When set to `start-level', some commands will be performed in all headlines within the active region, provided that these headlines are of the same level than the first one. When set to a string, those commands will be performed on the matching headlines within the active region. Such string must be a tags/property/todo match as it is used in the agenda tags view. The list of commands is: `org-schedule', `org-deadline', `org-todo', `org-set-tags-command', `org-archive-subtree', `org-archive-set-tag', `org-toggle-archive-tag' and `org-archive-to-archive-sibling'. The archiving commands skip already archived entries. See `org-agenda-loop-over-headlines-in-active-region' for the equivalent option for agenda views.
org-man-command (funcall #'#[nil ('man) (t)])
- Type: (choice (const man) (const :ta…
- In file: ol-man.el
- Find modifications in git logs
The Emacs command to be used to display a man page.
org-man-logfiles-extensions (funcall #'#[nil ('("log" "out...
- Type: (repeat (string :tag "Extensio…
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
The list of file extensions to consider as Man logfiles.
org-man-pdf-process (funcall #'#[nil ('("tbl %f | ...
- Type: (choice (repeat :tag "Shell co…
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
Commands to process a Man file to a PDF file. This is a list of strings, each of them will be given to the shell as a command. %f in the command will be replaced by the relative file name, %F by the absolute file name, %b by the file base name (i.e. without directory and extension parts), %o by the base directory of the file and %O by the absolute file name of the output file. By default, Org uses 3 runs of to do the processing. Alternatively, this may be a Lisp function that does the processing. This function should accept the file name as its single argument.
org-man-remove-logfiles (funcall #'#[nil (t) (org-expo...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
Non-nil means remove the logfiles produced by PDF production. These are the .aux, .log, .out, and .toc files.
org-man-source-highlight (funcall #'#[nil (nil) (org-ex...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
Use GNU source highlight to embellish source blocks.
org-man-source-highlight-langs (funcall #'#[nil ('((emacs-lis...
- Type: (repeat (list (symbol :tag "Ma…
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
Alist mapping languages to their listing language counterpart. The key is a symbol, the major mode symbol without the "-mode". The value is the string that should be inserted as the language parameter for the listings package. If the mode name and the listings name are the same, the language does not need an entry in this list - but it does not hurt if it is present.
org-man-table-scientific-notation (funcall #'#[nil ("%sE%s") (or...
- Type: (choice (string :tag "Format s…
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
Format string to display numbers in scientific notation.
The format should have "%s" twice, for mantissa and exponent
(i.e. "%s\\times10^{%s}").
When nil, no transformation is made.
org-man-tables-centered (funcall #'#[nil (t) (org-expo...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
When non-nil, tables are exported in a center environment.
org-man-tables-verbatim (funcall #'#[nil (nil) (org-ex...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-man.el
- Find modifications in git logs
When non-nil, tables are exported verbatim.
org-mark-ring-length (funcall #'#[nil (4) (crm-sepa...
- Type: integer
- In file: org.el
- Find modifications in git logs
Number of different positions to be recorded in the ring. Changing this requires a restart of Emacs to work correctly.
org-md-footnote-format (funcall #'#[nil ("<sup>%s</su...
- Type: string
- Since: Emacs version 26.1
- In file: ox-md.el
- Find modifications in git logs
Format string for the footnote reference. The %s will be replaced by the footnote reference itself.
org-md-footnotes-section (funcall #'#[nil ("%s%s") (t)]...
- Type: string
- Since: Emacs version 26.1
- In file: ox-md.el
- Find modifications in git logs
Format string for the footnotes section. The first %s placeholder will be replaced with the localized Footnotes section heading, the second with the contents of the Footnotes section.
org-md-headline-style (funcall #'#[nil ('atx) (t)])
- Type: (choice (const :tag "Use \"atx…
- In file: ox-md.el
- Find modifications in git logs
Style used to format headlines. This variable can be set to either `atx', `setext', or `mixed'. Mixed style uses Setext style markup for the first two headline levels and uses ATX style markup for the remaining four levels.
org-md-link-org-files-as-md (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox-md.el
- Find modifications in git logs
Non-nil means make file links to "file.org" point to "file.md". When Org mode is exporting an Org file to markdown, links to non-markdown files are directly put into a "href" tag in markdown. However, links to other Org files (recognized by the extension ".org") should become links to the corresponding markdown file, assuming that the linked Org file will also be converted to markdown. When nil, the links still point to the plain ".org" file.
org-md-toplevel-hlevel (funcall #'#[nil (1) (t)])
- Type: integer
- In file: ox-md.el
- Find modifications in git logs
Heading level to use for level 1 Org headings in markdown export. If this is 1, headline levels will be preserved on export. If this is 2, top level Org headings will be exported to level 2 markdown headings, level 2 Org headings will be exported to level 3 markdown headings, and so on. Incrementing this value may be helpful when creating markdown to be included into another document or application that reserves top-level headings for its own use.
org-mhe-search-all-folders (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ol-mhe.el
- Find modifications in git logs
Non-nil means the search for the mh-message may extend to all folders. When non-nil, the search for a message will extend to all other folders if it cannot be found in the folder given in the link. Searching all folders may be slow with the default pick based search but is very efficient with one of the other search engines supported by MH-E.
org-mobile-agendas (funcall #'#[nil ('all) (t)])
- Type: (choice (const :tag "Default A…
- Since: Emacs version 24.1
- In file: org-mobile.el
- Find modifications in git logs
The agendas that should be pushed to the mobile application. Allowed values: `default' the weekly agenda and the global TODO list `custom' all custom agendas defined by the user `all' the custom agendas and the default ones `list' a list of selection key(s) as string.
org-mobile-allpriorities (funcall #'#[nil ("A B C") (t)...
- Type: string
- Since: Emacs version 24.4
- In file: org-mobile.el
- Find modifications in git logs
Default set of priority cookies for the index file.
org-mobile-checksum-binary (funcall #'#[nil ((or (executa...
- Type: string
- In file: org-mobile.el
- Find modifications in git logs
Executable used for computing checksums of agenda files.
org-mobile-directory (funcall #'#[nil ("") (t)])
- Type: directory
- In file: org-mobile.el
- Find modifications in git logs
The WebDAV directory where the interaction with the mobile takes place.
org-mobile-encryption-password (funcall #'#[nil ("") (t)])
- Type: (string :tag "Password")
- Since: Emacs version 24.1
- In file: org-mobile.el
- Find modifications in git logs
Password for encrypting files uploaded to the server. This is a single password which is used for AES-256 encryption. The same password must also be set in the mobile application. All Org files, including "mobileorg.org" will be encrypted using this password. SECURITY CONSIDERATIONS: Note that, when Org runs the encryption commands, the password could be visible briefly on your system with the `ps' command. So this method is only intended to keep the files secure on the server, not on your own machine. Also, if you set this variable in an init file (.emacs or .emacs.d/init.el or custom.el...) and if that file is stored in a way so that other can read it, this also limits the security of this approach. You can also leave this variable empty - Org will then ask for the password once per Emacs session.
org-mobile-encryption-tempfile (funcall #'#[nil ("~/orgtmpcry...
- Type: directory
- Since: Emacs version 24.1
- In file: org-mobile.el
- Find modifications in git logs
File that is being used as a temporary file for encryption. This must be local file on your local machine (not on the WebDAV server). You might want to put this file into a directory where only you have access.
org-mobile-files (funcall #'#[nil ('(org-agenda...
- Type: (list :greedy t (option (const…
- In file: org-mobile.el
- Find modifications in git logs
Files to be staged for the mobile application.
This is basically a list of files and directories. Files will be staged
directly. Directories will be search for files with the extension ".org".
In addition to this, the list may also contain the following symbols:
`org-agenda-files'
This means include the complete, unrestricted list of files given in
the variable `org-agenda-files'.
`org-agenda-text-search-extra-files'
Include the files given in the variable
`org-agenda-text-search-extra-files'.
org-mobile-files-exclude-regexp (funcall #'#[nil ("") (t)])
- Type: regexp
- Since: Emacs version 24.1
- In file: org-mobile.el
- Find modifications in git logs
A regexp to exclude files from `org-mobile-files'.
org-mobile-force-id-on-agenda-items (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-mobile.el
- Find modifications in git logs
Non-nil means make all agenda items carry an ID.
org-mobile-force-mobile-change (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Always" t…
- In file: org-mobile.el
- Find modifications in git logs
Non-nil means force the change made on the mobile device. So even if there have been changes to the computer version of the entry, force the new value set on the mobile. When nil, mark the entry from the mobile with an error message. Instead of nil or t, this variable can also be a list of symbols, indicating the editing types for which the mobile version should always dominate.
org-mobile-inbox-for-pull (funcall #'#[nil ("~/org/from-...
- Type: file
- In file: org-mobile.el
- Find modifications in git logs
The file where captured notes and flags will be appended to. During the execution of `org-mobile-pull', the file `org-mobile-capture-file' is emptied as soon as its contents have been appended to the file given here. This file should be in `org-directory', and not in the staging area or on the web server.
org-mobile-index-file (funcall #'#[nil ("index.org")...
- Type: file
- In file: org-mobile.el
- Find modifications in git logs
Index file with links to all Org files. It should be loaded by the mobile application. The file name is relative to `org-mobile-directory'. The "Address" field in the mobile application setup should point to this file.
org-mobile-use-encryption (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-mobile.el
- Find modifications in git logs
Non-nil means keep only encrypted files on the WebDAV server. Encryption uses AES-256, with a password given in `org-mobile-encryption-password'. When nil, plain files are kept on the server. Turning on encryption requires setting the same password in the mobile application. Before turning this on, check if the mobile application does support it.
org-modules (funcall #'#[nil ('(ol-doi ol-...
- Type: (set :greedy t (const :tag " …
- In file: org.el
- Find modifications in git logs
Modules that should always be loaded together with org.el. If a description starts with <C>, the file is not part of Emacs and Org mode, so loading it will require that you have properly installed org-contrib package from NonGNU Emacs Lisp Package Archive https://elpa.nongnu.org/nongnu/org-contrib.html You can also use this system to load external packages (i.e. neither Org core modules, nor org-contrib modules). Just add symbols to the end of the list. If the package is called org-xyz.el, then you need to add the symbol `xyz', and the package must have a call to: (provide \='org-xyz) For export specific modules, see also `org-export-backends'.
org-mouse-1-follows-link (funcall #'#[nil ((if (boundp ...
- Type: (choice (const :tag "A double …
- Since: Emacs version 26.1
- In file: org-keys.el
- Find modifications in git logs
Non-nil means Mouse-1 on a link will follow the link. A longer mouse click will still set point. Needs to be set before org.el is loaded.
org-mouse-features (funcall #'#[nil ('(context-me...
- Type: (set :greedy t (const :tag "Mo…
- In file: org-mouse.el
- Find modifications in git logs
The features of org-mouse that should be activated. Changing this variable requires a restart of Emacs to get activated.
org-mouse-punctuation (funcall #'#[nil (":") (t)])
- Type: string
- In file: org-mouse.el
- Find modifications in git logs
Punctuation used when inserting text by drag and drop.
org-n-level-faces (funcall #'#[nil ((length org-...
- Type: integer
- In file: org-faces.el
- Find modifications in git logs
The number of different faces to be used for headlines. Org mode defines 8 different headline faces, so this can be at most 8. If it is less than 8, the level-1 face gets reused for level N+1 etc.
org-num-face (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Like the …
- In file: org-num.el
- Find modifications in git logs
Face to use for numbering. When nil, use the same face as the headline. This value is ignored if `org-num-format-function' specifies a face for its output.
org-num-format-function (funcall #'#[nil (#'org-num-de...
- Type: function
- In file: org-num.el
- Find modifications in git logs
Function used to display numbering. It is called with one argument, a list of numbers, and should return a string, or nil. When nil, no numbering is displayed. Any `face' text property on the returned string overrides `org-num-face'.
org-num-max-level (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Number ev…
- In file: org-num.el
- Find modifications in git logs
Level below which headlines are not numbered. When set to nil, all headlines are numbered.
org-num-skip-commented (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-num.el
- Find modifications in git logs
Non-nil means commented sub-trees are not numbered.
org-num-skip-footnotes (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-num.el
- Find modifications in git logs
Non-nil means footnotes sections are not numbered.
org-num-skip-unnumbered (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-num.el
- Find modifications in git logs
Non-nil means numbering obeys to UNNUMBERED property.
org-occur-case-fold-search (funcall #'#[nil (t) (crm-sepa...
- Type: (choice (const :tag "Case-sens…
- Since: Emacs version 26.1
- In file: org.el
- Find modifications in git logs
Non-nil means `org-occur' should be case-insensitive. If set to `smart' the search will be case-insensitive only if it doesn't specify any upper case character.
org-odd-levels-only (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means skip even levels and only use odd levels for the outline. This has the effect that two stars are being added/taken away in promotion/demotion commands. It also influences how levels are handled by the exporters. Changing it requires restart of `font-lock-mode' to become effective for fontification also in regions already fontified. You may also set this on a per-file basis by adding one of the following lines to the buffer: #+STARTUP: odd #+STARTUP: oddeven
org-odt-content-template-file (funcall #'#[nil (nil) (hfy-us...
- Type: (choice (const nil) (file))
- Since: Emacs version 24.3
- In file: ox-odt.el
- Find modifications in git logs
Template file for "content.xml". The exporter embeds the exported content just before "</office:text>" element. If unspecified, the file named "OrgOdtContentTemplate.xml" under `org-odt-styles-dir' is used.
org-odt-convert-capabilities (funcall #'#[nil ('(("Text" ("...
- Type: (choice (const :tag "None" nil…
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Specify input and output formats of `org-odt-convert-process'. More correctly, specify the set of input and output formats that the user is actually interested in. This variable is an alist where each element is of the form (DOCUMENT-CLASS INPUT-FMT-LIST OUTPUT-FMT-ALIST). INPUT-FMT-LIST is a list of INPUT-FMTs. OUTPUT-FMT-ALIST is an alist where each element is of the form (OUTPUT-FMT OUTPUT-FILE-EXTENSION EXTRA-OPTIONS). The variable is interpreted as follows: `org-odt-convert-process' can take any document that is in INPUT-FMT-LIST and produce any document that is in the OUTPUT-FMT-LIST. A document converted to OUTPUT-FMT will have OUTPUT-FILE-EXTENSION as the file name extension. OUTPUT-FMT serves dual purposes: - It is used for populating completion candidates during `org-odt-convert' commands. - It is used as the value of "%f" specifier in `org-odt-convert-process'. EXTRA-OPTIONS is used as the value of "%x" specifier in `org-odt-convert-process'. DOCUMENT-CLASS is used to group a set of file formats in INPUT-FMT-LIST in to a single class. Note that this variable inherently captures how LibreOffice based converters work. LibreOffice maps documents of various formats to classes like Text, Web, Spreadsheet, Presentation etc and allow document of a given class (irrespective of its source format) to be converted to any of the export formats associated with that class. See default setting of this variable for a typical configuration.
org-odt-convert-process (funcall #'#[nil ("LibreOffice...
- Type: (choice :convert-widget (lambd…
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Use this converter to convert from "odt" format to other formats. During customization, the list of converter names are populated from `org-odt-convert-processes'.
org-odt-convert-processes (funcall #'#[nil ('(("LibreOff...
- Type: (choice (const :tag "None" nil…
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Specify a list of document converters and their usage. The converters in this list are offered as choices while customizing `org-odt-convert-process'. This variable is a list where each element is of the form (CONVERTER-NAME CONVERTER-CMD). CONVERTER-NAME is the name of the converter. CONVERTER-CMD is the shell command for the converter and can contain format specifiers. These format specifiers are interpreted as below: %i input file name in full %I input file name as a URL %f format of the output file %o output file name in full %O output file name as a URL %d output dir in full %D output dir as a URL. %x extra options as set in `org-odt-convert-capabilities'.
org-odt-create-custom-styles-for-srcblocks (funcall #'#[nil (t) (hfy-user...
- Type: boolean
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Whether custom styles for colorized source blocks be automatically created. When this option is turned on, the exporter creates custom styles for source blocks based on the advice of `htmlfontify'. Creation of custom styles happen as part of `org-odt-hfy-face-to-css'. When this option is turned off exporter does not create such styles. Use the latter option if you do not want the custom styles to be based on your current display settings. It is necessary that the styles.xml already contains needed styles for colorizing to work. This variable is effective only if `org-odt-fontify-srcblocks' is turned on.
org-odt-display-outline-level (funcall #'#[nil (2) (hfy-user...
- Type: integer
- Since: Emacs version 24.4
- In file: ox-odt.el
- Find modifications in git logs
Outline levels considered for enumerating captioned entities.
org-odt-fontify-srcblocks (funcall #'#[nil (t) (hfy-user...
- Type: boolean
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Specify whether or not source blocks need to be fontified. Turn this option on if you want to colorize the source code blocks in the exported file. For colorization to work, you need to make available an enhanced version of `htmlfontify' library.
org-odt-format-drawer-function (funcall #'#[nil (#'(lambda (_...
- Type: function
- Since: Emacs version 26.1
- In file: ox-odt.el
- Find modifications in git logs
Function called to format a drawer in ODT code. The function must accept two parameters: NAME the drawer name, like "LOGBOOK" CONTENTS the contents of the drawer. The function should return the string to be exported. The default value simply returns the value of CONTENTS.
org-odt-format-headline-function (funcall #'#[nil ('org-odt-for...
- Type: function
- Since: Emacs version 26.1
- In file: ox-odt.el
- Find modifications in git logs
Function to format headline text. This function will be called with 5 arguments: TODO the todo keyword (string or nil). TODO-TYPE the type of todo (symbol: `todo', `done', nil) PRIORITY the priority of the headline (integer or nil) TEXT the main headline text (string). TAGS the tags string, separated with colons (string or nil). The function result will be used as headline text.
org-odt-format-inlinetask-function (funcall #'#[nil ('org-odt-for...
- Type: function
- Since: Emacs version 26.1
- In file: ox-odt.el
- Find modifications in git logs
Function called to format an inlinetask in ODT code. The function must accept six parameters: TODO the todo keyword, as a string TODO-TYPE the todo type, a symbol among `todo', `done' and nil. PRIORITY the inlinetask priority, as a string NAME the inlinetask name, as a string. TAGS the inlinetask tags, as a string. CONTENTS the contents of the inlinetask, as a string. The function should return the string to be exported.
org-odt-inline-formula-rules (funcall #'#[nil ('(("file" . ...
- Type: (alist :key-type (string :tag …
- Since: Emacs version 24.4
- In file: ox-odt.el
- Find modifications in git logs
Rules characterizing formula files that can be inlined into ODT. A rule consists in an association whose key is the type of link to consider, and value is a regexp that will be matched against link's path.
org-odt-inline-image-rules (funcall #'#[nil ((list (cons ...
- Type: (alist :key-type (string :tag …
- Since: Emacs version 26.1
- In file: ox-odt.el
- Find modifications in git logs
Rules characterizing image files that can be inlined into ODT. A rule consists in an association whose key is the type of link to consider, and value is a regexp that will be matched against link's path.
org-odt-pixels-per-inch (funcall #'#[nil (96.0) (hfy-u...
- Type: float
- Since: Emacs version 24.4
- In file: ox-odt.el
- Find modifications in git logs
Scaling factor for converting images pixels to inches. Use this for sizing of embedded images. See Info node `(org) Images in ODT export' for more information.
org-odt-preferred-output-format (funcall #'#[nil (nil) (hfy-us...
- Type: (choice :convert-widget (lambd…
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Automatically post-process to this format after exporting to "odt". Command `org-odt-export-to-odt' exports first to "odt" format and then uses `org-odt-convert-process' to convert the resulting document to this format. During customization of this variable, the list of valid values are populated based on `org-odt-convert-capabilities'. You can set this option on per-file basis using file local values. See Info node `(emacs) File Variables'.
org-odt-prettify-xml (funcall #'#[nil (nil) (hfy-us...
- Type: boolean
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Specify whether or not the xml output should be prettified. When this option is turned on, `indent-region' is run on all component xml buffers before they are saved. Turn this off for regular use. Turn this on if you need to examine the xml visually.
org-odt-schema-dir (funcall #'#[nil ((cl-find-if ...
- Type: (choice (const :tag "Not set" …
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Directory that contains OpenDocument schema files. This directory contains: 1. rnc files for OpenDocument schema 2. a "schemas.xml" file that specifies locating rules needed for auto validation of OpenDocument XML files. Use the customize interface to set this variable. This ensures that `rng-schema-locating-files' is updated and auto-validation of OpenDocument XML takes place based on the value `rng-nxml-auto-validate-flag'. The default value of this variable varies depending on the version of org in use and is initialized from `org-odt-schema-dir-list'. The OASIS schema files are available only in the org's private git repository. It is *not* bundled with GNU ELPA tar or standard Emacs distribution.
org-odt-styles-file (funcall #'#[nil (nil) (hfy-us...
- Type: (choice (const :tag "Factory s…
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Default styles file for use with ODT export.
Valid values are one of:
1. nil
2. path to a styles.xml file
3. path to a *.odt or a *.ott file
4. list of the form (ODT-OR-OTT-FILE (FILE-MEMBER-1 FILE-MEMBER-2
...))
In case of option 1, an in-built styles.xml is used. See
`org-odt-styles-dir' for more information.
In case of option 3, the specified file is unzipped and the
styles.xml embedded therein is used.
In case of option 4, the specified ODT-OR-OTT-FILE is unzipped
and FILE-MEMBER-1, FILE-MEMBER-2 etc are copied in to the
generated odt file. Use relative path for specifying the
FILE-MEMBERS. styles.xml must be specified as one of the
FILE-MEMBERS.
Use options 1, 2 or 3 only if styles.xml alone suffices for
achieving the desired formatting. Use option 4, if the styles.xml
references additional files like header and footer images for
achieving the desired formatting.
Use "#+ODT_STYLES_FILE: ..." directive to set this variable on
a per-file basis. For example,
#+ODT_STYLES_FILE: "/path/to/styles.xml" or
#+ODT_STYLES_FILE: ("/path/to/file.ott" ("styles.xml" "image/hdr.png")).
org-odt-table-styles (funcall #'#[nil ('(("OrgEquat...
- Type: (choice (const :tag "None" nil…
- Since: Emacs version 24.1
- In file: ox-odt.el
- Find modifications in git logs
Specify how Table Styles should be derived from a Table Template.
This is a list where each element is of the
form (TABLE-STYLE-NAME TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS).
TABLE-STYLE-NAME is the style associated with the table through
"#+ATTR_ODT: :style TABLE-STYLE-NAME" line.
TABLE-TEMPLATE-NAME is a set of - up to 9 - automatic
TABLE-CELL-STYLE-NAMEs and PARAGRAPH-STYLE-NAMEs (as defined
below) that is included in `org-odt-content-template-file'.
TABLE-CELL-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
"TableCell"
PARAGRAPH-STYLE-NAME := TABLE-TEMPLATE-NAME + TABLE-CELL-TYPE +
"TableParagraph"
TABLE-CELL-TYPE := "FirstRow" | "LastColumn" |
"FirstRow" | "LastRow" |
"EvenRow" | "OddRow" |
"EvenColumn" | "OddColumn" | ""
where "+" above denotes string concatenation.
TABLE-CELL-OPTIONS is an alist where each element is of the
form (TABLE-CELL-STYLE-SELECTOR . ON-OR-OFF).
TABLE-CELL-STYLE-SELECTOR := `use-first-row-styles' |
`use-last-row-styles' |
`use-first-column-styles' |
`use-last-column-styles' |
`use-banding-rows-styles' |
`use-banding-columns-styles' |
`use-first-row-styles'
ON-OR-OFF := t | nil
For example, with the following configuration
(setq org-odt-table-styles
\='(("TableWithHeaderRowsAndColumns" "Custom"
((use-first-row-styles . t)
(use-first-column-styles . t)))
("TableWithHeaderColumns" "Custom"
((use-first-column-styles . t)))))
1. A table associated with "TableWithHeaderRowsAndColumns"
style will use the following table-cell styles -
"CustomFirstRowTableCell", "CustomFirstColumnTableCell",
"CustomTableCell" and the following paragraph styles
"CustomFirstRowTableParagraph",
"CustomFirstColumnTableParagraph", "CustomTableParagraph"
as appropriate.
2. A table associated with "TableWithHeaderColumns" style will
use the following table-cell styles -
"CustomFirstColumnTableCell", "CustomTableCell" and the
following paragraph styles
"CustomFirstColumnTableParagraph", "CustomTableParagraph"
as appropriate..
Note that TABLE-TEMPLATE-NAME corresponds to the
"<table:table-template>" elements contained within
"<office:styles>". The entries (TABLE-STYLE-NAME
TABLE-TEMPLATE-NAME TABLE-CELL-OPTIONS) correspond to
"table:template-name" and "table:use-first-row-styles" etc
attributes of "<table:table>" element. Refer ODF-1.2
specification for more information. Also consult the
implementation filed under `org-odt-get-table-cell-styles'.
The TABLE-STYLE-NAME "OrgEquation" is used internally for
formatting of numbered display equations. Do not delete this
style from the list.
org-odt-use-date-fields (funcall #'#[nil (nil) (hfy-us...
- Type: boolean
- Since: Emacs version 24.4
- In file: ox-odt.el
- Find modifications in git logs
Non-nil, if timestamps should be exported as date fields. When nil, export timestamps as plain text. When non-nil, map `org-timestamp-custom-formats' to a pair of OpenDocument date-styles with names "OrgDate1" and "OrgDate2" respectively. A timestamp with no time component is formatted with style "OrgDate1" while one with explicit hour and minutes is formatted with style "OrgDate2". This feature is experimental. Most (but not all) of the common %-specifiers in `format-time-string' are supported. Specifically, locale-dependent specifiers like "%c", "%x" are formatted as canonical Org timestamps. For finer control, avoid these %-specifiers. Textual specifiers like "%b", "%h", "%B", "%a", "%A" etc., are displayed by the application in the default language and country specified in `org-odt-styles-file'. Note that the default styles file uses language "en" and country "GB". You can localize the week day and month strings in the exported document by setting the default language and country either using the application UI or through a custom styles file. See `org-odt--build-date-styles' for implementation details.
org-odt-with-forbidden-chars (funcall #'#[nil ("") (hfy-use...
- Type: (choice (const :tag "Leave for…
- In file: ox-odt.el
- Find modifications in git logs
String to replace forbidden XML characters. When set to t, forbidden characters are left as-is. When set to nil, an error is thrown. See `org-odt-forbidden-char-re' for the list of forbidden characters that cannot occur inside ODT documents. You may also consider export filters to perform more fine-grained replacements. See info node `(org)Advanced Export Configuration'.
org-odt-with-latex (funcall #'#[nil (org-export-w...
- Type: (choice (const :tag "Do not pr…
- In file: ox-odt.el
- Find modifications in git logs
Non-nil means process LaTeX math snippets.
When set, the exporter will process LaTeX environments and
fragments.
This option can also be set with the +OPTIONS line,
e.g. "tex:dvipng". Allowed values are:
nil Ignore math snippets.
t, `mathml' Convert the LaTeX fragments to MathML if the
`org-latex-to-mathml-convert-command' is usable.
SYMBOL Convert the LaTeX fragments to images using any symbol
defined in `org-preview-latex-process-alist', e.g.,
`dvipng'.
`verbatim' Keep everything in verbatim.
If the desired converter is not available or any other symbol is
provided, process as `verbatim'.
org-open-directory-means-index-dot-org (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
When non-nil a link to a directory really means to "index.org". When nil, following a directory link runs Dired or opens a finder/explorer window on that directory.
org-open-non-existing-files (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means `org-open-file' opens non-existing files. When nil, an error is thrown. This variable applies only to external applications because they might choke on non-existing files. If the link is to a file that will be opened in Emacs, the variable is ignored.
org-org-htmlized-css-url (funcall #'#[nil (nil) (htmliz...
- Type: (choice (const :tag "Don't inc…
- In file: ox-org.el
- Find modifications in git logs
URL pointing to the CSS defining colors for htmlized Emacs buffers. Normally when creating an htmlized version of an Org buffer, htmlize will create the CSS to define the font colors. However, this does not work when converting in batch mode, and it also can look bad if different people with different fontification setup work on the same website. When this variable is non-nil, creating an htmlized version of an Org buffer using `org-org-export-as-org' will include a link to this URL if the setting of `org-html-htmlize-output-type' is `css'.
org-org-with-cite-processors (funcall #'#[nil (nil) (htmliz...
- Type: boolean
- In file: ox-org.el
- Find modifications in git logs
Non-nil means use citation processors when exporting citations.
org-org-with-special-rows (funcall #'#[nil (t) (htmlize-...
- Type: boolean
- In file: ox-org.el
- Find modifications in git logs
Non-nil means export special table rows. Special rows are the rows containing special marking characters, as described in the Info node `(org)Advanced features'.
org-outline-path-complete-in-steps (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-refile.el
- Find modifications in git logs
Non-nil means complete the outline path in hierarchical steps. When Org uses the refile interface to select an outline path (see `org-refile-use-outline-path'), the completion of the path can be done in a single go, or it can be done in steps down the headline hierarchy. Going in steps is probably the best if you do not use a special completion package like `ido' or `icicles'. However, when using these packages, going in one step can be very fast, while still showing the whole path to the entry.
org-persist-default-expiry (funcall #'#[nil (30) (pp-use-...
- Type: (choice (const :tag "Never" ne…
- In file: org-persist.el
- Find modifications in git logs
Default expiry condition for persistent data. When this variable is nil, all the data vanishes at the end of Emacs session. When `never', the data never vanishes. When a number, the data is deleted that number days after last access. When a function, it should be a function returning non-nil when the data is expired. The function will be called with a single argument - collection.
org-persist-directory (funcall #'#[nil ((expand-file...
- Type: directory
- In file: org-persist.el
- Find modifications in git logs
Directory where the data is stored.
org-persist-remote-files (funcall #'#[nil (100) (pp-use...
- Type: (choice (const :tag "Never" ni…
- In file: org-persist.el
- Find modifications in git logs
Whether to keep persistent data for remote files. When this variable is nil, never save persistent data associated with remote files. When t, always keep the data. When `check-existence', contact remote server containing the file and only keep the data when the file exists on the server. When a number, keep up to that number persistent values for remote files. Note that the last option `check-existence' may cause Emacs to show password prompts to log in.
org-plain-list-ordered-item-terminator (funcall #'#[nil (t) (t)])
- Type: (choice (const :tag "dot like …
- In file: org-list.el
- Find modifications in git logs
The character that makes a line with leading number an ordered list item. Valid values are ?. and ?\). To get both terminators, use t. This variable needs to be set before org.el is loaded. If you need to make a change while Emacs is running, use the customize interface or run the following code after updating it: `\[org-element-update-syntax]'
org-plantuml-args (funcall #'#[nil ((list "-head...
- Type: (repeat string)
- In file: ob-plantuml.el
- Find modifications in git logs
The arguments passed to plantuml when executing PlantUML.
org-plantuml-exec-mode (funcall #'#[nil ('jar) (t)])
- Type: symbol
- In file: ob-plantuml.el
- Find modifications in git logs
Method to use for PlantUML diagram generation. `jar' means to use java together with the JAR. The JAR can be configured via `org-plantuml-jar-path'. `plantuml' means to use the PlantUML executable. The executable can be configured via `org-plantuml-executable-path'. You can also configure extra arguments via `org-plantuml-args'.
org-plantuml-executable-path (funcall #'#[nil ("plantuml") ...
- Type: string
- In file: ob-plantuml.el
- Find modifications in git logs
File name of the PlantUML executable.
org-plantuml-jar-path (funcall #'#[nil ("") (t)])
- Type: string
- Since: Emacs version 24.1
- In file: ob-plantuml.el
- Find modifications in git logs
Path to the plantuml.jar file.
org-plot/gnuplot-script-preamble (funcall #'#[nil ("") (t)])
- Type: (choice string function)
- In file: org-plot.el
- Find modifications in git logs
String of function to be inserted before the gnuplot plot command is run. Note that this is in addition to, not instead of other content generated in `org-plot/gnuplot-script'. If a function, it is called with the parameters used by the current plot type (see `org-plot/preset-plot-types'), and must return a string to be used.
org-plot/gnuplot-term-extra (funcall #'#[nil ("") (t)])
- Type: (choice string function)
- In file: org-plot.el
- Find modifications in git logs
String or function which provides the extra term options. E.g. a value of "size 1050,650" would cause "set term ... size 1050,650" to be used. If a function, it is called with the parameters used by the current plot type, see `org-plot/preset-plot-types'.
org-plot/preset-plot-types (funcall #'#[nil ('((2d :plot-...
- Type: alist
- In file: org-plot.el
- Find modifications in git logs
List of plists describing the available plot types. The car is the type name, and the property :plot-func must be set. The value of :plot-func is a lambda which yields plot-lines (a list of strings) as the cdr. All lambda functions have the parameters of `org-plot/gnuplot-script' and PLOT-STR passed to them. i.e. they are called with the following signature: (TABLE DATA-FILE NUM-COLS PARAMS PLOT-STR) Potentially useful parameters in PARAMS include: :set :line :map :title :file :ind :timeind :timefmt :textind :deps :labels :xlabels :ylabels :xmin :xmax :ymin :ymax :ticks In addition to :plot-func, the following optional properties may be set. - :plot-cmd - A gnuplot command appended to each plot-line. Accepts string or nil. Default value: nil. - :check-ind-type - Whether the types of ind values should be checked. Accepts boolean. - :plot-str - the formula string passed to :plot-func as PLOT-STR Accepts string. Default value: "'%s' using %s%d%s with %s title '%s'" - :data-dump - Function to dump the table to a datafile for ease of use. Accepts function with arguments: (table data-file num-cols params) - :plot-pre - Gnuplot code to be inserted early into the script, just after term and output have been set. Accepts string, nil, or lambda function which returns string or nil. Defaults to nil.
org-pretty-entities (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Non-nil means show entities as UTF8 characters. When nil, the \name form remains in the buffer.
org-pretty-entities-include-sub-superscripts (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Non-nil means pretty entity display includes formatting sub/superscripts.
org-preview-latex-default-process (funcall #'#[nil ('dvipng) (cr...
- Type: symbol
- Since: Emacs version 26.1
- In file: org.el
- Find modifications in git logs
The default process to convert LaTeX fragments to image files. All available processes and theirs documents can be found in `org-preview-latex-process-alist', which see.
org-preview-latex-image-directory (funcall #'#[nil ("ltximg/") (...
- Type: string
- Since: Emacs version 26.1
- In file: org.el
- Find modifications in git logs
Path to store latex preview images. A relative path here creates many directories relative to the processed Org files paths. An absolute path puts all preview images at the same place.
org-preview-latex-process-alist (funcall #'#[nil ('((dvipng :p...
- Type: (alist :tag "LaTeX to image ba…
- In file: org.el
- Find modifications in git logs
Definitions of external processes for LaTeX previewing.
Org mode can use some external commands to generate TeX snippet's images for
previewing or inserting into HTML files, e.g., "dvipng". This variable tells
`org-create-formula-image' how to call them.
The value is an alist with the pattern (NAME . PROPERTIES). NAME is a symbol.
PROPERTIES accepts the following attributes:
:programs list of strings, required programs.
:description string, describe the process.
:message string, message it when required programs cannot be found.
:image-input-type string, input file type of image converter (e.g., "dvi").
:image-output-type string, output file type of image converter (e.g., "png").
:image-size-adjust cons of numbers, the car element is used to adjust LaTeX
image size showed in buffer and the cdr element is for
HTML file. This option is only useful for process
developers, users should use variable
`org-format-latex-options' instead.
:post-clean list of strings, files matched are to be cleaned up once
the image is generated. When nil, the files with ".dvi",
".xdv", ".pdf", ".tex", ".aux", ".log", ".svg",
".png", ".jpg", ".jpeg" or ".out" extension will
be cleaned up.
:latex-header list of strings, the LaTeX header of the snippet file.
When nil, the fallback value is used instead, which is
controlled by `org-format-latex-header',
`org-latex-default-packages-alist' and
`org-latex-packages-alist', which see.
:latex-compiler list of LaTeX commands, as strings or a function.
Each of them is given to the shell.
Place-holders "%t", "%b" and "%o" are
replaced with values defined below.
When a function, that function should accept the
file name as its single argument.
:image-converter list of image converter commands strings or a
function. Each of them is given to the shell
and supports any of the following place-holders
defined below.
When a function, that function should accept the
file name as its single argument.
If set, :transparent-image-converter is used instead of :image-converter to
convert an image when the background color is nil or "Transparent".
Place-holders used by `:image-converter' and `:latex-compiler':
%f input file name
%b base name of input file
%o base directory of input file
%O absolute output file name
Place-holders only used by `:image-converter':
%D dpi, which is used to adjust image size by some processing commands.
%S the image size scale ratio, which is used to adjust image size by some
processing commands.
org-priority-default (funcall #'#[nil (66) (crm-sep...
- Type: (restricted-sexp :tag "Number …
- In file: org.el
- Find modifications in git logs
The default priority of TODO items. This is the priority an item gets if no explicit priority is given. When starting to cycle on an empty priority the first step in the cycle depends on `org-priority-start-cycle-with-default'. The resulting first step priority must not exceed the range from `org-priority-highest' to `org-priority-lowest' which means that `org-priority-default' has to be in this range exclusive or inclusive to the range boundaries. Else the first step refuses to set the default and the second will fall back on (depending on the command used) the highest or lowest priority.
org-priority-enable-commands (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means priority commands are active. When nil, these commands will be disabled, so that you never accidentally set a priority.
org-priority-faces (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Defaults"…
- In file: org-faces.el
- Find modifications in git logs
Faces for specific Priorities.
This is an association list, whose keys are priorities and values are
faces. The face can be a symbol, a color as a string, or a property
list of attributes, like
(:foreground "blue" :weight bold :underline t).
If it is a color string, the variable `org-faces-easy-properties'
determines if it is a foreground or a background color.
org-priority-get-priority-function (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const nil) (function)…
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Function to extract the priority from a string. The string is normally the headline. If this is nil, Org computes the priority from the priority cookie like [#A] in the headline. It returns an integer, increasing by 1000 for each priority level. The user can set a different function here, which should take a string as an argument and return the numeric priority.
org-priority-highest (funcall #'#[nil (65) (crm-sep...
- Type: (restricted-sexp :tag "Number …
- In file: org.el
- Find modifications in git logs
The highest priority of TODO items. A character like ?A, ?B, etc., or a numeric value like 1, 2, etc. The default is the character ?A, which is 65 as a numeric value. If you set `org-priority-highest' to a numeric value inferior to 65, Org assumes you want to use digits for the priority cookie. If you set it to >=65, Org assumes you want to use alphabetical characters. In both cases, the value of `org-priority-highest' must be smaller than `org-priority-lowest': for example, if "A" is the highest priority, it is smaller than the lowest "C" priority: 65 < 67.
org-priority-lowest (funcall #'#[nil (67) (crm-sep...
- Type: (restricted-sexp :tag "Number …
- In file: org.el
- Find modifications in git logs
The lowest priority of TODO items. A character like ?C, ?B, etc., or a numeric value like 9, 8, etc. The default is the character ?C, which is 67 as a numeric value. If you set `org-priority-lowest' to a numeric value inferior to 65, Org assumes you want to use digits for the priority cookie. If you set it to >=65, Org assumes you want to use alphabetical characters. In both cases, the value of `org-priority-lowest' must be greater than `org-priority-highest': for example, if "C" is the lowest priority, it is greater than the highest "A" priority: 67 > 65.
org-priority-start-cycle-with-default (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means start with default priority when starting to cycle. When this is nil, the first step in the cycle will be (depending on the command used) one higher or lower than the default priority. See also `org-priority-default'.
org-properties-postprocess-alist (funcall #'#[nil (nil) (crm-se...
- Type: (alist :key-type (string :tag …
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Alist of properties and functions to adjust inserted values.
Elements of this alist must be of the form
([string] [function])
where [string] must be a property name and [function] must be a
lambda expression: this lambda expression must take one argument,
the value to adjust, and return the new value as a string.
For example, this element will allow the property "Remaining"
to be updated wrt the relation between the "Effort" property
and the clock summary:
(("Remaining" (lambda(value)
(let ((clocksum (org-clock-sum-current-item))
(effort (org-duration-to-minutes
(org-entry-get (point) "Effort"))))
(org-duration-from-minutes (- effort clocksum))))))
org-property-format (funcall #'#[nil ("%-10s %s") ...
- Type: string
- In file: org.el
- Find modifications in git logs
How property key/value pairs should be formatted by `indent-line'. When `indent-line' hits a property definition, it will format the line according to this format, mainly to make sure that the values are lined-up with respect to each other.
org-property-separators (funcall #'#[nil (nil) (crm-se...
- Type: (alist :key-type (choice (repe…
- In file: org.el
- Find modifications in git logs
An alist to control how properties are combined. The car of each item should be either a list of property names or a regular expression, while the cdr should be the separator to use when combining that property. If an alist item cannot be found that matches a given property, a single space will be used as the separator.
org-protocol-data-separator (funcall #'#[nil ("/+\\|\\?") ...
- Type: regexp
- Since: Emacs version 24.4
- In file: org-protocol.el
- Find modifications in git logs
The default data separator to use. This should be a single regexp string.
org-protocol-default-template-key (funcall #'#[nil (nil) (t)])
- Type: (choice (const nil) (string))
- In file: org-protocol.el
- Find modifications in git logs
The default template key to use. This is usually a single character string but can also be a string with two characters.
org-protocol-project-alist (funcall #'#[nil (nil) (t)])
- Type: alist
- In file: org-protocol.el
- Find modifications in git logs
Map URLs to local filenames for `org-protocol-open-source' (open-source).
Each element of this list must be of the form:
(module-name :property value property: value ...)
where module-name is an arbitrary name. All the values are strings.
Possible properties are:
:online-suffix - the suffix to strip from the published URLs
:working-suffix - the replacement for online-suffix
:base-url - the base URL, e.g. https://www.example.com/project/
Last slash required.
:working-directory - the local working directory. This is what
base-url will be replaced with.
:redirects - A list of cons cells, each of which maps a
regular expression to match to a path relative
to `:working-directory'.
Example:
(setq org-protocol-project-alist
\='(("https://orgmode.org/worg/"
:online-suffix ".php"
:working-suffix ".org"
:base-url "https://orgmode.org/worg/"
:working-directory "/home/user/org/Worg/")
("localhost org-notes/"
:online-suffix ".html"
:working-suffix ".org"
:base-url "http://localhost/org/"
:working-directory "/home/user/org/"
:rewrites (("org/?$" . "index.php")))
("Hugo based blog"
:base-url "https://www.site.com/"
:working-directory "~/site/content/post/"
:online-suffix ".html"
:working-suffix ".md"
:rewrites (("\(https://site.com/[0-9]+/[0-9]+/[0-9]+/\)"
. ".md")))
("GNU emacs OpenGrok"
:base-url "https://opengrok.housegordon.com/source/xref/emacs/"
:working-directory "~/dev/gnu-emacs/")))
The :rewrites line of "localhost org-notes" entry tells
`org-protocol-open-source' to open /home/user/org/index.php,
if the URL cannot be mapped to an existing file, and ends with
either "org" or "org/". The "GNU emacs OpenGrok" entry
does not include any suffix properties, allowing local source
file to be opened as found by OpenGrok.
Consider using the interactive functions `org-protocol-create'
and `org-protocol-create-for-org' to help you filling this
variable with valid contents.
org-protocol-protocol-alist (funcall #'#[nil (nil) (t)])
- Type: (alist)
- In file: org-protocol.el
- Find modifications in git logs
Register custom handlers for org-protocol.
Each element of this list must be of the form:
(module-name :protocol protocol :function func :kill-client nil)
protocol - protocol to detect in a filename without trailing
colon and slashes. See rfc1738 section 2.1 for more
on this. If you define a protocol "my-protocol",
`org-protocol-check-filename-for-protocol' will search
filenames for "org-protocol:/my-protocol" and
trigger your action for every match. `org-protocol'
is defined in `org-protocol-the-protocol'. Double and
triple slashes are compressed to one by emacsclient.
function - function that handles requests with protocol and takes
one argument. If a new-style link (key=val&key2=val2)
is given, the argument will be a property list with
the values from the link. If an old-style link is
given (val1/val2), the argument will be the filename
with all protocols stripped.
If the function returns nil, emacsclient and -server
do nothing. Any non-nil return value is considered a
valid filename and thus passed to the server.
`org-protocol.el' provides some support for handling
old-style filenames, if you follow the conventions
used for the standard handlers in
`org-protocol-protocol-alist-default'. See
`org-protocol-parse-parameters'.
kill-client - If t, kill the client immediately, once the sub-protocol is
detected. This is necessary for actions that can be interrupted by
`C-g' to avoid dangling emacsclients. Note that all other command
line arguments but the this one will be discarded. Greedy handlers
still receive the whole list of arguments though.
Here is an example:
(setq org-protocol-protocol-alist
\='(("my-protocol"
:protocol "my-protocol"
:function my-protocol-handler-function)
("your-protocol"
:protocol "your-protocol"
:function your-protocol-handler-function)))
org-protocol-reverse-list-of-files (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-protocol.el
- Find modifications in git logs
Non-nil means re-reverse the list of filenames passed on the command line. The filenames passed on the command line are passed to the emacs-server in reverse order. Set to t (default) to re-reverse the list, i.e. use the sequence on the command line. If nil, the sequence of the filenames is unchanged.
org-provide-todo-statistics (funcall #'#[nil (t) (crm-sepa...
- Type: (choice (const :tag "Yes, only…
- In file: org.el
- Find modifications in git logs
Non-nil means update todo statistics after insert and toggle. ALL-HEADLINES means update todo statistics by including headlines with no TODO keyword as well, counting them as not done. A list of TODO keywords means the same, but skip keywords that are not in this list. When set to a list of two lists, the first list contains keywords to consider as TODO keywords, the second list contains keywords to consider as DONE keywords. When this is set, todo statistics is updated in the parent of the current entry each time a todo state is changed.
org-publish-list-skipped-files (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox-publish.el
- Find modifications in git logs
Non-nil means show message about files *not* published.
org-publish-project-alist (funcall #'#[nil (nil) (t)])
- Type: alist
- In file: ox-publish.el
- Find modifications in git logs
Association list to control publishing behavior.
\<org-mode-map>
Each element of the alist is a publishing project. The car of
each element is a string, uniquely identifying the project. The
cdr of each element is in one of the following forms:
1. A well-formed property list with an even number of elements,
alternating keys and values, specifying parameters for the
publishing process.
(:property value :property value ... )
2. A meta-project definition, specifying of a list of
sub-projects:
(:components ("project-1" "project-2" ...))
When the CDR of an element of `org-publish-project-alist' is in
this second form, the elements of the list after `:components'
are taken to be components of the project, which group together
files requiring different publishing options. When you publish
such a project with `\[org-publish]', the components all publish.
When a property is given a value in `org-publish-project-alist',
its setting overrides the value of the corresponding user
variable (if any) during publishing. However, options set within
a file override everything.
Most properties are optional, but some should always be set:
`:base-directory'
Directory containing publishing source files.
`:base-extension'
Extension (without the dot!) of source files. This can be
a regular expression. If not given, "org" will be used as
default extension. If it is `any', include all the files,
even without extension.
`:publishing-directory'
Directory (possibly remote) where output files will be
published.
If `:recursive' is non-nil files in sub-directories of
`:base-directory' are considered.
The `:exclude' property may be used to prevent certain files from
being published. Its value may be a string or regexp matching
file names you don't want to be published.
The `:include' property may be used to include extra files. Its
value may be a list of filenames to include. The filenames are
considered relative to the base directory.
When both `:include' and `:exclude' properties are given values,
the exclusion step happens first.
One special property controls which backend function to use for
publishing files in the project. This can be used to extend the
set of file types publishable by `org-publish', as well as the
set of output formats.
`:publishing-function'
Function to publish file. Each backend may define its
own (i.e. `org-latex-publish-to-pdf',
`org-html-publish-to-html'). May be a list of functions, in
which case each function in the list is invoked in turn.
Another property allows you to insert code that prepares
a project for publishing. For example, you could call GNU Make
on a certain makefile, to ensure published files are built up to
date.
`:preparation-function'
Function to be called before publishing this project. This
may also be a list of functions. Preparation functions are
called with the project properties list as their sole
argument.
`:completion-function'
Function to be called after publishing this project. This
may also be a list of functions. Completion functions are
called with the project properties list as their sole
argument.
Some properties control details of the Org publishing process,
and are equivalent to the corresponding user variables listed in
the right column. Backend specific properties may also be
included. See the backend documentation for more information.
:author variable `user-full-name'
:creator `org-export-creator-string'
:email `user-mail-address'
:exclude-tags `org-export-exclude-tags'
:headline-levels `org-export-headline-levels'
:language `org-export-default-language'
:preserve-breaks `org-export-preserve-breaks'
:section-numbers `org-export-with-section-numbers'
:select-tags `org-export-select-tags'
:time-stamp-file `org-export-timestamp-file'
:with-archived-trees `org-export-with-archived-trees'
:with-author `org-export-with-author'
:with-creator `org-export-with-creator'
:with-date `org-export-with-date'
:with-drawers `org-export-with-drawers'
:with-email `org-export-with-email'
:with-emphasize `org-export-with-emphasize'
:with-entities `org-export-with-entities'
:with-fixed-width `org-export-with-fixed-width'
:with-footnotes `org-export-with-footnotes'
:with-inlinetasks `org-export-with-inlinetasks'
:with-latex `org-export-with-latex'
:with-planning `org-export-with-planning'
:with-priority `org-export-with-priority'
:with-properties `org-export-with-properties'
:with-smart-quotes `org-export-with-smart-quotes'
:with-special-strings `org-export-with-special-strings'
:with-statistics-cookies' `org-export-with-statistics-cookies'
:with-sub-superscript `org-export-with-sub-superscripts'
:with-toc `org-export-with-toc'
:with-tables `org-export-with-tables'
:with-tags `org-export-with-tags'
:with-tasks `org-export-with-tasks'
:with-timestamps `org-export-with-timestamps'
:with-title `org-export-with-title'
:with-todo-keywords `org-export-with-todo-keywords'
The following properties may be used to control publishing of
a site-map of files or summary page for a given project.
`:auto-sitemap'
Whether to publish a site-map during
`org-publish-current-project' or `org-publish-all'.
`:sitemap-filename'
Filename for output of site-map. Defaults to "sitemap.org".
`:sitemap-title'
Title of site-map page. Defaults to name of file.
`:sitemap-style'
Can be `list' (site-map is just an itemized list of the
titles of the files involved) or `tree' (the directory
structure of the source files is reflected in the site-map).
Defaults to `tree'.
`:sitemap-format-entry'
Plugin function used to format entries in the site-map. It
is called with three arguments: the file or directory name
relative to base directory, the site map style and the
current project. It has to return a string.
Defaults to `org-publish-sitemap-default-entry', which turns
file names into links and use document titles as
descriptions. For specific formatting needs, one can use
`org-publish-find-date', `org-publish-find-title' and
`org-publish-find-property', to retrieve additional
information about published documents.
`:sitemap-function'
Plugin function to use for generation of site-map. It is
called with two arguments: the title of the site-map, as
a string, and a representation of the files involved in the
project, as returned by `org-list-to-lisp'. The latter can
further be transformed using `org-list-to-generic',
`org-list-to-subtree' and alike. It has to return a string.
Defaults to `org-publish-sitemap-default', which generates
a plain list of links to all files in the project.
If you create a site-map file, adjust the sorting like this:
`:sitemap-sort-folders'
Where folders should appear in the site-map. Set this to
`first' or `last' to display folders first or last,
respectively. When set to `ignore' (default), folders are
ignored altogether. Any other value will mix files and
folders. This variable has no effect when site-map style is
`tree'.
`:sitemap-sort-files'
The site map is normally sorted alphabetically. You can
change this behavior setting this to `anti-chronologically',
`chronologically', or nil.
`:sitemap-ignore-case'
Should sorting be case-sensitive? Default nil.
The following property control the creation of a concept index.
`:makeindex'
Create a concept index. The file containing the index has to
be called "theindex.org". If it doesn't exist in the
project, it will be generated. Contents of the index are
stored in the file "theindex.inc", which can be included in
"theindex.org".
Other properties affecting publication.
`:body-only'
Set this to t to publish only the body of the documents.
org-publish-sitemap-file-entry-format (funcall #'#[nil ("%t") (org-t...
- Type: string
- In file: org-compat.el
- Find modifications in git logs
Format string for site-map file entry. You could use brackets to delimit on what part the link will be. %t is the title. %a is the author. %d is the date.
org-publish-sitemap-sort-files (funcall #'#[nil ('alphabetica...
- Type: symbol
- In file: ox-publish.el
- Find modifications in git logs
Method to sort files in site-maps. Possible values are `alphabetically', `chronologically', `anti-chronologically' and nil. If `alphabetically', files will be sorted alphabetically. If `chronologically', files will be sorted with older modification time first. If `anti-chronologically', files will be sorted with newer modification time first. nil won't sort files. You can overwrite this default per project in your `org-publish-project-alist', using `:sitemap-sort-files'.
org-publish-sitemap-sort-folders (funcall #'#[nil ('ignore) (t)...
- Type: (choice (const :tag "Folders b…
- Since: Emacs version 26.1
- In file: ox-publish.el
- Find modifications in git logs
A symbol, denoting if folders are sorted first in site-maps. Possible values are `first', `last', `ignore' and nil. If `first', folders will be sorted before files. If `last', folders are sorted to the end after the files. If `ignore', folders do not appear in the site-map. Any other value will mix files and folders. You can overwrite this default per project in your `org-publish-project-alist', using `:sitemap-sort-folders'. This variable is ignored when site-map style is `tree'.
org-publish-sitemap-sort-ignore-case (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: ox-publish.el
- Find modifications in git logs
Non-nil when site-map sorting should ignore case. You can overwrite this default per project in your `org-publish-project-alist', using `:sitemap-ignore-case'.
org-publish-timestamp-directory (funcall #'#[nil ((convert-sta...
- Type: directory
- In file: ox-publish.el
- Find modifications in git logs
Name of directory in which to store publishing timestamps.
org-publish-use-timestamps-flag (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: ox-publish.el
- Find modifications in git logs
Non-nil means use timestamp checking to publish only changed files. When nil, do no timestamp checking and always publish all files.
org-read-date-display-live (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means display current interpretation of date prompt live. This display will be in an overlay, in the minibuffer. Note that live display is only active when `org-read-date-popup-calendar' is non-nil.
org-read-date-force-compatible-dates (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Should date/time prompt force dates that are guaranteed to work in Emacs? Depending on the system Emacs is running on, certain dates cannot be represented with the type used internally to represent time. Dates between 1970-1-1 and 2038-1-1 can always be represented correctly. Some systems allow for earlier dates, some for later, some for both. One way to find out is to insert any date into an Org buffer, putting the cursor on the year and hitting S-up and S-down to test the range. When this variable is set to t, the date/time prompt will not let you specify dates outside the 1970-2037 range, so it is certain that these dates will work in whatever version of Emacs you are running, and also that you can move a file from one Emacs implementation to another. Whenever Org is forcing the year for you, it will display a message and beep. When this variable is nil, Org will check if the date is representable in the specific Emacs implementation you are using. If not, it will force a year, usually the current year, and beep to remind you. Currently this setting is not recommended because the likelihood that you will open your Org files in an Emacs that has limited date range is not negligible. A workaround for this problem is to use diary sexp dates for time stamps outside of this range.
org-read-date-popup-calendar (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means pop up a calendar when prompting for a date. In the calendar, the date can be selected with \`mouse-1'. However, the minibuffer will also be active, and you can simply enter the date as well. When nil, only the minibuffer will be available.
org-read-date-prefer-future (funcall #'#[nil (t) (crm-sepa...
- Type: (choice (const :tag "Never" ni…
- In file: org.el
- Find modifications in git logs
Non-nil means assume future for incomplete date input from user. This affects the following situations: 1. The user gives a month but not a year. For example, if it is April and you enter "feb 2", this will be read as Feb 2, *next* year. "May 5", however, will be this year. 2. The user gives a day, but no month. For example, if today is the 15th, and you enter "3", Org will read this as the third of *next* month. However, if you enter "17", it will be considered as *this* month. If you set this variable to the symbol `time', then also the following will work: 3. If the user gives a time. If the time is before now, it will be interpreted as tomorrow. Currently none of this works for ISO week specifications. When this option is nil, the current day, month and year will always be used as defaults. See also `org-agenda-jump-prefer-future'.
org-refile-active-region-within-subtree (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-refile.el
- Find modifications in git logs
Non-nil means also refile active region within a subtree. By default `org-refile' doesn't allow refiling regions if they don't contain a set of subtrees, but it might be convenient to do so sometimes: in that case, the first line of the region is converted to a headline before refiling.
org-refile-allow-creating-parent-nodes (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Never" ni…
- In file: org-refile.el
- Find modifications in git logs
Non-nil means allow the creation of new nodes as refile targets. New nodes are then created by adding "/new node name" to the completion of an existing node. When the value of this variable is `confirm', new node creation must be confirmed by the user (recommended). When nil, the completion must match an existing entry. Note that, if the new heading is not seen by the criteria listed in `org-refile-targets', multiple instances of the same heading would be created by trying again to file under the new heading.
org-refile-target-verify-function (funcall #'#[nil (nil) (t)])
- Type: (choice (const nil) (function)…
- In file: org-refile.el
- Find modifications in git logs
Function to verify if the headline at point should be a refile target. The function will be called without arguments, with point at the beginning of the headline. It should return t and leave point where it is if the headline is a valid target for refiling. If the target should not be selected, the function must return nil. In addition to this, it may move point to a place from where the search should be continued. For example, the function may decide that the entire subtree of the current entry should be excluded and move point to the end of the subtree.
org-refile-targets (funcall #'#[nil (nil) (t)])
- Type: (repeat (cons (choice :value o…
- In file: org-refile.el
- Find modifications in git logs
Targets for refiling entries with `\[org-refile]'.
This is a list of cons cells. Each cell contains:
- a specification of the files to be considered, either a list of files,
or a symbol whose function or variable value will be used to retrieve
a file name or a list of file names. If you use `org-agenda-files' for
that, all agenda files will be scanned for targets. Nil means consider
headlines in the current buffer.
- A specification of how to find candidate refile targets. This may be
any of:
- t to indicate that all headlines should be considered.
- a cons cell (:tag . "TAG") to identify refile targets by a tag.
This tag has to be present in all target headlines, inheritance will
not be considered.
- a cons cell (:todo . "KEYWORD") to identify refile targets by
todo keyword.
- a cons cell (:regexp . "REGEXP") with a regular expression matching
headlines that are refiling targets.
- a cons cell (:level . N). Any headline of level N is considered a target.
Note that, when `org-odd-levels-only' is set, level corresponds to
order in hierarchy, not to the number of stars.
- a cons cell (:maxlevel . N). Any headline with level <= N is a target.
Note that, when `org-odd-levels-only' is set, level corresponds to
order in hierarchy, not to the number of stars.
Each element of this list generates a set of possible targets.
The union of these sets is presented (with completion) to
the user by `org-refile'.
You can set the variable `org-refile-target-verify-function' to a function
to verify each headline found by the simple criteria above.
When this variable is nil, all top-level headlines in the current buffer
are used, equivalent to the value `((nil . (:level . 1)))'.
org-refile-use-cache (funcall #'#[nil (nil) (t)])
- Type: boolean
- Since: Emacs version 24.1
- In file: org-refile.el
- Find modifications in git logs
Non-nil means cache refile targets to speed up the process. \<org-mode-map>The cache for a particular file will be updated automatically when the buffer has been killed, or when any of the marker used for flagging refile targets no longer points at a live buffer. If you have added new entries to a buffer that might themselves be targets, you need to clear the cache manually by pressing `C-0 \[org-refile]' or, if you find that easier, `\[universal-argument] \[universal-argument] \[universal-argument] \[org-refile]'.
org-refile-use-outline-path (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Not" nil)…
- In file: org-refile.el
- Find modifications in git logs
Non-nil means provide refile targets as paths. So a level 3 headline will be available as level1/level2/level3. When the value is `file', also include the file name (without directory) into the path. In this case, you can also stop the completion after the file name, to get entries inserted as top level in the file. When `full-file-path', include the full file path. When `buffer-name', use the buffer name.
org-remove-highlights-with-change (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means any change to the buffer will remove temporary highlights. \<org-mode-map>Such highlights are created by `org-occur' and `org-clock-display'. When nil, `\[org-ctrl-c-ctrl-c]' needs to be used to get rid of the highlights. The highlights created by `org-latex-preview' always need `\[org-latex-preview]' to be removed.
org-replace-disputed-keys (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-keys.el
- Find modifications in git logs
Non-nil means use alternative key bindings for some keys. Org mode uses S-<cursor> keys for changing timestamps and priorities. These keys are also used by other packages like Shift Select mode, CUA mode or Windmove. If you want to use Org mode together with one of these other modes, or more generally if you would like to move some Org mode commands to other keys, set this variable and configure the keys with the variable `org-disputed-keys'. This option is only relevant at load-time of Org mode, and must be set *before* org.el is loaded. Changing it requires a restart of Emacs to become effective.
org-resource-download-policy (funcall #'#[nil ('prompt) (cr...
- Type: (choice (const :tag "Always do…
- In file: org.el
- Find modifications in git logs
The policy applied to requests to obtain remote resources. This affects keywords like #+setupfile and #+include on export, `org-persist-write:url',and `org-attach-url' in non-interactive Emacs sessions. This recognizes four possible values: - t (dangerous), remote resources should always be downloaded. - prompt, you will be prompted to download resources not considered safe. - safe, only resources considered safe will be downloaded. - nil, never download remote resources. A resource is considered safe if it matches one of the patterns in `org-safe-remote-resources'.
org-return-follows-link (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-keys.el
- Find modifications in git logs
Non-nil means on links RET will open links, timestamps, and citations. In tables, the special behavior of RET has precedence.
org-reverse-note-order (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Reverse a…
- In file: org.el
- Find modifications in git logs
Non-nil means store new notes at the beginning of a file or entry. When nil, new notes will be filed to the end of a file or entry. This can also be a list with cons cells of regular expressions that are matched against file names, and values.
org-safe-remote-resources (funcall #'#[nil (nil) (crm-se...
- Type: (repeat regexp)
- In file: org.el
- Find modifications in git logs
A list of regexp patterns matching safe URIs. URI regexps are applied to both URLs and Org files requesting remote resources.
org-scheduled-delay-days (funcall #'#[nil (0) (crm-sepa...
- Type: integer
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
Number of days before a scheduled item becomes active. This variable governs the display in sparse trees and in the agenda. The default value (i.e. 0) means: don't delay scheduled item. When negative, it means use this number (the absolute value of it) even if a scheduled item has a different individual delay time specified. Custom commands can set this variable in the options section.
org-scheduled-past-days (funcall #'#[nil (10000) (orig...
- Type: integer
- In file: org-agenda.el
- Find modifications in git logs
Number of days to continue listing scheduled items not marked DONE. When an item is scheduled on a date, it shows up in the agenda on this day and will be listed until it is marked done or for the number of days given here.
org-self-insert-cluster-for-undo (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means cluster self-insert commands for undo when possible. If this is set, then, like in the Emacs command loop, 20 consecutive characters will be undone together. This is configurable, because there is some impact on typing performance.
org-show-notification-handler (funcall #'#[nil (nil) (org-st...
- Type: (choice (const nil) (string :t…
- In file: org-clock.el
- Find modifications in git logs
Function or program to send notification with. The function or program will be called with the notification string as argument.
org-show-notification-timeout (funcall #'#[nil (3) (org-stat...
- Type: integer
- In file: org-clock.el
- Find modifications in git logs
Number of seconds to wait before closing Org notifications. This is applied to notifications sent with `notifications-notify' and `w32-notification-notify' only, not other mechanisms possibly set through `org-show-notification-handler'.
org-sort-function (funcall #'#[nil (#'string-col...
- Type: (choice (const :tag "According…
- In file: org-macs.el
- Find modifications in git logs
Function used to compare strings when sorting. This function affects how Org mode sorts headlines, agenda items, table lines, etc. The function must accept either 2 or 4 arguments: strings to compare and, optionally, LOCALE and IGNORE-CASE - locale name and flag to make comparison case-insensitive. The default value uses sorting rules according to OS language. Users who want to make sorting language-independent, may customize the value to `org-sort-function-fallback'. Note that some string sorting rules are known to be not accurate on MacOS. See https://debbugs.gnu.org/cgi/bugreport.cgi?bug=59275. MacOS users may customize the value to `org-sort-function-fallback'.
org-sparse-tree-default-date-type (funcall #'#[nil (nil) (texmat...
- Type: (choice (const :tag "Scheduled…
- Since: Emacs version 26.1
- In file: org.el
- Find modifications in git logs
The default date type when building a sparse tree.
When this is nil, a date is a scheduled or a deadline timestamp.
Otherwise, these types are allowed:
all: all timestamps
active: only active timestamps (<...>)
inactive: only inactive timestamps ([...])
scheduled: only scheduled timestamps
deadline: only deadline timestamps
org-sparse-tree-open-archived-trees (funcall #'#[nil (nil) (texmat...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means sparse tree construction shows matches in archived trees. When nil, matches in these trees are highlighted, but the trees are kept in collapsed state.
org-special-ctrl-a/e (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "off" nil)…
- In file: org.el
- Find modifications in git logs
Non-nil means `C-a' and `C-e' behave specially in headlines and items. When t, `C-a' will bring back the cursor to the beginning of the headline text, i.e. after the stars and after a possible TODO keyword. In an item, this will be the position after bullet and check-box, if any. When the cursor is already at that position, another `C-a' will bring it to the beginning of the line. `C-e' will jump to the end of the headline, ignoring the presence of tags in the headline. A second `C-e' will then jump to the true end of the line, after any tags. This also means that, when this variable is non-nil, `C-e' also will never jump beyond the end of the heading of a folded section, i.e. not after the ellipses. When set to the symbol `reversed', the first `C-a' or `C-e' works normally, going to the true line boundary first. Only a directly following, identical keypress will bring the cursor to the special positions. This may also be a cons cell where the behavior for `C-a' and `C-e' is set separately.
org-special-ctrl-k (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means that \<org-mode-map>\[org-kill-line] will behave specially in headlines. When nil, \[org-kill-line] will call the default `kill-line' command. Otherwise, the following will happen when point is in a headline: - At the beginning of a headline, kill the entire line. - In the middle of the headline text, kill the text up to the tags. - After the headline text and before the tags, kill all the tags.
org-special-ctrl-o (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means, make `open-line' (\[open-line]) insert a row in tables.
org-speed-commands (funcall #'#[nil ('(("Outline ...
- Type: (repeat :value ("k" . ignore) …
- In file: org-keys.el
- Find modifications in git logs
Alist of speed commands. The car of each entry is a string with a single letter, which must be assigned to `self-insert-command' in the global map. The cdr is either a command to be called interactively, a function to be called, or a form to be evaluated. An entry that is just a list with a single string will be interpreted as a descriptive headline that will be added when listing the speed commands in the Help buffer using the `?' speed command.
org-src-ask-before-returning-to-edit-buffer (funcall #'#[nil (t) (t)])
- Type: boolean
- Since: Emacs version 24.4
- In file: org-src.el
- Find modifications in git logs
Non-nil means ask before switching to an existing edit buffer. If nil, when `org-edit-src-code' is used on a block that already has an active edit buffer, it will switch to that edit buffer immediately; otherwise it will ask whether you want to return to the existing edit buffer.
org-src-block-faces (funcall #'#[nil (nil) (t)])
- Type: (repeat (list (string :tag "la…
- In file: org-src.el
- Find modifications in git logs
Alist of faces to be used for source-block.
Each element is a cell of the format
("language" FACE)
Where FACE is either a defined face or an anonymous face. Empty
language string refers to source blocks without specified language.
For instance, the following would color the background of
emacs-lisp source blocks and python source blocks in purple and
green, respectability.
(setq org-src-block-faces
\='(("emacs-lisp" (:background "#EEE2FF"))
("python" (:background "#e5ffb8"))))
org-src-content-indentation (funcall #'#[nil (2) (t)])
- Type: integer
- In file: org-src.el
- Find modifications in git logs
Indentation for the content of a source code block. This should be the number of spaces added to the indentation of the #+begin line in order to compute the indentation of the block content after editing it with `\[org-edit-src-code]'. This customization also affects how the source code and example blocks are printed - when interpreting Org AST (during export), during detangling, and indentation. It has no effect if `org-src-preserve-indentation' is non-nil.
org-src-fontify-natively (funcall #'#[nil (t) (buffer-f...
- Type: boolean
- Since: Emacs version 26.1
- In file: org.el
- Find modifications in git logs
When non-nil, fontify code in code blocks. See also the `org-block' face.
org-src-lang-modes (funcall #'#[nil ((cons '("C" ...
- Type: (repeat (cons (string :tag "La…
- In file: org-src.el
- Find modifications in git logs
Alist mapping languages to their major mode. The key is the language name. The value is the mode name, as a string or a symbol, without the "-mode" suffix. For many languages this is simple, but for language where this is not the case, this variable provides a way to simplify things on the user side. For example, there is no `ocaml-mode' in Emacs, but the mode to use is `tuareg-mode'.
org-src-preserve-indentation (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-src.el
- Find modifications in git logs
If non-nil preserve leading whitespace characters on export. If non-nil leading whitespace characters in source code blocks are preserved on export, or adjusted while indenting or when switching between the org buffer and the language mode edit buffer. When this variable is nil, while indenting with `\[org-indent-block]' or after editing with `\[org-edit-src-code]', the minimum (across-lines) number of leading whitespace characters are removed from all lines, and the code block is uniformly indented according to the value of `org-src-content-indentation'.
org-src-tab-acts-natively (funcall #'#[nil (t) (t)])
- Type: boolean
- In file: org-src.el
- Find modifications in git logs
If non-nil, TAB uses the language's major-mode binding in code blocks.
org-src-window-setup (funcall #'#[nil ('reorganize-...
- Type: (choice (const plain) (const c…
- In file: org-src.el
- Find modifications in git logs
How the source code edit buffer should be displayed.
Possible values for this option are:
plain Show edit buffer using `display-buffer'. Users can
further control the display behavior by modifying
`display-buffer-alist' and its relatives.
current-window Show edit buffer in the current window, keeping all other
windows.
split-window-below Show edit buffer below the current window, keeping all
other windows.
split-window-right Show edit buffer to the right of the current window,
keeping all other windows.
other-window Use `switch-to-buffer-other-window' to display edit buffer.
reorganize-frame Show only two windows on the current frame, the current
window and the edit buffer.
other-frame Use `switch-to-buffer-other-frame' to display edit buffer.
Also, when exiting the edit buffer, kill that frame.
Values that modify the window layout (reorganize-frame, split-window-below,
split-window-right) will restore the layout after exiting the edit buffer.
org-startup-align-all-tables (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means align all tables when visiting a file. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: align #+STARTUP: noalign
org-startup-folded (funcall #'#[nil ('showeveryth...
- Type: (choice (const :tag "nofold: s…
- In file: org.el
- Find modifications in git logs
Initial folding state of headings when entering Org mode. Allowed values are: symbol `nofold' Do not fold headings. symbol `fold' Fold everything, leaving only top-level headings visible. symbol `content' Leave all the headings and sub-headings visible, but hide their text. This is an equivalent of table of contents. symbol `show2levels', `show3levels', `show4levels', `show5levels' Show headings up to Nth level. symbol `showeverything' (default) Start Org mode in fully unfolded state. Unlike all other allowed values, this value prevents drawers, blocks, and archived subtrees from being folded even when `org-cycle-hide-block-startup', `org-cycle-open-archived-trees', or `org-cycle-hide-drawer-startup' are non-nil. Per-subtree visibility settings (see manual node `(org)Initial visibility)') are also ignored. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: fold (or `overview', this is equivalent) #+STARTUP: nofold (or `showall', this is equivalent) #+STARTUP: content #+STARTUP: show<n>levels (<n> = 2..5) #+STARTUP: showeverything Set `org-agenda-inhibit-startup' to a non-nil value if you want to ignore this option when Org opens agenda files for the first time.
org-startup-indented (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Not" nil)…
- In file: org.el
- Find modifications in git logs
Non-nil means turn on `org-indent-mode' on startup. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: indent #+STARTUP: noindent
org-startup-numerated (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Not" nil)…
- In file: org.el
- Find modifications in git logs
Non-nil means turn on `org-num-mode' on startup. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: num #+STARTUP: nonum
org-startup-shrink-all-tables (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 27.1
- In file: org.el
- Find modifications in git logs
Non-nil means shrink all table columns with a width cookie. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: shrink
org-startup-truncated (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means entering Org mode will set `truncate-lines'. This is useful since some lines containing links can be very long and uninteresting. Also tables look terrible when wrapped. The variable `org-startup-truncated' enables you to configure truncation for Org mode different to the other modes that use the variable `truncate-lines' and as a shortcut instead of putting the variable `truncate-lines' into the `org-mode-hook'. If one wants to configure truncation for Org mode not statically but dynamically e.g. in a hook like `ediff-prepare-buffer-hook' then the variable `truncate-lines' has to be used because in such a case it is too late to set the variable `org-startup-truncated'.
org-startup-with-beamer-mode (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
Non-nil means turn on `org-beamer-mode' on startup. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: beamer
org-startup-with-latex-preview (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
Non-nil means preview LaTeX fragments when loading a new Org file. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: latexpreview #+STARTUP: nolatexpreview
org-startup-with-link-previews (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 29.4
- In file: org.el
- Find modifications in git logs
Non-nil means show link previews when loading a new Org file. This can also be configured on a per-file basis by adding one of the following lines anywhere in the buffer: #+STARTUP: linkpreviews #+STARTUP: nolinkpreviews
org-structure-template-alist (funcall #'#[nil ('(("a" . "ex...
- Type: (repeat (cons (string :tag "Ke…
- In file: org.el
- Find modifications in git logs
An alist of keys and block types. `org-insert-structure-template' will display a menu with this list of templates to choose from. The block type is inserted, with "#+begin_" and "#+end_" added automatically. If the block type consists of just uppercase letters, "#+BEGIN_" and "#+END_" are added instead. The menu keys are defined by the car of each entry in this alist. If two entries have the keys "a" and "aa" respectively, the former will be inserted by typing "a TAB/RET/SPC" and the latter will be inserted by typing "aa". If an entry with the key "aab" is later added, it can be inserted by typing "ab". If loaded, Org Tempo also uses `org-structure-template-alist'. A block can be inserted by pressing TAB after the string "<KEY".
org-stuck-projects (funcall #'#[nil ('("+LEVEL=2/...
- Type: (list (string :tag "Tags/TODO …
- In file: org-agenda.el
- Find modifications in git logs
How to identify stuck projects. This is a list of four items: 1. A tags/todo/property matcher string that is used to identify a project. See Info node `(org) Matching tags and properties' for a description of tag and property searches. The entire tree below a headline matched by this is considered one project. 2. A list of TODO keywords identifying non-stuck projects. If the project subtree contains any headline with one of these todo keywords, the project is considered to be not stuck. If you specify "*" as a keyword, any TODO keyword will mark the project unstuck. 3. A list of tags identifying non-stuck projects. If the project subtree contains any headline with one of these tags, the project is considered to be not stuck. If you specify "*" as a tag, any tag will mark the project unstuck. Note that this is about the explicit presence of a tag somewhere in the subtree, inherited tags do not count here. If inherited tags make a project not stuck, use "-TAG" in the tags part of the matcher under (1.) above. 4. An arbitrary regular expression matching non-stuck projects. If the project turns out to be not stuck, search continues also in the subtree to see if any of the subtasks have project status. See also the variable `org-tags-match-list-sublevels' which applies to projects matched by this search as well. After defining this variable, you may use `org-agenda-list-stuck-projects' (bound to `\[org-agenda] #') to produce the list.
org-support-shift-select (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Never" ni…
- In file: org.el
- Find modifications in git logs
Non-nil means make shift-cursor commands select text when possible. \<org-mode-map> In Emacs 23, when `shift-select-mode' is on, shifted cursor keys start selecting a region, or enlarge regions started in this way. In Org mode, in special contexts, these same keys are used for other purposes, important enough to compete with shift selection. Org tries to balance these needs by supporting `shift-select-mode' outside these special contexts, under control of this variable. The default of this variable is nil, to avoid confusing behavior. Shifted cursor keys will then execute Org commands in the following contexts: - on a headline, changing TODO state (left/right) and priority (up/down) - on a time stamp, changing the time - in a plain list item, changing the bullet type - in a property definition line, switching between allowed values - in the BEGIN line of a clock table (changing the time block). - in a table, moving the cell in the specified direction. Outside these contexts, the commands will throw an error. When this variable is t and the cursor is not in a special context, Org mode will support shift-selection for making and enlarging regions. To make this more effective, the bullet cycling will no longer happen anywhere in an item line, but only if the cursor is exactly on the bullet. If you set this variable to the symbol `always', then the keys will not be special in headlines, property lines, item lines, and table cells, to make shift selection work there as well. If this is what you want, you can use the following alternative commands: `\[org-todo]' and `\[org-priority]' to change TODO state and priority, `\[universal-argument] \[universal-argument] \[org-todo]' can be used to switch TODO sets, `\[org-ctrl-c-minus]' to cycle item bullet types, and properties can be edited by hand or in column view. However, when the cursor is on a timestamp, shift-cursor commands will still edit the time stamp - this is just too good to give up.
org-tab-follows-link (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-keys.el
- Find modifications in git logs
Non-nil means on links TAB will follow the link. Needs to be set before Org is loaded. This really should not be used, it does not make sense, and the implementation is bad.
org-table-allow-automatic-line-recalculation (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means lines marked with |#| or |*| will be recomputed automatically. \<org-mode-map>Automatically means when `TAB' or `RET' or `\[org-ctrl-c-ctrl-c]' are pressed in the line.
org-table-auto-blank-field (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means automatically blank table field when starting to type into it. This only happens when typing immediately after a field motion command (TAB, S-TAB or RET).
org-table-automatic-realign (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means automatically re-align table when pressing TAB or RETURN. When nil, aligning is only done with `\[org-table-align]', or after column removal/insertion.
org-table-convert-region-max-lines (funcall #'#[nil (999) (sort-f...
- Type: integer
- In file: org-table.el
- Find modifications in git logs
Max lines that `org-table-convert-region' will attempt to process. The function can be slow on larger regions; this safety feature prevents it from hanging Emacs.
org-table-copy-increment (funcall #'#[nil (t) (sort-fol...
- Type: (choice (const :tag "Use the d…
- Since: Emacs version 26.1
- In file: org-table.el
- Find modifications in git logs
Non-nil means increment when copying current field with `\[org-table-copy-down]'.
org-table-default-size (funcall #'#[nil ("5x2") (sort...
- Type: string
- In file: org-table.el
- Find modifications in git logs
The default size for newly created tables, Columns x Rows.
org-table-duration-custom-format (funcall #'#[nil ('hours) (sor...
- Type: (choice (const :tag "Seconds" …
- Since: Emacs version 24.1
- In file: org-table.el
- Find modifications in git logs
Format for the output of calc computations like $1+$2;t. The default value is `hours', and will output the results as a number of hours. Other allowed values are `seconds', `minutes' and `days', and the output will be a fraction of seconds, minutes or days. `hh:mm' selects to use hours and minutes, ignoring seconds. The `U' flag in a table formula will select this specific format for a single formula.
org-table-duration-hour-zero-padding (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- Since: Emacs version 26.1
- In file: org-table.el
- Find modifications in git logs
Non-nil means hours in table duration computations should be zero-padded. So this is about 08:32:34 versus 8:33:34.
org-table-exit-follow-field-mode-when-leaving-table (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- Since: Emacs version 24.1
- In file: org-table.el
- Find modifications in git logs
Non-nil means automatically exit the follow mode. When nil, the follow mode will stay on and be active in any table the cursor enters. Since the table follow filed mode messes with the window configuration, it is not recommended to set this variable to nil, except maybe locally in a special file that has mostly tables with long fields.
org-table-export-default-format (funcall #'#[nil ("orgtbl-to-t...
- Type: string
- In file: org-table.el
- Find modifications in git logs
Default export parameters for `org-table-export'. These can be overridden for a specific table by setting the TABLE_EXPORT_FORMAT property. See the manual section on orgtbl radio tables for the different export transformations and available parameters.
org-table-fix-formulas-confirm (funcall #'#[nil (nil) (sort-f...
- Type: (choice (const :tag "with yes-…
- Since: Emacs version 24.1
- In file: org-table.el
- Find modifications in git logs
Whether the user should confirm when Org fixes formulas.
org-table-formula-constants (funcall #'#[nil (nil) (sort-f...
- Type: (repeat (cons (string :tag "na…
- In file: org-table.el
- Find modifications in git logs
Alist with constant names and values, for use in table formulas.
The car of each element is a name of a constant, without the `$' before it.
The cdr is the value as a string. For example, if you'd like to use the
speed of light in a formula, you would configure
(setq org-table-formula-constants \='(("c" . "299792458.")))
and then use it in an equation like `$1*$c'.
Constants can also be defined on a per-file basis using a line like
#+CONSTANTS: c=299792458. pi=3.14 eps=2.4e-6
org-table-formula-create-columns (funcall #'#[nil (nil) (sort-f...
- Type: (choice (const :tag "Out-of-bo…
- In file: org-table.el
- Find modifications in git logs
Non-nil means evaluation of formula can add new columns. When non-nil, evaluating an out-of-bounds field can insert as many columns as needed. When set to `warn', issue a warning when doing so. When set to `prompt', ask user before creating a new column. Otherwise, throw an error.
org-table-formula-evaluate-inline (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means TAB and RET evaluate a formula in current table field. If the current field starts with an equal sign, it is assumed to be a formula which should be evaluated as described in the manual and in the documentation string of the command `org-table-eval-formula'. This feature requires the Emacs calc package. When this variable is nil, formula calculation is only available through the command `\[org-table-eval-formula]'.
org-table-formula-field-format (funcall #'#[nil ("%s") (sort-...
- Type: string
- Since: Emacs version 24.1
- In file: org-table.el
- Find modifications in git logs
Format for fields which contain the result of a formula. For example, using "~%s~" will display the result within tilde characters. Beware that modifying the display can prevent the field from being used in another formula.
org-table-formula-use-constants (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means interpret constants in formulas in tables. A constant looks like `$c' or `$Grav' and will be replaced before evaluation by the value given in `org-table-formula-constants', or by a value obtained from the `constants.el' package.
org-table-header-line-p (funcall #'#[nil (nil) (sort-f...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Activate `org-table-header-line-mode' by default?
org-table-number-fraction (funcall #'#[nil (0.5) (sort-f...
- Type: number
- In file: org-table.el
- Find modifications in git logs
Fraction of numbers in a column required to make the column align right. In a column all non-white fields are considered. If at least this fraction of fields is matched by `org-table-number-regexp', alignment to the right border applies.
org-table-number-regexp (funcall #'#[nil ("^\\([<>]?[-...
- Type: (choice (const :tag "Positive …
- In file: org-table.el
- Find modifications in git logs
Regular expression for recognizing numbers in table columns.
If a table column contains mostly numbers, it will be aligned to the
right. If not, it will be aligned to the left.
The default value of this option is a regular expression which allows
anything which looks remotely like a number as used in scientific
context. For example, all of the following will be considered a
number:
12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
Other options offered by the customize interface are more restrictive.
org-table-relative-ref-may-cross-hline (funcall #'#[nil (t) (sort-fol...
- Type: (choice (const :tag "Allow cro…
- In file: org-table.el
- Find modifications in git logs
Non-nil means relative formula references may cross hlines.
Here are the allowed values:
nil Relative references may not cross hlines. They will reference the
field next to the hline instead. Coming from below, the reference
will be to the field below the hline. Coming from above, it will be
to the field above.
t Relative references may cross hlines.
error An attempt to cross a hline will throw an error.
It is probably good to never set this variable to nil, for the sake of
portability of tables.
org-table-shrunk-column-indicator (funcall #'#[nil ("…") (sort-f...
- Type: string
- In file: org-table.el
- Find modifications in git logs
String to be displayed in a shrunk column.
org-table-tab-jumps-over-hlines (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means tab in the last column of a table with jump over a hline. If a horizontal separator line is following the current line, `org-table-next-field' can either create a new row before that line, or jump over the line. When this option is nil, a new line will be created before this line.
org-table-use-standard-references (funcall #'#[nil ('from) (sort...
- Type: (choice (const :tag "Never, do…
- In file: org-table.el
- Find modifications in git logs
Non-nil means using table references like B3 instead of @3$2. Possible values are: nil never use them from accept as input, do not present for editing t accept as input and present for editing
org-tag-alist (funcall #'#[nil (nil) (crm-se...
- Type: (repeat (choice (cons :tag "Ta…
- In file: org.el
- Find modifications in git logs
Default tags available in Org files. The value of this variable is an alist. Associations either: (TAG) (TAG . SELECT) (SPECIAL) where TAG is a tag as a string, SELECT is character, used to select that tag through the fast tag selection interface, and SPECIAL is one of the following keywords: `:startgroup', `:startgrouptag', `:grouptags', `:endgroup', `:endgrouptag' or `:newline'. These keywords are used to define a hierarchy of tags. See manual for details. When this variable is nil, Org mode bases tag input on what is already in the buffer. The value can be overridden locally by using a TAGS keyword, e.g., #+TAGS: tag1 tag2 See also `org-tag-persistent-alist' to sidestep this behavior.
org-tag-faces (funcall #'#[nil (nil) (t)])
- Type: (repeat (cons (string :tag "Ta…
- In file: org-faces.el
- Find modifications in git logs
Faces for specific tags. This is a list of cons cells, with tags in the car and faces in the cdr. The face can be a symbol, a foreground color (in which case the rest is inherited from the `org-tag' face) or a property list of attributes, like (:foreground "blue" :weight bold :underline t). If you set this variable through customize, it will immediately be effective in new buffers and in modified lines. If you set it with Lisp, a restart of Emacs is required to activate the changes.
org-tag-persistent-alist (funcall #'#[nil (nil) (crm-se...
- Type: (repeat (choice (cons :tag "Ta…
- In file: org.el
- Find modifications in git logs
Tags always available in Org files. The value of this variable is an alist. Associations either: (TAG) (TAG . SELECT) (SPECIAL) where TAG is a tag as a string, SELECT is a character, used to select that tag through the fast tag selection interface, and SPECIAL is one of the following keywords: `:startgroup', `:startgrouptag', `:grouptags', `:endgroup', `:endgrouptag' or `:newline'. These keywords are used to define a hierarchy of tags. See manual for details. Unlike to `org-tag-alist', tags defined in this variable do not depend on a local TAGS keyword. Instead, to disable these tags on a per-file basis, insert anywhere in the file: #+STARTUP: noptag
org-tempo-keywords-alist (funcall #'#[nil ('(("L" . "la...
- Type: (repeat (cons (string :tag "Ke…
- In file: org-tempo.el
- Find modifications in git logs
Keyword completion elements. This is an alist of KEY characters and corresponding KEYWORDS, just like `org-structure-template-alist'. The tempo snippet "<KEY" will be expanded using the KEYWORD value. For example "<L" at the beginning of a line is expanded to "#+latex:". Do not use "I" as a KEY, as it is reserved for expanding "#+include".
org-texinfo-active-timestamp-format (funcall #'#[nil ("@emph{%s}")...
- Type: string
- In file: ox-texinfo.el
- Find modifications in git logs
A `format' string to be applied to active timestamps.
org-texinfo-classes (funcall #'#[nil ('(("info" "@...
- Type: (repeat (list (string :tag "Te…
- Since: Emacs version 27.1
- In file: ox-texinfo.el
- Find modifications in git logs
Alist of Texinfo classes and associated header and structure.
If #+TEXINFO_CLASS is set in the buffer, use its value and the
associated information. Here is the structure of a class
definition:
(class-name
header-string
(numbered-1 unnumbered-1 unnumbered-no-toc-1 appendix-1)
(numbered-2 unnumbered-2 unnumbered-no-toc-2 appendix-2)
...)
The header string
-----------------
The header string is inserted in the header of the generated
document, right after "@setfilename" and "@settitle"
commands.
If it contains the special string
"@documentencoding AUTO"
"AUTO" will be replaced with an appropriate coding system. See
`org-texinfo-coding-system' for more information. Likewise, if
the string contains the special string
"@documentlanguage AUTO"
"AUTO" will be replaced with the language defined in the
buffer, through #+LANGUAGE keyword, or globally, with
`org-export-default-language', which see.
The sectioning structure
------------------------
The sectioning structure of the class is given by the elements
following the header string. For each sectioning level, a number
of strings is specified. A %s formatter is mandatory in each
section string and will be replaced by the title of the section.
org-texinfo-coding-system (funcall #'#[nil (nil) (org-te...
- Type: coding-system
- In file: ox-texinfo.el
- Find modifications in git logs
Default document encoding for Texinfo output. If nil it will default to `buffer-file-coding-system'.
org-texinfo-compact-itemx (funcall #'#[nil (nil) (org-te...
- Type: boolean
- In file: ox-texinfo.el
- Find modifications in git logs
Non-nil means certain items in description list become `@itemx'. If this is non-nil and an item in a description list has no body but is followed by another item, then the second item is transcoded to `@itemx'. See info node `(org)Plain lists in Texinfo export' for how to enable this for individual lists.
org-texinfo-default-class (funcall #'#[nil ("info") (org...
- Type: (string :tag "Texinfo class")
- In file: ox-texinfo.el
- Find modifications in git logs
The default Texinfo class.
org-texinfo-diary-timestamp-format (funcall #'#[nil ("@emph{%s}")...
- Type: string
- In file: ox-texinfo.el
- Find modifications in git logs
A `format' string to be applied to diary timestamps.
org-texinfo-format-drawer-function (funcall #'#[nil (#'(lambda (_...
- Type: function
- Since: Emacs version 24.4
- In file: ox-texinfo.el
- Find modifications in git logs
Function called to format a drawer in Texinfo code. The function must accept two parameters: NAME the drawer name, like "LOGBOOK" CONTENTS the contents of the drawer. The function should return the string to be exported. The default function simply returns the value of CONTENTS.
org-texinfo-format-headline-function (funcall #'#[nil ('org-texinfo...
- Type: function
- Since: Emacs version 26.1
- In file: ox-texinfo.el
- Find modifications in git logs
Function to format headline text. This function will be called with 5 arguments: TODO the todo keyword (string or nil). TODO-TYPE the type of todo (symbol: `todo', `done', nil) PRIORITY the priority of the headline (integer or nil) TEXT the main headline text (string). TAGS the tags as a list of strings (list of strings or nil). The function result will be used in the section format string.
org-texinfo-format-inlinetask-function (funcall #'#[nil ('org-texinfo...
- Type: function
- In file: ox-texinfo.el
- Find modifications in git logs
Function called to format an inlinetask in Texinfo code. The function must accept six parameters: TODO the todo keyword, as a string TODO-TYPE the todo type, a symbol among `todo', `done' and nil. PRIORITY the inlinetask priority, as a string NAME the inlinetask name, as a string. TAGS the inlinetask tags, as a list of strings. CONTENTS the contents of the inlinetask, as a string. The function should return the string to be exported.
org-texinfo-inactive-timestamp-format (funcall #'#[nil ("@emph{%s}")...
- Type: string
- In file: ox-texinfo.el
- Find modifications in git logs
A `format' string to be applied to inactive timestamps.
org-texinfo-info-process (funcall #'#[nil ('("makeinfo ...
- Type: (choice (repeat :tag "Shell co…
- Since: Emacs version 26.1
- In file: ox-texinfo.el
- Find modifications in git logs
Commands to process a Texinfo file to an INFO file. This is a list of strings, each of them will be given to the shell as a command. %f in the command will be replaced by the relative file name, %F by the absolute file name, %b by the file base name (i.e. without directory and extension parts), %o by the base directory of the file and %O by the absolute file name of the output file. Alternatively, this may be a Lisp function that does the processing, This function should accept the file name as its single argument.
org-texinfo-link-with-unknown-path-format (funcall #'#[nil ("@indicateur...
- Type: string
- In file: ox-texinfo.el
- Find modifications in git logs
Format string for links with unknown path type.
org-texinfo-logfiles-extensions (funcall #'#[nil ('("aux" "toc...
- Type: (repeat (string :tag "Extensio…
- In file: ox-texinfo.el
- Find modifications in git logs
The list of file extensions to consider as Texinfo logfiles. The logfiles will be remove if `org-texinfo-remove-logfiles' is non-nil.
org-texinfo-node-description-column (funcall #'#[nil (32) (org-tex...
- Type: integer
- In file: ox-texinfo.el
- Find modifications in git logs
Column at which to start the description in the node listings. If a node title is greater than this length, the description will be placed after the end of the title.
org-texinfo-remove-logfiles (funcall #'#[nil (t) (org-texi...
- Type: boolean
- In file: ox-texinfo.el
- Find modifications in git logs
Non-nil means remove the logfiles produced by compiling a Texinfo file. By default, logfiles are files with these extensions: .aux, .toc, .cp, .fn, .ky, .pg and .tp. To define the set of logfiles to remove, set `org-texinfo-logfiles-extensions'.
org-texinfo-table-default-markup (funcall #'#[nil ("@asis") (or...
- Type: string
- Since: Emacs version 26.1
- In file: ox-texinfo.el
- Find modifications in git logs
Default markup for first column in two-column tables. This should an indicating command, e.g., "@code", "@kbd" or "@samp". It can be overridden locally using the ":indic" attribute.
org-texinfo-table-scientific-notation (funcall #'#[nil (nil) (org-te...
- Type: (choice (string :tag "Format s…
- In file: ox-texinfo.el
- Find modifications in git logs
Format string to display numbers in scientific notation.
The format should have "%s" twice, for mantissa and exponent
(i.e. "%s\\times10^{%s}").
When nil, no transformation is made.
org-texinfo-tables-verbatim (funcall #'#[nil (nil) (org-te...
- Type: boolean
- In file: ox-texinfo.el
- Find modifications in git logs
When non-nil, tables are exported verbatim.
org-texinfo-text-markup-alist (funcall #'#[nil ('((bold . "@...
- Type: alist
- Since: Emacs version 26.1
- In file: ox-texinfo.el
- Find modifications in git logs
Alist of Texinfo expressions to convert text markup. The key must be a symbol among `bold', `code', `italic', `strike-through', `underscore' and `verbatim'. The value is a formatting string to wrap fontified text with. Value can also be set to the following symbols: `verb', `samp' and `code'. With the first one, Org uses "@verb" to create a format string and selects a delimiter character that isn't in the string. For the other two, Org uses "@samp" or "@code" to typeset and protects special characters. When no association is found for a given markup, text is returned as-is.
org-texinfo-with-latex (funcall #'#[nil ((and org-exp...
- Type: (choice (const :tag "Detect" d…
- In file: ox-texinfo.el
- Find modifications in git logs
When non-nil, the Texinfo exporter attempts to process LaTeX math. When set to t, the exporter will process LaTeX environments and fragments as Texinfo "@displaymath" and "@math" commands respectively. Alternatively, when set to `detect', the exporter does so only if the installed version of Texinfo supports the necessary commands.
org-timer-default-timer (funcall #'#[nil ("0") (t)])
- Type: string
- Since: Emacs version 26.1
- In file: org-timer.el
- Find modifications in git logs
The default timer when a timer is set, in minutes or hh:mm:ss format. When 0, the user is prompted for a value.
org-timer-display (funcall #'#[nil ('mode-line) ...
- Type: (choice (const :tag "Mode line…
- In file: org-timer.el
- Find modifications in git logs
Define where running timer is displayed, if at all. When a timer is running, Org can display it in the mode line and/or frame title. Allowed values are: both displays in both mode line and frame title mode-line displays only in mode line (default) frame-title displays only in frame title nil current timer is not displayed
org-timer-format (funcall #'#[nil ("%s ") (t)])
- Type: string
- In file: org-timer.el
- Find modifications in git logs
The format to insert the time of the timer. This format must contain one instance of "%s" which will be replaced by the value of the timer.
org-timestamp-custom-formats (funcall #'#[nil ('("%m/%d/%y ...
- Type: (cons string string)
- In file: org.el
- Find modifications in git logs
Custom formats for time stamps. See `format-time-string' for the syntax. These are overlaid over the default ISO format if the variable `org-display-custom-times' is set. Time like %H:%M should be at the end of the second format. The custom formats are also honored by export commands, if custom time display is turned on at the time of export. This variable also affects how timestamps are exported when `org-display-custom-times' is set. Leading "<" or "[" and trailing ">" or "]" pair will be stripped from the format strings in Emacs buffers. The brackets will be preserved on export.
org-timestamp-rounding-minutes (funcall #'#[nil ('(0 5)) (crm...
- Type: (list (integer :tag "when inse…
- In file: org.el
- Find modifications in git logs
Number of minutes to round time stamps to. \<org-mode-map>These are two values, the first applies when first creating a time stamp. The second applies when changing it with the commands `S-up' and `S-down'. When changing the time stamp, this means that it will change in steps of N minutes, as given by the second value. When a setting is 0 or 1, insert the time unmodified. Useful rounding numbers should be factors of 60, so for example 5, 10, 15. When this is larger than 1, you can still force an exact time stamp by using a double prefix argument to a time stamp command like `\[org-timestamp]' or `\[org-timestamp-inactive], and by using a prefix arg to `S-up/down' to specify the exact number of minutes to shift.
org-todo-interpretation (funcall #'#[nil ('sequence) (...
- Type: (choice (const sequence) (cons…
- In file: org.el
- Find modifications in git logs
Controls how TODO keywords are interpreted. This variable is in principle obsolete and is only used for backward compatibility, if the interpretation of todo keywords is not given already in `org-todo-keywords'. See that variable for more information.
org-todo-keyword-faces (funcall #'#[nil (nil) (t)])
- Type: (repeat (cons (string :tag "Ke…
- In file: org-faces.el
- Find modifications in git logs
Faces for specific TODO keywords. This is a list of cons cells, with TODO keywords in the car and faces in the cdr. The face can be a symbol, a color as a string (in which case the rest is inherited from the `org-todo' face), or a property list of attributes, like (:foreground "blue" :weight bold :underline t). If it is a color string, the variable `org-faces-easy-properties' determines if it is a foreground or a background color.
org-todo-keywords (funcall #'#[nil ('((sequence ...
- Type: (choice (repeat :tag "Old synt…
- In file: org.el
- Find modifications in git logs
List of TODO entry keyword sequences and their interpretation. \<org-mode-map>This is a list of sequences. Each sequence starts with a symbol, either `sequence' or `type', indicating if the keywords should be interpreted as a sequence of action steps, or as different types of TODO items. The first keywords are states requiring action - these states will select a headline for inclusion into the global TODO list Org produces. If one of the "keywords" is the vertical bar, "|", the remaining keywords signify that no further action is necessary. If "|" is not found, the last keyword is treated as the only DONE state of the sequence. The command `\[org-todo]' cycles an entry through these states, and one additional state where no keyword is present. For details about this cycling, see the manual. TODO keywords and interpretation can also be set on a per-file basis with the special #+SEQ_TODO and #+TYP_TODO lines. Each keyword can optionally specify a character for fast state selection (in combination with the variable `org-use-fast-todo-selection') and specifiers for state change logging, using the same syntax that is used in the "#+TODO:" lines. For example, "WAIT(w)" says that the WAIT state can be selected with the "w" key. "WAIT(w!)" indicates to record a time stamp each time this state is selected. Each keyword may also specify if a timestamp or a note should be recorded when entering or leaving the state, by adding additional characters in the parenthesis after the keyword. This looks like this: "WAIT(w@/!)". "@" means to add a note (with time), "!" means to record only the time of the state change. With X and Y being either "@" or "!", "X/Y" means use X when entering the state, and use Y when leaving the state if and only if the *target* state does not define X. You may omit any of the fast-selection key or X or /Y, so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid. For backward compatibility, this variable may also be just a list of keywords. In this case the interpretation (sequence or type) will be taken from the (otherwise obsolete) variable `org-todo-interpretation'.
org-todo-repeat-to-state (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Use the p…
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
The TODO state to which a repeater should return the repeating task. By default this is the first task of a TODO sequence or the previous state of a TYPE_TODO set. But you can specify to use the previous state in a TODO sequence or a string. Alternatively, you can set the :REPEAT_TO_STATE: property of the entry, which has precedence over this option.
org-track-ordered-property-with-tag (funcall #'#[nil (nil) (org-st...
- Type: (choice (const :tag "No tracki…
- In file: org.el
- Find modifications in git logs
Should the ORDERED property also be shown as a tag? The ORDERED property decides if an entry should require subtasks to be completed in sequence. Since a property is not very visible, setting this option means that toggling the ORDERED property with the command `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is not relevant for the behavior, but it makes things more visible. Note that toggling the tag with tags commands will not change the property and therefore not influence behavior! This can be t, meaning the tag ORDERED should be used. It can also be a string to select a different tag for this task.
org-treat-S-cursor-todo-selection-as-state-change (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means switching TODO states with S-cursor counts as state change. This is the default behavior. However, setting this to nil allows a convenient way to select a TODO state and bypass any logging associated with that.
org-treat-insert-todo-heading-as-state-change (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means inserting a TODO heading is treated as state change. So when the command `\[org-insert-todo-heading]' is used, state change logging will apply if appropriate. When nil, the new TODO item will be inserted directly, and no logging will take place.
org-use-effective-time (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.1
- In file: org.el
- Find modifications in git logs
If non-nil, consider `org-extend-today-until' when creating timestamps. For example, if `org-extend-today-until' is 8, and it's 4am, then the "effective time" of any timestamps between midnight and 8am will be 23:59 of the previous day.
org-use-extra-keys (funcall #'#[nil (nil) (t)])
- Type: boolean
- In file: org-keys.el
- Find modifications in git logs
Non-nil means use extra key sequence definitions for certain commands. This happens automatically if `display-graphic-p' returns nil. This variable lets you do the same manually. You must set it before loading Org.
org-use-fast-tag-selection (funcall #'#[nil ('auto) (crm-...
- Type: (choice (const :tag "Always" t…
- In file: org.el
- Find modifications in git logs
Non-nil means use fast tag selection scheme. This is a special interface to select and deselect tags with single keys. When nil, fast selection is never used. When the symbol `auto', fast selection is used if and only if selection characters for tags have been configured, either through the variable `org-tag-alist' or through a #+TAGS line in the buffer. When t, fast selection is always used and selection keys are assigned automatically if necessary.
org-use-fast-todo-selection (funcall #'#[nil ('auto) (crm-...
- Type: (choice (const :tag "Never" ni…
- In file: org.el
- Find modifications in git logs
\<org-mode-map>Non-nil means use the fast todo selection scheme with `\[org-todo]'. This variable describes if and under what circumstances the cycling mechanism for TODO keywords will be replaced by a single-key, direct selection scheme, where the choices are displayed in a little window. When nil, fast selection is never used. This means that the command will always switch to the next state. When it is the symbol `auto', fast selection is whenever selection keys have been defined. `expert' is like `auto', but no special window with the keyword will be shown, choices will only be listed in the prompt. In all cases, the special interface is only used if access keys have actually been assigned by the user, i.e. if keywords in the configuration are followed by a letter in parenthesis, like TODO(t).
org-use-last-clock-out-time-as-effective-time (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
When non-nil, use the last clock out time for `org-todo'. Note that this option has precedence over the combined use of `org-use-effective-time' and `org-extend-today-until'.
org-use-property-inheritance (funcall #'#[nil (nil) (crm-se...
- Type: (choice (const :tag "Not" nil)…
- In file: org.el
- Find modifications in git logs
Non-nil means properties apply also for sublevels. This setting is chiefly used during property searches. Turning it on can cause significant overhead when doing a search, which is why it is not on by default. When nil, only the properties directly given in the current entry count. When t, every property is inherited. The value may also be a list of properties that should have inheritance, or a regular expression matching properties that should be inherited. However, note that some special properties use inheritance under special circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS, and the properties ending in "_ALL" when they are used as descriptor for valid values of a property. Note for programmers: When querying an entry with `org-entry-get', you can control if inheritance should be used. By default, `org-entry-get' looks only at the local properties. You can request inheritance by setting the inherit argument to t (to force inheritance) or to `selective' (to respect the setting in this variable).
org-use-speed-commands (funcall #'#[nil (nil) (t)])
- Type: (choice (const :tag "Never" ni…
- In file: org-keys.el
- Find modifications in git logs
Non-nil means activate single letter commands at beginning of a headline.
This may also be a function to test for appropriate locations where speed
commands should be active.
For example, to activate speed commands when the point is on any
star at the beginning of the headline, you can do this:
(setopt org-use-speed-commands
(lambda ()
(and (looking-at org-outline-regexp)
(looking-back "^\\**"))))
Note that prior to Emacs 29, `setopt' is unavailable, and
`custom-set-variables' or `setq' is used instead.
org-use-sub-superscripts (funcall #'#[nil (t) (crm-sepa...
- Type: (choice (const :tag "Always in…
- Since: Emacs version 24.4
- In file: org.el
- Find modifications in git logs
Non-nil means interpret "_" and "^" for display.
If you want to control how Org exports those characters, see
`org-export-with-sub-superscripts'.
When this option is turned on, you can use TeX-like syntax for
sub- and superscripts within the buffer. Several characters after
"_" or "^" will be considered as a single item - so grouping
with {} is normally not needed. For example, the following things
will be parsed as single sub- or superscripts:
10^24 or 10^tau several digits will be considered 1 item.
10^-12 or 10^-tau a leading sign with digits or a word
x^2-y^3 will be read as x^2 - y^3, because items are
terminated by almost any nonword/nondigit char.
x^(2 - i) expression inside round braces, including the
braces is read as a sub/superscript.
x_{i^2} curly braces do grouping; braces are not
considered a part of the sub/superscript.
Still, ambiguity is possible. So when in doubt, use {} to enclose
the sub/superscript. If you set this variable to the symbol `{}',
the curly braces are *required* in order to trigger interpretations as
sub/superscript. This can be helpful in documents that need "_"
frequently in plain text.
Setting this variable does not change Org mode markup. Org mode will
still parse the matching text as sub/superscript internally. It is
only the visual appearance that will be changed.
org-use-tag-inheritance (funcall #'#[nil (t) (crm-sepa...
- Type: (choice (const :tag "Not" nil)…
- In file: org.el
- Find modifications in git logs
Non-nil means tags in levels apply also for sublevels. When nil, only the tags directly given in a specific line apply there. This may also be a list of tags that should be inherited, or a regexp that matches tags that should be inherited. Additional control is possible with the variable `org-tags-exclude-from-inheritance' which gives an explicit list of tags to be excluded from inheritance, even if the value of `org-use-tag-inheritance' would select it for inheritance. If this option is t, a match early-on in a tree can lead to a large number of matches in the subtree when constructing the agenda or creating a sparse tree. If you only want to see the first match in a tree during a search, check out the variable `org-tags-match-list-sublevels'.
org-yank-adjusted-subtrees (funcall #'#[nil (nil) (crm-se...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means when yanking subtrees, adjust the level. With this setting, `org-paste-subtree' is used to insert the subtree, see this function for details.
org-yank-dnd-default-attach-method (funcall #'#[nil (nil) (org-wi...
- Type: (choice (const :tag "Default a…
- In file: org.el
- Find modifications in git logs
Default attach method to use when DND action is unspecified. This attach method is used when the DND action is `private'. This is also used when `org-yank-image-save-method' is nil. When nil, use `org-attach-method'.
org-yank-dnd-method (funcall #'#[nil ('ask) (org-w...
- Type: (choice (const :tag "Attach" a…
- In file: org.el
- Find modifications in git logs
Action to perform on the dropped and the pasted files. When the value is the symbol, . `attach' -- attach dropped/pasted file . `open' -- visit/open dropped/pasted file in Emacs . `file-link' -- insert file: link to dropped/pasted file . `ask' -- ask what to do out of the above.
org-yank-folded-subtrees (funcall #'#[nil (t) (crm-sepa...
- Type: boolean
- In file: org.el
- Find modifications in git logs
Non-nil means when yanking subtrees, fold them. If the kill is a single subtree, or a sequence of subtrees, i.e. if it starts with a heading and all other headings in it are either children or siblings, then fold all the subtrees. However, do this only if no text after the yank would be swallowed into a folded tree by this action.
org-yank-image-file-name-function (funcall #'#[nil (#'org-yank-i...
- Type: (radio (function-item :doc "Au…
- In file: org.el
- Find modifications in git logs
Function to generate filename for image yanked from clipboard. By default, this autogenerates a filename based on the current time. It is called with no arguments and should return a string without any extension which is used as the filename.
org-yank-image-save-method (funcall #'#[nil ('attach) (or...
- Type: (choice (const :tag "Add it as…
- In file: org.el
- Find modifications in git logs
Method to save images yanked from clipboard and dropped to Emacs. It can be the symbol `attach' to add it as an attachment, or a directory name to copy/cut the image to that directory, or a function that will be called without arguments and should return the directory name, as a string.
orgtbl-optimized (funcall #'#[nil (t) (sort-fol...
- Type: boolean
- In file: org-table.el
- Find modifications in git logs
Non-nil means use the optimized table editor version for `orgtbl-mode'. In the optimized version, the table editor takes over all simple keys that normally just insert a character. In tables, the characters are inserted in a way to minimize disturbing the table structure (i.e. in overwrite mode for empty fields). Outside tables, the correct binding of the keys is restored. Changing this variable requires a restart of Emacs to become effective.
orgtbl-radio-table-templates (funcall #'#[nil ('((latex-mod...
- Type: (repeat (list (symbol :tag "Ma…
- In file: org-table.el
- Find modifications in git logs
Templates for radio tables in different major modes. Each template must define lines that will be treated as a comment and that must contain the "BEGIN RECEIVE ORGTBL %n" and "END RECEIVE ORGTBL" lines where "%n" will be replaced with the name of the table during insertion of the template. The transformed table will later be inserted between these lines. The template should also contain a minimal table in a multiline comment. If multiline comments are not possible in the buffer language, you can pack it into a string that will not be used when the code is compiled or executed. Above the table will you need a line with the fixed string "#+ORGTBL: SEND", followed by instruction on how to convert the table into a data structure useful in the language of the buffer. Check the manual for the section on "Translator functions", and more generally check out the Info node `(org)Tables in arbitrary syntax'. All occurrences of %n in a template will be replaced with the name of the table, obtained by prompting the user.