emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: "François Pinard" <pinard@iro.umontreal.ca>
To: emacs-orgmode@gnu.org
Subject: Babel and capitalization
Date: Mon, 21 May 2012 10:58:42 -0400	[thread overview]
Message-ID: <86k405r36l.fsf@mercure.progiciels-bpi.ca> (raw)

Hi, Org people!

A while ago, we discussed capitalization on this list, as the manual was
irregular on things like #+BEGIN_SRC and #+begin_src.  After some
discussion and hesitation, Bastien decided to stick to upper case in the
manual, and despite it was not my own preference, I amended all my Org
files to use upper case, for consistency.

Now, I have a script, run at least daily, which checks all my Org files
for a lot of nits.  After I started to study some of Babel facilities
(yesterday), my script now trips on Babel results:

--8<---------------cut here---------------start------------->8---
~/fp/notes/notes.org:33: Wrong capitalization
~/fp/notes/notes.org:57: Wrong capitalization
--8<---------------cut here---------------end--------------->8---

And indeed, I get, trying an example taken from this mailing list:

--8<---------------cut here---------------start------------->8---
#+BEGIN_SRC R :results output
citation()
#+END_SRC

#+RESULTS:
#+begin_example

To cite R in publications use:

  R Development Core Team (2011). R: A language and environment for
  statistical computing. R Foundation for Statistical Computing,
  Vienna, Austria. ISBN 3-900051-07-0, URL http://www.R-project.org/.

A BibTeX entry for LaTeX users is

  @Manual{,
    title = {R: A Language and Environment for Statistical Computing},
    author = {{R Development Core Team}},
    organization = {R Foundation for Statistical Computing},
    address = {Vienna, Austria},
    year = {2011},
    note = {{ISBN} 3-900051-07-0},
    url = {http://www.R-project.org/},
  }

We have invested a lot of time and effort in creating R, please cite it
when using it for data analysis. See also ‘citation("pkgname")’ for
citing R packages.
#+end_example
--8<---------------cut here---------------end--------------->8---

If I correct #+begin_example to #+BEGIN_EXAMPLE, etc. and retry, the
result returns to lower case.

I could of course modify my nit-picking program so it recognizes the
#+RESULTS: case, but my feeling is that Org should be consistent overall
on capitalization.  And by telling this, of course, I disregard my own
preference.  Consistency has a stronger appeal to me.

François

next             reply	other threads:[~2012-05-21 14:58 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-21 14:58 François Pinard [this message]
2012-05-21 13:48 ` Babel and capitalization Eric Schulte
2012-05-21 16:01   ` François Pinard

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=86k405r36l.fsf@mercure.progiciels-bpi.ca \
    --to=pinard@iro.umontreal.ca \
    --cc=emacs-orgmode@gnu.org \
    /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

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).