emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Status of syntax specification
@ 2020-05-17  9:54 Gerry Agbobada
  2020-05-18 13:55 ` Nicolas Goaziou
  0 siblings, 1 reply; 3+ messages in thread
From: Gerry Agbobada @ 2020-05-17  9:54 UTC (permalink / raw)
  To: emacs-orgmode

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

Hello,

I found on Worg a "draft" for org syntax description : https://orgmode.org/worg/dev/org-syntax.html

Do you think this paper marked as draft is good enough to use as a source to make a parser ?  <https://orgmode.org/worg/dev/org-syntax.html>
I think it'd be nice to try to finalize this ; but I don't know who to contact to see how I can help
 if I know almost nothing about standards and technical writing.


Best regards,
Gerry Agbobada

[-- Attachment #2: Type: text/html, Size: 760 bytes --]

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Status of syntax specification
  2020-05-17  9:54 Status of syntax specification Gerry Agbobada
@ 2020-05-18 13:55 ` Nicolas Goaziou
  2020-05-19  8:44   ` Gerry Agbobada
  0 siblings, 1 reply; 3+ messages in thread
From: Nicolas Goaziou @ 2020-05-18 13:55 UTC (permalink / raw)
  To: Gerry Agbobada; +Cc: emacs-orgmode

Hello,

"Gerry Agbobada" <gerry@gagbo.net> writes:

> I found on Worg a "draft" for org syntax description : https://orgmode.org/worg/dev/org-syntax.html
>
> Do you think this paper marked as draft is good enough to use as
> a source to make a parser ?

It is "good enough", but possibly slightly inaccurate at some points.

It would need proof reading, and comparing with "org-element.el", the
actual implementation of the syntax. Formalization may be better better,
too.

> I think it'd be nice to try to finalize this ; but I don't know who to contact to see how I can help
> if I know almost nothing about standards and technical writing.

Reading it and comparing with documentation might help.

Regards,

-- 
Nicolas Goaziou


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Status of syntax specification
  2020-05-18 13:55 ` Nicolas Goaziou
@ 2020-05-19  8:44   ` Gerry Agbobada
  0 siblings, 0 replies; 3+ messages in thread
From: Gerry Agbobada @ 2020-05-19  8:44 UTC (permalink / raw)
  To: Nicolas Goaziou; +Cc: emacs-orgmode

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

> It would need proof reading, and comparing with "org-element.el", the
> actual implementation of the syntax. Formalization may be better better,
> too.

I didn't know that there was a single point of entry to parse elements. I think my first step will be to try to write spec tests in elisp then. Hopefully I can cover most cases in the draft, and then see if org-element returns the tree that I expect for a cursor in various positions.

Spec tests should use ERT too right ? If I try to write those, I might as well make them in a suitable way for integration in org-mode codebase.

Thanks for the draft at least, it is a very helpful kickstart !


Gerry Agbobada

[-- Attachment #2: Type: text/html, Size: 932 bytes --]

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-05-19  8:44 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-17  9:54 Status of syntax specification Gerry Agbobada
2020-05-18 13:55 ` Nicolas Goaziou
2020-05-19  8:44   ` Gerry Agbobada

Code repositories for project(s) associated with this 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).