emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Timothy <tecosaur@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Some commentary on the Org Syntax document
Date: Thu, 02 Dec 2021 17:23:08 +0800	[thread overview]
Message-ID: <87mtljpd1w.fsf@gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 2302 bytes --]

Hi All (& Nicolas in particular again),

With my recent efforts to write a parser based on
<https://orgmode.org/worg/dev/org-syntax.html>, I’ve developed a few thoughts on
that document. Hopefully, they can lead to some improvements and
clarifications.

――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――

As a general comment, in many places the Org Syntax document states what
characters a component can contain, but not what objects/elements. This feels
like a bit of a hole in the current specifications.


Sections
════════

Heading
───────

⁃ Ok, so `TITLE' can have any character but a newline, but what Org components can it contain?
  I’m going to assume any object?


Affiliated Keywords
═══════════════════


Greater Elements
════════════════

Greater blocks
──────────────

⁃ It is not explained what is ment by a “special block”
⁃ Aren’t lines starting with `#+' also quoted by a comma?


Drawers and Property Drawers
────────────────────────────

⁃ “Contents can contain any element but another drawer”
  • Does “any element” mean “any Element or Greater Element”


Dynamic Blocks
──────────────

⁃ It is not specified what `CONTENTS' may be
⁃ Surely `PARAMETERS' cannot contain a newline?


Plain Lists and Items
─────────────────────

⁃ It is not completely clear what content an item may have.
  I assume any Object?


Tables
──────

⁃ Surely newlines are not allowed in `FORMULAS'


Elements
════════

Clocks
──────

Two allowed forms are listed, but are all four of the below allowed or only two?
┌────
│ CLOCK: INACTIVE-TIMESTAMP
│ CLOCK: INACTIVE-TIMESTAMP DURATION
│ CLOCK: INACTIVE-TIMESTAMP-RANGE
│ CLOCK: INACTIVE-TIMESTAMP-RANGE DURATION
└────

All the best,
Timothy

next             reply	other threads:[~2021-12-02  9:33 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-02  9:23 Timothy [this message]
2021-12-02 19:00 ` Some commentary on the Org Syntax document Tom Gillespie
2021-12-02 19:16   ` Timothy
2021-12-04  5:26     ` Tom Gillespie
2021-12-04  6:17     ` Ihor Radchenko
2021-12-04  6:48       ` Timothy
2021-12-04  7:40         ` Ihor Radchenko
2021-12-04  8:09           ` Timothy
2021-12-04  9:41           ` Nicolas Goaziou
2021-12-04 14:00             ` Ihor Radchenko
2021-12-04 14:43               ` Nicolas Goaziou
2021-12-05  6:30                 ` Ihor Radchenko
2021-12-05  9:28                   ` 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=87mtljpd1w.fsf@gmail.com \
    --to=tecosaur@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

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).