Re: Org now fontifies code blocks

From: Dan Davison <davison@stats.ox.ac.uk>
To: Erik Iverson <eriki@ccbr.umn.edu>
Cc: "Sébastien Vauban" <wxhgmqzgwmuf@spammotel.com>, emacs-orgmode@gnu.org
Subject: Re: Org now fontifies code blocks
Date: Wed, 08 Sep 2010 15:17:03 -0400	[thread overview]
Message-ID: <87r5h4avv4.fsf@stats.ox.ac.uk> (raw)
In-Reply-To: <4C87D922.40109@ccbr.umn.edu> (Erik Iverson's message of "Wed, 08 Sep 2010 13:42:42 -0500")

Erik Iverson <eriki@ccbr.umn.edu> writes:

> Sébastien Vauban wrote:
>> Hi Bastien and Dan,
>>
>> Bastien wrote:
>>> Dan Davison <davison@stats.ox.ac.uk> writes:
>>>
>>>> (We badly need a customize group for these org-src but non-babel
>>>> variables[1]. That suggests to me subsuming the "Babel" group (Should be
>>>> "Org Babel" for consistency?) within a new group, perhaps "Org Code" or
>>>> "Org Src" or "Org Source Code" ? Views?
>>> I find "Org Code" and "Org Source Code" rather ambiguous.

Yes, you're right!

>>> "Org Src" is
>>> better but still a bit too general IMHO.
>>>
>>> "Org Src Block"?

I do sometimes find myself wondering whether "src" is a little cryptic
for user-level documentation: an alternative would be "code" as in "code
blocks". But src is hard-wired into "begin_src", and it is familiar to
many programmers, and it is already traditional in Org-mode, so perhaps
it is fine.

>> The terminology of such code blocks in Noweb was "scraps". We often see
>> "snippets" as well, but (not being English-native), that can be more for pure
>> text (not specifically code).
>>
>> Then, it could be "Org Scraps" or similar variants.
>
> Or "chunk", which I subjectively find the most phonetically pleasing.

I would like there to be some uniformity in this, across documentation,
docstrings and function and variable names. I have been guilty of using
"code blocks" in docstrings and commit logs. So if "src block" is /the/
Org-mode way of referring to these things, then let's stick to it!

For the purposes of customize, we don't have to abbreviate, so we could
also have 

"Org Source Code Blocks"

but as Bastien sugests, "Org Src Blocks" would be a natural Org-mode
term.

Dan

>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode