From mboxrd@z Thu Jan  1 00:00:00 1970
From: Nicolas Goaziou <n.goaziou@gmail.com>
Subject: Re: Macros [was: Re: ATTR_HTML for a clickable image, howto?]
Date: Thu, 05 Jul 2012 17:09:08 +0200
Message-ID: <8762a2s0rv.fsf@gmail.com>
References: <86pqbrywgr.fsf@iro.umontreal.ca> <87r4w63602.fsf@gnu.org>
	<86vclekyqo.fsf@iro.umontreal.ca> <4F7EAED9.2040804@christianmoe.com>
	<CAJcAo8vc=OKcvzmSB0O1QcHzCPtqGp6jOX34ZsqFZqtHqid5uw@mail.gmail.com>
	<4F803DDC.20808@christianmoe.com>
	<CAJcAo8vF5_oaHMokNQNA-f0y=DKbTMi-e3caDEj_8iZoMUFMCA@mail.gmail.com>
	<4F853CCD.4020601@christianmoe.com>
	<86r4ufr7hx.fsf_-_@mercure.progiciels-bpi.ca> <87wr2ijmoc.fsf@gnu.org>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
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]:58717)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <n.goaziou@gmail.com>) id 1SmnjO-0008MK-3C
	for emacs-orgmode@gnu.org; Thu, 05 Jul 2012 11:12:39 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <n.goaziou@gmail.com>) id 1SmnjH-0000am-VN
	for emacs-orgmode@gnu.org; Thu, 05 Jul 2012 11:12:33 -0400
In-Reply-To: <87wr2ijmoc.fsf@gnu.org> (Bastien's message of "Thu, 05 Jul 2012
	16:40:51 +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: Bastien <bzg@gnu.org>
Cc: =?utf-8?Q?Fran=C3=A7ois?= Pinard <pinard@iro.umontreal.ca>, emacs-orgmode@gnu.org

Hello,

Bastien <bzg@gnu.org> writes:

> Fran=C3=A7ois Pinard <pinard@iro.umontreal.ca> writes:
>
>> If macros are there to stay in Org, it might be worth documenting a more
>> complete specification about how to define and use them.
>
> I'd welcome some improvement of the manual wrt macros -- any taker?

Before documenting anything, we should first define them clearly. That
is, we can define them through documentation, but we shouldn't write
documentation by looking at their current implementation.

Should macros be allowed anywhere (which means that the user can shoot
himself in the foot) or should their expansion happen in a protected
environment (thus limiting their power)?

In the first case, can macros generate inline Babel code, that will be
executed before export?

In the second case, what types of elements are allowed in the protected
environment?

Also, do we want to allow multiples macros definitions to stack up? I.e.

  #+MACRO: a-macro First line of the macro.
  #+MACRO: a-macro Second line of the macro.

If so, do we allow blank lines in them, meaning they can break document
structure even more?

Can the macros be nested?

Since macros arguments are comma-separated, how do one insert commas
within an argument?

Are newline characters allowed in arguments? If not, what else is
forbidden there?

There are probably other questions, but it should be a good start for
a correct implementation.


Regards,

--=20
Nicolas Goaziou