UP | HOME

Org API

Table of Contents

Org-Eval API functions (org-eval.el)

org-eval form

Eval form and return result.

org-eval-handle-snippets limit &optional replace

Evaluate code snippets and display the results as display property. When replace is non-nil, replace the code region with the result (used for export).

org-eval-in-calendar form &optional keepdate

Eval form in the calendar window and return to current window. When keepdate is non-nil, update org-ans2 from the cursor date, otherwise stick to the current value of org-ans2.

org-eval-light-current-snippet &optional arg

Execute the current #+begin_src #+end_src block, and dump the results into the buffer immediately following the src block, commented by org-eval-light-make-region-example.

org-eval-light-eval-subtree &optional arg

Replace EVAL snippets in the entire subtree.

org-eval-light-lisp form

Evaluate the given form and return the result as a string.

org-eval-light-make-region-example beg end

Comment out region using either the '^:' or the =beg=IN_EXAMPLE syntax based on the size of the region as compared to org-eval-light-example-size-cutoff.

org-eval-lisp form

Evaluate the given form and return the result as a string.

org-eval-replace-snippts

Replace EVAL snippets in the entire buffer. This should go into the org-export-preprocess-hook.

org-evaluate-time-range &optional to-buffer

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.

Documentation from the http://orgmode.org/worg/ website (either in its HTML format or in its Org format) is licensed under the GNU Free Documentation License version 1.3 or later. The code examples and css stylesheets are licensed under the GNU General Public License v3 or later.