From: Ihor Radchenko <yantar92@posteo.net>
To: Max Nikulin <manikulin@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Verbatim content (inline-special-block)
Date: Fri, 12 Apr 2024 17:53:24 +0000 [thread overview]
Message-ID: <87r0facvsb.fsf@localhost> (raw)
In-Reply-To: <uvb3u7$o1r$1@ciao.gmane.io>
Max Nikulin <manikulin@gmail.com> writes:
>> It may be enough to have @kbd{@code{...}} - it is not like Texinfo has a
>> concept of truly verbatim text like in Org.
>>
>> Alternatively, we may allow two classes of inline markup:
>> @foo{parsed *text* inside}
>> and
>> @foo={verbatim *text* inside}/@foo~{verbatim *text* inside}
>>
>> This way, instead of @code{}, we should use @code~{...} or even
>> @~{...}/@={...} (mnemonics for ~...~ and =...=)
>
> I consider @foo={}-like variants as unnecessary complications of the
> inline special block feature. The idea of composition is better from my
> point of view. With this approach it is enough to have non-conflicting
> syntax for non-parsed fragments. I am against making @code{} a special
> name with suppressed markup parsing. The price of composition in
> comparison with @foo={} is more verbose markup.
Then, do you have an idea about such syntax?
One option I thought of was making @foo{=...=} a special type of boundary
delimiting non-parsing contents. However, it is not very elegant IMHO.
> By the way, Org has src_lang{...} syntax for almost non-parsed fragments
> (neglecting requirement of balanced curly brackets that is an issue).
Yes, but it is handled differently by exporters from =verbatim=/~code~.
In fact, even the idea with @foo{@code{...}} may be problematic in this
regard - @code{...} inside, if we treat it as an equivalent of ~code~,
may be problematic if some export backends do something unusual about
code markup.
> Actually "=" in @foo={} is a kind of special argument distinct from ones
> specified inside [] and {}.
Yes, but it is much easier to parse. If we use a proper attribute, we
run into all kind of issues with how consistent it should be with the
parsing rules for other attributes (should it be inherited? may it
appear in arbitrary place in [...]?). And if we make it special, we will
run in various special cases in the parser...
>>> @code{def calculate(@param{expr}, @param{env})}
> [...]
>> Also, the reason why Texinfo users do @param in @code is the lack of
>> automatic syntax highlighting, unlike in Org mode.
>
> Is ox-texinfo able to convert syntax highlighting to native texinfo markup?
No.
> So if @markup{} is not allowed in verbatim content then it is another
> feature loosely related to custom inline blocks.
May you elaborate?
--
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:[~2024-04-12 17:54 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-11 10:49 inline-special-block: part2 Max Nikulin
2024-04-11 11:03 ` Verbatim content (inline-special-block) Max Nikulin
2024-04-11 12:58 ` Ihor Radchenko
2024-04-12 10:55 ` Max Nikulin
2024-04-12 17:53 ` Ihor Radchenko [this message]
2024-04-11 11:08 ` Link to the repository (Re: inline-special-block: part2) Max Nikulin
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=87r0facvsb.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=manikulin@gmail.com \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).