emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@gmail.com>
To: rms@gnu.org
Cc: eliz@gnu.org,  theophilusx@gmail.com,  monnier@iro.umontreal.ca,
	acm@muc.de,  emacs-orgmode@gnu.org, emacs-devel@gnu.org
Subject: Org syntax compatibility with texinfo syntax (was: Org mode and Emacs (was: Convert README.org to plain text README while installing package))
Date: Fri, 17 Jun 2022 14:42:40 +0800	[thread overview]
Message-ID: <87k09frdsv.fsf@localhost> (raw)
In-Reply-To: <87h74mv56b.fsf@localhost>

I am forwarding yet another email from the emacs-devel thread to here.
This thread includes both emacs-devel and Org ML.
I will still keep emacs-devel in the loop because people from there can
provide a useful insight about texinfo capabilities.

Richard Stallman wrote:

> I don't know for certain that every possible nesting "does the right
> thing".  I do know that @var{} is used inside many other constructs.
> By contrast, @dfn{} would not be nested inside or around other
> contructs very much.  @key can be nested inside @kbd, and it behaves
> a little differently when nested.

signifying (in addition to previous message), that
1. Texinfo has some software documentation-specific markup elements
2. Those elements can be nested in non-trivial ways, similar to Org's
org-element-object-restrictions, the that nesting can affect formatted
export (again, similar to Org).

With regards to Org syntax, I do not think that we must include all the
possible texinfo elements into Org standard.
@dfn, @key, and @var constructs are extremely specific to software
documentation and have no sense to maintain as a part of general-purpose
markup syntax.

However, what we can do is to allow extending Org syntax to support such
elements. We do support custom syntax elements already (or are
discussing such support):

We have the following, potentially customizeable syntax elements:
- Org links (extensible via org-link-set-parameters)
- Special blocks (de-facto extensible in export backends; also,
- [FR] Inline special blocks idea being discussed in

The links are somewhat limited wrt nesting: links cannot be nested
inside links thus limiting their usefulness as custom markup. Hence, we
may need to look more closely into the idea of inline special blocks
(discuss it in https://orgmode.org/list/87a6b8pbhg.fsf@posteo.net).

Special blocks already support custom :type, but lack convenient Elisp
interface like org-link-set-parameters. (let's keep this part in

I'd like to keep discussion on the specifics of customizeable Org syntax
in the relevant threads.

In here, I'd like to hear feedback on possible additional
incompatibilities between texinfo and Org. Is there anything (not
covered by the above list) that is present in texinfo, but impossible in

For starters, Org does not have a full support for generating index
(apart from ox-texinfo and ox-publish). Though see


  parent reply	other threads:[~2022-06-17  6:45 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <YpuV9DKe9kzNt5np@ACM>
     [not found] ` <871qw31ois.fsf@yahoo.com>
     [not found]   ` <8735gj4ceo.fsf@gnu.org>
     [not found]     ` <87ee038ipt.fsf@gmx.de>
     [not found]       ` <87o7z61v59.fsf@gmail.com>
     [not found]         ` <Yp3l+rjJ0mAIcVZJ@ACM>
     [not found]           ` <87bkv527p5.fsf@gmail.com>
     [not found]             ` <835yld93w7.fsf@gnu.org>
     [not found]               ` <877d5t0yrn.fsf@gmail.com>
     [not found]                 ` <Yp92eI2pEuc/gQu4@ACM>
     [not found]                   ` <jwvtu8wbbjb.fsf-monnier+emacs@gnu.org>
     [not found]                     ` <87r140yuof.fsf@gmail.com>
     [not found]                       ` <E1nzQh5-0001OB-22@fencepost.gnu.org>
     [not found]                         ` <875yl9e7zm.fsf@gmail.com>
     [not found]                           ` <83czfh12kp.fsf@gnu.org>
     [not found]                             ` <87pmjhghu2.fsf@localhost>
     [not found]                               ` <835yl910gp.fsf@gnu.org>
     [not found]                                 ` <87wndndbhq.fsf@gmail.com>
     [not found]                                   ` <83bkuzznws.fsf@gnu.org>
     [not found]                                     ` <877d5mqmkh.fsf@localhost>
     [not found]                                       ` <E1o0sgC-0000jg-U3@fencepost.gnu.org>
2022-06-14  0:43                                         ` Org mode and Emacs (was: Convert README.org to plain text README while installing package) Ihor Radchenko
2022-06-15  5:58                                           ` Ihor Radchenko
2022-06-16 10:05                                             ` Tom Gillespie
2022-06-18 10:56                                               ` Simplified Org mode for newcomer Emacs veterans (was: Org mode and Emacs (was: Convert README.org to plain text README while installing package)) Ihor Radchenko
2022-06-18 22:04                                                 ` Tim Cross
2022-06-19  8:49                                                   ` Ihor Radchenko
2022-06-17  6:42                                             ` Ihor Radchenko [this message]
     [not found]                                   ` <E1o0Bgv-0008SK-Gs@fencepost.gnu.org>
     [not found]                                     ` <874k0qbrhe.fsf@localhost>
     [not found]                                       ` <E1o0WEH-0004wk-Hw@fencepost.gnu.org>
     [not found]                                         ` <87v8t3wfgd.fsf@localhost>
     [not found]                                           ` <87zgifxt48.fsf@gmail.com>
2022-06-15  6:13                                             ` Cusom special block export, similar org org-link :export parameter (was: Org mode and Emacs) Ihor Radchenko

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:

  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=87k09frdsv.fsf@localhost \
    --to=yantar92@gmail.com \
    --cc=acm@muc.de \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=rms@gnu.org \
    --cc=theophilusx@gmail.com \


* 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


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).