From: tsd@tsdye.com (Thomas S. Dye)
To: Eric Schulte <eric.schulte@gmx.com>
Cc: Bastien <bzg@altern.org>,
"François Pinard" <pinard@iro.umontreal.ca>,
nicholas.dokos@hp.com, emacs-orgmode@gnu.org,
"Bernt Hansen" <bernt@norang.ca>
Subject: [PATCH] Re: Capitalisation and good taste ?
Date: Wed, 11 Jan 2012 11:26:25 -1000 [thread overview]
Message-ID: <m1obua53su.fsf_-_@tsdye.com> (raw)
In-Reply-To: <8739bmneis.fsf@gmx.com> (Eric Schulte's message of "Wed, 11 Jan 2012 13:57:31 -0700")
[-- Attachment #1: Type: text/plain, Size: 110 bytes --]
Aloha all,
The attached patch to the manual includes information on the RESULTS
keyword.
All the best,
Tom
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Manual patch --]
[-- Type: text/x-patch, Size: 2109 bytes --]
From 7fbabd20ed1477e706633945c98400ee48fb0ab2 Mon Sep 17 00:00:00 2001
From: Thomas Dye <dk@poto.myhome.westell.com>
Date: Wed, 11 Jan 2012 11:23:19 -1000
Subject: [PATCH] * doc/org.texi: #+RESULTS now user-configurable
---
doc/org.texi | 17 ++++++++++++-----
1 files changed, 12 insertions(+), 5 deletions(-)
diff --git a/doc/org.texi b/doc/org.texi
index a9f0139..2229358 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -12629,17 +12629,24 @@ of tangled code files.
@section Evaluating code blocks
@cindex code block, evaluating
@cindex source code, evaluating
+@cindex #+RESULTS
Code blocks can be evaluated@footnote{Whenever code is evaluated there is a
potential for that code to do harm. Org mode provides safeguards to ensure
that code is only evaluated after explicit confirmation from the user. For
information on these safeguards (and on how to disable them) see @ref{Code
evaluation security}.} and the results of evaluation optionally placed in the
-Org mode buffer. By default, the evaluation facility is only enabled for
-Lisp code blocks specified as @code{emacs-lisp}. However, source code blocks
-in many languages can be evaluated within Org mode (see @ref{Languages} for a
-list of supported languages and @ref{Structure of code blocks} for
-information on the syntax used to define a code block).
+Org mode buffer. The results of evaluation are placed following a line that
+begins by default with @code{#+RESULTS} and optionally a cache identifier
+and/or the name of the evaluated code block. The default value of
+@code{#+RESULTS} can be changed with the customizable variable
+@code{org-babel-results-keyword}.
+
+By default, the evaluation facility is only enabled for Lisp code blocks
+specified as @code{emacs-lisp}. However, source code blocks in many languages
+can be evaluated within Org mode (see @ref{Languages} for a list of supported
+languages and @ref{Structure of code blocks} for information on the syntax
+used to define a code block).
@kindex C-c C-c
There are a number of ways to evaluate code blocks. The simplest is to press
--
1.7.5.4
[-- Attachment #3: Type: text/plain, Size: 629 bytes --]
Eric Schulte <eric.schulte@gmx.com> writes:
>>
>> I'm going to push up a patch which will change to inserting #+RESULTS:
>> by default as well as a user-configurable variable which can be used to
>> customize this behavior.
>
> Done. This variable is named `org-babel-results-keyword'
>
> ,----
> | org-babel-results-keyword's value is "RESULTS"
> |
> | Documentation:
> | Keyword used to name results generated by code blocks.
> | Should be either RESULTS or NAME however any capitalization may
> | be used.
> |
> | You can customize this variable.
> |
> | [back]
> `----
>
> Best,
--
Thomas S. Dye
http://www.tsdye.com
next prev parent reply other threads:[~2012-01-11 21:26 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-01-10 3:19 Capitalisation and good taste ? François Pinard
2012-01-10 3:55 ` Bernt Hansen
2012-01-10 5:13 ` Nick Dokos
2012-01-10 5:35 ` François Pinard
2012-01-10 7:37 ` Nick Dokos
2012-01-10 14:59 ` François Pinard
2012-01-10 15:46 ` Nick Dokos
2012-01-10 19:32 ` Bastien
2012-01-10 19:38 ` Eric Schulte
2012-01-10 19:55 ` Bastien
2012-01-10 20:18 ` François Pinard
2012-01-10 20:57 ` Martyn Jago
2012-01-11 7:49 ` Sebastien Vauban
2012-01-14 22:15 ` François Pinard
2012-01-14 23:01 ` Sebastien Vauban
2012-01-11 15:40 ` Bastien
2012-01-14 22:25 ` François Pinard
2012-01-11 15:38 ` Bastien
2012-01-11 20:47 ` Eric Schulte
2012-01-11 20:57 ` Eric Schulte
2012-01-11 21:26 ` Thomas S. Dye [this message]
2012-01-11 22:42 ` [PATCH] " Eric Schulte
2012-01-12 7:42 ` Bastien
2012-01-10 5:22 ` François Pinard
2012-01-10 17:45 ` Tommy Kelly
2012-01-10 21:19 ` Eric S Fraga
2012-01-10 23:41 ` Sankalp
2012-01-21 4:00 ` Leo Alekseyev
2012-01-21 12:16 ` Bernt Hansen
2012-01-21 20:08 ` Eric S Fraga
2012-01-21 23:03 ` Bernt Hansen
2012-01-23 8:49 ` Eric S Fraga
2012-01-24 14:42 ` Bastien
2012-01-10 21:13 ` Eric S Fraga
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m1obua53su.fsf_-_@tsdye.com \
--to=tsd@tsdye.com \
--cc=bernt@norang.ca \
--cc=bzg@altern.org \
--cc=emacs-orgmode@gnu.org \
--cc=eric.schulte@gmx.com \
--cc=nicholas.dokos@hp.com \
--cc=pinard@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).