From mboxrd@z Thu Jan  1 00:00:00 1970
From: Eric Schulte <schulte.eric@gmail.com>
Subject: [RFC] Standardized code block keywords
Date: Thu, 20 Oct 2011 15:50:52 -0600
Message-ID: <87y5wfgwn7.fsf_-_@gmail.com>
References: <87pqhrih3s.fsf@gmail.com>
	<30891.1319141196@alphaville.dokosmarshall.org>
	<87fwinifqu.fsf@gmail.com>
	<32184.1319143892@alphaville.dokosmarshall.org>
	<808vofwf1w.fsf@somewhere.org>
Mime-Version: 1.0
Content-Type: text/plain
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([140.186.70.92]:60934)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <schulte.eric@gmail.com>) id 1RH0Vw-0006eu-AG
	for emacs-orgmode@gnu.org; Thu, 20 Oct 2011 17:51:01 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <schulte.eric@gmail.com>) id 1RH0Vv-0003OW-3G
	for emacs-orgmode@gnu.org; Thu, 20 Oct 2011 17:51:00 -0400
Received: from mail-gx0-f169.google.com ([209.85.161.169]:38700)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <schulte.eric@gmail.com>) id 1RH0Vu-0003OQ-Vb
	for emacs-orgmode@gnu.org; Thu, 20 Oct 2011 17:50:59 -0400
Received: by ggnh4 with SMTP id h4so3759819ggn.0
	for <emacs-orgmode@gnu.org>; Thu, 20 Oct 2011 14:50:58 -0700 (PDT)
In-Reply-To: <808vofwf1w.fsf@somewhere.org> (Sebastien Vauban's message of
	"Thu, 20 Oct 2011 23:04:11 +0200")
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/emacs-orgmode>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
To: Sebastien Vauban <wxhgmqzgwmuf@spammotel.com>
Cc: emacs-orgmode@gnu.org

> [1] I have the same "annoying" feelings with #+SOURCE, #+SRCNAME, #+FUNCTION,
> #+CALL, #+LOB, and SBE, some of which are interchangeable; some not. I'd prefer
> deprecating an old form when a better one is found.

This point of view has been raised previously both on the mailing list
and in the #org-mode IRC chat room.  I think it is time that we decided
as a community what we want to do about the prevalence of code block
synonyms -- we should make this decision before the release of Emacs24
after which syntax will become harder to change.

There are currently a number of instances of synonymous keywords when
dealing with code blocks, specifically.

         named code blocks [1] -- "source" "srcname" "function"
calling external functions [2] -- "call" "lob"
                named data [3] -- "tblname" "resname" "results" "data"

Ideally if we limit each of the above to only one alternative we could
simplify the specification of code blocks in Org-mode making them easier
to learn and use and removing some of the mystery around their syntax.

What does everyone think?

Are there suggestions for the best names for each code block entity
(either in the list or not in the list)?

Are there cases where we want to continue to allow synonyms (e.g., in
named data so that "results" can be used for code block results but
"data" can be used for hand-written data)?

Thanks -- Eric

Footnotes: 
[1] named code blocks

    #+source: foo
    #+begin_src emacs-lisp
      'foo
    #+end_src

    #+srcname: foo
    #+begin_src emacs-lisp
      'foo
    #+end_src

    #+function: foo
    #+begin_src emacs-lisp
      'foo
    #+end_src

[2]  calling external functions

    #+call: foo()

    #+lob: foo()

[3]  named data

    #+data: something
    : something

    #+results: something
    : something

    etc...

-- 
Eric Schulte
http://cs.unm.edu/~eschulte/