From: Bastien <bzg@altern.org>
To: Nicolas Goaziou <n.goaziou@gmail.com>
Cc: Nick Dokos <nicholas.dokos@hp.com>,
emacs-orgmode mailing list <emacs-orgmode@gnu.org>,
Marcelo de Moraes Serpa <celoserpa@gmail.com>,
Carsten Dominik <carsten.dominik@gmail.com>
Subject: Re: Formal description of Org files
Date: Tue, 19 Jul 2011 01:35:23 +0200 [thread overview]
Message-ID: <87ipqzupqc.fsf@gnu.org> (raw)
In-Reply-To: <87vcuzhmsq.fsf@gmail.com> (Nicolas Goaziou's message of "Mon, 18 Jul 2011 13:04:53 +0200")
Hi Nicolas,
Nicolas Goaziou <n.goaziou@gmail.com> writes:
> I didn't follow closely the thread, but I think having a formal
> description of Org files is unrealistic at the moment.
Still it would be useful to *try* to describe Org's various elements as
formally as possible.
> Org "format" is heavily dependant on user-configurable variables deeply
> installed within emacs. Some of these variables can drastically change
> the grammar of the Org file. Example:
>
> #+begin_src org
> - item 1
>
> - item a
> #+end_src
>
> Now, if org-empty-line-terminates-plain-lists is a non-nil value, any
> parser should detect two lists of one item each, while keeping it to nil
> will imply there is one list of two items.
>
> Another example: (setq org-deadline-string "ZORGLUB:"). I let you
> imagine what confusion it might introduce if the external tool you want
> to use/implement isn't aware of this change.
>
> Sure, it's all plain text, so Org files are accessible from outside
> emacs. But, for now, only the plain-text structure is accessible from
> the wild, not the Org one.
>
> I can see three options here:
>
> - We remove every configurability concerning Org structure: we enforce
> DEADLINE to stay DEADLINE, lists items to be separated by a blank
> line, etc. But this isn't serious, is it?
Nope :)
> - We consider that Org "format" is a package containing the body _and_
> every configuration variable. But it isn't plain-text nor a format
> anymore.
Not really useful -- the purpose of better defining the format is to
make it parsable outside Emacs.
> - We implement an intermediary real format (maybe in plain text, but
> I'd favor a nested-lists construct) that would serve as the common
> denominator for every exporter _and_ importer out there. I already
> suggested something like this in a recent thread about
> exporters. Obviously, I think this one is the only viable (and,
> icing on the cake, this would also be very useful for Org
> development).
I see yet another option:
Describe a plain text format with the _default_ config options.
Meaning DEADLINE will be DEADLINE -- and nothing else.
--
Bastien
next prev parent reply other threads:[~2011-07-18 23:35 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-04-15 7:58 Formal description of Org files Carsten Dominik
2011-04-15 8:54 ` Rainer Stengele
2011-04-15 10:57 ` Carsten Dominik
2011-04-15 11:50 ` Peter Frings
2011-04-15 12:05 ` Carsten Dominik
2011-04-15 15:25 ` Jambunathan K
2011-04-20 11:57 ` Olaf.Hamann
2011-04-15 12:58 ` Christian Egli
2011-04-15 13:42 ` Peter Frings
2011-04-15 13:52 ` Filippo A. Salustri
2011-04-15 14:20 ` Wes Hardaker
2011-04-15 17:29 ` Eric Schulte
2011-04-15 18:31 ` Nick Dokos
2011-04-20 12:37 ` Olivier Schwander
2011-07-15 18:07 ` Marcelo de Moraes Serpa
2011-07-16 16:56 ` Bastien
2011-07-16 17:09 ` Nick Dokos
2011-07-16 17:12 ` Bastien
2011-07-16 18:00 ` Searching the org list (was: Formal description of Org files) Memnon Anon
2011-07-16 18:21 ` Formal description of Org files suvayu ali
2011-07-16 18:43 ` Nick Dokos
2011-07-17 23:14 ` Eric Schulte
2011-07-18 9:30 ` Christopher Witte
2011-07-18 23:32 ` Bastien
2011-07-18 21:02 ` Marcelo de Moraes Serpa
2011-07-18 21:03 ` Marcelo de Moraes Serpa
2011-07-18 11:04 ` Nicolas Goaziou
2011-07-18 23:35 ` Bastien [this message]
2011-07-19 6:16 ` Jambunathan K
2011-07-24 18:58 ` Bastien
-- strict thread matches above, loose matches on Subject: below --
2011-04-15 17:13 Rustom Mody
2011-04-15 17:27 ` MidLifeXis at PerlMonks
2014-09-21 12:10 Gustav Wikström
2014-09-21 12:43 ` Nicolas Goaziou
2014-10-02 8:28 ` Samuel Loury
2014-10-02 17:03 ` Nicolas Goaziou
2014-10-04 19:49 ` Gustav Wikström
2014-09-26 8:12 ` Eric S Fraga
2014-09-26 12:53 ` Grant Rettke
2014-09-26 20:51 ` Eric S Fraga
2014-10-04 19:41 ` Gustav Wikström
2014-10-06 14:22 ` Samuel Loury
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=87ipqzupqc.fsf@gnu.org \
--to=bzg@altern.org \
--cc=carsten.dominik@gmail.com \
--cc=celoserpa@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=n.goaziou@gmail.com \
--cc=nicholas.dokos@hp.com \
/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).