On 03/08/2023 22:03, Nicholas D Steeves wrote:
Nicolas Goaziou to emacs-orgmode. Re: * [[shell:cat ~/tmp | grep "asdf
:: "]] does not work. Wed, 24 Feb 2016 18:38:09 +0100
This is not a bug. - .... :: *is* description list syntax, no matter how
you look at it. You can easily work around this, e.g., by starting the
link on the next line.
I read the thread upstream, and see what you mean, and upstream's
perspective makes sense. How do you feel about keeping this bug open,
I do not see any value in having this bug in the open state, but I am
leaving decision up to you. I rarely visit list of bugs for the elpa-org
and org-mode packages.
because this "gotcha" should be documented somewhere. I'm not sure if
org-mode's documentation would be the best place, because it's non-free.
In my opinion, the "first wins" rule should be prominently stressed in
Org mode syntax description and it should be done in some general
section, not in description of items
https://orgmode.org/worg/org-syntax.html#Items
It should help to make behavior of pandoc, org-ruby, etc. more
consistent. However I can not suggest specific wording.
Despite some conflict of licenses, I do not think it is possible to
avoid reading of the Org mode manual. It may benefit from a note on
ambiguous syntax. Currently it has some references to zero width space
hack only
https://orgmode.org/manual/Escape-Character.html
that has some drawbacks and not applicable to links.
https://orgmode.org/manual/Link-Format.html
Discusses escaping of brackets only disregarding possible interference
with other markup structures.
https://orgmode.org/manual/Plain-Lists.html
does not mention possible issues as well.
Besides the manual, there are online-only (unless you clone the
repository) docs at https://orgmode.org/worg/ If you are more
comfortable with Debian wiki, you may create a page with tricks there.
Perhaps it would be more "visible" to users than the bug report.
For future readers of this bug, Brian G Powell wrote some nice style
suggestions for avoiding this pitfall, so here is the link:
https://list.orgmode.org/CAFm0skF=3JNXQQPFYutEvM8y+FRZJziE+QngVX=gocx3rkq...@mail.gmail.com/#t
While I agree with Brian in general, in this particular case I would
consider a more concise variant: breaking "::" by insertion of some
characters:
- [[shell:cat ~/tmp | grep "asdf :"": "]] does +not+ work.
More checkers may be added to `org-lint' to catch similar pitfalls.
Indeed! Please go ahead and give this bug a more useful title.
It falls in a rather generic class of
"Enclosing markup may lead to unexpected parsing results"
perhaps
"Double colon unexpectedly converts an item into description list"
would be better
