Lesser blocks allowing unescaped lines

Lesser blocks allowing unescaped lines

[Tom Alexander]

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
```

which parses as:
```
(org-data
(:standard-properties
  [1 1 1 60 60 0 nil org-data nil nil nil 3 60 nil #<buffer *scratch*> nil nil nil]
  :path nil :CATEGORY "foo")
(section
  (:standard-properties
   [1 1 1 60 60 0 nil first-section nil nil nil 1 60 nil #<buffer *scratch*> nil nil #0])
  (keyword
   (:standard-properties
    [1 1 nil nil 17 0 nil top-comment nil nil nil nil nil nil #<buffer *scratch*> nil nil #1]
    :key "CATEGORY" :value "foo"))
  (src-block
   (:standard-properties
    [17 17 nil nil 60 0 nil nil nil nil nil nil nil nil #<buffer *scratch*> nil nil #1]
    :language "text" :switches nil :parameters nil :number-lines nil :preserve-indent nil :retain-labels t :use-labels t :label-fmt nil :value "#+CATEGORY: bar\n"))))
```

whereas I would expect this to be
```
(section
  (keyword :key "CATEGORY" :value "foo")
  (paragraph "#+begin_src text")
  (keyword :key "CATEGORY" :value "bar")
  (paragraph "#+end_src")
)
```

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


[1] https://orgmode.org/worg/org-syntax.html#Blocks

--
Tom Alexander
pgp: https://fizz.buzz/pgp.asc

Re: Lesser blocks allowing unescaped lines

[Max Nikulin]

On 30/09/2023 12:06, Tom Alexander wrote:
> 
> 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
> ```

You have to quote #+end_src inside source code blocks or #+end_example 
in the case of #+begin_example block

#+begin_example
,#+end_example
#+end_example

Re: Lesser blocks allowing unescaped lines

[Ihor Radchenko]

"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>

Re: Lesser blocks allowing unescaped lines

[Tom Alexander]

Thank you! Makes sense.

--
Tom Alexander
pgp: https://fizz.buzz/pgp.asc