From mboxrd@z Thu Jan  1 00:00:00 1970
From: Carsten Dominik <carsten.dominik@gmail.com>
Subject: Re: variable names in manual
Date: Fri, 26 Apr 2013 10:46:58 +0200
Message-ID: <0E4CF51C-C71C-435B-B382-8C85514C0113@gmail.com>
References: <94889.1366933045@greg-minshalls-mbp.local>
	<20130425234809.GC12340@kuru.dyndns-at-home.com>
	<FC50E84E-6D2C-42BF-96E0-983DF00841EE@gmail.com>
	<20130426084103.GD2769@kuru.dyndns-at-home.com>
Mime-Version: 1.0 (Mac OS X Mail 6.3 \(1503\))
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: quoted-printable
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([208.118.235.92]:33084)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <carsten.dominik@gmail.com>) id 1UVeJ4-0001Tw-EL
	for emacs-orgmode@gnu.org; Fri, 26 Apr 2013 04:47:03 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <carsten.dominik@gmail.com>) id 1UVeJ3-0008Rw-2T
	for emacs-orgmode@gnu.org; Fri, 26 Apr 2013 04:47:02 -0400
Received: from ezel.ic.uva.nl ([146.50.108.158]:46884)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <carsten.dominik@gmail.com>) id 1UVeJ2-0008Rb-Qg
	for emacs-orgmode@gnu.org; Fri, 26 Apr 2013 04:47:01 -0400
In-Reply-To: <20130426084103.GD2769@kuru.dyndns-at-home.com>
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: Suvayu Ali <fatkasuvayu+linux@gmail.com>
Cc: emacs-orgmode@gnu.org


On 26 apr. 2013, at 10:41, Suvayu Ali <fatkasuvayu+linux@gmail.com> =
wrote:

> Hi Carsten,
>=20
> On Fri, Apr 26, 2013 at 10:10:32AM +0200, Carsten Dominik wrote:
>>=20
>> I suspect that the cases you are talking about here are due
>> to incorrect use of the texinfo command @var{}.  This should
>> only be used for metasyntactical variables, when they stand
>> for something else in a description.=20
>>=20
>> Here is an example from the current manual.
>>=20
>>  You can customize this behavior using the option
>>  @var{org-table-use-standard-references}.} to use another, more =
general
>>  representation that looks like this:
>>  @example
>>  @@@var{row}$@var{column}
>>  @end example
>>=20
>> The first use of @var is incorrect, @code should be used here.  But
>> the use in @var{row} and @var{column} is correct.
>>=20
>> I believe that a while ago we did use @var and @code correctly, but
>> someone went through and changed the @code{org-...} to @var{org-...}
>> at some point.  We need to change this back.
>=20
> I believe reverting this commit should do it:
>=20
>  commit 7ed97e767dd4f4fbceac39a9758dbf594a4fd2fd
>  Author: Bastien Guerry <bzg@altern.org>
>  Date:   Mon Apr 15 00:51:20 2013 +0200
>=20
>      org.texi: Use @var{...} instead of @code{...} for variables
>=20
>      * org.texi: Use @var{...} instead of @code{...} for =
variables.}}}}

Yes, I agree.  Let's wait for Bastien to take a last look at this, but =
it should indeed be reverted.

- Carsten

>=20
> Cheers,
>=20
> --=20
> Suvayu
>=20
> Open source is the future. It sets us free.