From: Nick Dokos <nicholas.dokos@hp.com>
To: Bernt Hansen <bernt@norang.ca>
Cc: =?utf-8?Q?Fran=C3=A7ois?= Pinard <pinard@iro.umontreal.ca>,
nicholas.dokos@hp.com, emacs-orgmode@gnu.org
Subject: Re: Capitalisation and good taste ?
Date: Tue, 10 Jan 2012 00:13:11 -0500 [thread overview]
Message-ID: <23144.1326172391@gamaville.dokosmarshall.org> (raw)
In-Reply-To: Message from Bernt Hansen <bernt@norang.ca> of "Mon\, 09 Jan 2012 22\:55\:24 EST." <87aa5wcitv.fsf@norang.ca>
Bernt Hansen <bernt@norang.ca> wrote:
> pinard@iro.umontreal.ca (François Pinard) writes:
>
> > I really have mixed feelings about capitalisation of #+WORDS, and wonder
> > if some consensus and good taste has developed over time among Org mode
> > users. What is the collective wisdom saying as being nicer among:
> >
> > #+LATEX_HEADER:
> > #+Latex_Header:
> > #+LaTeX_HEADER:
> > #+latex_header:
> >
> > etc.
> >
> > I'm just unable to fix myself on any convention, and my own lack of
> > decision irritates me. I hate changing my mind so often, and my files
> > are already a mess on this particular point.
> >
> > Despite all capitals have the advantage of standing out clearly, I
> > usually don't like any kind of shouting in my files. If I was writing
> > constants in C code, I would tolerate some exceptions of course, but
> > now, I'm writing documentation. #+begin_quote and such are just OK in
> > small letters, they really look like shouting otherwise.
> >
> > On the other hand, it seems that #+TITLE, #+AUTHOR and #+EMAIL, and all
> > those things which are high lighted in gray, use capitals only in all
> > examples I've seen so far. Maybe the pale high lighting is a
> > counter-measure so it gets tolerable.
> >
> > It seems that capitals are also favoured for #+OPTIONS, #+BIND, and many
> > other things (high lighted in red), yet I got the impression that parts
> > of the documentation (which look "newer" or "younger" to me on the
> > average) are getting away from the all capital conventions. I do not
> > really know.
> >
> > The writing "LaTeX" has the nicety of being the proper way to write
> > LaTeX, which is mandated by Lamport (after TeX has been mandated by
> > Knuth). And I will not even speak of the revolutionary iTex, because I
> > do not have a bell handy! :-) If any of you are not aware of it, make
> > sure you do not miss http://www.youtube.com/watch?v=eKaI78K_rgA (you
> > then need half an hour of free time to listen to the video).
> >
> > Not helping is that the manual and the Wiki are not using capitalisation
> > consistently between files, and even sometimes in the same area of a
> > same file. They are not giving me clear advice about what is proper
> > style.
> >
> > Maybe this has already been debated to death? I do not know for Org
> > mode files, yet I know that style issues are usually flame-prone. I'm
> > surely not trying to start any kind of war. Nevertheless, I would like
> > if the manual and the Wiki select and document a preferred convention,
> > and were amended to be very consistent on it. So, I'll have a clear
> > model to follow. :-)
>
> Hi François,
>
> A long time ago all capitals was the only way these keywords were
> supported. Since then they have become case insensitive and I use all
> lowercase for most of my keywords now (#+begin_src:, #+begin_example:
> etc)
>
> With fontification these stand out enough now and the capitalization can
> be removed. I still tend to use allcaps at the top of the file for
> things like #+FILETAGS:, #+TITLE:, #+OPTIONS, etc but the blocks
> embedded in my text are all lowercase now.
>
> I wouldn't spend too much time agonizing over the 'right' way - do what
> works for you :)
>
... and check out "easy templates" to get consistent capitalization
*and* speed up your typing:
(info "(org) Easy Templates")
Nick
next prev parent reply other threads:[~2012-01-10 5:13 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 [this message]
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 ` [PATCH] " Thomas S. Dye
2012-01-11 22:42 ` 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=23144.1326172391@gamaville.dokosmarshall.org \
--to=nicholas.dokos@hp.com \
--cc=bernt@norang.ca \
--cc=emacs-orgmode@gnu.org \
--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).