From: Nicolas Goaziou <n.goaziou@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: [RFC] [PATCH] [parser] org-element.el: Handle block parameters
Date: Thu, 31 Oct 2013 12:00:23 +0100 [thread overview]
Message-ID: <878ux9aens.fsf@gmail.com> (raw)
In-Reply-To: <87ob66bdp5.fsf@gmail.com> (Aaron Ecay's message of "Wed, 30 Oct 2013 18:23:34 -0400")
Hello,
Aaron Ecay <aaronecay@gmail.com> writes:
> 2013ko urriak 30an, Nicolas Goaziou-ek idatzi zuen:
>> IIRC, I already suggested a solution with Babel for this problem.
>> There's no need to complicate core Org syntax for such a specific
>> case.
>
> And I already said why I disagree that your proposal is a solution.
> Special blocks are “Containers targeted at export back-ends” (according
> to the manual). Is it appropriate for such containers to have metadata
> attached? As I explain below, I think so. Whether you approve or
> disapprove of the use to which someone puts that metadata in a specific
> instance is a different question, as long as we agree that the metadata
> is potentially useful for some things.
Metadata relative to export back-ends is stuffed into #+attr_backend
keywords. There's no reason to clobber Org syntax with back-ends
metadata.
>> Actually, there are two points to consider:
>>
>> 1. Providing something like :author implies that all back-ends in core
>> and contrib and the manual have to be updated accordingly.
>
> Yes, that is desirable eventually. I guess whoever implements :author
> for quotes (maybe it will be me) will need to think about all these
> things. (Though I’m not sure that all backends have to be updated in
> one fell swoop. The old behavior is still fine as a fall-back until all
> backends catch up to the new standard.
All backends will not magically catch-up if nobody does the job.
Creating new syntax has a cost, which is higher than simply adding a few
lines in "org-element.el".
>> 2. "parameters" is too vague to be useful. It needs to be parsed
>> further, which means that we must define explicitly use cases and
>> keywords. Thus, I don't think adding "parameters" to every block is
>> a good move if we don't know beforehand how they will be used.
>>
>> Though, it is possible to extend the syntax to well-defined
>> specific cases. :author may be one of them, there are certainly
>> others.
>
> I have the opposite view. The parser should provide a set of convenient
> tools to elisp code, which are useful for extending org’s functionality
> at the elisp level. An “if you build it they will come” approach.
I'm trying to unify and simplify Org syntax. The simpler the better.
That doesn't mean that the syntax cannot be extended, but I'd like to
see a concrete good reason for it. "Let's do it as it might be used
later" just doesn't cut it.
Moreover, your proposal, IMO, is not well-enough defined. You merely add
a free-form string and call it "parameters". Parameters for what? Which
syntax: a plist, switches? Why cannot some parameters fit into other
affiliated keywords (e.g. HEADER)? What happens if the line is too long:
is there another location for them? What happens if they compete with
other affiliated keywords, i.e. what if I write
#+begin_quote :caption "Something"
So, again, it is important to know what they do so we can deduce what
location is the more appropriate for them. For example, "attributes"
should be short enough to fit on a single line. Switches are good
candidates, a plist is not (see switches in example blocks, for
example), unless we limit allowed keywords in it.
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2013-10-31 11:00 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-10-28 19:04 [RFC] [PATCH] [parser] org-element.el: Handle block parameters Aaron Ecay
2013-10-29 8:20 ` Nicolas Goaziou
2013-10-30 4:28 ` Aaron Ecay
2013-10-30 8:01 ` Nicolas Goaziou
2013-10-30 22:23 ` Aaron Ecay
2013-10-31 11:00 ` Nicolas Goaziou [this message]
2013-10-31 18:15 ` Aaron Ecay
2013-10-31 19:08 ` Nicolas Goaziou
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=878ux9aens.fsf@gmail.com \
--to=n.goaziou@gmail.com \
--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
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).