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

From: Ihor Radchenko <yantar92@posteo.net>
To: Tom Alexander <tom@fizz.buzz>
Cc: emacs-orgmode@gnu.org
Subject: Re: Lesser blocks allowing unescaped lines
Date: Thu, 05 Oct 2023 10:29:38 +0000	[thread overview]
Message-ID: <875y3ljral.fsf@localhost> (raw)
In-Reply-To: <dafba8bc-bbb8-4110-a4f5-b1d673d3d295@app.fastmail.com>

"Tom Alexander" <tom@fizz.buzz> writes:

> This happens in worg at: https://git.sr.ht/~bzg/worg/tree/ba6cda890f200d428a5d68e819eef15b5306055f/exporters/ox-docstrings.org#L2490
>
> The documentation for lesser blocks[1] states:
>> Lines beginning with an asterisk or `#+` must be quoted by a comma (`,*`, `,#+`).
>
> However, the following test document parses as a lesser block despite containing a line starting with an unescaped #+:
> ```
> #+CATEGORY: foo
> #+begin_src text
> #+CATEGORY: bar
> #+end_src
> ```

Escaping #+ lines is optional and mostly necessary to avoid confusing
parser.
For example, one would need to escape


#+CATEGORY: foo
#+begin_src text
,#+end_src
#+end_src

for obvious reasons.

I have clarified the syntax document in
https://git.sr.ht/~bzg/worg/commit/b1d16efc

Hope the new examples explain better what is going on.

> This test document shows that lines with an unescaped "*" do break up the lesser block:
> ```
> * foo
> #+begin_src text
> * bar
> #+end_src
> ```

Unlike #+ lines, * is _always_ interpreted as a heading. So, it must
always be escaped.

The parser simply removes commas in all the ,* and ,#+ lines.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

next prev parent reply	other threads:[~2023-10-05 10:29 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-30  5:06 Lesser blocks allowing unescaped lines Tom Alexander
2023-10-01 15:30 ` Max Nikulin
2023-10-05 10:29 ` Ihor Radchenko [this message]
2023-10-07  1:18   ` Tom Alexander

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=875y3ljral.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=tom@fizz.buzz \
    /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).